DescribeDhcpOptions

Description

Gives you information about one or more sets of DHCP options. You can specify one or more DHCP options set IDs, or no IDs (to describe all your sets of DHCP options).

You can filter the results to return information only about sets of options that match criteria you specify. For example, you could get information for sets that have a certain value for the domain-name option. You can specify multiple values for the filter. The option must match at least one of the specified values for the options set to be included in the results.

You can specify multiple filters (e.g., a certain value for domain-name, and a tag with a certain value). The result includes information for a set of options only if the specified option matches all your filters. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? 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 table shows the available filters.

Filter Name	Description
`dchp-options-id`	The ID of a set of DHCP options. Type: String
`key`	The key for one of the options (e.g., `domain-name`). Type: String
`value`	The value for one of the options. Type: String
`tag-key`	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=X, see the `tag:key` filter later in this table. For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide. Type: String
`tag-value`	Value of a tag assigned to the resource. This filter is independent of the `tag-key` filter. Type: String
`tag:``key`	Filters the results based on a specific tag/value combination. Example: To list just the resources assigned tag Purpose=X, then specify: `Filter.1.Name=tag:Purpose` `Filter.1.Value.1=X` Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify: `Filter.1.Name=tag:Purpose` `Filter.1.Value.1=X` `Filter.1.Value.2=Y`

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

Request Parameters

Name Description Required

Name	Description	Required
`DhcpOptionsId.n`	A DHCP options set ID. You can specify more than one in the request. Type: String Default: Returns information about all your sets of DHCP options, or only those otherwise specified.	No
`Filter.n.Name`	Name of a filter. See the preceding table for a list of allowed filter names. Type: String Default: Returns information about all your sets of DHCP options, or only those you otherwise specify.	No
`Filter.n.Value.m`	A value for the filter. See the preceding table for a list of allowed values for each filter. Type: String Default: None	No

DhcpOptionsId.n

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

Type: String

Default: Returns information about all your sets of DHCP options, or only those otherwise specified.

No

Filter.n.Name

Name of a filter. See the preceding table for a list of allowed filter names.

Type: String

Default: Returns information about all your sets of DHCP options, or only those you otherwise specify.

No

Filter.n.Value.m

A value for the filter. See the preceding table for a list of allowed values for each filter.

Type: String

Default: None

No

Response Elements

The elements in the following table are wrapped in a DescribeDhcpOptionsResponse structure.

Name Description

Name	Description
`requestId`	The ID of the request. Type: xsd:string
`dhcpOptionsSet`	A list of DHCP options sets. Each set's information is wrapped in an `item` element. Type: DhcpOptionsType Ancestor: `DescribeDhcpOptionsResponse` Children: `item`

requestId

The ID of the request.

Type: xsd:string

dhcpOptionsSet

A list of DHCP options sets. Each set's information is wrapped in an item element.

Type: DhcpOptionsType

Ancestor: DescribeDhcpOptionsResponse

Children: item

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/2011-01-01/">
  <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
  <dhcpOptionsSet>
    <item>
      <dhcpOptionsId>dopt-7a8b9c2d</dhcpOptionsId>
      <dhcpConfigurationSet>
        <item>
          <key>domain-name</key>
          <valueSet>
            <item>
              <value>mydomain.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

DescribeDhcpOptions

Description

Request Parameters

Response Elements

Examples

Example Request

Example Response

Example Request

Related Operations