Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RedshiftData.CancelStatement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels a running query. To be canceled, a query must be running.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Creating a Request

data CancelStatement Source #

See: newCancelStatement smart constructor.

Constructors

CancelStatement'
Fields id :: Text The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by `BatchExecuteStatment`, `ExecuteStatment`, and `ListStatements`.

Instances

Instances details

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

newCancelStatement Source #

Arguments

:: Text	`CancelStatement`
-> CancelStatement

Create a value of CancelStatement 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:

CancelStatement, cancelStatement_id - The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

Request Lenses

cancelStatement_id :: Lens' CancelStatement Text Source #

The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment, ExecuteStatment, and ListStatements.

Destructuring the Response

data CancelStatementResponse Source #

See: newCancelStatementResponse smart constructor.

Constructors

CancelStatementResponse'
Fields status :: Maybe Bool A value that indicates whether the cancel statement succeeded (true). httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CancelStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.CancelStatement Associated Types type Rep CancelStatementResponse :: Type -> Type # Methods from :: CancelStatementResponse -> Rep CancelStatementResponse x # to :: Rep CancelStatementResponse x -> CancelStatementResponse #
Read CancelStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.CancelStatement Methods readsPrec :: Int -> ReadS CancelStatementResponse # readList :: ReadS [CancelStatementResponse] # readPrec :: ReadPrec CancelStatementResponse # readListPrec :: ReadPrec [CancelStatementResponse] #
Show CancelStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.CancelStatement Methods showsPrec :: Int -> CancelStatementResponse -> ShowS # show :: CancelStatementResponse -> String # showList :: [CancelStatementResponse] -> ShowS #
NFData CancelStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.CancelStatement Methods rnf :: CancelStatementResponse -> () #
Eq CancelStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.CancelStatement Methods (==) :: CancelStatementResponse -> CancelStatementResponse -> Bool # (/=) :: CancelStatementResponse -> CancelStatementResponse -> Bool #
type Rep CancelStatementResponse Source #
Instance details Defined in Amazonka.RedshiftData.CancelStatement type Rep CancelStatementResponse = D1 ('MetaData "CancelStatementResponse" "Amazonka.RedshiftData.CancelStatement" "amazonka-redshift-data-2.0-Hy9KEgtH5Bc3altuyuPuYo" 'False) (C1 ('MetaCons "CancelStatementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelStatementResponse Source #

Arguments

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

Create a value of CancelStatementResponse 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:

CancelStatementResponse, cancelStatementResponse_status - A value that indicates whether the cancel statement succeeded (true).

$sel:httpStatus:CancelStatementResponse', cancelStatementResponse_httpStatus - The response's http status code.

Response Lenses

cancelStatementResponse_status :: Lens' CancelStatementResponse (Maybe Bool) Source #

A value that indicates whether the cancel statement succeeded (true).

cancelStatementResponse_httpStatus :: Lens' CancelStatementResponse Int Source #

The response's http status code.