Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTagsForResource

List tags for a resource. For more information, see AWS Proton resources and tagging in the AWS Proton User Guide.

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 list.

Type: Integer

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

Required: No

nextToken

A token that indicates the location of the next resource tag in the array of resource tags, after the list of resource tags that was previously requested.

Type: String

Required: No

resourceArn

The Amazon Resource Name (ARN) of the resource for the listed tags.

Type: String

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

Pattern: arn:(aws|aws-cn|aws-us-gov):[a-zA-Z0-9-]+:[a-zA-Z0-9-]*:\d{12}:([\w+=,.@-]+[/:])*[\w+=,.@-]+

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 that indicates the location of the next resource tag in the array of resource tags, after the current requested list of resource tags.

Type: String

tags

A list of resource tags with detail data.

Type: Array of Tag objects

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

Errors

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

AccessDeniedException

There isn't sufficient access for performing this action.

HTTP Status Code: 400

InternalServerException

The request failed to register with the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource wasn't found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input is invalid or an out-of-range value was supplied for the input parameter.

HTTP Status Code: 400