amazonka-cloudtrail-1.6.0: Amazon CloudTrail SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudTrail.LookupEvents

Contents

Description

Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:

  • Event ID
  • Event name
  • Event source
  • Resource name
  • Resource type
  • User name

All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

Important: The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

Important: Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

This operation returns paginated results.

Synopsis

Creating a Request

lookupEvents :: LookupEvents #

Creates a value of LookupEvents with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • leStartTime - Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.
  • leLookupAttributes - Contains a list of lookup attributes. Currently the list can contain only one item.
  • leNextToken - The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of Username with a value of root, the call with NextToken should include those same parameters.
  • leEndTime - Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.
  • leMaxResults - The number of events to return. Possible values are 1 through 50. The default is 10.

data LookupEvents #

Contains a request for LookupEvents.

See: lookupEvents smart constructor.

Instances

Eq LookupEvents # 
Data LookupEvents # 

Methods

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

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

toConstr :: LookupEvents -> Constr #

dataTypeOf :: LookupEvents -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LookupEvents) #

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

gmapT :: (forall b. Data b => b -> b) -> LookupEvents -> LookupEvents #

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

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

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

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

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

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

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

Read LookupEvents # 
Show LookupEvents # 
Generic LookupEvents # 

Associated Types

type Rep LookupEvents :: * -> * #

Hashable LookupEvents # 
ToJSON LookupEvents # 
NFData LookupEvents # 

Methods

rnf :: LookupEvents -> () #

AWSPager LookupEvents # 
AWSRequest LookupEvents # 
ToHeaders LookupEvents # 
ToPath LookupEvents # 
ToQuery LookupEvents # 
type Rep LookupEvents # 
type Rep LookupEvents = D1 * (MetaData "LookupEvents" "Network.AWS.CloudTrail.LookupEvents" "amazonka-cloudtrail-1.6.0-FtX1PWl9UH1Ll5Gb3xSmkU" False) (C1 * (MetaCons "LookupEvents'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_leStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_leLookupAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [LookupAttribute])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_leNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_leEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_leMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))))))
type Rs LookupEvents # 

Request Lenses

leStartTime :: Lens' LookupEvents (Maybe UTCTime) #

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

leLookupAttributes :: Lens' LookupEvents [LookupAttribute] #

Contains a list of lookup attributes. Currently the list can contain only one item.

leNextToken :: Lens' LookupEvents (Maybe Text) #

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of Username with a value of root, the call with NextToken should include those same parameters.

leEndTime :: Lens' LookupEvents (Maybe UTCTime) #

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

leMaxResults :: Lens' LookupEvents (Maybe Natural) #

The number of events to return. Possible values are 1 through 50. The default is 10.

Destructuring the Response

lookupEventsResponse #

Creates a value of LookupEventsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lersNextToken - The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of Username with a value of root, the call with NextToken should include those same parameters.
  • lersEvents - A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.
  • lersResponseStatus - -- | The response status code.

data LookupEventsResponse #

Contains a response to a LookupEvents action.

See: lookupEventsResponse smart constructor.

Instances

Eq LookupEventsResponse # 
Data LookupEventsResponse # 

Methods

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

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

toConstr :: LookupEventsResponse -> Constr #

dataTypeOf :: LookupEventsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LookupEventsResponse) #

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

gmapT :: (forall b. Data b => b -> b) -> LookupEventsResponse -> LookupEventsResponse #

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

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

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

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

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

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

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

Read LookupEventsResponse # 
Show LookupEventsResponse # 
Generic LookupEventsResponse # 
NFData LookupEventsResponse # 

Methods

rnf :: LookupEventsResponse -> () #

type Rep LookupEventsResponse # 
type Rep LookupEventsResponse = D1 * (MetaData "LookupEventsResponse" "Network.AWS.CloudTrail.LookupEvents" "amazonka-cloudtrail-1.6.0-FtX1PWl9UH1Ll5Gb3xSmkU" False) (C1 * (MetaCons "LookupEventsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_lersNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_lersEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Event]))) (S1 * (MetaSel (Just Symbol "_lersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

lersNextToken :: Lens' LookupEventsResponse (Maybe Text) #

The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of Username with a value of root, the call with NextToken should include those same parameters.

lersEvents :: Lens' LookupEventsResponse [Event] #

A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.

lersResponseStatus :: Lens' LookupEventsResponse Int #

  • - | The response status code.