Network.AWS.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

getTrailStatus

Arguments

:: Text

gtsName

-> GetTrailStatus

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:

• gtsName - 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

data GetTrailStatus

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

See: getTrailStatus smart constructor.

Instances

Eq GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

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

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

Data GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetTrailStatus -> c GetTrailStatus

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetTrailStatus

toConstr :: GetTrailStatus -> Constr

dataTypeOf :: GetTrailStatus -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetTrailStatus)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetTrailStatus)

gmapT :: (forall b. Data b => b -> b) -> GetTrailStatus -> GetTrailStatus

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetTrailStatus -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetTrailStatus -> r

gmapQ :: (forall d. Data d => d -> u) -> GetTrailStatus -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetTrailStatus -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetTrailStatus -> m GetTrailStatus

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTrailStatus -> m GetTrailStatus

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTrailStatus -> m GetTrailStatus

Read GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

readsPrec :: Int -> ReadS GetTrailStatus

readList :: ReadS [GetTrailStatus]

readPrec :: ReadPrec GetTrailStatus

readListPrec :: ReadPrec [GetTrailStatus]

Show GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

showsPrec :: Int -> GetTrailStatus -> ShowS

show :: GetTrailStatus -> String

showList :: [GetTrailStatus] -> ShowS

Generic GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Associated Types

type Rep GetTrailStatus :: Type -> Type

Methods

from :: GetTrailStatus -> Rep GetTrailStatus x

to :: Rep GetTrailStatus x -> GetTrailStatus

Hashable GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

hashWithSalt :: Int -> GetTrailStatus -> Int

hash :: GetTrailStatus -> Int

ToJSON GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

toJSON :: GetTrailStatus -> Value

toEncoding :: GetTrailStatus -> Encoding

toJSONList :: [GetTrailStatus] -> Value

toEncodingList :: [GetTrailStatus] -> Encoding

AWSRequest GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Associated Types

type Rs GetTrailStatus :: Type

Methods

request :: GetTrailStatus -> Request GetTrailStatus

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetTrailStatus -> ClientResponse -> m (Response GetTrailStatus)

ToHeaders GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

toHeaders :: GetTrailStatus -> [Header]

ToPath GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

toPath :: GetTrailStatus -> ByteString

ToQuery GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

toQuery :: GetTrailStatus -> QueryString

NFData GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

rnf :: GetTrailStatus -> ()

type Rep GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

type Rep GetTrailStatus = D1 (MetaData "GetTrailStatus" "Network.AWS.CloudTrail.GetTrailStatus" "amazonka-cloudtrail-1.6.1-1ASQobB9oxr6dsaqg3j95A" True) (C1 (MetaCons "GetTrailStatus'" PrefixI True) (S1 (MetaSel (Just "_gtsName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs GetTrailStatus

Defined in Network.AWS.CloudTrail.GetTrailStatus

type Rs GetTrailStatus = GetTrailStatusResponse

Request Lenses

gtsName :: 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 format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Destructuring the Response

getTrailStatusResponse

Arguments

:: Int

gtsrsResponseStatus

-> GetTrailStatusResponse

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 - This field is deprecated.
• gtsrsLatestDeliveryError - 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.
• gtsrsLatestDigestDeliveryTime - Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
• gtsrsLatestNotificationAttemptSucceeded - This field is deprecated.
• gtsrsStartLoggingTime - Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
• gtsrsLatestNotificationError - 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 - This field is deprecated.
• gtsrsIsLogging - Whether the CloudTrail is currently logging AWS API calls.
• gtsrsTimeLoggingStarted - This field is deprecated.
• gtsrsLatestDigestDeliveryError - 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.
• gtsrsLatestDeliveryAttemptTime - This field is deprecated.
• gtsrsLatestDeliveryTime - Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
• gtsrsLatestCloudWatchLogsDeliveryTime - Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
• gtsrsLatestCloudWatchLogsDeliveryError - Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
• gtsrsLatestNotificationTime - 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 - This field is deprecated.
• gtsrsStopLoggingTime - Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
• gtsrsResponseStatus - -- | The response status code.

data GetTrailStatusResponse

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

See: getTrailStatusResponse smart constructor.

Instances

Eq GetTrailStatusResponse

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

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

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

Data GetTrailStatusResponse

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetTrailStatusResponse -> c GetTrailStatusResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetTrailStatusResponse

toConstr :: GetTrailStatusResponse -> Constr

dataTypeOf :: GetTrailStatusResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetTrailStatusResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetTrailStatusResponse)

gmapT :: (forall b. Data b => b -> b) -> GetTrailStatusResponse -> GetTrailStatusResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetTrailStatusResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetTrailStatusResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetTrailStatusResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetTrailStatusResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetTrailStatusResponse -> m GetTrailStatusResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTrailStatusResponse -> m GetTrailStatusResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetTrailStatusResponse -> m GetTrailStatusResponse

Read GetTrailStatusResponse

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

readsPrec :: Int -> ReadS GetTrailStatusResponse

readList :: ReadS [GetTrailStatusResponse]

readPrec :: ReadPrec GetTrailStatusResponse

readListPrec :: ReadPrec [GetTrailStatusResponse]

Show GetTrailStatusResponse

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

showsPrec :: Int -> GetTrailStatusResponse -> ShowS

show :: GetTrailStatusResponse -> String

showList :: [GetTrailStatusResponse] -> ShowS

Generic GetTrailStatusResponse

Defined in Network.AWS.CloudTrail.GetTrailStatus

Associated Types

type Rep GetTrailStatusResponse :: Type -> Type

Methods

from :: GetTrailStatusResponse -> Rep GetTrailStatusResponse x

to :: Rep GetTrailStatusResponse x -> GetTrailStatusResponse

NFData GetTrailStatusResponse

Defined in Network.AWS.CloudTrail.GetTrailStatus

Methods

rnf :: GetTrailStatusResponse -> ()

type Rep GetTrailStatusResponse

Defined in Network.AWS.CloudTrail.GetTrailStatus

type Rep GetTrailStatusResponse = D1 (MetaData "GetTrailStatusResponse" "Network.AWS.CloudTrail.GetTrailStatus" "amazonka-cloudtrail-1.6.1-1ASQobB9oxr6dsaqg3j95A" False) (C1 (MetaCons "GetTrailStatusResponse'" PrefixI True) ((((S1 (MetaSel (Just "_gtsrsTimeLoggingStopped") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gtsrsLatestDeliveryError") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gtsrsLatestDigestDeliveryTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_gtsrsLatestNotificationAttemptSucceeded") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_gtsrsStartLoggingTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_gtsrsLatestNotificationError") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gtsrsLatestDeliveryAttemptSucceeded") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_gtsrsIsLogging") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_gtsrsTimeLoggingStarted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 (MetaSel (Just "_gtsrsLatestDigestDeliveryError") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gtsrsLatestDeliveryAttemptTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gtsrsLatestDeliveryTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_gtsrsLatestCloudWatchLogsDeliveryTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 (MetaSel (Just "_gtsrsLatestCloudWatchLogsDeliveryError") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gtsrsLatestNotificationTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 (MetaSel (Just "_gtsrsLatestNotificationAttemptTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_gtsrsStopLoggingTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 (MetaSel (Just "_gtsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))))

Response Lenses

gtsrsTimeLoggingStopped :: Lens' GetTrailStatusResponse (Maybe Text)

This field is deprecated.

gtsrsLatestDeliveryError :: 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 the topic Error Responses in the Amazon S3 API Reference.

gtsrsLatestDigestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)

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

gtsrsLatestNotificationAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text)

This field is deprecated.

gtsrsStartLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)

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

gtsrsLatestNotificationError :: 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 .

gtsrsLatestDeliveryAttemptSucceeded :: Lens' GetTrailStatusResponse (Maybe Text)

This field is deprecated.

gtsrsIsLogging :: Lens' GetTrailStatusResponse (Maybe Bool)

Whether the CloudTrail is currently logging AWS API calls.

gtsrsTimeLoggingStarted :: Lens' GetTrailStatusResponse (Maybe Text)

This field is deprecated.

gtsrsLatestDigestDeliveryError :: 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 the topic Error Responses in the Amazon S3 API Reference.

gtsrsLatestDeliveryAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text)

This field is deprecated.

gtsrsLatestDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)

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

gtsrsLatestCloudWatchLogsDeliveryTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)

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

gtsrsLatestCloudWatchLogsDeliveryError :: Lens' GetTrailStatusResponse (Maybe Text)

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

gtsrsLatestNotificationTime :: 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.

gtsrsLatestNotificationAttemptTime :: Lens' GetTrailStatusResponse (Maybe Text)

This field is deprecated.

gtsrsStopLoggingTime :: Lens' GetTrailStatusResponse (Maybe UTCTime)

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

gtsrsResponseStatus :: Lens' GetTrailStatusResponse Int

• - | The response status code.