CloudTrail / Client / delete_trail
delete_trail¶
- CloudTrail.Client.delete_trail(**kwargs)¶
Deletes a trail. This operation must be called from the Region in which the trail was created.
DeleteTrailcannot 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.
See also: AWS API Documentation
Request Syntax
response = client.delete_trail( Name='string' )
- Parameters:
Name (string) –
[REQUIRED]
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- 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.TrailNotFoundExceptionCloudTrail.Client.exceptions.InvalidTrailNameExceptionCloudTrail.Client.exceptions.CloudTrailARNInvalidExceptionCloudTrail.Client.exceptions.ConflictExceptionCloudTrail.Client.exceptions.ThrottlingExceptionCloudTrail.Client.exceptions.InvalidHomeRegionExceptionCloudTrail.Client.exceptions.UnsupportedOperationExceptionCloudTrail.Client.exceptions.OperationNotPermittedExceptionCloudTrail.Client.exceptions.NotOrganizationMasterAccountExceptionCloudTrail.Client.exceptions.NoManagementAccountSLRExistsExceptionCloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionException