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:
-
dhcp_options_ids
(Optional[DhcpOptionsIdStringList], default:
None
)
–
The IDs of DHCP option sets.
-
next_token
(Optional[String], default:
None
)
–
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
-
max_results
(Optional[DescribeDhcpOptionsMaxResults], default:
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.
-
dry_run
(Optional[Boolean], default:
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
(Optional[FilterList], default:
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 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.
Raises:
Examples:
To describe a DHCP options set
This example describes the specified DHCP options set.
>>> client.describe_dhcp_options(dhcp_options_ids=['dopt-d9070ebb'])
Source code in docs_src/capo_ec2/_services/ec2.py
| def describe_dhcp_options(
self,
*,
config_overrides: Optional[EC2ClientConfig] = None,
dhcp_options_ids: Optional[
"capo_ec2.types.dhcp_options_id_string_list.DhcpOptionsIdStringList"
] = None,
next_token: Optional["capo_ec2.types.string.String"] = None,
max_results: Optional[
"capo_ec2.types.describe_dhcp_options_max_results.DescribeDhcpOptionsMaxResults"
] = None,
dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
) -> "capo_ec2.types.describe_dhcp_options_result.DescribeDhcpOptionsResult":
"""<p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html">DHCP option sets</a> in the <i>Amazon VPC User Guide</i>.</p>
Args:
dhcp_options_ids: <p>The IDs of DHCP option sets.</p>
next_token: <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
max_results: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination">Pagination</a>.</p>
dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
filters: <p>The filters.</p> <ul> <li> <p> <code>dhcp-options-id</code> - The ID of a DHCP options set.</p> </li> <li> <p> <code>key</code> - The key for one of the options (for example, <code>domain-name</code>).</p> </li> <li> <p> <code>value</code> - The value for one of the options.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the DHCP options set.</p> </li> <li> <p> <code>tag</code> - 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 <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>
Raises:
capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To describe a DHCP options set
This example describes the specified DHCP options set.
>>> client.describe_dhcp_options(dhcp_options_ids=['dopt-d9070ebb'])
"""
def _handler(
req: "OperationRequest[capo_ec2.types.describe_dhcp_options_request.DescribeDhcpOptionsRequest]",
) -> OperationResponse[
"capo_ec2.types.describe_dhcp_options_result.DescribeDhcpOptionsResult"
]:
import capo_ec2._operations.amazon_ec2.describe_dhcp_options
output, http_response = (
capo_ec2._operations.amazon_ec2.describe_dhcp_options.describe_dhcp_options(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDhcpOptions")
)
input_: capo_ec2.types.describe_dhcp_options_request.DescribeDhcpOptionsRequest = {}
if dhcp_options_ids is not None:
input_["dhcp_options_ids"] = dhcp_options_ids
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if dry_run is not None:
input_["dry_run"] = dry_run
if filters is not None:
input_["filters"] = filters
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|