Amazon Elastic Compute Cloud
API Reference (API Version 2013-02-01)
AWS Documentation » Amazon EC2 » API Reference » Actions » DescribeDhcpOptions
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

DescribeDhcpOptions

Description

Describes one or more of your sets of DHCP options.

For more information about DHCP options sets, see Using DHCP Options with Your VPC in the Amazon Virtual Private Cloud User Guide.

Request Parameters

DhcpOptionsId.n

A DHCP options set ID. You can specify more than one in the request.

Type: String

Default: Describes your sets of DHCP options, or only those otherwise specified.

Required: No

Filter.n.Name

The name of a filter. See the Supported Filters section for a list of supported filter names.

Type: String

Default: None

Required: No

Filter.n.Value.m

A value for the filter. See the Supported Filters section for a list of supported values for each filter.

Type: String

Default: None

Required: No

Supported Filters

You can specify filters so that the response includes information for only certain sets of DHCP options. For example, you can use a filter to specify that you're interested in sets of DHCP options with a particular value for the domain-name option. You can specify multiple values for a filter. The response includes information for a set of DHCP options only if it matches at least one of the filter values that you specified.

You can specify multiple filters; for example, specify sets of DHCP options that have a specific value for the domain-name option and a specific tag. The response includes information for a set of DHCP options only if it matches all the filters that you specified. If there's no match, no special message is returned, the response is simply empty.

You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) matches exactly one character. You can escape special characters using a backslash (\) before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following are the available filters.

dhcp-options-id

The ID of a set of DHCP options.

Type: String

key

The key for one of the options (for example, domain-name).

Type: String

value

The value for one of the options.

Type: String

tag-key

The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key filter.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

Type: String

tag-value

The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Type: String

tag:key

Filters the response based on a specific tag/value combination.

Example: To list just the resources that have been assigned tag Purpose=X, specify:

Filter.1.Name=tag:Purpose

Filter.1.Value.1=X

Example: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:

Filter.1.Name=tag:Purpose

Filter.1.Value.1=X

Filter.1.Value.2=Y

Response Elements

The following elements are returned in a DescribeDhcpOptionsResponse element.

requestId

The ID of the request.

Type: xsd:string

dhcpOptionsSet

A list of DHCP options sets, each one wrapped in an item element.

Type: DhcpOptionsType

Examples

Example Request

This example gives a description of the DHCP options set with ID dopt-7a8b9c2d. 

https://ec2.amazonaws.com/?Action=DescribeDhcpOptions
&DhcpOptionsId.1=dopt-7a8b9c2d
&AUTHPARAMS

Example Response

<DescribeDhcpOptionsResponse xmlns="http://ec2.amazonaws.com/doc/2013-02-01/">
  <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
  <dhcpOptionsSet>
    <item>
      <dhcpOptionsId>dopt-7a8b9c2d</dhcpOptionsId>
      <dhcpConfigurationSet>
        <item>
          <key>domain-name</key>
          <valueSet>
            <item>
              <value>example.com</value>
            </item>
          </valueSet>
        </item>
        <item>
          <key>domain-name-servers</key>
          <valueSet>
            <item>
              <value>10.2.5.1</value>
          </item>
          </valueSet>
        </item>
        <item>
          <key>domain-name-servers</key>
          <valueSet>
            <item>
              <value>10.2.5.2</value>
              </item>
          </valueSet>
        </item>
      </dhcpConfigurationSet>
      <tagSet/>
    </item>
  </dhcpOptionsSet>
</DescribeDhcpOptionsResponse>

Example Request

This example uses filters to give a description of any DHCP options set that includes a domain-name option whose value includes the string example.

https://ec2.amazonaws.com/?Action=DescribeDhcpOptions
&Filter.1.Name=key
&Filter.1.Value.1=domain-name
&Filter.2.Name=value
&Filter.2.Value.1=*example*
&AUTHPARAMS
Document Conventions« PreviousNext »
Terms of UseDid this page help you?  Yes | No |  Tell us about it...