Skip to content

Describe Dhcp Options

ec2_describe_dhcp_options R Documentation

Describes your DHCP option sets

Description

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.

Usage

ec2_describe_dhcp_options(DhcpOptionsIds, Filters, DryRun, NextToken,
  MaxResults)

Arguments

DhcpOptionsIds

The IDs of DHCP option sets.

Filters

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:\<key\> - 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.

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.

NextToken

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

MaxResults

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.

Value

A list with the following syntax: 

list(
  DhcpOptions = list(
    list(
      DhcpConfigurations = list(
        list(
          Key = "string",
          Values = list(
            list(
              Value = "string"
            )
          )
        )
      ),
      DhcpOptionsId = "string",
      OwnerId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_dhcp_options(
  DhcpOptionsIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# This example describes the specified DHCP options set.
svc$describe_dhcp_options(
  DhcpOptionsIds = list(
    "dopt-d9070ebb"
  )
)

## End(Not run)