Amazonka.CloudWatchLogs.DescribeQueries

Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run 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.

Creating a Request

data DescribeQueries

See: newDescribeQueries smart constructor.

Constructors

DescribeQueries'

Fields

• logGroupName :: Maybe Text

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

• maxResults :: Maybe Natural

  Limits the number of returned queries to the specified number.

• nextToken :: Maybe Text
• status :: Maybe QueryStatus

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

Instances

ToJSON DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

toJSON :: DescribeQueries -> Value

toEncoding :: DescribeQueries -> Encoding

toJSONList :: [DescribeQueries] -> Value

toEncodingList :: [DescribeQueries] -> Encoding

ToHeaders DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

toHeaders :: DescribeQueries -> [Header]

ToPath DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

toPath :: DescribeQueries -> ByteString

ToQuery DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

toQuery :: DescribeQueries -> QueryString

AWSPager DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

page :: DescribeQueries -> AWSResponse DescribeQueries -> Maybe DescribeQueries

AWSRequest DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Associated Types

type AWSResponse DescribeQueries

Methods

request :: (Service -> Service) -> DescribeQueries -> Request DescribeQueries

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeQueries -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeQueries)))

Generic DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Associated Types

type Rep DescribeQueries :: Type -> Type

Methods

from :: DescribeQueries -> Rep DescribeQueries x

to :: Rep DescribeQueries x -> DescribeQueries

Read DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

readsPrec :: Int -> ReadS DescribeQueries

readList :: ReadS [DescribeQueries]

readPrec :: ReadPrec DescribeQueries

readListPrec :: ReadPrec [DescribeQueries]

Show DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

showsPrec :: Int -> DescribeQueries -> ShowS

show :: DescribeQueries -> String

showList :: [DescribeQueries] -> ShowS

NFData DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

rnf :: DescribeQueries -> ()

Eq DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

(==) :: DescribeQueries -> DescribeQueries -> Bool

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

Hashable DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

hashWithSalt :: Int -> DescribeQueries -> Int

hash :: DescribeQueries -> Int

type AWSResponse DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

type AWSResponse DescribeQueries = DescribeQueriesResponse

type Rep DescribeQueries

Defined in Amazonka.CloudWatchLogs.DescribeQueries

type Rep DescribeQueries = D1 ('MetaData "DescribeQueries" "Amazonka.CloudWatchLogs.DescribeQueries" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "DescribeQueries'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "logGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryStatus)))))

newDescribeQueries :: DescribeQueries

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:

DescribeQueries, describeQueries_logGroupName - Limits the returned queries to only those for the specified log group.

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

DescribeQueries, describeQueries_nextToken - Undocumented member.

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

Request Lenses

describeQueries_logGroupName :: Lens' DescribeQueries (Maybe Text)

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

describeQueries_maxResults :: Lens' DescribeQueries (Maybe Natural)

Limits the number of returned queries to the specified number.

describeQueries_nextToken :: Lens' DescribeQueries (Maybe Text)

Undocumented member.

describeQueries_status :: Lens' DescribeQueries (Maybe QueryStatus)

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

Destructuring the Response

data DescribeQueriesResponse

See: newDescribeQueriesResponse smart constructor.

Constructors

DescribeQueriesResponse'

Fields

• nextToken :: Maybe Text
• queries :: Maybe [QueryInfo]

  The list of queries that match the request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeQueriesResponse

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Associated Types

type Rep DescribeQueriesResponse :: Type -> Type

Methods

from :: DescribeQueriesResponse -> Rep DescribeQueriesResponse x

to :: Rep DescribeQueriesResponse x -> DescribeQueriesResponse

Read DescribeQueriesResponse

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

readsPrec :: Int -> ReadS DescribeQueriesResponse

readList :: ReadS [DescribeQueriesResponse]

readPrec :: ReadPrec DescribeQueriesResponse

readListPrec :: ReadPrec [DescribeQueriesResponse]

Show DescribeQueriesResponse

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

showsPrec :: Int -> DescribeQueriesResponse -> ShowS

show :: DescribeQueriesResponse -> String

showList :: [DescribeQueriesResponse] -> ShowS

NFData DescribeQueriesResponse

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

rnf :: DescribeQueriesResponse -> ()

Eq DescribeQueriesResponse

Defined in Amazonka.CloudWatchLogs.DescribeQueries

Methods

(==) :: DescribeQueriesResponse -> DescribeQueriesResponse -> Bool

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

type Rep DescribeQueriesResponse

Defined in Amazonka.CloudWatchLogs.DescribeQueries

type Rep DescribeQueriesResponse = D1 ('MetaData "DescribeQueriesResponse" "Amazonka.CloudWatchLogs.DescribeQueries" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "DescribeQueriesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "queries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [QueryInfo])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeQueriesResponse

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:

DescribeQueries, describeQueriesResponse_nextToken - Undocumented member.

$sel:queries:DescribeQueriesResponse', describeQueriesResponse_queries - The list of queries that match the request.

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

Response Lenses

describeQueriesResponse_nextToken :: Lens' DescribeQueriesResponse (Maybe Text)

Undocumented member.

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

The list of queries that match the request.

describeQueriesResponse_httpStatus :: Lens' DescribeQueriesResponse Int

The response's http status code.