trail_status

Creates, updates, deletes, gets or lists a trail_status resource.

Overview

Name	trail_status
Type	Resource
Id	aws.cloudtrail.trail_status

Fields

The following fields are returned by SELECT queries:

get_trail_status

Name	Datatype	Description
is_logging	boolean	Whether the CloudTrail trail is currently logging Amazon Web Services API calls.
latest_cloud_watch_logs_delivery_error	string	Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
latest_cloud_watch_logs_delivery_time	string (date-time)	Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
latest_delivery_attempt_succeeded	string	This field is no longer in use.
latest_delivery_attempt_time	string	This field is no longer in use.
latest_delivery_error	string	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. 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	string (date-time)	Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
latest_digest_delivery_error	string	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. 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	string (date-time)	Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
latest_notification_attempt_succeeded	string	This field is no longer in use.
latest_notification_attempt_time	string	This field is no longer in use.
latest_notification_error	string	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	string (date-time)	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.
start_logging_time	string (date-time)	Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.
stop_logging_time	string (date-time)	Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.
time_logging_started	string	This field is no longer in use.
time_logging_stopped	string	This field is no longer in use.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_trail_status	select	region		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_trail_status

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.

SELECT
is_logging,
latest_cloud_watch_logs_delivery_error,
latest_cloud_watch_logs_delivery_time,
latest_delivery_attempt_succeeded,
latest_delivery_attempt_time,
latest_delivery_error,
latest_delivery_time,
latest_digest_delivery_error,
latest_digest_delivery_time,
latest_notification_attempt_succeeded,
latest_notification_attempt_time,
latest_notification_error,
latest_notification_time,
start_logging_time,
stop_logging_time,
time_logging_started,
time_logging_stopped
FROM aws.cloudtrail.trail_status
WHERE region = '{{ region }}' -- required
;