ResourceGroupsTaggingAPI ¶

Table of Contents

ResourceGroupsTaggingAPI
- Client
- Paginators

Client ¶

class ResourceGroupsTaggingAPI.Client¶

A low-level client representing AWS Resource Groups Tagging API

import boto3

client = boto3.client('resourcegroupstaggingapi')

These are the available methods:

can_paginate()
describe_report_creation()
get_compliance_summary()
get_paginator()
get_resources()
get_tag_keys()
get_tag_values()
get_waiter()
start_report_creation()
tag_resources()
untag_resources()

can_paginate(operation_name)¶

Check if an operation can be paginated.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns: True if the operation can be paginated, False otherwise.

describe_report_creation()¶

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's management account and from the us-east-1 Region.

See also: AWS API Documentation

Request Syntax

response = client.describe_report_creation()

Return type

dict

Returns

Response Syntax

{
    'Status': 'string',
    'S3Location': 'string',
    'ErrorMessage': 'string'
}

Response Structure

(dict) --
- Status (string) --
  Reports the status of the operation.
  
  The operation status can be one of the following:
  - RUNNING - Report creation is in progress.
  - SUCCEEDED - Report creation is complete. You can open the report from the Amazon S3 bucket that you specified when you ran StartReportCreation .
  - FAILED - Report creation timed out or the Amazon S3 bucket is not accessible.
  - NO REPORT - No report was generated in the last 90 days.
- S3Location (string) --
  The path to the Amazon S3 bucket where the report was stored on creation.
- ErrorMessage (string) --
  Details of the common errors that all operations return.

Exceptions

ResourceGroupsTaggingAPI.Client.exceptions.ConstraintViolationException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException
ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException

get_compliance_summary(**kwargs)¶

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies in the Organizations User Guide.

You can call this operation only from the organization's management account and from the us-east-1 Region.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

See also: AWS API Documentation

Request Syntax

response = client.get_compliance_summary(
    TargetIdFilters=[
        'string',
    ],
    RegionFilters=[
        'string',
    ],
    ResourceTypeFilters=[
        'string',
    ],
    TagKeyFilters=[
        'string',
    ],
    GroupBy=[
        'TARGET_ID'|'REGION'|'RESOURCE_TYPE',
    ],
    MaxResults=123,
    PaginationToken='string'
)

Parameters

TargetIdFilters (list) --
Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.
- (string) --
RegionFilters (list) --
Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
- (string) --
ResourceTypeFilters (list) --
Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType] . For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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 * Amazon Web Services General Reference * for the following:
- For a list of service name strings, see Amazon Web Services Service Namespaces .
- For resource type strings, see Example ARNs .
- For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
- (string) --
TagKeyFilters (list) --
Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
- (string) --
GroupBy (list) --
Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
- (string) --
MaxResults (integer) -- Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.
PaginationToken (string) -- Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Return type

dict

Returns

Response Syntax

{
    'SummaryList': [
        {
            'LastUpdated': 'string',
            'TargetId': 'string',
            'TargetIdType': 'ACCOUNT'|'OU'|'ROOT',
            'Region': 'string',
            'ResourceType': 'string',
            'NonCompliantResources': 123
        },
    ],
    'PaginationToken': 'string'
}

Response Structure

(dict) --
- SummaryList (list) --
  
  A table that shows counts of noncompliant resources.
  - (dict) --
    
    A count of noncompliant resources.
    - LastUpdated (string) --
      
      The timestamp that shows when this summary was generated in this Region.
    - TargetId (string) --
      
      The account identifier or the root identifier of the organization. If you don't know the root ID, you can call the Organizations ListRoots API.
    - TargetIdType (string) --
      
      Whether the target is an account, an OU, or the organization root.
    - Region (string) --
      
      The Amazon Web Services Region that the summary applies to.
    - ResourceType (string) --
      
      The Amazon Web Services resource type.
    - NonCompliantResources (integer) --
      
      The count of noncompliant resources.
- PaginationToken (string) --
  
  A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

Exceptions

ResourceGroupsTaggingAPI.Client.exceptions.ConstraintViolationException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException
ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException

get_paginator(operation_name)¶

Create a paginator for an operation.

Parameters: operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError: Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type: L{botocore.paginate.Paginator}
Returns: A paginator object.

get_resources(**kwargs)¶

Returns all the tagged or previously tagged resources that are located in the specified Amazon Web Services Region for the account.

Depending on what information you want returned, you can also specify the following:

Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.
Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the Organizations User Guide.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

See also: AWS API Documentation

Request Syntax

response = client.get_resources(
    PaginationToken='string',
    TagFilters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ResourcesPerPage=123,
    TagsPerPage=123,
    ResourceTypeFilters=[
        'string',
    ],
    IncludeComplianceDetails=True|False,
    ExcludeCompliantResources=True|False,
    ResourceARNList=[
        'string',
    ]
)

Parameters

PaginationToken (string) -- Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.
TagFilters (list) --
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:
- If you don't specify a TagFilter , the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [] .
- If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.
- If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.
- If you don't specify a value for a key, the response returns all resources that are tagged with that key, with any or no value. For example, for the following filters: filter1= {keyA,{value1}} , filter2={keyB,{value2,value3,value4}} , filter3= {keyC} :
  - GetResources({filter1}) returns resources tagged with key1=value1
  - GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4
  - GetResources({filter3}) returns resources tagged with any tag with the key key3 , and with any or no value
  - GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
- (dict) --
  A list of tags (keys and values) that are used to specify the associated resources.
  - Key (string) --
    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
  - Values (list) --
    One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
    - (string) --
ResourcesPerPage (integer) -- Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.
TagsPerPage (integer) --
Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

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 three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 items.
ResourceTypeFilters (list) --
Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType] . For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API .

You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:

ec2:instance,s3:bucket,auditmanager
- (string) --
IncludeComplianceDetails (boolean) -- Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.
ExcludeCompliantResources (boolean) --
Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true .
ResourceARNList (list) --
Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this parameter and any of the pagination parameters (ResourcesPerPage , TagsPerPage , PaginationToken ) in the same request. If you specify both, you get an Invalid Parameter exception.

If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .
- (string) --

Return type

dict

Returns

Response Syntax

{
    'PaginationToken': 'string',
    'ResourceTagMappingList': [
        {
            'ResourceARN': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ComplianceDetails': {
                'NoncompliantKeys': [
                    'string',
                ],
                'KeysWithNoncompliantValues': [
                    'string',
                ],
                'ComplianceStatus': True|False
            }
        },
    ]
}

Response Structure

(dict) --
- PaginationToken (string) --
  
  A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.
- 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) --
      
      The ARN of the resource.
    - Tags (list) --
      
      The tags that have been applied to one or more Amazon Web Services resources.
      - (dict) --
        
        The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference .
        
        Key (string) --
        
        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
        
        Value (string) --
        
        One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
    - ComplianceDetails (dict) --
      
      Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.
      - NoncompliantKeys (list) --
        
        These tag keys on the resource are noncompliant with the effective tag policy.
        
        (string) --
      - KeysWithNoncompliantValues (list) --
        
        These are keys defined in the effective policy that are on the resource with either incorrect case treatment or noncompliant values.
        
        (string) --
      - ComplianceStatus (boolean) --
        
        Whether a resource is compliant with the effective tag policy.

Exceptions

ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException
ResourceGroupsTaggingAPI.Client.exceptions.PaginationTokenExpiredException

get_tag_keys(**kwargs)¶

Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

See also: AWS API Documentation

Request Syntax

response = client.get_tag_keys(
    PaginationToken='string'
)

Parameters

PaginationToken (string) -- Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

Return type

dict

Returns

Response Syntax

{
    'PaginationToken': 'string',
    'TagKeys': [
        'string',
    ]
}

Response Structure

(dict) --
- PaginationToken (string) --
  A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.
- TagKeys (list) --
  A list of all tag keys in the Amazon Web Services account.
  - (string) --

Exceptions

ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException
ResourceGroupsTaggingAPI.Client.exceptions.PaginationTokenExpiredException

get_tag_values(**kwargs)¶

Returns all tag values for the specified key that are used in the specified Amazon Web Services Region for the calling account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

See also: AWS API Documentation

Request Syntax

response = client.get_tag_values(
    PaginationToken='string',
    Key='string'
)

Parameters

PaginationToken (string) -- Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.
Key (string) --
[REQUIRED]

Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.

Return type

dict

Returns

Response Syntax

{
    'PaginationToken': 'string',
    'TagValues': [
        'string',
    ]
}

Response Structure

(dict) --
- PaginationToken (string) --
  
  A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.
- TagValues (list) --
  
  A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.
  - (string) --

Exceptions

ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException
ResourceGroupsTaggingAPI.Client.exceptions.PaginationTokenExpiredException

get_waiter(waiter_name)¶

Returns an object that can wait for some condition.

Parameters: waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns: The specified waiter object.
Return type: botocore.waiter.Waiter

start_report_creation(**kwargs)¶

Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.

The generated report is saved to the following location:

s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv

You can call this operation only from the organization's management account and from the us-east-1 Region.

See also: AWS API Documentation

Request Syntax

response = client.start_report_creation(
    S3Bucket='string'
)

Parameters

S3Bucket (string) --

[REQUIRED]

The name of the Amazon S3 bucket where the report will be stored; for example:

awsexamplebucket

For more information on S3 bucket requirements, including an example bucket policy, see the example S3 bucket policy on this page.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) --

Exceptions

ResourceGroupsTaggingAPI.Client.exceptions.ConcurrentModificationException
ResourceGroupsTaggingAPI.Client.exceptions.ConstraintViolationException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException
ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException

tag_resources(**kwargs)¶

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

Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API . If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.
Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the Amazon Web Services General Reference.
You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services 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 the documentation for each service.

Warning

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag an Amazon EC2 instance using the TagResources operation, you must have both of the following permissions:

tag:TagResource
ec2:CreateTags

See also: AWS API Documentation

Request Syntax

response = client.tag_resources(
    ResourceARNList=[
        'string',
    ],
    Tags={
        'string': 'string'
    }
)

Parameters

ResourceARNList (list) --
[REQUIRED]

Specifies the list of ARNs of the resources that you want to apply tags to.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .
- (string) --
Tags (dict) --
[REQUIRED]

Specifies a list of tags that you want to add to the specified resources. A tag consists of a key and a value that you define.
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'FailedResourcesMap': {
        'string': {
            'StatusCode': 123,
            'ErrorCode': 'InternalServiceException'|'InvalidParameterException',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

(dict) --
- FailedResourcesMap (dict) --
  
  A map containing a key-value pair for each failed item that couldn't be tagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.
  - (string) --
    - (dict) --
      
      Information about the errors that are returned for each failed resource. This information can include InternalServiceException and InvalidParameterException errors. It can also include any valid error code returned by the Amazon Web Services service that hosts the resource that the ARN key represents.
      
      The following are common error codes that you might receive from other Amazon Web Services services:
      - InternalServiceException – This can mean that the Resource Groups Tagging API didn't receive a response from another Amazon Web Services service. It can also mean that the resource type in the request is not supported by the Resource Groups Tagging API. In these cases, it's safe to retry the request and then call GetResources to verify the changes.
      - AccessDeniedException – This can mean that you need permission to call the tagging operations in the Amazon Web Services service that contains the resource. For example, to use the Resource Groups Tagging API to tag a Amazon CloudWatch alarm resource, you need permission to call both ` TagResources https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html`__ and ` TagResource https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html`__ in the CloudWatch API.
      For more information on errors that are generated from other Amazon Web Services services, see the documentation for that service.
      - 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 Amazon Web Services service that hosts the resource that you want to tag.
      - ErrorMessage (string) --
        
        The message of the common error.

Exceptions

ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException

untag_resources(**kwargs)¶

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 the documentation for the service whose resource you want to untag.
You can only tag resources that are located in the specified Amazon Web Services Region for the calling Amazon Web Services account.

Minimum permissions

In addition to the tag:UntagResources permission required by this operation, you must also have the remove tags permission defined by the service that created the resource. For example, to remove the tags from an Amazon EC2 instance using the UntagResources operation, you must have both of the following permissions:

tag:UntagResource
ec2:DeleteTags

See also: AWS API Documentation

Request Syntax

response = client.untag_resources(
    ResourceARNList=[
        'string',
    ],
    TagKeys=[
        'string',
    ]
)

Parameters

ResourceARNList (list) --
[REQUIRED]

Specifies a list of ARNs of the resources that you want to remove tags from.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .
- (string) --
TagKeys (list) --
[REQUIRED]

Specifies a list of tag keys that you want to remove from the specified resources.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'FailedResourcesMap': {
        'string': {
            'StatusCode': 123,
            'ErrorCode': 'InternalServiceException'|'InvalidParameterException',
            'ErrorMessage': 'string'
        }
    }
}

Response Structure

(dict) --
- FailedResourcesMap (dict) --
  
  A map containing a key-value pair for each failed item that couldn't be untagged. The key is the ARN of the failed resource. The value is a FailureInfo object that contains an error code, a status code, and an error message. If there are no errors, the FailedResourcesMap is empty.
  - (string) --
    - (dict) --
      
      Information about the errors that are returned for each failed resource. This information can include InternalServiceException and InvalidParameterException errors. It can also include any valid error code returned by the Amazon Web Services service that hosts the resource that the ARN key represents.
      
      The following are common error codes that you might receive from other Amazon Web Services services:
      - InternalServiceException – This can mean that the Resource Groups Tagging API didn't receive a response from another Amazon Web Services service. It can also mean that the resource type in the request is not supported by the Resource Groups Tagging API. In these cases, it's safe to retry the request and then call GetResources to verify the changes.
      - AccessDeniedException – This can mean that you need permission to call the tagging operations in the Amazon Web Services service that contains the resource. For example, to use the Resource Groups Tagging API to tag a Amazon CloudWatch alarm resource, you need permission to call both ` TagResources https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html`__ and ` TagResource https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html`__ in the CloudWatch API.
      For more information on errors that are generated from other Amazon Web Services services, see the documentation for that service.
      - 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 Amazon Web Services service that hosts the resource that you want to tag.
      - ErrorMessage (string) --
        
        The message of the common error.

Exceptions

ResourceGroupsTaggingAPI.Client.exceptions.InvalidParameterException
ResourceGroupsTaggingAPI.Client.exceptions.ThrottledException
ResourceGroupsTaggingAPI.Client.exceptions.InternalServiceException

Paginators ¶

The available paginators are:

ResourceGroupsTaggingAPI.Paginator.GetComplianceSummary
ResourceGroupsTaggingAPI.Paginator.GetResources
ResourceGroupsTaggingAPI.Paginator.GetTagKeys
ResourceGroupsTaggingAPI.Paginator.GetTagValues

class ResourceGroupsTaggingAPI.Paginator.GetComplianceSummary¶

paginator = client.get_paginator('get_compliance_summary')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ResourceGroupsTaggingAPI.Client.get_compliance_summary().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TargetIdFilters=[
        'string',
    ],
    RegionFilters=[
        'string',
    ],
    ResourceTypeFilters=[
        'string',
    ],
    TagKeyFilters=[
        'string',
    ],
    GroupBy=[
        'TARGET_ID'|'REGION'|'RESOURCE_TYPE',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

TargetIdFilters (list) --
Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.
- (string) --
RegionFilters (list) --
Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
- (string) --
ResourceTypeFilters (list) --
Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType] . For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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 * Amazon Web Services General Reference * for the following:
- For a list of service name strings, see Amazon Web Services Service Namespaces .
- For resource type strings, see Example ARNs .
- For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces .
You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
- (string) --
TagKeyFilters (list) --
Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
- (string) --
GroupBy (list) --
Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'SummaryList': [
        {
            'LastUpdated': 'string',
            'TargetId': 'string',
            'TargetIdType': 'ACCOUNT'|'OU'|'ROOT',
            'Region': 'string',
            'ResourceType': 'string',
            'NonCompliantResources': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SummaryList (list) --
  
  A table that shows counts of noncompliant resources.
  - (dict) --
    
    A count of noncompliant resources.
    - LastUpdated (string) --
      
      The timestamp that shows when this summary was generated in this Region.
    - TargetId (string) --
      
      The account identifier or the root identifier of the organization. If you don't know the root ID, you can call the Organizations ListRoots API.
    - TargetIdType (string) --
      
      Whether the target is an account, an OU, or the organization root.
    - Region (string) --
      
      The Amazon Web Services Region that the summary applies to.
    - ResourceType (string) --
      
      The Amazon Web Services resource type.
    - NonCompliantResources (integer) --
      
      The count of noncompliant resources.
- NextToken (string) --
  
  A token to resume pagination.

class ResourceGroupsTaggingAPI.Paginator.GetResources¶

paginator = client.get_paginator('get_resources')

paginate(**kwargs)¶

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',
    ],
    IncludeComplianceDetails=True|False,
    ExcludeCompliantResources=True|False,
    ResourceARNList=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

TagFilters (list) --
Specifies a list of TagFilters (keys and values) to restrict the output to only those resources that have tags with the specified keys and, if included, the specified values. Each TagFilter must contain a key with values optional. A request can include up to 50 keys, and each key can include up to 20 values.

Note the following when deciding how to use TagFilters:
- If you don't specify a TagFilter , the response includes all resources that are currently tagged or ever had a tag. Resources that currently don't have tags are shown with an empty tag set, like this: "Tags": [] .
- If you specify more than one filter in a single request, the response returns only those resources that satisfy all filters.
- If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.
- If you don't specify a value for a key, the response returns all resources that are tagged with that key, with any or no value. For example, for the following filters: filter1= {keyA,{value1}} , filter2={keyB,{value2,value3,value4}} , filter3= {keyC} :
  - GetResources({filter1}) returns resources tagged with key1=value1
  - GetResources({filter2}) returns resources tagged with key2=value2 or key2=value3 or key2=value4
  - GetResources({filter3}) returns resources tagged with any tag with the key key3 , and with any or no value
  - GetResources({filter1,filter2,filter3}) returns resources tagged with (key1=value1) and (key2=value2 or key2=value3 or key2=value4) and (key3, any or no value)
- (dict) --
  A list of tags (keys and values) that are used to specify the associated resources.
  - Key (string) --
    One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
  - Values (list) --
    One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
    - (string) --
TagsPerPage (integer) --
Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

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 three pages. The first page displays the first 10 resources, each with its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The third page displays the remaining 2 resources, each with its 10 tags.

You can set TagsPerPage to a minimum of 100 items up to a maximum of 500 items.
ResourceTypeFilters (list) --
Specifies the resource types that you want included in the response. The format of each resource type is service[:resourceType] . For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes 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). For the list of services whose resources you can use in this parameter, see Services that support the Resource Groups Tagging API .

You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter. For example, the following string would limit the response to only Amazon EC2 instances, Amazon S3 buckets, or any Audit Manager resource:

ec2:instance,s3:bucket,auditmanager
- (string) --
IncludeComplianceDetails (boolean) -- Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.
ExcludeCompliantResources (boolean) --
Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.

You can use this parameter only if the IncludeComplianceDetails parameter is also set to true .
ResourceARNList (list) --
Specifies a list of ARNs of resources for which you want to retrieve tag data. You can't specify both this parameter and any of the pagination parameters (ResourcesPerPage , TagsPerPage , PaginationToken ) in the same request. If you specify both, you get an Invalid Parameter exception.

If a resource specified by this parameter doesn't exist, it doesn't generate an error; it simply isn't included in the response.

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference .
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ResourceTagMappingList': [
        {
            'ResourceARN': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'ComplianceDetails': {
                'NoncompliantKeys': [
                    'string',
                ],
                'KeysWithNoncompliantValues': [
                    'string',
                ],
                'ComplianceStatus': True|False
            }
        },
    ],
    '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) --
      
      The ARN of the resource.
    - Tags (list) --
      
      The tags that have been applied to one or more Amazon Web Services resources.
      - (dict) --
        
        The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference .
        
        Key (string) --
        
        One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
        
        Value (string) --
        
        One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
    - ComplianceDetails (dict) --
      
      Information that shows whether a resource is compliant with the effective tag policy, including details on any noncompliant tag keys.
      - NoncompliantKeys (list) --
        
        These tag keys on the resource are noncompliant with the effective tag policy.
        
        (string) --
      - KeysWithNoncompliantValues (list) --
        
        These are keys defined in the effective policy that are on the resource with either incorrect case treatment or noncompliant values.
        
        (string) --
      - ComplianceStatus (boolean) --
        
        Whether a resource is compliant with the effective tag policy.
- NextToken (string) --
  
  A token to resume pagination.

class ResourceGroupsTaggingAPI.Paginator.GetTagKeys¶

paginator = client.get_paginator('get_tag_keys')

paginate(**kwargs)¶

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,
        'StartingToken': 'string'
    }
)

Parameters

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems (integer) --
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.
StartingToken (string) --
A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'TagKeys': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TagKeys (list) --
  A list of all tag keys in the Amazon Web Services account.
  - (string) --
- NextToken (string) --
  A token to resume pagination.

class ResourceGroupsTaggingAPI.Paginator.GetTagValues¶

paginator = client.get_paginator('get_tag_values')

paginate(**kwargs)¶

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,
        'StartingToken': 'string'
    }
)

Parameters

Key (string) --
[REQUIRED]

Specifies the tag key for which you want to list all existing values that are currently used in the specified Amazon Web Services Region for the calling account.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  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.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'TagValues': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TagValues (list) --
  
  A list of all tag values for the specified key currently used in the specified Amazon Web Services Region for the calling account.
  - (string) --
- NextToken (string) --
  
  A token to resume pagination.

Navigation

Table Of Contents

ResourceGroupsTaggingAPI¶

Client¶

Paginators¶

Navigation

ResourceGroupsTaggingAPI ¶

Client ¶

Paginators ¶