TagResource
Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.
Request Syntax
{
"resourceArn": "string
",
"tags": [
{
"key": "string
",
"value": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- resourceArn
-
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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
-
A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: Yes
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.
- ConflictException
-
When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
HTTP Status Code: 400
- InternalServerException
-
Thrown when an error internal to the service occurs while processing a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
Thrown when accessing or deleting a resource that does not exist.
HTTP Status Code: 400
- ServiceQuotaExceededException
-
Thrown when you attempt to create more resources than the service allows based on service quotas.
HTTP Status Code: 400
- ValidationException
-
Thrown when the HTTP request contains invalid input or is missing required input.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: