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

Amazonka.CloudTrail.ListQueries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for EventDataStore. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding StartTime and EndTime parameters, and a QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

Synopsis

data ListQueries = ListQueries' {
- endTime :: Maybe POSIX
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- queryStatus :: Maybe QueryStatus
- startTime :: Maybe POSIX
- eventDataStore :: Text
}
newListQueries :: Text -> ListQueries
listQueries_endTime :: Lens' ListQueries (Maybe UTCTime)
listQueries_maxResults :: Lens' ListQueries (Maybe Natural)
listQueries_nextToken :: Lens' ListQueries (Maybe Text)
listQueries_queryStatus :: Lens' ListQueries (Maybe QueryStatus)
listQueries_startTime :: Lens' ListQueries (Maybe UTCTime)
listQueries_eventDataStore :: Lens' ListQueries Text
data ListQueriesResponse = ListQueriesResponse' {
- nextToken :: Maybe Text
- queries :: Maybe [Query]
- httpStatus :: Int
}
newListQueriesResponse :: Int -> ListQueriesResponse
listQueriesResponse_nextToken :: Lens' ListQueriesResponse (Maybe Text)
listQueriesResponse_queries :: Lens' ListQueriesResponse (Maybe [Query])
listQueriesResponse_httpStatus :: Lens' ListQueriesResponse Int

Creating a Request

data ListQueries Source #

See: newListQueries smart constructor.

Constructors

ListQueries'

Fields

endTime :: Maybe POSIX
Use with StartTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.
maxResults :: Maybe Natural
The maximum number of queries to show on a page.
nextToken :: Maybe Text
A token you can use to get the next page of results.
queryStatus :: Maybe QueryStatus
The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.
startTime :: Maybe POSIX
Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.
eventDataStore :: Text
The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

Instances

Instances details

ToJSON ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods toJSON :: ListQueries -> Value # toEncoding :: ListQueries -> Encoding # toJSONList :: [ListQueries] -> Value # toEncodingList :: [ListQueries] -> Encoding #
ToHeaders ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods toHeaders :: ListQueries -> [Header] #
ToPath ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods toPath :: ListQueries -> ByteString #
ToQuery ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods toQuery :: ListQueries -> QueryString #
AWSRequest ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Associated Types type AWSResponse ListQueries # Methods request :: (Service -> Service) -> ListQueries -> Request ListQueries # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListQueries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListQueries))) #
Generic ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Associated Types type Rep ListQueries :: Type -> Type # Methods from :: ListQueries -> Rep ListQueries x # to :: Rep ListQueries x -> ListQueries #
Read ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods readsPrec :: Int -> ReadS ListQueries # readList :: ReadS [ListQueries] # readPrec :: ReadPrec ListQueries # readListPrec :: ReadPrec [ListQueries] #
Show ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods showsPrec :: Int -> ListQueries -> ShowS # show :: ListQueries -> String # showList :: [ListQueries] -> ShowS #
NFData ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods rnf :: ListQueries -> () #
Eq ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods (==) :: ListQueries -> ListQueries -> Bool # (/=) :: ListQueries -> ListQueries -> Bool #
Hashable ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods hashWithSalt :: Int -> ListQueries -> Int # hash :: ListQueries -> Int #
type AWSResponse ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries type AWSResponse ListQueries = ListQueriesResponse
type Rep ListQueries Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries type Rep ListQueries = D1 ('MetaData "ListQueries" "Amazonka.CloudTrail.ListQueries" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "ListQueries'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "queryStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryStatus)) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "eventDataStore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListQueries Source #

Arguments

:: Text	`$sel:eventDataStore:ListQueries'`
-> ListQueries

Create a value of ListQueries 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:endTime:ListQueries', listQueries_endTime - Use with StartTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

$sel:maxResults:ListQueries', listQueries_maxResults - The maximum number of queries to show on a page.

ListQueries, listQueries_nextToken - A token you can use to get the next page of results.

ListQueries, listQueries_queryStatus - The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

$sel:startTime:ListQueries', listQueries_startTime - Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

$sel:eventDataStore:ListQueries', listQueries_eventDataStore - The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

Request Lenses

listQueries_endTime :: Lens' ListQueries (Maybe UTCTime) Source #

Use with StartTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

listQueries_maxResults :: Lens' ListQueries (Maybe Natural) Source #

The maximum number of queries to show on a page.

listQueries_nextToken :: Lens' ListQueries (Maybe Text) Source #

A token you can use to get the next page of results.

listQueries_queryStatus :: Lens' ListQueries (Maybe QueryStatus) Source #

The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

listQueries_startTime :: Lens' ListQueries (Maybe UTCTime) Source #

Use with EndTime to bound a ListQueries request, and limit its results to only those queries run within a specified time period.

listQueries_eventDataStore :: Lens' ListQueries Text Source #

The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.

Destructuring the Response

data ListQueriesResponse Source #

See: newListQueriesResponse smart constructor.

Constructors

ListQueriesResponse'
Fields nextToken :: Maybe Text A token you can use to get the next page of results. queries :: Maybe [Query] Lists matching query results, and shows query ID, status, and creation time of each query. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListQueriesResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Associated Types type Rep ListQueriesResponse :: Type -> Type # Methods from :: ListQueriesResponse -> Rep ListQueriesResponse x # to :: Rep ListQueriesResponse x -> ListQueriesResponse #
Read ListQueriesResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods readsPrec :: Int -> ReadS ListQueriesResponse # readList :: ReadS [ListQueriesResponse] # readPrec :: ReadPrec ListQueriesResponse # readListPrec :: ReadPrec [ListQueriesResponse] #
Show ListQueriesResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods showsPrec :: Int -> ListQueriesResponse -> ShowS # show :: ListQueriesResponse -> String # showList :: [ListQueriesResponse] -> ShowS #
NFData ListQueriesResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods rnf :: ListQueriesResponse -> () #
Eq ListQueriesResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries Methods (==) :: ListQueriesResponse -> ListQueriesResponse -> Bool # (/=) :: ListQueriesResponse -> ListQueriesResponse -> Bool #
type Rep ListQueriesResponse Source #
Instance details Defined in Amazonka.CloudTrail.ListQueries type Rep ListQueriesResponse = D1 ('MetaData "ListQueriesResponse" "Amazonka.CloudTrail.ListQueries" "amazonka-cloudtrail-2.0-6vmpMB1YeZzDIMmexWGsF3" 'False) (C1 ('MetaCons "ListQueriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "queries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Query])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListQueriesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListQueriesResponse'`
-> ListQueriesResponse

Create a value of ListQueriesResponse 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:

ListQueries, listQueriesResponse_nextToken - A token you can use to get the next page of results.

$sel:queries:ListQueriesResponse', listQueriesResponse_queries - Lists matching query results, and shows query ID, status, and creation time of each query.

$sel:httpStatus:ListQueriesResponse', listQueriesResponse_httpStatus - The response's http status code.

Response Lenses

listQueriesResponse_nextToken :: Lens' ListQueriesResponse (Maybe Text) Source #

A token you can use to get the next page of results.

listQueriesResponse_queries :: Lens' ListQueriesResponse (Maybe [Query]) Source #

Lists matching query results, and shows query ID, status, and creation time of each query.

listQueriesResponse_httpStatus :: Lens' ListQueriesResponse Int Source #

The response's http status code.