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 |
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' {}
- 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.
DescribeDhcpOptions' | |
|
Instances
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
DescribeDhcpOptionsResponse' | |
|
Instances
newDescribeDhcpOptionsResponse Source #
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.