Skip to content

remove_tags

Operation

remove_tags

remove_tags(request: RemoveTagsInput | RemoveTagsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RemoveTagsInputDict]) -> RemoveTagsOutput

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

Parameters:

Name Type Description Default
request RemoveTagsInput | RemoveTagsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[RemoveTagsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RemoveTagsOutput

An instance of RemoveTagsOutput.

remove_tags async

remove_tags(request: RemoveTagsInput | RemoveTagsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RemoveTagsInputDict]) -> RemoveTagsOutput

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

Parameters:

Name Type Description Default
request RemoveTagsInput | RemoveTagsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[RemoveTagsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
RemoveTagsOutput

An instance of RemoveTagsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

RemoveTagsInputDict

Bases: TypedDict

Dictionary form of RemoveTagsInput.

Attributes

resource_id instance-attribute
resource_id: Required[str]

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

tags_list instance-attribute
tags_list: Required[Sequence[Tag | TagDict]]

Specifies a list of tags to be removed.

RemoveTagsInput dataclass

Bases: _SerdeShape

Specifies the tags to remove from a trail, event data store, dashboard, or channel.

Attributes

resource_id class-attribute instance-attribute
resource_id: str | None = ...

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

tags_list class-attribute instance-attribute
tags_list: list[Tag] | None = ...

Specifies a list of tags to be removed.

Output

RemoveTagsOutput dataclass

Bases: _SerdeShape

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

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.