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",
}

Constant Summary collapse

SENSITIVE =
[]

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)


23744
23745
23746
23747
23748
23749
23750
23751
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23744

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

#filtersArray<Types::Filter>

The 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 | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).

  • tag:<key> - 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:



23744
23745
23746
23747
23748
23749
23750
23751
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23744

class DescribeTagsRequest < Struct.new(
  :dry_run,
  :filters,
  :max_results,
  :next_token)
  SENSITIVE = []
  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)


23744
23745
23746
23747
23748
23749
23750
23751
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23744

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

#next_tokenString

The token to retrieve the next page of results.

Returns:

  • (String)


23744
23745
23746
23747
23748
23749
23750
23751
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23744

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