paws.compute (version 0.1.12)

ec2_describe_dhcp_options: Describes one or more of your DHCP options sets

Description

Describes one or more of your DHCP options sets.

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

Usage

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

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"
)

Arguments

DhcpOptionsIds

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Filters

One or more 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 AWS 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 for the next page of results.

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

if (FALSE) {
# This example describes the specified DHCP options set.
svc$describe_dhcp_options(
  DhcpOptionsIds = list(
    "dopt-d9070ebb"
  )
)
}