Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatchLogs.DescribeQueries

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.

This operation returns paginated results.

Synopsis

data DescribeQueries = DescribeQueries' {
- status :: Maybe QueryStatus
- logGroupName :: Maybe Text
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
}
newDescribeQueries :: DescribeQueries
describeQueries_status :: Lens' DescribeQueries (Maybe QueryStatus)
describeQueries_logGroupName :: Lens' DescribeQueries (Maybe Text)
describeQueries_nextToken :: Lens' DescribeQueries (Maybe Text)
describeQueries_maxResults :: Lens' DescribeQueries (Maybe Natural)
data DescribeQueriesResponse = DescribeQueriesResponse' {
- queries :: Maybe [QueryInfo]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeQueriesResponse :: Int -> DescribeQueriesResponse
describeQueriesResponse_queries :: Lens' DescribeQueriesResponse (Maybe [QueryInfo])
describeQueriesResponse_nextToken :: Lens' DescribeQueriesResponse (Maybe Text)
describeQueriesResponse_httpStatus :: Lens' DescribeQueriesResponse Int

Creating a Request

data DescribeQueries Source #

See: newDescribeQueries smart constructor.

Constructors

DescribeQueries'

Fields

status :: Maybe QueryStatus
Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.
logGroupName :: Maybe Text
Limits the returned queries to only those for the specified log group.
nextToken :: Maybe Text
maxResults :: Maybe Natural
Limits the number of returned queries to the specified number.

Instances

Instances details

Eq DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods (==) :: DescribeQueries -> DescribeQueries -> Bool # (/=) :: DescribeQueries -> DescribeQueries -> Bool #
Read DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods readsPrec :: Int -> ReadS DescribeQueries # readList :: ReadS [DescribeQueries] # readPrec :: ReadPrec DescribeQueries # readListPrec :: ReadPrec [DescribeQueries] #
Show DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods showsPrec :: Int -> DescribeQueries -> ShowS # show :: DescribeQueries -> String # showList :: [DescribeQueries] -> ShowS #
Generic DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Associated Types type Rep DescribeQueries :: Type -> Type # Methods from :: DescribeQueries -> Rep DescribeQueries x # to :: Rep DescribeQueries x -> DescribeQueries #
NFData DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods rnf :: DescribeQueries -> () #
Hashable DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods hashWithSalt :: Int -> DescribeQueries -> Int # hash :: DescribeQueries -> Int #
ToJSON DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods toJSON :: DescribeQueries -> Value # toEncoding :: DescribeQueries -> Encoding # toJSONList :: [DescribeQueries] -> Value # toEncodingList :: [DescribeQueries] -> Encoding #
AWSPager DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods page :: DescribeQueries -> AWSResponse DescribeQueries -> Maybe DescribeQueries #
AWSRequest DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Associated Types type AWSResponse DescribeQueries # Methods request :: DescribeQueries -> Request DescribeQueries # response :: MonadResource m => Logger -> Service -> Proxy DescribeQueries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeQueries))) #
ToHeaders DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods toHeaders :: DescribeQueries -> [Header] #
ToPath DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods toPath :: DescribeQueries -> ByteString #
ToQuery DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods toQuery :: DescribeQueries -> QueryString #
type Rep DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries type Rep DescribeQueries = D1 ('MetaData "DescribeQueries" "Amazonka.CloudWatchLogs.DescribeQueries" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "DescribeQueries'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryStatus)) :: S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeQueries Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries type AWSResponse DescribeQueries = DescribeQueriesResponse

newDescribeQueries :: DescribeQueries Source #

Create a value of DescribeQueries 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:status:DescribeQueries', describeQueries_status - Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

$sel:logGroupName:DescribeQueries', describeQueries_logGroupName - Limits the returned queries to only those for the specified log group.

$sel:nextToken:DescribeQueries', describeQueries_nextToken - Undocumented member.

$sel:maxResults:DescribeQueries', describeQueries_maxResults - Limits the number of returned queries to the specified number.

Request Lenses

describeQueries_status :: Lens' DescribeQueries (Maybe QueryStatus) Source #

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

describeQueries_logGroupName :: Lens' DescribeQueries (Maybe Text) Source #

Limits the returned queries to only those for the specified log group.

describeQueries_nextToken :: Lens' DescribeQueries (Maybe Text) Source #

Undocumented member.

describeQueries_maxResults :: Lens' DescribeQueries (Maybe Natural) Source #

Limits the number of returned queries to the specified number.

Destructuring the Response

data DescribeQueriesResponse Source #

See: newDescribeQueriesResponse smart constructor.

Constructors

DescribeQueriesResponse'
Fields queries :: Maybe [QueryInfo] The list of queries that match the request. nextToken :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeQueriesResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods (==) :: DescribeQueriesResponse -> DescribeQueriesResponse -> Bool # (/=) :: DescribeQueriesResponse -> DescribeQueriesResponse -> Bool #
Read DescribeQueriesResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods readsPrec :: Int -> ReadS DescribeQueriesResponse # readList :: ReadS [DescribeQueriesResponse] # readPrec :: ReadPrec DescribeQueriesResponse # readListPrec :: ReadPrec [DescribeQueriesResponse] #
Show DescribeQueriesResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods showsPrec :: Int -> DescribeQueriesResponse -> ShowS # show :: DescribeQueriesResponse -> String # showList :: [DescribeQueriesResponse] -> ShowS #
Generic DescribeQueriesResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Associated Types type Rep DescribeQueriesResponse :: Type -> Type # Methods from :: DescribeQueriesResponse -> Rep DescribeQueriesResponse x # to :: Rep DescribeQueriesResponse x -> DescribeQueriesResponse #
NFData DescribeQueriesResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries Methods rnf :: DescribeQueriesResponse -> () #
type Rep DescribeQueriesResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeQueries type Rep DescribeQueriesResponse = D1 ('MetaData "DescribeQueriesResponse" "Amazonka.CloudWatchLogs.DescribeQueries" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "DescribeQueriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QueryInfo])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeQueriesResponse Source #

Arguments

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

Create a value of DescribeQueriesResponse 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:queries:DescribeQueriesResponse', describeQueriesResponse_queries - The list of queries that match the request.

$sel:nextToken:DescribeQueries', describeQueriesResponse_nextToken - Undocumented member.

$sel:httpStatus:DescribeQueriesResponse', describeQueriesResponse_httpStatus - The response's http status code.

Response Lenses

describeQueriesResponse_queries :: Lens' DescribeQueriesResponse (Maybe [QueryInfo]) Source #

The list of queries that match the request.

describeQueriesResponse_nextToken :: Lens' DescribeQueriesResponse (Maybe Text) Source #

Undocumented member.

describeQueriesResponse_httpStatus :: Lens' DescribeQueriesResponse Int Source #

The response's http status code.