CognitoIdentity / Client / tag_resource

tag_resource

CognitoIdentity.Client.tag_resource(**kwargs)

Assigns a set of tags to the specified Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

Parameters:

• ResourceArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the identity pool.

• Tags (dict) –

  [REQUIRED]

  The tags to assign to the identity pool.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• CognitoIdentity.Client.exceptions.InvalidParameterException

• CognitoIdentity.Client.exceptions.ResourceNotFoundException

• CognitoIdentity.Client.exceptions.NotAuthorizedException

• CognitoIdentity.Client.exceptions.TooManyRequestsException

• CognitoIdentity.Client.exceptions.InternalErrorException