Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- getTrailStatus :: Text -> GetTrailStatus
- data GetTrailStatus
- gtsName :: Lens' GetTrailStatus Text
- getTrailStatusResponse :: Int -> GetTrailStatusResponse
- data GetTrailStatusResponse
- gtsrsTimeLoggingStopped :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsLatestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsLatestDigestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- gtsrsLatestNotificationAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsStartLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- gtsrsLatestNotificationError :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsLatestDeliveryAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsIsLogging :: Lens' GetTrailStatusResponse (Maybe Bool)
- gtsrsTimeLoggingStarted :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsLatestDigestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsLatestDeliveryAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsLatestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- gtsrsLatestCloudWatchLogsDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- gtsrsLatestCloudWatchLogsDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsLatestNotificationTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- gtsrsLatestNotificationAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text)
- gtsrsStopLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- gtsrsResponseStatus :: Lens' GetTrailStatusResponse Int
Creating a Request
Creates a value of GetTrailStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetTrailStatus Source #
The name of a trail about which you want the current status.
See: getTrailStatus
smart constructor.
Request Lenses
gtsName :: Lens' GetTrailStatus Text Source #
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 format of a trail ARN is 'arn:aws:cloudtrail:us-east-1:123456789012:trail\/MyTrail'.
Destructuring the Response
getTrailStatusResponse Source #
Creates a value of GetTrailStatusResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gtsrsTimeLoggingStopped
gtsrsLatestDeliveryError
gtsrsLatestDigestDeliveryTime
gtsrsLatestNotificationAttemptSucceeded
gtsrsStartLoggingTime
gtsrsLatestNotificationError
gtsrsLatestDeliveryAttemptSucceeded
gtsrsIsLogging
gtsrsTimeLoggingStarted
gtsrsLatestDigestDeliveryError
gtsrsLatestDeliveryAttemptTime
gtsrsLatestDeliveryTime
gtsrsLatestCloudWatchLogsDeliveryTime
gtsrsLatestCloudWatchLogsDeliveryError
gtsrsLatestNotificationTime
gtsrsLatestNotificationAttemptTime
gtsrsStopLoggingTime
gtsrsResponseStatus
data GetTrailStatusResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: getTrailStatusResponse
smart constructor.
Response Lenses
gtsrsTimeLoggingStopped :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is deprecated.
gtsrsLatestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text) Source #
Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.
This error occurs only when there is a problem with the destination S3
bucket and will not occur for timeouts. To resolve the issue, create a
new bucket and call UpdateTrail
to specify the new bucket, or fix the
existing objects so that CloudTrail can again write to the bucket.
gtsrsLatestDigestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
gtsrsLatestNotificationAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is deprecated.
gtsrsStartLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
gtsrsLatestNotificationError :: Lens' GetTrailStatusResponse (Maybe Text) Source #
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.
gtsrsLatestDeliveryAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is deprecated.
gtsrsIsLogging :: Lens' GetTrailStatusResponse (Maybe Bool) Source #
Whether the CloudTrail is currently logging AWS API calls.
gtsrsTimeLoggingStarted :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is deprecated.
gtsrsLatestDigestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text) Source #
Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.
This error occurs only when there is a problem with the destination S3
bucket and will not occur for timeouts. To resolve the issue, create a
new bucket and call UpdateTrail
to specify the new bucket, or fix the
existing objects so that CloudTrail can again write to the bucket.
gtsrsLatestDeliveryAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is deprecated.
gtsrsLatestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
gtsrsLatestCloudWatchLogsDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
gtsrsLatestCloudWatchLogsDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text) Source #
Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
gtsrsLatestNotificationTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
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.
gtsrsLatestNotificationAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is deprecated.
gtsrsStopLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
gtsrsResponseStatus :: Lens' GetTrailStatusResponse Int Source #
The response status code.