OpenSearchServiceServerless / Client / tag_resource

tag_resource#

OpenSearchServiceServerless.Client.tag_resource(**kwargs)#

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags=[
        {
            'key': 'string',
            'value': 'string'
        },
    ]
)
Parameters:
  • resourceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

  • tags (list) –

    [REQUIRED]

    A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.

    • (dict) –

      A map of key-value pairs associated to an OpenSearch Serverless resource.

      • key (string) – [REQUIRED]

        The key to use in the tag.

      • value (string) – [REQUIRED]

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • OpenSearchServiceServerless.Client.exceptions.InternalServerException

  • OpenSearchServiceServerless.Client.exceptions.ResourceNotFoundException

  • OpenSearchServiceServerless.Client.exceptions.ConflictException

  • OpenSearchServiceServerless.Client.exceptions.ValidationException

  • OpenSearchServiceServerless.Client.exceptions.ServiceQuotaExceededException