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()
generate_presigned_url()
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 master 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.

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

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 AWS Organizations User Guide.

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

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) --
The 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) --
A list of Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
- (string) --
ResourceTypeFilters (list) --
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 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 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 .
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.
- (string) --
TagKeyFilters (list) --
A list of tag keys to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
- (string) --
GroupBy (list) --
A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
- (string) --
MaxResults (integer) -- A limit that restricts the number of results that are returned per page.
PaginationToken (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.

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 AWS Organizations ListRoots API.
    - TargetIdType (string) --
      
      Whether the target is an account, an OU, or the organization root.
    - Region (string) --
      
      The AWS Region that the summary applies to.
    - ResourceType (string) --
      
      The AWS resource type.
    - NonCompliantResources (integer) --
      
      The count of noncompliant resources.
- 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.

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 Region for the AWS 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 AWS Organizations User Guide.

Note

You can check the PaginationToken response parameter to determine if a query is complete. Queries occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.

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
)

Parameters

PaginationToken (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.
TagFilters (list) --
A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as 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 do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.
- If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated 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 specified 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 any values for a key, the response returns resources that are tagged with that key irrespective of the value. For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:
  - 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 containing key3 as its tag key, irrespective of its value
  - GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the 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) --
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
    - (string) --
ResourcesPerPage (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 100 items.
TagsPerPage (integer) --
AWS 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 and the maximum of 500 items.
ResourceTypeFilters (list) --
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 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 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 .
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.
- (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 .

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 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) --
      
      The ARN of the resource.
    - 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 Tagging AWS Resources in the AWS 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) --
        
        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
    - 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.

get_tag_keys(**kwargs)¶

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'
)

Parameters

PaginationToken (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.

Return type

dict

Returns

Response Syntax

{
    'PaginationToken': 'string',
    'TagKeys': [
        '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.
- TagKeys (list) --
  A list of all tag keys in the AWS account.
  - (string) --

get_tag_values(**kwargs)¶

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'
)

Parameters

PaginationToken (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 (string) --
[REQUIRED]

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

Return type

dict

Returns

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.
  - (string) --

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 accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily.

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 master 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) --

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 that support tagging, see this list .
Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.
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 this list .

See also: AWS API Documentation

Request Syntax

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

Parameters

ResourceARNList (list) --
[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 .
- (string) --
Tags (dict) --
[REQUIRED]

The 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 AWS service that hosts the resource that the ARN key represents.
      
      The following are common error codes that you might receive from other AWS services:
      - InternalServiceException – This can mean that the Resource Groups Tagging API didn't receive a response from another AWS service. It can also mean the 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 calling tagging operations in the AWS service that contains the resource. For example, to use the Resource Groups Tagging API to tag a CloudWatch alarm resource, you need permission to call ` TagResources http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html`__ and ` TagResource http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html`__ in the CloudWatch API.
      For more information on errors that are generated from other AWS 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 AWS service that hosts the resource that you want to tag.
      - ErrorMessage (string) --
        
        The message of the common error.

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 this list .
You can only tag resources that are located in the specified Region for the AWS account.

See also: AWS API Documentation

Request Syntax

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

Parameters

ResourceARNList (list) --
[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 .
- (string) --
TagKeys (list) --
[REQUIRED]

A list of the 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) --
  
  Details of resources that could not be untagged. An error code, status code, and error message are returned for each failed item.
  - (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 AWS service that hosts the resource that the ARN key represents.
      
      The following are common error codes that you might receive from other AWS services:
      - InternalServiceException – This can mean that the Resource Groups Tagging API didn't receive a response from another AWS service. It can also mean the 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 calling tagging operations in the AWS service that contains the resource. For example, to use the Resource Groups Tagging API to tag a CloudWatch alarm resource, you need permission to call ` TagResources http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html`__ and ` TagResource http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html`__ in the CloudWatch API.
      For more information on errors that are generated from other AWS 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 AWS service that hosts the resource that you want to tag.
      - ErrorMessage (string) --
        
        The message of the common error.

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) --
The 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) --
A list of Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
- (string) --
ResourceTypeFilters (list) --
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 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 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 .
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.
- (string) --
TagKeyFilters (list) --
A list of tag keys to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
- (string) --
GroupBy (list) --
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 AWS Organizations ListRoots API.
    - TargetIdType (string) --
      
      Whether the target is an account, an OU, or the organization root.
    - Region (string) --
      
      The AWS Region that the summary applies to.
    - ResourceType (string) --
      
      The AWS 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,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

TagFilters (list) --
A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as 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 do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.
- If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated 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 specified 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 any values for a key, the response returns resources that are tagged with that key irrespective of the value. For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:
  - 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 containing key3 as its tag key, irrespective of its value
  - GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the 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) --
    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
    - (string) --
TagsPerPage (integer) --
AWS 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 and the maximum of 500 items.
ResourceTypeFilters (list) --
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 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 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 .
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.
- (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 .
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 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 Tagging AWS Resources in the AWS 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) --
        
        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
    - 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 AWS 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]

The key for which you want to list all existing values in the specified Region for the AWS 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 in the AWS account.
  - (string) --
- NextToken (string) --
  
  A token to resume pagination.

Navigation

Table Of Contents

ResourceGroupsTaggingAPI¶

Client¶

Paginators¶

Navigation

ResourceGroupsTaggingAPI ¶

Client ¶

Paginators ¶