CloudTrail / Client / remove_tags

remove_tags#

CloudTrail.Client.remove_tags(**kwargs)#

Removes the specified tags from a trail, event data store, dashboard, or channel.

See also: AWS API Documentation

Request Syntax

response = client.remove_tags(
    ResourceId='string',
    TagsList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ResourceId (string) –

    [REQUIRED]

    Specifies the ARN of the trail, event data store, dashboard, or channel from which tags should be removed.

    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 dashboard ARN format: arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

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

  • TagsList (list) –

    [REQUIRED]

    Specifies a list of tags to be removed.

    • (dict) –

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

      • Key (string) – [REQUIRED]

        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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

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

Exceptions

  • 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.InvalidTagParameterException

  • CloudTrail.Client.exceptions.InactiveEventDataStoreException

  • CloudTrail.Client.exceptions.EventDataStoreNotFoundException

  • CloudTrail.Client.exceptions.ChannelNotFoundException

  • CloudTrail.Client.exceptions.UnsupportedOperationException

  • CloudTrail.Client.exceptions.OperationNotPermittedException

  • CloudTrail.Client.exceptions.NotOrganizationMasterAccountException

  • CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException

  • CloudTrail.Client.exceptions.ConflictException