You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeDhcpOptionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeDhcpOptionsRequest data as a hash:

{
  dhcp_options_ids: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
  next_token: "String",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dhcp_options_idsArray<String>

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

Returns:

  • (Array<String>)


10999
11000
11001
11002
11003
11004
11005
11006
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10999

class DescribeDhcpOptionsRequest < Struct.new(
  :dhcp_options_ids,
  :filters,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


10999
11000
11001
11002
11003
11004
11005
11006
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10999

class DescribeDhcpOptionsRequest < Struct.new(
  :dhcp_options_ids,
  :filters,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#filtersArray<Types::Filter>

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.

Returns:



10999
11000
11001
11002
11003
11004
11005
11006
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10999

class DescribeDhcpOptionsRequest < Struct.new(
  :dhcp_options_ids,
  :filters,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


10999
11000
11001
11002
11003
11004
11005
11006
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10999

class DescribeDhcpOptionsRequest < Struct.new(
  :dhcp_options_ids,
  :filters,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


10999
11000
11001
11002
11003
11004
11005
11006
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10999

class DescribeDhcpOptionsRequest < Struct.new(
  :dhcp_options_ids,
  :filters,
  :dry_run,
  :next_token,
  :max_results)
  include Aws::Structure
end