DirectoryService / Client / list_tags_for_resource

list_tags_for_resource#

DirectoryService.Client.list_tags_for_resource(**kwargs)#

Lists all tags on a directory.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceId='string',
    NextToken='string',
    Limit=123
)
Parameters:

  • ResourceId (string) –

    [REQUIRED]

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

  • NextToken (string) – Reserved for future use.

  • Limit (integer) – Reserved for future use.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Tags (list) –

      List of tags returned by the ListTagsForResource operation.

      • (dict) –

        Metadata assigned to a directory consisting of a key-value pair.

        • Key (string) –

          Required name of the tag. The string value can be Unicode characters and cannot be prefixed with “aws:”. The string can contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

        • Value (string) –

          The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

    • NextToken (string) –

      Reserved for future use.

Exceptions

  • DirectoryService.Client.exceptions.EntityDoesNotExistException

  • DirectoryService.Client.exceptions.InvalidNextTokenException

  • DirectoryService.Client.exceptions.InvalidParameterException

  • DirectoryService.Client.exceptions.ClientException

  • DirectoryService.Client.exceptions.ServiceException