OpenSearchIngestion / Client / tag_resource

tag_resource#

OpenSearchIngestion.Client.tag_resource(**kwargs)#

Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    Arn='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:
  • Arn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the pipeline to tag.

  • Tags (list) –

    [REQUIRED]

    The list of key-value tags to add to the pipeline.

    • (dict) –

      A tag (key-value pair) for an OpenSearch Ingestion pipeline.

      • Key (string) – [REQUIRED]

        The tag key. Tag keys must be unique for the pipeline to which they are attached.

      • Value (string) – [REQUIRED]

        The value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • OpenSearchIngestion.Client.exceptions.LimitExceededException

  • OpenSearchIngestion.Client.exceptions.ValidationException

  • OpenSearchIngestion.Client.exceptions.InternalException

  • OpenSearchIngestion.Client.exceptions.AccessDeniedException

  • OpenSearchIngestion.Client.exceptions.ResourceNotFoundException