Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeDhcpOptions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes one or more of your DHCP options sets.

For more information, see DHCP options sets in the Amazon Virtual Private Cloud User Guide.

This operation returns paginated results.

Synopsis

data DescribeDhcpOptions = DescribeDhcpOptions' {
- dhcpOptionsIds :: Maybe [Text]
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newDescribeDhcpOptions :: DescribeDhcpOptions
describeDhcpOptions_dhcpOptionsIds :: Lens' DescribeDhcpOptions (Maybe [Text])
describeDhcpOptions_dryRun :: Lens' DescribeDhcpOptions (Maybe Bool)
describeDhcpOptions_filters :: Lens' DescribeDhcpOptions (Maybe [Filter])
describeDhcpOptions_maxResults :: Lens' DescribeDhcpOptions (Maybe Natural)
describeDhcpOptions_nextToken :: Lens' DescribeDhcpOptions (Maybe Text)
data DescribeDhcpOptionsResponse = DescribeDhcpOptionsResponse' {
- dhcpOptions :: Maybe [DhcpOptions]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeDhcpOptionsResponse :: Int -> DescribeDhcpOptionsResponse
describeDhcpOptionsResponse_dhcpOptions :: Lens' DescribeDhcpOptionsResponse (Maybe [DhcpOptions])
describeDhcpOptionsResponse_nextToken :: Lens' DescribeDhcpOptionsResponse (Maybe Text)
describeDhcpOptionsResponse_httpStatus :: Lens' DescribeDhcpOptionsResponse Int

Creating a Request

data DescribeDhcpOptions Source #

See: newDescribeDhcpOptions smart constructor.

Constructors

DescribeDhcpOptions'

Fields

dhcpOptionsIds :: Maybe [Text]
The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
filters :: Maybe [Filter]
One or more filters.
- dhcp-options-id - The ID of a DHCP options set.
- key - The key for one of the options (for example, domain-name).
- value - The value for one of the options.
- owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
- tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
- tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
maxResults :: Maybe Natural
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken :: Maybe Text
The token for the next page of results.

Instances

Instances details

ToHeaders DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods toHeaders :: DescribeDhcpOptions -> [Header] #
ToPath DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods toPath :: DescribeDhcpOptions -> ByteString #
ToQuery DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods toQuery :: DescribeDhcpOptions -> QueryString #
AWSPager DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods page :: DescribeDhcpOptions -> AWSResponse DescribeDhcpOptions -> Maybe DescribeDhcpOptions #
AWSRequest DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Associated Types type AWSResponse DescribeDhcpOptions # Methods request :: (Service -> Service) -> DescribeDhcpOptions -> Request DescribeDhcpOptions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDhcpOptions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDhcpOptions))) #
Generic DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Associated Types type Rep DescribeDhcpOptions :: Type -> Type # Methods from :: DescribeDhcpOptions -> Rep DescribeDhcpOptions x # to :: Rep DescribeDhcpOptions x -> DescribeDhcpOptions #
Read DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods readsPrec :: Int -> ReadS DescribeDhcpOptions # readList :: ReadS [DescribeDhcpOptions] # readPrec :: ReadPrec DescribeDhcpOptions # readListPrec :: ReadPrec [DescribeDhcpOptions] #
Show DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods showsPrec :: Int -> DescribeDhcpOptions -> ShowS # show :: DescribeDhcpOptions -> String # showList :: [DescribeDhcpOptions] -> ShowS #
NFData DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods rnf :: DescribeDhcpOptions -> () #
Eq DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods (==) :: DescribeDhcpOptions -> DescribeDhcpOptions -> Bool # (/=) :: DescribeDhcpOptions -> DescribeDhcpOptions -> Bool #
Hashable DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods hashWithSalt :: Int -> DescribeDhcpOptions -> Int # hash :: DescribeDhcpOptions -> Int #
type AWSResponse DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions type AWSResponse DescribeDhcpOptions = DescribeDhcpOptionsResponse
type Rep DescribeDhcpOptions Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions type Rep DescribeDhcpOptions = D1 ('MetaData "DescribeDhcpOptions" "Amazonka.EC2.DescribeDhcpOptions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeDhcpOptions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dhcpOptionsIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeDhcpOptions :: DescribeDhcpOptions Source #

Create a value of DescribeDhcpOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dhcpOptionsIds:DescribeDhcpOptions', describeDhcpOptions_dhcpOptionsIds - The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

$sel:dryRun:DescribeDhcpOptions', describeDhcpOptions_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

$sel:filters:DescribeDhcpOptions', describeDhcpOptions_filters - One or more filters.

dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

$sel:maxResults:DescribeDhcpOptions', describeDhcpOptions_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

DescribeDhcpOptions, describeDhcpOptions_nextToken - The token for the next page of results.

Request Lenses

describeDhcpOptions_dhcpOptionsIds :: Lens' DescribeDhcpOptions (Maybe [Text]) Source #

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

describeDhcpOptions_dryRun :: Lens' DescribeDhcpOptions (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

describeDhcpOptions_filters :: Lens' DescribeDhcpOptions (Maybe [Filter]) Source #

One or more filters.

dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

describeDhcpOptions_maxResults :: Lens' DescribeDhcpOptions (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

describeDhcpOptions_nextToken :: Lens' DescribeDhcpOptions (Maybe Text) Source #

The token for the next page of results.

Destructuring the Response

data DescribeDhcpOptionsResponse Source #

See: newDescribeDhcpOptionsResponse smart constructor.

Constructors

DescribeDhcpOptionsResponse'
Fields dhcpOptions :: Maybe [DhcpOptions] Information about one or more DHCP options sets. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeDhcpOptionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Associated Types type Rep DescribeDhcpOptionsResponse :: Type -> Type # Methods from :: DescribeDhcpOptionsResponse -> Rep DescribeDhcpOptionsResponse x # to :: Rep DescribeDhcpOptionsResponse x -> DescribeDhcpOptionsResponse #
Read DescribeDhcpOptionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods readsPrec :: Int -> ReadS DescribeDhcpOptionsResponse # readList :: ReadS [DescribeDhcpOptionsResponse] # readPrec :: ReadPrec DescribeDhcpOptionsResponse # readListPrec :: ReadPrec [DescribeDhcpOptionsResponse] #
Show DescribeDhcpOptionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods showsPrec :: Int -> DescribeDhcpOptionsResponse -> ShowS # show :: DescribeDhcpOptionsResponse -> String # showList :: [DescribeDhcpOptionsResponse] -> ShowS #
NFData DescribeDhcpOptionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods rnf :: DescribeDhcpOptionsResponse -> () #
Eq DescribeDhcpOptionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions Methods (==) :: DescribeDhcpOptionsResponse -> DescribeDhcpOptionsResponse -> Bool # (/=) :: DescribeDhcpOptionsResponse -> DescribeDhcpOptionsResponse -> Bool #
type Rep DescribeDhcpOptionsResponse Source #
Instance details Defined in Amazonka.EC2.DescribeDhcpOptions type Rep DescribeDhcpOptionsResponse = D1 ('MetaData "DescribeDhcpOptionsResponse" "Amazonka.EC2.DescribeDhcpOptions" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeDhcpOptionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dhcpOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DhcpOptions])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDhcpOptionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDhcpOptionsResponse'`
-> DescribeDhcpOptionsResponse

Create a value of DescribeDhcpOptionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dhcpOptions:DescribeDhcpOptionsResponse', describeDhcpOptionsResponse_dhcpOptions - Information about one or more DHCP options sets.

DescribeDhcpOptions, describeDhcpOptionsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeDhcpOptionsResponse', describeDhcpOptionsResponse_httpStatus - The response's http status code.

Response Lenses

describeDhcpOptionsResponse_dhcpOptions :: Lens' DescribeDhcpOptionsResponse (Maybe [DhcpOptions]) Source #

Information about one or more DHCP options sets.

describeDhcpOptionsResponse_nextToken :: Lens' DescribeDhcpOptionsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeDhcpOptionsResponse_httpStatus :: Lens' DescribeDhcpOptionsResponse Int Source #

The response's http status code.