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.SnowDeviceManagement.CancelTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled.

A task might still run if it's processed from the queue before the CancelTask operation changes the task's state.

Synopsis

data CancelTask = CancelTask' {
- taskId :: Text
}
newCancelTask :: Text -> CancelTask
cancelTask_taskId :: Lens' CancelTask Text
data CancelTaskResponse = CancelTaskResponse' {
- taskId :: Maybe Text
- httpStatus :: Int
}
newCancelTaskResponse :: Int -> CancelTaskResponse
cancelTaskResponse_taskId :: Lens' CancelTaskResponse (Maybe Text)
cancelTaskResponse_httpStatus :: Lens' CancelTaskResponse Int

Creating a Request

data CancelTask Source #

See: newCancelTask smart constructor.

Constructors

CancelTask'
Fields taskId :: Text The ID of the task that you are attempting to cancel. You can retrieve a task ID by using the `ListTasks` operation.

Instances

Instances details

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

newCancelTask Source #

Arguments

:: Text	`CancelTask`
-> CancelTask

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

CancelTask, cancelTask_taskId - The ID of the task that you are attempting to cancel. You can retrieve a task ID by using the ListTasks operation.

Request Lenses

cancelTask_taskId :: Lens' CancelTask Text Source #

The ID of the task that you are attempting to cancel. You can retrieve a task ID by using the ListTasks operation.

Destructuring the Response

data CancelTaskResponse Source #

See: newCancelTaskResponse smart constructor.

Constructors

CancelTaskResponse'
Fields taskId :: Maybe Text The ID of the task that you are attempting to cancel. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCancelTaskResponse Source #

Arguments

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

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

CancelTask, cancelTaskResponse_taskId - The ID of the task that you are attempting to cancel.

$sel:httpStatus:CancelTaskResponse', cancelTaskResponse_httpStatus - The response's http status code.

Response Lenses

cancelTaskResponse_taskId :: Lens' CancelTaskResponse (Maybe Text) Source #

The ID of the task that you are attempting to cancel.

cancelTaskResponse_httpStatus :: Lens' CancelTaskResponse Int Source #

The response's http status code.