AWS IoT Things Graph
Welcome (API Version 2018-09-06)

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 all tags on an AWS IoT Things Graph 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 250.

Required: No

nextToken

The token that specifies the next page of results to return.

Type: String

Required: No

resourceArn

The Amazon Resource Name (ARN) of the resource whose tags are to be returned.

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

The token that specifies the next page of results to return.

Type: String

tags

List of tags returned by the ListTagsForResource operation.

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

InternalFailureException

HTTP Status Code: 500

InvalidRequestException

HTTP Status Code: 400

ResourceAlreadyExistsException

HTTP Status Code: 400

ThrottlingException

HTTP Status Code: 400

See Also

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