Amazonka.TimeStreamQuery.CancelQuery

Cancels a query that has been issued. Cancellation is provided only if the query has not completed running before the cancellation request was issued. Because cancellation is an idempotent operation, subsequent cancellation requests will return a CancellationMessage, indicating that the query has already been canceled. See code sample for details.

Creating a Request

data CancelQuery

See: newCancelQuery smart constructor.

Constructors

CancelQuery'

Fields

• queryId :: Text

  The ID of the query that needs to be cancelled. QueryID is returned as part of the query result.

Instances

ToJSON CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

toJSON :: CancelQuery -> Value

toEncoding :: CancelQuery -> Encoding

toJSONList :: [CancelQuery] -> Value

toEncodingList :: [CancelQuery] -> Encoding

ToHeaders CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

toHeaders :: CancelQuery -> [Header]

ToPath CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

toPath :: CancelQuery -> ByteString

ToQuery CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

toQuery :: CancelQuery -> QueryString

AWSRequest CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Associated Types

type AWSResponse CancelQuery

Methods

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

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

Generic CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Associated Types

type Rep CancelQuery :: Type -> Type

Methods

from :: CancelQuery -> Rep CancelQuery x

to :: Rep CancelQuery x -> CancelQuery

Read CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

readsPrec :: Int -> ReadS CancelQuery

readList :: ReadS [CancelQuery]

readPrec :: ReadPrec CancelQuery

readListPrec :: ReadPrec [CancelQuery]

Show CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

showsPrec :: Int -> CancelQuery -> ShowS

show :: CancelQuery -> String

showList :: [CancelQuery] -> ShowS

NFData CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

rnf :: CancelQuery -> ()

Eq CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

(==) :: CancelQuery -> CancelQuery -> Bool

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

Hashable CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

hashWithSalt :: Int -> CancelQuery -> Int

hash :: CancelQuery -> Int

type AWSResponse CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

type AWSResponse CancelQuery = CancelQueryResponse

type Rep CancelQuery

Defined in Amazonka.TimeStreamQuery.CancelQuery

type Rep CancelQuery = D1 ('MetaData "CancelQuery" "Amazonka.TimeStreamQuery.CancelQuery" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "CancelQuery'" 'PrefixI 'True) (S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelQuery

Arguments

:: Text

$sel:queryId:CancelQuery'

-> CancelQuery

Create a value of CancelQuery 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:CancelQuery', cancelQuery_queryId - The ID of the query that needs to be cancelled. QueryID is returned as part of the query result.

Request Lenses

cancelQuery_queryId :: Lens' CancelQuery Text

The ID of the query that needs to be cancelled. QueryID is returned as part of the query result.

Destructuring the Response

data CancelQueryResponse

See: newCancelQueryResponse smart constructor.

Constructors

CancelQueryResponse'

Fields

• cancellationMessage :: Maybe Text

  A CancellationMessage is returned when a CancelQuery request for the query specified by QueryId has already been issued.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CancelQueryResponse

Defined in Amazonka.TimeStreamQuery.CancelQuery

Associated Types

type Rep CancelQueryResponse :: Type -> Type

Methods

from :: CancelQueryResponse -> Rep CancelQueryResponse x

to :: Rep CancelQueryResponse x -> CancelQueryResponse

Read CancelQueryResponse

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

readsPrec :: Int -> ReadS CancelQueryResponse

readList :: ReadS [CancelQueryResponse]

readPrec :: ReadPrec CancelQueryResponse

readListPrec :: ReadPrec [CancelQueryResponse]

Show CancelQueryResponse

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

showsPrec :: Int -> CancelQueryResponse -> ShowS

show :: CancelQueryResponse -> String

showList :: [CancelQueryResponse] -> ShowS

NFData CancelQueryResponse

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

rnf :: CancelQueryResponse -> ()

Eq CancelQueryResponse

Defined in Amazonka.TimeStreamQuery.CancelQuery

Methods

(==) :: CancelQueryResponse -> CancelQueryResponse -> Bool

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

type Rep CancelQueryResponse

Defined in Amazonka.TimeStreamQuery.CancelQuery

type Rep CancelQueryResponse = D1 ('MetaData "CancelQueryResponse" "Amazonka.TimeStreamQuery.CancelQuery" "amazonka-timestream-query-2.0-HD7xx47Lw3eG6c52GyReXL" 'False) (C1 ('MetaCons "CancelQueryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cancellationMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelQueryResponse

Arguments

:: Int

$sel:httpStatus:CancelQueryResponse'

-> CancelQueryResponse

Create a value of CancelQueryResponse 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:cancellationMessage:CancelQueryResponse', cancelQueryResponse_cancellationMessage - A CancellationMessage is returned when a CancelQuery request for the query specified by QueryId has already been issued.

$sel:httpStatus:CancelQueryResponse', cancelQueryResponse_httpStatus - The response's http status code.

Response Lenses

cancelQueryResponse_cancellationMessage :: Lens' CancelQueryResponse (Maybe Text)

A CancellationMessage is returned when a CancelQuery request for the query specified by QueryId has already been issued.

cancelQueryResponse_httpStatus :: Lens' CancelQueryResponse Int

The response's http status code.