Amazonka.CloudWatchLogs.GetQueryResults

Returns the results from the specified query.

Only the fields requested in the query are returned, along with a @ptr field, which is the identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.

GetQueryResults does not start running a query. To run a query, use StartQuery.

If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start queries in linked source accounts. For more information, see CloudWatch cross-account observability.

Creating a Request

data GetQueryResults

See: newGetQueryResults smart constructor.

Constructors

GetQueryResults'

Fields

• queryId :: Text

  The ID number of the query.

Instances

ToJSON GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

toJSON :: GetQueryResults -> Value

toEncoding :: GetQueryResults -> Encoding

toJSONList :: [GetQueryResults] -> Value

toEncodingList :: [GetQueryResults] -> Encoding

ToHeaders GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

toHeaders :: GetQueryResults -> [Header]

ToPath GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

toPath :: GetQueryResults -> ByteString

ToQuery GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

toQuery :: GetQueryResults -> QueryString

AWSRequest GetQueryResults

Defined in Amazonka.CloudWatchLogs.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

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Associated Types

type Rep GetQueryResults :: Type -> Type

Methods

from :: GetQueryResults -> Rep GetQueryResults x

to :: Rep GetQueryResults x -> GetQueryResults

Read GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

readsPrec :: Int -> ReadS GetQueryResults

readList :: ReadS [GetQueryResults]

readPrec :: ReadPrec GetQueryResults

readListPrec :: ReadPrec [GetQueryResults]

Show GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

showsPrec :: Int -> GetQueryResults -> ShowS

show :: GetQueryResults -> String

showList :: [GetQueryResults] -> ShowS

NFData GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

rnf :: GetQueryResults -> ()

Eq GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

(==) :: GetQueryResults -> GetQueryResults -> Bool

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

Hashable GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

hashWithSalt :: Int -> GetQueryResults -> Int

hash :: GetQueryResults -> Int

type AWSResponse GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

type AWSResponse GetQueryResults = GetQueryResultsResponse

type Rep GetQueryResults

Defined in Amazonka.CloudWatchLogs.GetQueryResults

type Rep GetQueryResults = D1 ('MetaData "GetQueryResults" "Amazonka.CloudWatchLogs.GetQueryResults" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "GetQueryResults'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetQueryResults

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:

GetQueryResults, getQueryResults_queryId - The ID number of the query.

Request Lenses

getQueryResults_queryId :: Lens' GetQueryResults Text

The ID number of the query.

Destructuring the Response

data GetQueryResultsResponse

See: newGetQueryResultsResponse smart constructor.

Constructors

GetQueryResultsResponse'

Fields

• results :: Maybe [[ResultField]]

  The log events that matched the query criteria during the most recent time it ran.

  The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

• statistics :: Maybe QueryStatistics

  Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned. These values reflect the full raw results of the query.

• status :: Maybe QueryStatus

  The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

  Queries time out after 15 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetQueryResultsResponse

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Associated Types

type Rep GetQueryResultsResponse :: Type -> Type

Methods

from :: GetQueryResultsResponse -> Rep GetQueryResultsResponse x

to :: Rep GetQueryResultsResponse x -> GetQueryResultsResponse

Read GetQueryResultsResponse

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

readsPrec :: Int -> ReadS GetQueryResultsResponse

readList :: ReadS [GetQueryResultsResponse]

readPrec :: ReadPrec GetQueryResultsResponse

readListPrec :: ReadPrec [GetQueryResultsResponse]

Show GetQueryResultsResponse

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

showsPrec :: Int -> GetQueryResultsResponse -> ShowS

show :: GetQueryResultsResponse -> String

showList :: [GetQueryResultsResponse] -> ShowS

NFData GetQueryResultsResponse

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

rnf :: GetQueryResultsResponse -> ()

Eq GetQueryResultsResponse

Defined in Amazonka.CloudWatchLogs.GetQueryResults

Methods

(==) :: GetQueryResultsResponse -> GetQueryResultsResponse -> Bool

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

type Rep GetQueryResultsResponse

Defined in Amazonka.CloudWatchLogs.GetQueryResults

type Rep GetQueryResultsResponse = D1 ('MetaData "GetQueryResultsResponse" "Amazonka.CloudWatchLogs.GetQueryResults" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "GetQueryResultsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [[ResultField]])) :*: S1 ('MetaSel ('Just "statistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryStatistics))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetQueryResultsResponse

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:

$sel:results:GetQueryResultsResponse', getQueryResultsResponse_results - The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

$sel:statistics:GetQueryResultsResponse', getQueryResultsResponse_statistics - Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned. These values reflect the full raw results of the query.

GetQueryResultsResponse, getQueryResultsResponse_status - The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 15 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

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

Response Lenses

getQueryResultsResponse_results :: Lens' GetQueryResultsResponse (Maybe [[ResultField]])

The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

getQueryResultsResponse_statistics :: Lens' GetQueryResultsResponse (Maybe QueryStatistics)

Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned. These values reflect the full raw results of the query.

getQueryResultsResponse_status :: Lens' GetQueryResultsResponse (Maybe QueryStatus)

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 15 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

getQueryResultsResponse_httpStatus :: Lens' GetQueryResultsResponse Int

The response's http status code.