get_trail_status¶
Operation¶
async
¶
get_trail_status(input: GetTrailStatusInput, plugins: list[Plugin] | None = None) -> 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 |
|---|---|---|---|
input
|
GetTrailStatusInput
|
An instance of |
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 |
|---|---|
GetTrailStatusOutput
|
An instance of |
Input¶
dataclass
¶
The name of a trail about which you want the current status.
Attributes¶
class-attribute
instance-attribute
¶
name: str | None = 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¶
dataclass
¶
Returns the objects or data listed below if successful. Otherwise, returns an error.
Attributes¶
class-attribute
instance-attribute
¶
is_logging: bool | None = None
Whether the CloudTrail trail is currently logging Amazon Web Services API calls.
class-attribute
instance-attribute
¶
latest_cloud_watch_logs_delivery_error: str | None = None
Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
class-attribute
instance-attribute
¶
latest_cloud_watch_logs_delivery_time: datetime | None = None
Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
class-attribute
instance-attribute
¶
latest_delivery_attempt_succeeded: str | None = None
This field is no longer in use.
class-attribute
instance-attribute
¶
latest_delivery_attempt_time: str | None = None
This field is no longer in use.
class-attribute
instance-attribute
¶
latest_delivery_error: str | None = 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.
class-attribute
instance-attribute
¶
latest_delivery_time: datetime | None = None
Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
class-attribute
instance-attribute
¶
latest_digest_delivery_error: str | None = 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.
class-attribute
instance-attribute
¶
latest_digest_delivery_time: datetime | None = None
Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
class-attribute
instance-attribute
¶
latest_notification_attempt_succeeded: str | None = None
This field is no longer in use.
class-attribute
instance-attribute
¶
latest_notification_attempt_time: str | None = None
This field is no longer in use.
class-attribute
instance-attribute
¶
latest_notification_error: str | None = 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.
class-attribute
instance-attribute
¶
latest_notification_time: datetime | None = 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.
class-attribute
instance-attribute
¶
start_logging_time: datetime | None = None
Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.
class-attribute
instance-attribute
¶
stop_logging_time: datetime | None = None
Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.