ListTags - Amazon OpenSearch Service


Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

Request Syntax

GET /2021-01-01/tags/?arn=ARN HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


Amazon Resource Name (ARN) for the domain to view tags for.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "TagList": [ { "Key": "string", "Value": "string" } ] }

Response Elements

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

The following data is returned in JSON format by the service.


List of resource tags associated with the specified domain.

Type: Array of Tag objects


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


An error occurred while processing the request.

HTTP Status Code: 400


Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500


An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409


An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400



This example illustrates one usage of ListTags.

Sample Request

GET /2021-01-01/tags/?arn=arn%3Aaws%3Aes%3Aus-east-1%3A302040998751%3Adomain%2Fmarketing HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/2.15.13 Python/3.11.6 Windows/10 exe/AMD64 prompt/off command/opensearch.list-tags X-Amz-Date: 20240212T221352Z X-Amz-Security-Token: IQoJb3JpZ2luX2VjEIwEaCXVz== Authorization: AWS4-HMAC-SHA256 Credential=ASIAU/20240212/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=8f19277a8b3e677b1f8efcfa58e419c04e83b6b79c2db3125b151c1c2f4c8539

Sample Response

{ "TagList": [ { "Key": "department", "Value": "marketing" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: