Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

TagResource

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

Request Syntax


POST /2022-01-01/osis/tagResource/?arn=Arn HTTP/1.1
Content-type: application/json

{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

Arn

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

Length Constraints: Minimum length of 46. Maximum length of 76.

Pattern: ^arn:(aws|aws\-cn|aws\-us\-gov|aws\-iso|aws\-iso\-b):osis:.+:pipeline\/.+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Tags

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

Type: Array of Tag objects

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to access the resource.

HTTP Status Code: 403

InternalException

The request failed because of an unknown error, exception, or failure (the failure is internal to the service).

HTTP Status Code: 500

LimitExceededException

You attempted to create more than the allowed number of tags.

HTTP Status Code: 409

ResourceNotFoundException

You attempted to access or delete a resource that does not exist.

HTTP Status Code: 404

ValidationException

An exception for missing or invalid input fields.

HTTP Status Code: 400