Skip to content

get_trail_status

Operation

get_trail_status

get_trail_status(request: GetTrailStatusInput | GetTrailStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTrailStatusInputDict]) -> GetTrailStatusOutput

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.

Parameters:

Name Type Description Default
request GetTrailStatusInput | GetTrailStatusInputDict | 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[GetTrailStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetTrailStatusOutput

An instance of GetTrailStatusOutput.

get_trail_status async

get_trail_status(request: GetTrailStatusInput | GetTrailStatusInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTrailStatusInputDict]) -> GetTrailStatusOutput

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single Region. To return trail status from all Regions, you must call the operation on each Region.

Parameters:

Name Type Description Default
request GetTrailStatusInput | GetTrailStatusInputDict | 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[GetTrailStatusInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetTrailStatusOutput

An instance of GetTrailStatusOutput.

Input

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

GetTrailStatusInputDict

Bases: TypedDict

Dictionary form of GetTrailStatusInput.

Attributes

name instance-attribute
name: Required[str]

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another Region), you must specify its ARN.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Note

If the trail is an organization trail and you are a member account in the organization in Organizations, you must provide the full ARN of that trail, and not just the name.

GetTrailStatusInput dataclass

Bases: _SerdeShape

The name of a trail about which you want the current status.

Attributes

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

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another Region), you must specify its ARN.

The following is the format of a trail ARN: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Note

If the trail is an organization trail and you are a member account in the organization in Organizations, you must provide the full ARN of that trail, and not just the name.

Output

GetTrailStatusOutput dataclass

Bases: _SerdeShape

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

Attributes

is_logging class-attribute instance-attribute
is_logging: bool | None = ...

Whether the CloudTrail trail is currently logging Amazon Web Services API calls.

latest_cloud_watch_logs_delivery_error class-attribute instance-attribute
latest_cloud_watch_logs_delivery_error: str | None = ...

Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

latest_cloud_watch_logs_delivery_time class-attribute instance-attribute
latest_cloud_watch_logs_delivery_time: datetime | None = ...

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

latest_delivery_attempt_succeeded class-attribute instance-attribute
latest_delivery_attempt_succeeded: str | None = ...

This field is no longer in use.

latest_delivery_attempt_time class-attribute instance-attribute
latest_delivery_attempt_time: str | None = ...

This field is no longer in use.

latest_delivery_error class-attribute instance-attribute
latest_delivery_error: str | None = ...

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

Note

This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, fix the bucket policy so that CloudTrail can write to the bucket; or create a new bucket and call UpdateTrail to specify the new bucket.

latest_delivery_time class-attribute instance-attribute
latest_delivery_time: datetime | None = ...

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

latest_digest_delivery_error class-attribute instance-attribute
latest_digest_delivery_error: str | None = ...

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information, see Error Responses in the Amazon S3 API Reference.

Note

This error occurs only when there is a problem with the destination S3 bucket, and does not occur for requests that time out. To resolve the issue, fix the bucket policy so that CloudTrail can write to the bucket; or create a new bucket and call UpdateTrail to specify the new bucket.

latest_digest_delivery_time class-attribute instance-attribute
latest_digest_delivery_time: datetime | None = ...

Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

latest_notification_attempt_succeeded class-attribute instance-attribute
latest_notification_attempt_succeeded: str | None = ...

This field is no longer in use.

latest_notification_attempt_time class-attribute instance-attribute
latest_notification_attempt_time: str | None = ...

This field is no longer in use.

latest_notification_error class-attribute instance-attribute
latest_notification_error: str | None = ...

Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.

latest_notification_time class-attribute instance-attribute
latest_notification_time: datetime | None = ...

Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

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.

start_logging_time class-attribute instance-attribute
start_logging_time: datetime | None = ...

Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.

stop_logging_time class-attribute instance-attribute
stop_logging_time: datetime | None = ...

Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.

time_logging_started class-attribute instance-attribute
time_logging_started: str | None = ...

This field is no longer in use.

time_logging_stopped class-attribute instance-attribute
time_logging_stopped: str | None = ...

This field is no longer in use.