Skip to content

start_logging

Operation

start_logging

start_logging(request: StartLoggingInput | StartLoggingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartLoggingInputDict]) -> 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
request StartLoggingInput | StartLoggingInputDict | 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[StartLoggingInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartLoggingOutput

An instance of StartLoggingOutput.

start_logging async

start_logging(request: StartLoggingInput | StartLoggingInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartLoggingInputDict]) -> 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
request StartLoggingInput | StartLoggingInputDict | 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[StartLoggingInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartLoggingOutput

An instance of StartLoggingOutput.

Input

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

StartLoggingInputDict

Bases: TypedDict

Dictionary form of StartLoggingInput.

Attributes

name instance-attribute
name: Required[str]

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

StartLoggingInput dataclass

Bases: _SerdeShape

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

Attributes

name class-attribute instance-attribute
name: str | 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

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.