EC2 / Client / describe_dhcp_options

describe_dhcp_options#

EC2.Client.describe_dhcp_options(**kwargs)#

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.

Request Syntax

response = client.describe_dhcp_options(
    DhcpOptionsIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

DhcpOptionsIds (list) –
The IDs of DHCP option sets.
- (string) –
NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults (integer) – 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.
DryRun (boolean) – 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 (list) –
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.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'DhcpOptions': [
        {
            'OwnerId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'DhcpOptionsId': 'string',
            'DhcpConfigurations': [
                {
                    'Key': 'string',
                    'Values': [
                        {
                            'Value': 'string'
                        },
                    ]
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  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.
- DhcpOptions (list) –
  
  Information about the DHCP options sets.
  - (dict) –
    
    The set of DHCP options.
    - OwnerId (string) –
      
      The ID of the Amazon Web Services account that owns the DHCP options set.
    - Tags (list) –
      
      Any tags assigned to the DHCP options set.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - DhcpOptionsId (string) –
      
      The ID of the set of DHCP options.
    - DhcpConfigurations (list) –
      
      The DHCP options in the set.
      - (dict) –
        
        Describes a DHCP configuration option.
        
        Key (string) –
        
        The name of a DHCP option.
        
        Values (list) –
        
        The values for the DHCP option.
        
        (dict) –
        
        Describes a value for a resource attribute that is a String.
        
        Value (string) –
        
        The attribute value. The value is case-sensitive.

Examples

This example describes the specified DHCP options set.

response = client.describe_dhcp_options(
    DhcpOptionsIds=[
        'dopt-d9070ebb',
    ],
)

print(response)

Expected Output:

{
    'DhcpOptions': [
        {
            'DhcpConfigurations': [
                {
                    'Key': 'domain-name-servers',
                    'Values': [
                        {
                            'Value': '10.2.5.2',
                        },
                        {
                            'Value': '10.2.5.1',
                        },
                    ],
                },
            ],
            'DhcpOptionsId': 'dopt-d9070ebb',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}