describe_dhcp_options¶
Operation¶
describe_dhcp_options
async
¶
describe_dhcp_options(request: DescribeDhcpOptionsInput | DescribeDhcpOptionsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDhcpOptionsOutput
describe_dhcp_options(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDhcpOptionsInputDict]) -> DescribeDhcpOptionsOutput
Describes your DHCP option sets. The default is to describe all your DHCP option sets. Alternatively, you can specify specific DHCP option set IDs or filter the results to include only the DHCP option sets that match specific criteria.
For more information, see DHCP option sets in the Amazon VPC User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeDhcpOptionsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeDhcpOptionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDhcpOptionsInput structure.
Attributes¶
dhcp_options_ids
class-attribute
instance-attribute
¶
The IDs of DHCP option sets.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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
class-attribute
instance-attribute
¶
The 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- 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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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.
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Dictionaries¶
DescribeDhcpOptionsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeDhcpOptionsInput.
Attributes¶
dhcp_options_ids
instance-attribute
¶
The IDs of DHCP option sets.
dry_run
instance-attribute
¶
dry_run: bool | None
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
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The 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- 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 keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor 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.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Output¶
DescribeDhcpOptionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeDhcpOptionsOutput structure.
Attributes¶
dhcp_options
class-attribute
instance-attribute
¶
dhcp_options: list[DhcpOptions] | None = ...
Information about the DHCP options sets.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to include in another request to get the next page of items.
This value is null when there are no more items to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.