Skip to content

tag_resource

Operation

tag_resource

tag_resource(request: TagResourceInput | TagResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TagResourceInputDict]) -> TagResourceOutput

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.

Parameters:

Name Type Description Default
request TagResourceInput | TagResourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[TagResourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
TagResourceOutput

An instance of TagResourceOutput.

tag_resource async

tag_resource(request: TagResourceInput | TagResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TagResourceInputDict]) -> TagResourceOutput

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.

Parameters:

Name Type Description Default
request TagResourceInput | TagResourceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[TagResourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
TagResourceOutput

An instance of TagResourceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

TagResourceInputDict

Bases: TypedDict

Dictionary form of TagResourceInput.

Attributes

resource_arn instance-attribute
resource_arn: Required[str]

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

tags instance-attribute

The tags to assign to the identity pool.

TagResourceInput dataclass

Bases: _SerdeShape

Dataclass for TagResourceInput structure.

Attributes

resource_arn class-attribute instance-attribute
resource_arn: str | None = ...

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

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The tags to assign to the identity pool.

Output

TagResourceOutput dataclass

Bases: _SerdeShape

Dataclass for TagResourceOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.