Skip to content

tag_queue

Operation

tag_queue

tag_queue(request: TagQueueInput | TagQueueInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TagQueueInputDict]) -> TagQueueOutput

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

When you use queue tags, keep the following guidelines in mind:

  • Adding more than 50 tags to a queue isn't recommended.

  • Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.

  • Tags are case-sensitive.

  • A new tag with a key identical to that of an existing tag overwrites the existing tag.

For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.

Note

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.

Parameters:

Name Type Description Default
request TagQueueInput | TagQueueInputDict | 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[TagQueueInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
TagQueueOutput

An instance of TagQueueOutput.

tag_queue async

tag_queue(request: TagQueueInput | TagQueueInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[TagQueueInputDict]) -> TagQueueOutput

Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

When you use queue tags, keep the following guidelines in mind:

  • Adding more than 50 tags to a queue isn't recommended.

  • Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.

  • Tags are case-sensitive.

  • A new tag with a key identical to that of an existing tag overwrites the existing tag.

For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.

Note

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a username in the Amazon SQS Developer Guide.

Parameters:

Name Type Description Default
request TagQueueInput | TagQueueInputDict | 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[TagQueueInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
TagQueueOutput

An instance of TagQueueOutput.

Input

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

TagQueueInputDict

Bases: TypedDict

Dictionary form of TagQueueInput.

Attributes

queue_url instance-attribute
queue_url: Required[str]

The URL of the queue.

tags instance-attribute

The list of tags to be added to the specified queue.

TagQueueInput dataclass

Bases: _SerdeShape

Dataclass for TagQueueInput structure.

Attributes

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

The URL of the queue.

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

The list of tags to be added to the specified queue.

Output

TagQueueOutput dataclass

Bases: _SerdeShape

Dataclass for TagQueueOutput 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.