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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

Synopsis

data StopQuery = StopQuery' {
- queryId :: Text
}
newStopQuery :: Text -> StopQuery
stopQuery_queryId :: Lens' StopQuery Text
data StopQueryResponse = StopQueryResponse' {
- success :: Maybe Bool
- httpStatus :: Int
}
newStopQueryResponse :: Int -> StopQueryResponse
stopQueryResponse_success :: Lens' StopQueryResponse (Maybe Bool)
stopQueryResponse_httpStatus :: Lens' StopQueryResponse Int

Creating a Request

data StopQuery Source #

See: newStopQuery smart constructor.

Constructors

StopQuery'
Fields queryId :: Text The ID number of the query to stop. To find this ID number, use `DescribeQueries`.

Instances

Instances details

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

newStopQuery Source #

Arguments

:: Text	`$sel:queryId:StopQuery'`
-> StopQuery

Create a value of StopQuery 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:queryId:StopQuery', stopQuery_queryId - The ID number of the query to stop. To find this ID number, use DescribeQueries.

Request Lenses

stopQuery_queryId :: Lens' StopQuery Text Source #

The ID number of the query to stop. To find this ID number, use DescribeQueries.

Destructuring the Response

data StopQueryResponse Source #

See: newStopQueryResponse smart constructor.

Constructors

StopQueryResponse'
Fields success :: Maybe Bool This is true if the query was stopped by the `StopQuery` operation. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStopQueryResponse Source #

Arguments

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

Create a value of StopQueryResponse 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:success:StopQueryResponse', stopQueryResponse_success - This is true if the query was stopped by the StopQuery operation.

$sel:httpStatus:StopQueryResponse', stopQueryResponse_httpStatus - The response's http status code.

Response Lenses

stopQueryResponse_success :: Lens' StopQueryResponse (Maybe Bool) Source #

This is true if the query was stopped by the StopQuery operation.

stopQueryResponse_httpStatus :: Lens' StopQueryResponse Int Source #

The response's http status code.