CloudTrail / Client / list_tags



Lists the tags for the specified trails, event data stores, or channels in the current Region.

See also: AWS API Documentation

Request Syntax

response = client.list_tags(
  • ResourceIdList (list) –


    Specifies a list of trail, event data store, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs.

    Example trail ARN format: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

    Example event data store ARN format: arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE

    Example channel ARN format: arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890

    • (string) –

  • NextToken (string) – Reserved for future use.

Return type:



Response Syntax

    'ResourceTagList': [
            'ResourceId': 'string',
            'TagsList': [
                    'Key': 'string',
                    'Value': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    Returns the objects or data listed below if successful. Otherwise, returns an error.

    • ResourceTagList (list) –

      A list of resource tags.

      • (dict) –

        A resource tag.

        • ResourceId (string) –

          Specifies the ARN of the resource.

        • TagsList (list) –

          A list of tags.

          • (dict) –

            A custom key-value pair associated with a resource such as a CloudTrail trail, event data store, or channel.

            • Key (string) –

              The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

            • Value (string) –

              The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

    • NextToken (string) –

      Reserved for future use.


  • CloudTrail.Client.exceptions.ResourceNotFoundException

  • CloudTrail.Client.exceptions.CloudTrailARNInvalidException

  • CloudTrail.Client.exceptions.EventDataStoreARNInvalidException

  • CloudTrail.Client.exceptions.ChannelARNInvalidException

  • CloudTrail.Client.exceptions.ResourceTypeNotSupportedException

  • CloudTrail.Client.exceptions.InvalidTrailNameException

  • CloudTrail.Client.exceptions.InactiveEventDataStoreException

  • CloudTrail.Client.exceptions.EventDataStoreNotFoundException

  • CloudTrail.Client.exceptions.UnsupportedOperationException

  • CloudTrail.Client.exceptions.OperationNotPermittedException

  • CloudTrail.Client.exceptions.InvalidTokenException

  • CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException