Menu
AWS Directory Service
API Reference

ListTagsForResource

Lists all tags on a directory.

Request Syntax

{
   "Limit": number,
   "NextToken": "string",
   "ResourceId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

Limit

Reserved for future use.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

NextToken

Reserved for future use.

Type: String

Required: No

ResourceId

Identifier (ID) of the directory for which you want to retrieve tags.

Type: String

Pattern: ^[d]-[0-9a-f]{10}$

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

Reserved for future use.

Type: String

Tags

List of tags returned by the ListTagsForResource operation.

Type: Array of Tag objects

Errors

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

ClientException

A client exception has occurred.

HTTP Status Code: 400

EntityDoesNotExistException

The specified entity could not be found.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

Examples

The following examples are formatted for legibility.

Example Request

Copy
POST / HTTP/1.1 Host: ds.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 42 X-Amz-Target: DirectoryService_20150416.ListTagsForResource X-Amz-Date: 20161214T231352Z User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20161214/us-west-2/ds/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=72d8e8988d5a206b4e218f406544b06cb4f6fd9d8927a270317509c9861b0826 { "ResourceId":"d-926example", "Limit": 0 }

Example Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: fb7da12c-c252-11e6-a96d-2b0686697d23 Content-Type: application/x-amz-json-1.1 Content-Length: 53 Date: Wed, 14 Dec 2016 23:13:54 GMT { "Tags":[ { "Key":"environment", "Value":"production" } ] }

See Also

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