Amazon Athena
Amazon Athena Documentation (API Version 2017-05-18)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ListTagsForResource

Lists the tags associated with this workgroup.

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 results to be returned per request that lists the tags for the workgroup resource.

Type: Integer

Valid Range: Minimum value of 75.

Required: No

NextToken

The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the workgroup resource with the specified ARN.

Type: String

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

Required: No

ResourceARN

Lists the tags for the workgroup resource with the specified ARN.

Type: String

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

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 token to be used by the next request if this request is truncated.

Type: String

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

Tags

The list of tags associated with this workgroup.

Type: Array of Tag objects

Errors

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

InternalServerException

Indicates a platform issue, which may be due to a transient condition or outage.

HTTP Status Code: 500

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

HTTP Status Code: 400

ResourceNotFoundException

A resource, such as a workgroup, was not found.

HTTP Status Code: 400

See Also

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