Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeDhcpOptions

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DhcpOptionsId.N

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Type: Array of strings

Required: No

DryRun

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.

Type: Boolean

Required: No

Filter.N

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

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

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • 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=value filter.

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

Type: Array of Filter objects

Required: No

Response Elements

The following elements are returned by the service.

dhcpOptionsSet

Information about one or more DHCP options sets.

Type: Array of DhcpOptions objects

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example 1

This example describes the specified DHCP options set.

Sample Request

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

Sample Response

Copy
<DescribeDhcpOptionsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <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 2

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

Sample Request

Copy
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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: