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.FSx.CancelDataRepositoryTask

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel a task, Amazon FSx does the following.

Any files that FSx has already exported are not reverted.
FSx continues to export any files that are "in-flight" when the cancel operation is received.
FSx does not export any files that have not yet been exported.

Creating a Request

data CancelDataRepositoryTask Source #

Cancels a data repository task.

See: newCancelDataRepositoryTask smart constructor.

Constructors

CancelDataRepositoryTask'
Fields taskId :: Text Specifies the data repository task to cancel.

Instances

Instances details

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

newCancelDataRepositoryTask Source #

Arguments

:: Text	`CancelDataRepositoryTask`
-> CancelDataRepositoryTask

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

CancelDataRepositoryTask, cancelDataRepositoryTask_taskId - Specifies the data repository task to cancel.

Request Lenses

cancelDataRepositoryTask_taskId :: Lens' CancelDataRepositoryTask Text Source #

Specifies the data repository task to cancel.

Destructuring the Response

data CancelDataRepositoryTaskResponse Source #

See: newCancelDataRepositoryTaskResponse smart constructor.

Constructors

CancelDataRepositoryTaskResponse'

Fields

lifecycle :: Maybe DataRepositoryTaskLifecycle
The lifecycle status of the data repository task, as follows:
- PENDING - Amazon FSx has not started the task.
- EXECUTING - Amazon FSx is processing the task.
- FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
- SUCCEEDED - FSx completed the task successfully.
- CANCELED - Amazon FSx canceled the task and it did not complete.
- CANCELING - FSx is in process of canceling the task.
taskId :: Maybe Text
The ID of the task being canceled.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newCancelDataRepositoryTaskResponse Source #

Arguments

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

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

CancelDataRepositoryTaskResponse, cancelDataRepositoryTaskResponse_lifecycle - The lifecycle status of the data repository task, as follows:

PENDING - Amazon FSx has not started the task.
EXECUTING - Amazon FSx is processing the task.
FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
SUCCEEDED - FSx completed the task successfully.
CANCELED - Amazon FSx canceled the task and it did not complete.
CANCELING - FSx is in process of canceling the task.

CancelDataRepositoryTask, cancelDataRepositoryTaskResponse_taskId - The ID of the task being canceled.

$sel:httpStatus:CancelDataRepositoryTaskResponse', cancelDataRepositoryTaskResponse_httpStatus - The response's http status code.

Response Lenses

cancelDataRepositoryTaskResponse_lifecycle :: Lens' CancelDataRepositoryTaskResponse (Maybe DataRepositoryTaskLifecycle) Source #

The lifecycle status of the data repository task, as follows:

PENDING - Amazon FSx has not started the task.
EXECUTING - Amazon FSx is processing the task.
FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
SUCCEEDED - FSx completed the task successfully.
CANCELED - Amazon FSx canceled the task and it did not complete.
CANCELING - FSx is in process of canceling the task.

cancelDataRepositoryTaskResponse_taskId :: Lens' CancelDataRepositoryTaskResponse (Maybe Text) Source #

The ID of the task being canceled.

cancelDataRepositoryTaskResponse_httpStatus :: Lens' CancelDataRepositoryTaskResponse Int Source #

The response's http status code.