Amazonka.CloudWatchLogs.StopQuery

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.

Creating a Request

data StopQuery

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

ToJSON StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

toJSON :: StopQuery -> Value

toEncoding :: StopQuery -> Encoding

toJSONList :: [StopQuery] -> Value

toEncodingList :: [StopQuery] -> Encoding

ToHeaders StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

toHeaders :: StopQuery -> [Header]

ToPath StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

toPath :: StopQuery -> ByteString

ToQuery StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

toQuery :: StopQuery -> QueryString

AWSRequest StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Associated Types

type AWSResponse StopQuery

Methods

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

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

Generic StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Associated Types

type Rep StopQuery :: Type -> Type

Methods

from :: StopQuery -> Rep StopQuery x

to :: Rep StopQuery x -> StopQuery

Read StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

readsPrec :: Int -> ReadS StopQuery

readList :: ReadS [StopQuery]

readPrec :: ReadPrec StopQuery

readListPrec :: ReadPrec [StopQuery]

Show StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

showsPrec :: Int -> StopQuery -> ShowS

show :: StopQuery -> String

showList :: [StopQuery] -> ShowS

NFData StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

rnf :: StopQuery -> ()

Eq StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

(==) :: StopQuery -> StopQuery -> Bool

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

Hashable StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

hashWithSalt :: Int -> StopQuery -> Int

hash :: StopQuery -> Int

type AWSResponse StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

type AWSResponse StopQuery = StopQueryResponse

type Rep StopQuery

Defined in Amazonka.CloudWatchLogs.StopQuery

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

newStopQuery

Arguments

:: Text

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:

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

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

Destructuring the Response

data StopQueryResponse

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

Generic StopQueryResponse

Defined in Amazonka.CloudWatchLogs.StopQuery

Associated Types

type Rep StopQueryResponse :: Type -> Type

Methods

from :: StopQueryResponse -> Rep StopQueryResponse x

to :: Rep StopQueryResponse x -> StopQueryResponse

Read StopQueryResponse

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

readsPrec :: Int -> ReadS StopQueryResponse

readList :: ReadS [StopQueryResponse]

readPrec :: ReadPrec StopQueryResponse

readListPrec :: ReadPrec [StopQueryResponse]

Show StopQueryResponse

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

showsPrec :: Int -> StopQueryResponse -> ShowS

show :: StopQueryResponse -> String

showList :: [StopQueryResponse] -> ShowS

NFData StopQueryResponse

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

rnf :: StopQueryResponse -> ()

Eq StopQueryResponse

Defined in Amazonka.CloudWatchLogs.StopQuery

Methods

(==) :: StopQueryResponse -> StopQueryResponse -> Bool

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

type Rep StopQueryResponse

Defined in Amazonka.CloudWatchLogs.StopQuery

type Rep StopQueryResponse = D1 ('MetaData "StopQueryResponse" "Amazonka.CloudWatchLogs.StopQuery" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" '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

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)

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

stopQueryResponse_httpStatus :: Lens' StopQueryResponse Int

The response's http status code.