Class: Aws::EC2::Types::DescribePrefixListsRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribePrefixListsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Note:

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

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

Contains the parameters for DescribePrefixLists.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #dry_run ⇒ Boolean

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

• #max_results ⇒ Integer

  The maximum number of items to return for this request.

• #next_token ⇒ String

  The token for the next set of items to return.

• #prefix_list_ids ⇒ Array<String>

  One or more prefix list IDs.

Instance Attribute Details

#dry_run ⇒ Boolean

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)

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

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

#filters ⇒ Array<Types::Filter>

One or more filters.

• ‘prefix-list-id`: The ID of a prefix list.

• ‘prefix-list-name`: The name of a prefix list.

Returns:

• (Array<Types::Filter>)

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

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

#max_results ⇒ Integer

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

Returns:

• (Integer)

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

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

#next_token ⇒ String

The token for the next set of items to return. (You received this token from a prior call.)

Returns:

• (String)

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

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

#prefix_list_ids ⇒ Array<String>

One or more prefix list IDs.

Returns:

• (Array<String>)

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

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