Skip to content

CloudTrail  >  Operations  >  start_logging

start_logging

Operation

start_logging async 

start_logging(input: StartLoggingInput, plugins: list[Plugin] | None = None) -> StartLoggingOutput

Starts the recording of Amazon Web Services API calls and log file delivery for a trail. For a trail that is enabled in all Regions, this operation must be called from the Region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other Regions) of a trail that is enabled in all Regions.

Parameters:

Name Type Description Default
input StartLoggingInput

An instance of StartLoggingInput.

 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
StartLoggingOutput

An instance of StartLoggingOutput.

Input

StartLoggingInput dataclass

The request to CloudTrail to start logging Amazon Web Services API calls for an account.

Attributes

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

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs Amazon Web Services API calls. The following is the format of a trail ARN.

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Output

StartLoggingOutput dataclass

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