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.Types.DataRepositoryTask

Description

Synopsis

data DataRepositoryTask = DataRepositoryTask' {
- capacityToRelease :: Maybe Natural
- endTime :: Maybe POSIX
- failureDetails :: Maybe DataRepositoryTaskFailureDetails
- fileCacheId :: Maybe Text
- fileSystemId :: Maybe Text
- paths :: Maybe [Text]
- report :: Maybe CompletionReport
- resourceARN :: Maybe Text
- startTime :: Maybe POSIX
- status :: Maybe DataRepositoryTaskStatus
- tags :: Maybe (NonEmpty Tag)
- taskId :: Text
- lifecycle :: DataRepositoryTaskLifecycle
- type' :: DataRepositoryTaskType
- creationTime :: POSIX
}
newDataRepositoryTask :: Text -> DataRepositoryTaskLifecycle -> DataRepositoryTaskType -> UTCTime -> DataRepositoryTask
dataRepositoryTask_capacityToRelease :: Lens' DataRepositoryTask (Maybe Natural)
dataRepositoryTask_endTime :: Lens' DataRepositoryTask (Maybe UTCTime)
dataRepositoryTask_failureDetails :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskFailureDetails)
dataRepositoryTask_fileCacheId :: Lens' DataRepositoryTask (Maybe Text)
dataRepositoryTask_fileSystemId :: Lens' DataRepositoryTask (Maybe Text)
dataRepositoryTask_paths :: Lens' DataRepositoryTask (Maybe [Text])
dataRepositoryTask_report :: Lens' DataRepositoryTask (Maybe CompletionReport)
dataRepositoryTask_resourceARN :: Lens' DataRepositoryTask (Maybe Text)
dataRepositoryTask_startTime :: Lens' DataRepositoryTask (Maybe UTCTime)
dataRepositoryTask_status :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskStatus)
dataRepositoryTask_tags :: Lens' DataRepositoryTask (Maybe (NonEmpty Tag))
dataRepositoryTask_taskId :: Lens' DataRepositoryTask Text
dataRepositoryTask_lifecycle :: Lens' DataRepositoryTask DataRepositoryTaskLifecycle
dataRepositoryTask_type :: Lens' DataRepositoryTask DataRepositoryTaskType
dataRepositoryTask_creationTime :: Lens' DataRepositoryTask UTCTime

Documentation

data DataRepositoryTask Source #

A description of the data repository task. You use data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository. An Amazon File Cache resource uses a task to automatically release files from the cache.

See: newDataRepositoryTask smart constructor.

Constructors

DataRepositoryTask'

Fields

capacityToRelease :: Maybe Natural
Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
endTime :: Maybe POSIX
The time the system completed processing the task, populated after the task is complete.
failureDetails :: Maybe DataRepositoryTaskFailureDetails
Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.
fileCacheId :: Maybe Text
The system-generated, unique ID of the cache.
fileSystemId :: Maybe Text
The globally unique ID of the file system.
paths :: Maybe [Text]
An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
(Default) If Paths is not specified, Amazon FSx uses the file system root directory.
report :: Maybe CompletionReport
resourceARN :: Maybe Text
startTime :: Maybe POSIX
The time the system began processing the task.
status :: Maybe DataRepositoryTaskStatus
Provides the status of the number of files that the task has processed successfully and failed to process.
tags :: Maybe (NonEmpty Tag)
taskId :: Text
The system-generated, unique 17-digit ID of the data repository task.
lifecycle :: DataRepositoryTaskLifecycle
The lifecycle status of the data repository task, as follows:
- PENDING - The task has not started.
- EXECUTING - The task is in process.
- FAILED - The task was not able to be completed. For example, there may be files the task failed to process. The DataRepositoryTaskFailureDetails property provides more information about task failures.
- SUCCEEDED - The task has completed successfully.
- CANCELED - The task was canceled and it did not complete.
- CANCELING - The task is in process of being canceled.
You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the PENDING or EXECUTING states. Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.
type' :: DataRepositoryTaskType
The type of data repository task.
- EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.
- IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
- AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.
creationTime :: POSIX

Instances

Instances details

FromJSON DataRepositoryTask Source #
Instance details Defined in Amazonka.FSx.Types.DataRepositoryTask Methods parseJSON :: Value -> Parser DataRepositoryTask # parseJSONList :: Value -> Parser [DataRepositoryTask] #
Generic DataRepositoryTask Source #
Instance details Defined in Amazonka.FSx.Types.DataRepositoryTask Associated Types type Rep DataRepositoryTask :: Type -> Type # Methods from :: DataRepositoryTask -> Rep DataRepositoryTask x # to :: Rep DataRepositoryTask x -> DataRepositoryTask #
Read DataRepositoryTask Source #
Instance details Defined in Amazonka.FSx.Types.DataRepositoryTask Methods readsPrec :: Int -> ReadS DataRepositoryTask # readList :: ReadS [DataRepositoryTask] # readPrec :: ReadPrec DataRepositoryTask # readListPrec :: ReadPrec [DataRepositoryTask] #
Show DataRepositoryTask Source #
Instance details Defined in Amazonka.FSx.Types.DataRepositoryTask Methods showsPrec :: Int -> DataRepositoryTask -> ShowS # show :: DataRepositoryTask -> String # showList :: [DataRepositoryTask] -> ShowS #
NFData DataRepositoryTask Source #
Instance details Defined in Amazonka.FSx.Types.DataRepositoryTask Methods rnf :: DataRepositoryTask -> () #
Eq DataRepositoryTask Source #
Instance details Defined in Amazonka.FSx.Types.DataRepositoryTask Methods (==) :: DataRepositoryTask -> DataRepositoryTask -> Bool # (/=) :: DataRepositoryTask -> DataRepositoryTask -> Bool #
Hashable DataRepositoryTask Source #
Instance details Defined in Amazonka.FSx.Types.DataRepositoryTask Methods hashWithSalt :: Int -> DataRepositoryTask -> Int # hash :: DataRepositoryTask -> Int #
type Rep DataRepositoryTask Source #
Instance details Defined in Amazonka.FSx.Types.DataRepositoryTask type Rep DataRepositoryTask = D1 ('MetaData "DataRepositoryTask" "Amazonka.FSx.Types.DataRepositoryTask" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DataRepositoryTask'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "capacityToRelease") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "failureDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataRepositoryTaskFailureDetails)))) :: ((S1 ('MetaSel ('Just "fileCacheId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "fileSystemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "paths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "report") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CompletionReport))))) :: (((S1 ('MetaSel ('Just "resourceARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataRepositoryTaskStatus)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))))) :: ((S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataRepositoryTaskLifecycle)) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataRepositoryTaskType) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newDataRepositoryTask Source #

Arguments

:: Text	`$sel:taskId:DataRepositoryTask'`
-> DataRepositoryTaskLifecycle	`$sel:lifecycle:DataRepositoryTask'`
-> DataRepositoryTaskType	`$sel:type':DataRepositoryTask'`
-> UTCTime	`$sel:creationTime:DataRepositoryTask'`
-> DataRepositoryTask

Create a value of DataRepositoryTask 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:capacityToRelease:DataRepositoryTask', dataRepositoryTask_capacityToRelease - Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

$sel:endTime:DataRepositoryTask', dataRepositoryTask_endTime - The time the system completed processing the task, populated after the task is complete.

$sel:failureDetails:DataRepositoryTask', dataRepositoryTask_failureDetails - Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

$sel:fileCacheId:DataRepositoryTask', dataRepositoryTask_fileCacheId - The system-generated, unique ID of the cache.

$sel:fileSystemId:DataRepositoryTask', dataRepositoryTask_fileSystemId - The globally unique ID of the file system.

$sel:paths:DataRepositoryTask', dataRepositoryTask_paths - An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.

(Default) If Paths is not specified, Amazon FSx uses the file system root directory.

$sel:report:DataRepositoryTask', dataRepositoryTask_report - Undocumented member.

$sel:resourceARN:DataRepositoryTask', dataRepositoryTask_resourceARN - Undocumented member.

$sel:startTime:DataRepositoryTask', dataRepositoryTask_startTime - The time the system began processing the task.

$sel:status:DataRepositoryTask', dataRepositoryTask_status - Provides the status of the number of files that the task has processed successfully and failed to process.

$sel:tags:DataRepositoryTask', dataRepositoryTask_tags - Undocumented member.

$sel:taskId:DataRepositoryTask', dataRepositoryTask_taskId - The system-generated, unique 17-digit ID of the data repository task.

$sel:lifecycle:DataRepositoryTask', dataRepositoryTask_lifecycle - The lifecycle status of the data repository task, as follows:

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

You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the PENDING or EXECUTING states. Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.

$sel:type':DataRepositoryTask', dataRepositoryTask_type - The type of data repository task.

EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.
IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

$sel:creationTime:DataRepositoryTask', dataRepositoryTask_creationTime - Undocumented member.

dataRepositoryTask_capacityToRelease :: Lens' DataRepositoryTask (Maybe Natural) Source #

Specifies the amount of data to release, in GiB, by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.

dataRepositoryTask_endTime :: Lens' DataRepositoryTask (Maybe UTCTime) Source #

The time the system completed processing the task, populated after the task is complete.

dataRepositoryTask_failureDetails :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskFailureDetails) Source #

Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED.

dataRepositoryTask_fileCacheId :: Lens' DataRepositoryTask (Maybe Text) Source #

The system-generated, unique ID of the cache.

dataRepositoryTask_fileSystemId :: Lens' DataRepositoryTask (Maybe Text) Source #

The globally unique ID of the file system.

dataRepositoryTask_paths :: Lens' DataRepositoryTask (Maybe [Text]) Source #

An array of paths that specify the data for the data repository task to process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.

(Default) If Paths is not specified, Amazon FSx uses the file system root directory.

dataRepositoryTask_report :: Lens' DataRepositoryTask (Maybe CompletionReport) Source #

Undocumented member.

dataRepositoryTask_resourceARN :: Lens' DataRepositoryTask (Maybe Text) Source #

Undocumented member.

dataRepositoryTask_startTime :: Lens' DataRepositoryTask (Maybe UTCTime) Source #

The time the system began processing the task.

dataRepositoryTask_status :: Lens' DataRepositoryTask (Maybe DataRepositoryTaskStatus) Source #

Provides the status of the number of files that the task has processed successfully and failed to process.

dataRepositoryTask_tags :: Lens' DataRepositoryTask (Maybe (NonEmpty Tag)) Source #

Undocumented member.

dataRepositoryTask_taskId :: Lens' DataRepositoryTask Text Source #

The system-generated, unique 17-digit ID of the data repository task.

dataRepositoryTask_lifecycle :: Lens' DataRepositoryTask DataRepositoryTaskLifecycle Source #

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

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

You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the PENDING or EXECUTING states. Please retry when the data repository task is finished (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.

dataRepositoryTask_type :: Lens' DataRepositoryTask DataRepositoryTaskType Source #

The type of data repository task.

EXPORT_TO_REPOSITORY tasks export from your Amazon FSx for Lustre file system to a linked data repository.
IMPORT_METADATA_FROM_REPOSITORY tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
AUTO_RELEASE_DATA tasks automatically release files from an Amazon File Cache resource.

dataRepositoryTask_creationTime :: Lens' DataRepositoryTask UTCTime Source #

Undocumented member.