ListTagsForResource - Amazon Timestream
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

For similar capabilities to Amazon Timestream for LiveAnalytics, consider Amazon Timestream for InfluxDB. It offers simplified data ingestion and single-digit millisecond query response times for real-time analytics. Learn more here.

ListTagsForResource

List all tags on a Timestream query resource.

Request Syntax

{
   "MaxResults": number,
   "NextToken": "string",
   "ResourceARN": "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.

MaxResults

The maximum number of tags to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 200.

Required: No

NextToken

A pagination token to resume pagination.

Type: String

Required: No

ResourceARN

The Timestream resource with tags to be listed. This value is an Amazon Resource Name (ARN).

Type: String

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

Required: Yes

Response Syntax

{
   "NextToken": "string",
   "Tags": [ 
      { 
         "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.

NextToken

A pagination token to resume pagination with a subsequent call to ListTagsForResourceResponse.

Type: String

Tags

The tags currently associated with the Timestream resource.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Errors

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

InvalidEndpointException

The requested endpoint is invalid.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 400

ThrottlingException

The request was throttled due to excessive requests.

HTTP Status Code: 400

ValidationException

Invalid or malformed request.

HTTP Status Code: 400

See Also

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