CloudTrail / Client / get_trail_status

get_trail_status#

CloudTrail.Client.get_trail_status(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_trail_status(
    Name='string'
)
Parameters:

Name (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'IsLogging': True|False,
    'LatestDeliveryError': 'string',
    'LatestNotificationError': 'string',
    'LatestDeliveryTime': datetime(2015, 1, 1),
    'LatestNotificationTime': datetime(2015, 1, 1),
    'StartLoggingTime': datetime(2015, 1, 1),
    'StopLoggingTime': datetime(2015, 1, 1),
    'LatestCloudWatchLogsDeliveryError': 'string',
    'LatestCloudWatchLogsDeliveryTime': datetime(2015, 1, 1),
    'LatestDigestDeliveryTime': datetime(2015, 1, 1),
    'LatestDigestDeliveryError': 'string',
    'LatestDeliveryAttemptTime': 'string',
    'LatestNotificationAttemptTime': 'string',
    'LatestNotificationAttemptSucceeded': 'string',
    'LatestDeliveryAttemptSucceeded': 'string',
    'TimeLoggingStarted': 'string',
    'TimeLoggingStopped': 'string'
}

Response Structure

  • (dict) –

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

    • IsLogging (boolean) –

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

    • LatestDeliveryError (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.

      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, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

    • LatestNotificationError (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.

    • LatestDeliveryTime (datetime) –

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

    • LatestNotificationTime (datetime) –

      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.

    • StartLoggingTime (datetime) –

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

    • StopLoggingTime (datetime) –

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

    • LatestCloudWatchLogsDeliveryError (string) –

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

    • LatestCloudWatchLogsDeliveryTime (datetime) –

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

    • LatestDigestDeliveryTime (datetime) –

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

    • LatestDigestDeliveryError (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.

      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, create a new bucket, and then call UpdateTrail to specify the new bucket; or fix the existing objects so that CloudTrail can again write to the bucket.

    • LatestDeliveryAttemptTime (string) –

      This field is no longer in use.

    • LatestNotificationAttemptTime (string) –

      This field is no longer in use.

    • LatestNotificationAttemptSucceeded (string) –

      This field is no longer in use.

    • LatestDeliveryAttemptSucceeded (string) –

      This field is no longer in use.

    • TimeLoggingStarted (string) –

      This field is no longer in use.

    • TimeLoggingStopped (string) –

      This field is no longer in use.

Exceptions

  • CloudTrail.Client.exceptions.CloudTrailARNInvalidException

  • CloudTrail.Client.exceptions.TrailNotFoundException

  • CloudTrail.Client.exceptions.InvalidTrailNameException

  • CloudTrail.Client.exceptions.UnsupportedOperationException

  • CloudTrail.Client.exceptions.OperationNotPermittedException