Skip to content

delete_trail

Operation

delete_trail

delete_trail(request: DeleteTrailInput | DeleteTrailInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteTrailInputDict]) -> DeleteTrailOutput

Deletes a trail. This operation must be called from the Region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.

Warning

While deleting a CloudTrail trail is an irreversible action, CloudTrail does not delete log files in the Amazon S3 bucket for that trail, the Amazon S3 bucket itself, or the CloudWatchlog group to which the trail delivers events. Deleting a multi-Region trail will stop logging of events in all Amazon Web Services Regions enabled in your Amazon Web Services account. Deleting a single-Region trail will stop logging of events in that Region only. It will not stop logging of events in other Regions even if the trails in those other Regions have identical names to the deleted trail.

For information about account closure and deletion of CloudTrail trails, see https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-account-closure.html.

Parameters:

Name Type Description Default
request DeleteTrailInput | DeleteTrailInputDict | 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[DeleteTrailInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteTrailOutput

An instance of DeleteTrailOutput.

delete_trail async

delete_trail(request: DeleteTrailInput | DeleteTrailInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteTrailInputDict]) -> DeleteTrailOutput

Deletes a trail. This operation must be called from the Region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.

Warning

While deleting a CloudTrail trail is an irreversible action, CloudTrail does not delete log files in the Amazon S3 bucket for that trail, the Amazon S3 bucket itself, or the CloudWatchlog group to which the trail delivers events. Deleting a multi-Region trail will stop logging of events in all Amazon Web Services Regions enabled in your Amazon Web Services account. Deleting a single-Region trail will stop logging of events in that Region only. It will not stop logging of events in other Regions even if the trails in those other Regions have identical names to the deleted trail.

For information about account closure and deletion of CloudTrail trails, see https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-account-closure.html.

Parameters:

Name Type Description Default
request DeleteTrailInput | DeleteTrailInputDict | 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[DeleteTrailInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteTrailOutput

An instance of DeleteTrailOutput.

Input

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

DeleteTrailInputDict

Bases: TypedDict

Dictionary form of DeleteTrailInput.

Attributes

name instance-attribute
name: Required[str]

Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

DeleteTrailInput dataclass

Bases: _SerdeShape

The request that specifies the name of a trail to delete.

Attributes

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

Specifies the name or the CloudTrail ARN of the trail to be deleted. The following is the format of a trail ARN. arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Output

DeleteTrailOutput 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.