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

Class: Aws::EC2::Types::DescribeTagsRequest

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 DescribeTagsRequest data as a hash:

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

Contains the parameters for DescribeTags.

Instance Attribute Summary collapse

Instance Attribute Details

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


10335
10336
10337
10338
10339
10340
10341
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10335

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

#filtersArray<Types::Filter>

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

  • value - The tag value.

Returns:



10335
10336
10337
10338
10339
10340
10341
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10335

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

#max_resultsInteger

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

  • (Integer)


10335
10336
10337
10338
10339
10340
10341
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10335

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

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


10335
10336
10337
10338
10339
10340
10341
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10335

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