RemoveTags
Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources.
Request Syntax
POST /2021-01-01/tags-removal HTTP/1.1
Content-type: application/json
{
"ARN": "string
",
"TagKeys": [ "string
" ]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ARN
-
The Amazon Resource Name (ARN) of the domain, data source, or application from which you want to delete the specified tags.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
.*
Required: Yes
- TagKeys
-
The list of tag keys to remove from the domain, data source, or application.
Type: Array of strings
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.
- BaseException
-
An error occurred while processing the request.
HTTP Status Code: 400
- InternalException
-
Request processing failed because of an unknown error, exception, or internal failure.
HTTP Status Code: 500
- ValidationException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of RemoveTags.
Sample Request
POST /2021-01-01/tags-removal HTTP/1.1
Host: es.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Type: application/json
User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.remove-tags
X-Amz-Date: 20240212T221612Z
X-Amz-Security-Token: IQoJb3JpZ2luX2VjEI3wEaCXVz==
Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240212/us-east-1/es/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-security-token, Signature=8fe55108204bb96b157bd4a5ca747c54264cb3c9c01a8137b1daffdf2eabb654
Content-Length: 100
{"ARN": "arn:aws:es:us-east-1:123456789012:domain/marketing", "TagKeys": ["department", "marketing"]}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: ab0cd0ef-123g-4h5j-678k-l6m534no08p7
Content-Type: application/json
Content-Length: 0
Date: Mon, 12 Feb 2024 22:16:12 GMT
Connection: keep-alive
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: