Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
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.
Synopsis
- data GetTrailStatus = GetTrailStatus' {}
- newGetTrailStatus :: Text -> GetTrailStatus
- getTrailStatus_name :: Lens' GetTrailStatus Text
- data GetTrailStatusResponse = GetTrailStatusResponse' {
- isLogging :: Maybe Bool
- latestCloudWatchLogsDeliveryError :: Maybe Text
- latestCloudWatchLogsDeliveryTime :: Maybe POSIX
- latestDeliveryAttemptSucceeded :: Maybe Text
- latestDeliveryAttemptTime :: Maybe Text
- latestDeliveryError :: Maybe Text
- latestDeliveryTime :: Maybe POSIX
- latestDigestDeliveryError :: Maybe Text
- latestDigestDeliveryTime :: Maybe POSIX
- latestNotificationAttemptSucceeded :: Maybe Text
- latestNotificationAttemptTime :: Maybe Text
- latestNotificationError :: Maybe Text
- latestNotificationTime :: Maybe POSIX
- startLoggingTime :: Maybe POSIX
- stopLoggingTime :: Maybe POSIX
- timeLoggingStarted :: Maybe Text
- timeLoggingStopped :: Maybe Text
- httpStatus :: Int
- newGetTrailStatusResponse :: Int -> GetTrailStatusResponse
- getTrailStatusResponse_isLogging :: Lens' GetTrailStatusResponse (Maybe Bool)
- getTrailStatusResponse_latestCloudWatchLogsDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_latestCloudWatchLogsDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- getTrailStatusResponse_latestDeliveryAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_latestDeliveryAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_latestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_latestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- getTrailStatusResponse_latestDigestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_latestDigestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- getTrailStatusResponse_latestNotificationAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_latestNotificationAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_latestNotificationError :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_latestNotificationTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- getTrailStatusResponse_startLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- getTrailStatusResponse_stopLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)
- getTrailStatusResponse_timeLoggingStarted :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_timeLoggingStopped :: Lens' GetTrailStatusResponse (Maybe Text)
- getTrailStatusResponse_httpStatus :: Lens' GetTrailStatusResponse Int
Creating a Request
data GetTrailStatus Source #
The name of a trail about which you want the current status.
See: newGetTrailStatus
smart constructor.
GetTrailStatus' | |
|
Instances
Create a value of GetTrailStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetTrailStatus
, getTrailStatus_name
- 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
Request Lenses
getTrailStatus_name :: 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 following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
Destructuring the Response
data GetTrailStatusResponse Source #
Returns the objects or data listed below if successful. Otherwise, returns an error.
See: newGetTrailStatusResponse
smart constructor.
GetTrailStatusResponse' | |
|
Instances
newGetTrailStatusResponse Source #
Create a value of GetTrailStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isLogging:GetTrailStatusResponse'
, getTrailStatusResponse_isLogging
- Whether the CloudTrail trail is currently logging Amazon Web Services
API calls.
$sel:latestCloudWatchLogsDeliveryError:GetTrailStatusResponse'
, getTrailStatusResponse_latestCloudWatchLogsDeliveryError
- Displays any CloudWatch Logs error that CloudTrail encountered when
attempting to deliver logs to CloudWatch Logs.
$sel:latestCloudWatchLogsDeliveryTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestCloudWatchLogsDeliveryTime
- Displays the most recent date and time when CloudTrail delivered logs to
CloudWatch Logs.
$sel:latestDeliveryAttemptSucceeded:GetTrailStatusResponse'
, getTrailStatusResponse_latestDeliveryAttemptSucceeded
- This field is no longer in use.
$sel:latestDeliveryAttemptTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestDeliveryAttemptTime
- This field is no longer in use.
$sel:latestDeliveryError:GetTrailStatusResponse'
, getTrailStatusResponse_latestDeliveryError
- 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, 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.
$sel:latestDeliveryTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestDeliveryTime
- Specifies the date and time that CloudTrail last delivered log files to
an account's Amazon S3 bucket.
$sel:latestDigestDeliveryError:GetTrailStatusResponse'
, getTrailStatusResponse_latestDigestDeliveryError
- 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, 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.
$sel:latestDigestDeliveryTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestDigestDeliveryTime
- Specifies the date and time that CloudTrail last delivered a digest file
to an account's Amazon S3 bucket.
$sel:latestNotificationAttemptSucceeded:GetTrailStatusResponse'
, getTrailStatusResponse_latestNotificationAttemptSucceeded
- This field is no longer in use.
$sel:latestNotificationAttemptTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestNotificationAttemptTime
- This field is no longer in use.
$sel:latestNotificationError:GetTrailStatusResponse'
, getTrailStatusResponse_latestNotificationError
- 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.
$sel:latestNotificationTime:GetTrailStatusResponse'
, getTrailStatusResponse_latestNotificationTime
- 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.
$sel:startLoggingTime:GetTrailStatusResponse'
, getTrailStatusResponse_startLoggingTime
- Specifies the most recent date and time when CloudTrail started
recording API calls for an Amazon Web Services account.
$sel:stopLoggingTime:GetTrailStatusResponse'
, getTrailStatusResponse_stopLoggingTime
- Specifies the most recent date and time when CloudTrail stopped
recording API calls for an Amazon Web Services account.
$sel:timeLoggingStarted:GetTrailStatusResponse'
, getTrailStatusResponse_timeLoggingStarted
- This field is no longer in use.
$sel:timeLoggingStopped:GetTrailStatusResponse'
, getTrailStatusResponse_timeLoggingStopped
- This field is no longer in use.
$sel:httpStatus:GetTrailStatusResponse'
, getTrailStatusResponse_httpStatus
- The response's http status code.
Response Lenses
getTrailStatusResponse_isLogging :: Lens' GetTrailStatusResponse (Maybe Bool) Source #
Whether the CloudTrail trail is currently logging Amazon Web Services API calls.
getTrailStatusResponse_latestCloudWatchLogsDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text) Source #
Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
getTrailStatusResponse_latestCloudWatchLogsDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
getTrailStatusResponse_latestDeliveryAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is no longer in use.
getTrailStatusResponse_latestDeliveryAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is no longer in use.
getTrailStatusResponse_latestDeliveryError :: 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 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, 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.
getTrailStatusResponse_latestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
getTrailStatusResponse_latestDigestDeliveryError :: 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 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, 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.
getTrailStatusResponse_latestDigestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
getTrailStatusResponse_latestNotificationAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is no longer in use.
getTrailStatusResponse_latestNotificationAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is no longer in use.
getTrailStatusResponse_latestNotificationError :: 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.
getTrailStatusResponse_latestNotificationTime :: 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.
getTrailStatusResponse_startLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Specifies the most recent date and time when CloudTrail started recording API calls for an Amazon Web Services account.
getTrailStatusResponse_stopLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime) Source #
Specifies the most recent date and time when CloudTrail stopped recording API calls for an Amazon Web Services account.
getTrailStatusResponse_timeLoggingStarted :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is no longer in use.
getTrailStatusResponse_timeLoggingStopped :: Lens' GetTrailStatusResponse (Maybe Text) Source #
This field is no longer in use.
getTrailStatusResponse_httpStatus :: Lens' GetTrailStatusResponse Int Source #
The response's http status code.