Skip to content

tag_resource

Operation

tag_resource

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

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

  • TagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after a TagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource request again.

  • The application or removal of tags using TagResource and UntagResource APIs is eventually consistent. ListTagsOfResource API will only reflect the changes after a few seconds.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

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

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

  • TagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after a TagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource request again.

  • The application or removal of tags using TagResource and UntagResource APIs is eventually consistent. ListTagsOfResource API will only reflect the changes after a few seconds.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

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]

Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

tags instance-attribute

The tags to be assigned to the Amazon DynamoDB resource.

TagResourceInput dataclass

Bases: _SerdeShape

Dataclass for TagResourceInput structure.

Attributes

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

Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

The tags to be assigned to the Amazon DynamoDB resource.

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.