Skip to content

CloudTrail  >  Operations  >  stop_logging

stop_logging

Operation

stop_logging async 

stop_logging(input: StopLoggingInput, plugins: list[Plugin] | None = None) -> StopLoggingOutput

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.

Parameters:

Name Type Description Default
input StopLoggingInput

An instance of StopLoggingInput.

 required
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

Returns:

Type Description
StopLoggingOutput

An instance of StopLoggingOutput.

Input

StopLoggingInput dataclass

Passes the request to CloudTrail to stop logging Amazon Web Services API calls for the specified account.

Attributes

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

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

Output

StopLoggingOutput dataclass

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