Class: Aws::EC2::Types::DescribeIpamPoolsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeIpamPoolsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  A check for whether you have the required permissions for the action without actually making the request and provides an error response.

• #filters ⇒ Array<Types::Filter>

  One or more filters for the request.

• #ipam_pool_ids ⇒ Array<String>

  The IDs of the IPAM pools you would like information on.

• #max_results ⇒ Integer

  The maximum number of items to return for this request.

• #next_token ⇒ String

  The token for the next page of results.

Instance Attribute Details

#dry_run ⇒ Boolean

A check for 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)

# File 'lib/aws-sdk-ec2/types.rb', line 27861

class DescribeIpamPoolsRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :ipam_pool_ids)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

One or more filters for the request. For more information about filtering, see [Filtering CLI output].

[1]: docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 27861

class DescribeIpamPoolsRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :ipam_pool_ids)
  SENSITIVE = []
  include Aws::Structure
end

#ipam_pool_ids ⇒ Array<String>

The IDs of the IPAM pools you would like information on.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 27861

class DescribeIpamPoolsRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :ipam_pool_ids)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 27861

class DescribeIpamPoolsRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :ipam_pool_ids)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next page of results.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 27861

class DescribeIpamPoolsRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token,
  :ipam_pool_ids)
  SENSITIVE = []
  include Aws::Structure
end