CloudTrail / Client / stop_logging

stop_logging#

CloudTrail.Client.stop_logging(**kwargs)#

Suspends the recording of Amazon Web Services API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all Regions, this operation must be called from the Region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail enabled in all Regions.

Request Syntax

response = client.stop_logging(
    Name='string'
)

Parameters:

Name (string) –

[REQUIRED]

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging Amazon Web Services API calls. 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.TrailNotFoundException
CloudTrail.Client.exceptions.InvalidTrailNameException
CloudTrail.Client.exceptions.CloudTrailARNInvalidException
CloudTrail.Client.exceptions.ConflictException
CloudTrail.Client.exceptions.InvalidHomeRegionException
CloudTrail.Client.exceptions.UnsupportedOperationException
CloudTrail.Client.exceptions.OperationNotPermittedException
CloudTrail.Client.exceptions.NotOrganizationMasterAccountException
CloudTrail.Client.exceptions.NoManagementAccountSLRExistsException
CloudTrail.Client.exceptions.InsufficientDependencyServiceAccessPermissionException