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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

See Also:

Instance Attribute Summary collapse

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) 


15616
15617
15618
15619
15620
15621
15622
 
# File 'lib/aws-sdk-ec2/types.rb', line 15616

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

#filters ⇒ Array<Types::Filter>

One or more filters.

  • ‘key` - The tag key.

  • ‘resource-id` - The ID of the resource.

  • ‘resource-type` - The resource type (`customer-gateway` | `dedicated-host` | `dhcp-options` | `elastic-ip` | `fleet` | `fpga-image` | `image` | `instance` | `internet-gateway` | `launch-template` | `natgateway` | `network-acl` | `network-interface` | `reserved-instances` | `route-table` | `security-group` | `snapshot` | `spot-instances-request` | `subnet` | `volume` | `vpc` | `vpc-peering-connection` | `vpn-connection` | `vpn-gateway`).

  • ‘tag`:&lt;key&gt; - The key/value combination of the tag. For example, specify “tag:Owner” for the filter name and “TeamA” for the filter value to find resources with the tag “Owner=TeamA”.

  • ‘value` - The tag value.

Returns:



15616
15617
15618
15619
15620
15621
15622
 
# File 'lib/aws-sdk-ec2/types.rb', line 15616

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

#max_results ⇒ Integer

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) 


15616
15617
15618
15619
15620
15621
15622
 
# File 'lib/aws-sdk-ec2/types.rb', line 15616

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

#next_token ⇒ String

The token to retrieve the next page of results.

Returns:

  • (String) 


15616
15617
15618
15619
15620
15621
15622
 
# File 'lib/aws-sdk-ec2/types.rb', line 15616

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