Table of Contents
A low-level client representing AWS Resource Groups Tagging API:
client = session.create_client('resourcegroupstaggingapi')
These are the available methods:
Check if an operation can be paginated.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_resources(
PaginationToken='string',
TagFilters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
ResourcesPerPage=123,
TagsPerPage=123,
ResourceTypeFilters=[
'string',
]
)
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.
A list of tags (keys and values) that are used to specify the associated resources.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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.
The constraints on the resources that you want returned. The format of each resource type is service[:resourceType] . 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:
dict
Response Syntax
{
'PaginationToken': 'string',
'ResourceTagMappingList': [
{
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
PaginationToken (string) --
A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.
ResourceTagMappingList (list) --
A list of resource ARNs and the tags (keys and values) associated with each.
(dict) --
A list of resource ARNs and the tags (keys and values) that are associated with each.
ResourceARN (string) --
An array of resource ARN(s).
Tags (list) --
The tags that have been applied to one or more AWS resources.
(dict) --
The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see Tag Basics in the Amazon EC2 User Guide for Linux Instances .
Key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
Returns all tag keys in the specified region for the AWS account.
See also: AWS API Documentation
Request Syntax
response = client.get_tag_keys(
PaginationToken='string'
)
{
'PaginationToken': 'string',
'TagKeys': [
'string',
]
}
Response Structure
A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.
A list of all tag keys in the AWS account.
Returns all tag values for the specified key in the specified region for the AWS account.
See also: AWS API Documentation
Request Syntax
response = client.get_tag_values(
PaginationToken='string',
Key='string'
)
[REQUIRED]
The key for which you want to list all existing values in the specified region for the AWS account.
dict
Response Syntax
{
'PaginationToken': 'string',
'TagValues': [
'string',
]
}
Response Structure
(dict) --
PaginationToken (string) --
A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.
TagValues (list) --
A list of all tag values for the specified key in the AWS account.
Returns an object that can wait for some condition.
Applies one or more tags to the specified resources. Note the following:
See also: AWS API Documentation
Request Syntax
response = client.tag_resources(
ResourceARNList=[
'string',
],
Tags={
'string': 'string'
}
)
[REQUIRED]
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 .
[REQUIRED]
The tags that you want to add to the specified resources. A tag consists of a key and a value that you define.
dict
Response Syntax
{
'FailedResourcesMap': {
'string': {
'StatusCode': 123,
'ErrorCode': 'InternalServiceException'|'InvalidParameterException',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
FailedResourcesMap (dict) --
Details of resources that could not be tagged. An error code, status code, and error message are returned for each failed item.
(string) --
(dict) --
Details of the common errors that all actions return.
StatusCode (integer) --
The HTTP status code of the common error.
ErrorCode (string) --
The code of the common error. Valid values include InternalServiceException , InvalidParameterException , and any valid error code returned by the AWS service that hosts the resource that you want to tag.
ErrorMessage (string) --
The message of the common error.
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:
See also: AWS API Documentation
Request Syntax
response = client.untag_resources(
ResourceARNList=[
'string',
],
TagKeys=[
'string',
]
)
[REQUIRED]
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 .
[REQUIRED]
A list of the tag keys that you want to remove from the specified resources.
dict
Response Syntax
{
'FailedResourcesMap': {
'string': {
'StatusCode': 123,
'ErrorCode': 'InternalServiceException'|'InvalidParameterException',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
FailedResourcesMap (dict) --
Details of resources that could not be untagged. An error code, status code, and error message are returned for each failed item.
(string) --
(dict) --
Details of the common errors that all actions return.
StatusCode (integer) --
The HTTP status code of the common error.
ErrorCode (string) --
The code of the common error. Valid values include InternalServiceException , InvalidParameterException , and any valid error code returned by the AWS service that hosts the resource that you want to tag.
ErrorMessage (string) --
The message of the common error.
The available paginators are:
paginator = client.get_paginator('get_resources')
Creates an iterator that will paginate through responses from ResourceGroupsTaggingAPI.Client.get_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TagFilters=[
{
'Key': 'string',
'Values': [
'string',
]
},
],
TagsPerPage=123,
ResourceTypeFilters=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
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.
A list of tags (keys and values) that are used to specify the associated resources.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
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.
The constraints on the resources that you want returned. The format of each resource type is service[:resourceType] . 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:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ResourceTagMappingList': [
{
'ResourceARN': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceTagMappingList (list) --
A list of resource ARNs and the tags (keys and values) associated with each.
(dict) --
A list of resource ARNs and the tags (keys and values) that are associated with each.
ResourceARN (string) --
An array of resource ARN(s).
Tags (list) --
The tags that have been applied to one or more AWS resources.
(dict) --
The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see Tag Basics in the Amazon EC2 User Guide for Linux Instances .
Key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('get_tag_keys')
Creates an iterator that will paginate through responses from ResourceGroupsTaggingAPI.Client.get_tag_keys().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'TagKeys': [
'string',
],
'NextToken': 'string'
}
Response Structure
A list of all tag keys in the AWS account.
A token to resume pagination.
paginator = client.get_paginator('get_tag_values')
Creates an iterator that will paginate through responses from ResourceGroupsTaggingAPI.Client.get_tag_values().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Key='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The key for which you want to list all existing values in the specified region for the AWS account.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TagValues': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
TagValues (list) --
A list of all tag values for the specified key in the AWS account.
NextToken (string) --
A token to resume pagination.