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.GetQueryResults

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets event data results of a query. You must specify the QueryID value returned by the StartQuery operation, and an ARN for EventDataStore.

Synopsis

data GetQueryResults = GetQueryResults' {
- eventDataStore :: Maybe Text
- maxQueryResults :: Maybe Natural
- nextToken :: Maybe Text
- queryId :: Text
}
newGetQueryResults :: Text -> GetQueryResults
getQueryResults_eventDataStore :: Lens' GetQueryResults (Maybe Text)
getQueryResults_maxQueryResults :: Lens' GetQueryResults (Maybe Natural)
getQueryResults_nextToken :: Lens' GetQueryResults (Maybe Text)
getQueryResults_queryId :: Lens' GetQueryResults Text
data GetQueryResultsResponse = GetQueryResultsResponse' {
- errorMessage :: Maybe Text
- nextToken :: Maybe Text
- queryResultRows :: Maybe [[HashMap Text Text]]
- queryStatistics :: Maybe QueryStatistics
- queryStatus :: Maybe QueryStatus
- httpStatus :: Int
}
newGetQueryResultsResponse :: Int -> GetQueryResultsResponse
getQueryResultsResponse_errorMessage :: Lens' GetQueryResultsResponse (Maybe Text)
getQueryResultsResponse_nextToken :: Lens' GetQueryResultsResponse (Maybe Text)
getQueryResultsResponse_queryResultRows :: Lens' GetQueryResultsResponse (Maybe [[HashMap Text Text]])
getQueryResultsResponse_queryStatistics :: Lens' GetQueryResultsResponse (Maybe QueryStatistics)
getQueryResultsResponse_queryStatus :: Lens' GetQueryResultsResponse (Maybe QueryStatus)
getQueryResultsResponse_httpStatus :: Lens' GetQueryResultsResponse Int

Creating a Request

data GetQueryResults Source #

See: newGetQueryResults smart constructor.

Constructors

GetQueryResults'
Fields eventDataStore :: Maybe Text The ARN (or ID suffix of the ARN) of the event data store against which the query was run. maxQueryResults :: Maybe Natural The maximum number of query results to display on a single page. nextToken :: Maybe Text A token you can use to get the next page of query results. queryId :: Text The ID of the query for which you want to get results.

Instances

Instances details

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

newGetQueryResults Source #

Arguments

:: Text	`GetQueryResults`
-> GetQueryResults

Create a value of GetQueryResults 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:eventDataStore:GetQueryResults', getQueryResults_eventDataStore - The ARN (or ID suffix of the ARN) of the event data store against which the query was run.

$sel:maxQueryResults:GetQueryResults', getQueryResults_maxQueryResults - The maximum number of query results to display on a single page.

GetQueryResults, getQueryResults_nextToken - A token you can use to get the next page of query results.

GetQueryResults, getQueryResults_queryId - The ID of the query for which you want to get results.

Request Lenses

getQueryResults_eventDataStore :: Lens' GetQueryResults (Maybe Text) Source #

The ARN (or ID suffix of the ARN) of the event data store against which the query was run.

getQueryResults_maxQueryResults :: Lens' GetQueryResults (Maybe Natural) Source #

The maximum number of query results to display on a single page.

getQueryResults_nextToken :: Lens' GetQueryResults (Maybe Text) Source #

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

getQueryResults_queryId :: Lens' GetQueryResults Text Source #

The ID of the query for which you want to get results.

Destructuring the Response

data GetQueryResultsResponse Source #

See: newGetQueryResultsResponse smart constructor.

Constructors

GetQueryResultsResponse'

Fields

errorMessage :: Maybe Text
The error message returned if a query failed.
nextToken :: Maybe Text
A token you can use to get the next page of query results.
queryResultRows :: Maybe [[HashMap Text Text]]
Contains the individual event results of the query.
queryStatistics :: Maybe QueryStatistics
Shows the count of query results.
queryStatus :: Maybe QueryStatus
The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetQueryResultsResponse Source #

Arguments

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

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

GetQueryResultsResponse, getQueryResultsResponse_errorMessage - The error message returned if a query failed.

GetQueryResults, getQueryResultsResponse_nextToken - A token you can use to get the next page of query results.

$sel:queryResultRows:GetQueryResultsResponse', getQueryResultsResponse_queryResultRows - Contains the individual event results of the query.

$sel:queryStatistics:GetQueryResultsResponse', getQueryResultsResponse_queryStatistics - Shows the count of query results.

GetQueryResultsResponse, getQueryResultsResponse_queryStatus - The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

$sel:httpStatus:GetQueryResultsResponse', getQueryResultsResponse_httpStatus - The response's http status code.

Response Lenses

getQueryResultsResponse_errorMessage :: Lens' GetQueryResultsResponse (Maybe Text) Source #

The error message returned if a query failed.

getQueryResultsResponse_nextToken :: Lens' GetQueryResultsResponse (Maybe Text) Source #

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

getQueryResultsResponse_queryResultRows :: Lens' GetQueryResultsResponse (Maybe [[HashMap Text Text]]) Source #

Contains the individual event results of the query.

getQueryResultsResponse_queryStatistics :: Lens' GetQueryResultsResponse (Maybe QueryStatistics) Source #

Shows the count of query results.

getQueryResultsResponse_queryStatus :: Lens' GetQueryResultsResponse (Maybe QueryStatus) Source #

The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED.

getQueryResultsResponse_httpStatus :: Lens' GetQueryResultsResponse Int Source #

The response's http status code.