Class: Aws::ResourceGroupsTaggingAPI::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-resourcegroupstaggingapi/client.rb

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash) —

    a customizable set of options



152
153
154
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 152

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



501
502
503
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 501

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



504
505
506
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 504

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 479

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-resourcegroupstaggingapi'
  context[:gem_version] = '1.0.0'
  Seahorse::Client::Request.new(handlers, context)
end

#get_resources(params = {}) ⇒ Types::GetResourcesOutput

Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.

Examples:

Request syntax with placeholder values


resp = client.get_resources({
  pagination_token: "PaginationToken",
  tag_filters: [
    {
      key: "TagKey",
      values: ["TagValue"],
    },
  ],
  resources_per_page: 1,
  tags_per_page: 1,
  resource_type_filters: ["AmazonResourceType"],
})

Response structure


resp.pagination_token #=> String
resp.resource_tag_mapping_list #=> Array
resp.resource_tag_mapping_list[0].resource_arn #=> String
resp.resource_tag_mapping_list[0].tags #=> Array
resp.resource_tag_mapping_list[0].tags[0].key #=> String
resp.resource_tag_mapping_list[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pagination_token (String) —

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a ‘PaginationToken`, use that string for this value to request an additional page of data.

  • :tag_filters (Array<Types::TagFilter>) —

    A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values.

    If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter.

    If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters.

  • :resources_per_page (Integer) —

    A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 50 items.

  • :tags_per_page (Integer) —

    A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

    ‘GetResources` does not split a resource and its associated tags across pages. If the specified `TagsPerPage` would cause such a break, a `PaginationToken` is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a `TagsPerPage` of `100` and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags.

    You can set ‘TagsPerPage` to a minimum of 100 items and the maximum of 500 items.

  • :resource_type_filters (Array<String>) —

    The constraints on the resources that you want returned. The format of each resource type is ‘service`. For example, specifying a resource type of `ec2` returns all tagged Amazon EC2 resources (which includes tagged EC2 instances). Specifying a resource type of `ec2:instance` returns only EC2 instances.

    The string for each service name and resource type is the same as that embedded in a resource’s Amazon Resource Name (ARN). Consult the *AWS General Reference* for the following:

    • For a list of service name strings, see [AWS Service Namespaces].

    • For resource type strings, see [Example ARNs].

    • For more information about ARNs, see [Amazon Resource Names (ARNs) and AWS Service Namespaces].

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces [2]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax [3]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

See Also:



268
269
270
271
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 268

def get_resources(params = {}, options = {})
  req = build_request(:get_resources, params)
  req.send_request(options)
end

#get_tag_keys(params = {}) ⇒ Types::GetTagKeysOutput

Returns all tag keys in the specified region for the AWS account.

Examples:

Request syntax with placeholder values


resp = client.get_tag_keys({
  pagination_token: "PaginationToken",
})

Response structure


resp.pagination_token #=> String
resp.tag_keys #=> Array
resp.tag_keys[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pagination_token (String) —

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

Returns:

See Also:



302
303
304
305
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 302

def get_tag_keys(params = {}, options = {})
  req = build_request(:get_tag_keys, params)
  req.send_request(options)
end

#get_tag_values(params = {}) ⇒ Types::GetTagValuesOutput

Returns all tag values for the specified key in the specified region for the AWS account.

Examples:

Request syntax with placeholder values


resp = client.get_tag_values({
  pagination_token: "PaginationToken",
  key: "TagKey", # required
})

Response structure


resp.pagination_token #=> String
resp.tag_values #=> Array
resp.tag_values[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pagination_token (String) —

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

  • :key (required, String) —

    The key for which you want to list all existing values in the specified region for the AWS account.

Returns:

See Also:



342
343
344
345
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 342

def get_tag_values(params = {}, options = {})
  req = build_request(:get_tag_values, params)
  req.send_request(options)
end

#tag_resources(params = {}) ⇒ Types::TagResourcesOutput

Applies one or more tags to the specified resources. Note the following:

  • Not all resources can have tags. For a list of resources that support tagging, see [Supported Resources] in the *AWS Resource Groups and Tag Editor User Guide*.

  • Each resource can have up to 50 tags. For other limits, see [Tag Restrictions] in the *Amazon EC2 User Guide for Linux Instances*.

  • You can only tag resources that are located in the specified region for the AWS account.

  • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see [Obtaining Permissions for Tagging] in the *AWS Resource Groups and Tag Editor User Guide*.

[1]: docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/supported-resources.html [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions [3]: docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html

Examples:

Request syntax with placeholder values


resp = client.tag_resources({
  resource_arn_list: ["ResourceARN"], # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Response structure


resp.failed_resources_map #=> Hash
resp.failed_resources_map["ResourceARN"].status_code #=> Integer
resp.failed_resources_map["ResourceARN"].error_code #=> String, one of "InternalServiceException", "InvalidParameterException"
resp.failed_resources_map["ResourceARN"].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn_list (required, Array<String>) —

    A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces] in the *AWS General Reference*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :tags (required, Hash<String,String>) —

    The tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

Returns:

See Also:



410
411
412
413
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 410

def tag_resources(params = {}, options = {})
  req = build_request(:tag_resources, params)
  req.send_request(options)
end

#untag_resources(params = {}) ⇒ Types::UntagResourcesOutput

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

  • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see [Obtaining Permissions for Tagging] in the *AWS Resource Groups and Tag Editor User Guide*.

  • You can only tag resources that are located in the specified region for the AWS account.

[1]: docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html

Examples:

Request syntax with placeholder values


resp = client.untag_resources({
  resource_arn_list: ["ResourceARN"], # required
  tag_keys: ["TagKey"], # required
})

Response structure


resp.failed_resources_map #=> Hash
resp.failed_resources_map["ResourceARN"].status_code #=> Integer
resp.failed_resources_map["ResourceARN"].error_code #=> String, one of "InternalServiceException", "InvalidParameterException"
resp.failed_resources_map["ResourceARN"].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn_list (required, Array<String>) —

    A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see [Amazon Resource Names (ARNs) and AWS Service Namespaces] in the *AWS General Reference*.

    [1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

  • :tag_keys (required, Array<String>) —

    A list of the tag keys that you want to remove from the specified resources.

Returns:

See Also:



470
471
472
473
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 470

def untag_resources(params = {}, options = {})
  req = build_request(:untag_resources, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


494
495
496
 
# File 'lib/aws-sdk-resourcegroupstaggingapi/client.rb', line 494

def waiter_names
  []
end