Amazonka.CloudTrail.GetTrailStatus

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.

Creating a Request

data GetTrailStatus

The name of a trail about which you want the current status.

See: newGetTrailStatus smart constructor.

Constructors

GetTrailStatus'

Fields

• name :: Text

  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

Instances

ToJSON GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

toJSON :: GetTrailStatus -> Value

toEncoding :: GetTrailStatus -> Encoding

toJSONList :: [GetTrailStatus] -> Value

toEncodingList :: [GetTrailStatus] -> Encoding

ToHeaders GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

toHeaders :: GetTrailStatus -> [Header]

ToPath GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

toPath :: GetTrailStatus -> ByteString

ToQuery GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

toQuery :: GetTrailStatus -> QueryString

AWSRequest GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Associated Types

type AWSResponse GetTrailStatus

Methods

request :: (Service -> Service) -> GetTrailStatus -> Request GetTrailStatus

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTrailStatus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTrailStatus)))

Generic GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Associated Types

type Rep GetTrailStatus :: Type -> Type

Methods

from :: GetTrailStatus -> Rep GetTrailStatus x

to :: Rep GetTrailStatus x -> GetTrailStatus

Read GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

readsPrec :: Int -> ReadS GetTrailStatus

readList :: ReadS [GetTrailStatus]

readPrec :: ReadPrec GetTrailStatus

readListPrec :: ReadPrec [GetTrailStatus]

Show GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

showsPrec :: Int -> GetTrailStatus -> ShowS

show :: GetTrailStatus -> String

showList :: [GetTrailStatus] -> ShowS

NFData GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

rnf :: GetTrailStatus -> ()

Eq GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

(==) :: GetTrailStatus -> GetTrailStatus -> Bool

(/=) :: GetTrailStatus -> GetTrailStatus -> Bool

Hashable GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

hashWithSalt :: Int -> GetTrailStatus -> Int

hash :: GetTrailStatus -> Int

type AWSResponse GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

type AWSResponse GetTrailStatus = GetTrailStatusResponse

type Rep GetTrailStatus

Defined in Amazonka.CloudTrail.GetTrailStatus

type Rep GetTrailStatus = D1 ('MetaData "GetTrailStatus" "Amazonka.CloudTrail.GetTrailStatus" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "GetTrailStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetTrailStatus

Arguments

:: Text

GetTrailStatus

-> GetTrailStatus

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

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

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

See: newGetTrailStatusResponse smart constructor.

Constructors

GetTrailStatusResponse'

Fields

• isLogging :: Maybe Bool

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

• latestCloudWatchLogsDeliveryError :: Maybe Text

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

• latestCloudWatchLogsDeliveryTime :: Maybe POSIX

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

• latestDeliveryAttemptSucceeded :: Maybe Text

  This field is no longer in use.

• latestDeliveryAttemptTime :: Maybe Text

  This field is no longer in use.

• latestDeliveryError :: Maybe Text

  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.

• latestDeliveryTime :: Maybe POSIX

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

• latestDigestDeliveryError :: Maybe Text

  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.

• latestDigestDeliveryTime :: Maybe POSIX

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

• latestNotificationAttemptSucceeded :: Maybe Text

  This field is no longer in use.

• latestNotificationAttemptTime :: Maybe Text

  This field is no longer in use.

• latestNotificationError :: Maybe Text

  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.

• latestNotificationTime :: Maybe POSIX

  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 :: Maybe POSIX

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

• stopLoggingTime :: Maybe POSIX

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

• timeLoggingStarted :: Maybe Text

  This field is no longer in use.

• timeLoggingStopped :: Maybe Text

  This field is no longer in use.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetTrailStatusResponse

Defined in Amazonka.CloudTrail.GetTrailStatus

Associated Types

type Rep GetTrailStatusResponse :: Type -> Type

Methods

from :: GetTrailStatusResponse -> Rep GetTrailStatusResponse x

to :: Rep GetTrailStatusResponse x -> GetTrailStatusResponse

Read GetTrailStatusResponse

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

readsPrec :: Int -> ReadS GetTrailStatusResponse

readList :: ReadS [GetTrailStatusResponse]

readPrec :: ReadPrec GetTrailStatusResponse

readListPrec :: ReadPrec [GetTrailStatusResponse]

Show GetTrailStatusResponse

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

showsPrec :: Int -> GetTrailStatusResponse -> ShowS

show :: GetTrailStatusResponse -> String

showList :: [GetTrailStatusResponse] -> ShowS

NFData GetTrailStatusResponse

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

rnf :: GetTrailStatusResponse -> ()

Eq GetTrailStatusResponse

Defined in Amazonka.CloudTrail.GetTrailStatus

Methods

(==) :: GetTrailStatusResponse -> GetTrailStatusResponse -> Bool

(/=) :: GetTrailStatusResponse -> GetTrailStatusResponse -> Bool

type Rep GetTrailStatusResponse

Defined in Amazonka.CloudTrail.GetTrailStatus

type Rep GetTrailStatusResponse = D1 ('MetaData "GetTrailStatusResponse" "Amazonka.CloudTrail.GetTrailStatus" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "GetTrailStatusResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "isLogging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "latestCloudWatchLogsDeliveryError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "latestCloudWatchLogsDeliveryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "latestDeliveryAttemptSucceeded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "latestDeliveryAttemptTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latestDeliveryError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "latestDeliveryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "latestDigestDeliveryError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latestDigestDeliveryTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :*: (((S1 ('MetaSel ('Just "latestNotificationAttemptSucceeded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latestNotificationAttemptTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "latestNotificationError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "latestNotificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "startLoggingTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "stopLoggingTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "timeLoggingStarted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "timeLoggingStopped") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newGetTrailStatusResponse

Arguments

:: Int

$sel:httpStatus:GetTrailStatusResponse'

-> GetTrailStatusResponse

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)

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

getTrailStatusResponse_latestCloudWatchLogsDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)

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

getTrailStatusResponse_latestCloudWatchLogsDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)

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

getTrailStatusResponse_latestDeliveryAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text)

This field is no longer in use.

getTrailStatusResponse_latestDeliveryAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text)

This field is no longer in use.

getTrailStatusResponse_latestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)

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)

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

getTrailStatusResponse_latestDigestDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)

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)

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)

This field is no longer in use.

getTrailStatusResponse_latestNotificationAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text)

This field is no longer in use.

getTrailStatusResponse_latestNotificationError :: Lens' GetTrailStatusResponse (Maybe Text)

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)

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)

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)

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)

This field is no longer in use.

getTrailStatusResponse_timeLoggingStopped :: Lens' GetTrailStatusResponse (Maybe Text)

This field is no longer in use.

getTrailStatusResponse_httpStatus :: Lens' GetTrailStatusResponse Int

The response's http status code.