list_tags_for_resource

CloudDirectory.Client.list_tags_for_resource(**kwargs)

Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

  • NextToken (string) -- The pagination token. This is for future use. Currently pagination is not supported for tagging.
  • MaxResults (integer) -- The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Tags (list) --

      A list of tag key value pairs that are associated with the response.

      • (dict) --

        The tag structure that contains a tag key and value.

        • Key (string) --

          The key that is associated with the tag.

        • Value (string) --

          The value that is associated with the tag.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • CloudDirectory.Client.exceptions.InternalServiceException
  • CloudDirectory.Client.exceptions.InvalidArnException
  • CloudDirectory.Client.exceptions.RetryableConflictException
  • CloudDirectory.Client.exceptions.ValidationException
  • CloudDirectory.Client.exceptions.LimitExceededException
  • CloudDirectory.Client.exceptions.AccessDeniedException
  • CloudDirectory.Client.exceptions.ResourceNotFoundException
  • CloudDirectory.Client.exceptions.InvalidTaggingRequestException