| 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.CreateDataRepositoryTask
Description
Creates an Amazon FSx for Lustre data repository task. You use data
repository tasks to perform bulk operations between your Amazon FSx file
system and its linked data repositories. An example of a data repository
task is exporting any data and metadata changes, including POSIX
metadata, to files, directories, and symbolic links (symlinks) from your
FSx file system to a linked data repository. A
CreateDataRepositoryTask operation will fail if a data repository is
not linked to the FSx file system. To learn more about data repository
tasks, see
Data Repository Tasks.
To learn more about linking a data repository to your file system, see
Linking your file system to an S3 bucket.
Synopsis
- data CreateDataRepositoryTask = CreateDataRepositoryTask' {}
- newCreateDataRepositoryTask :: DataRepositoryTaskType -> Text -> CompletionReport -> CreateDataRepositoryTask
- createDataRepositoryTask_capacityToRelease :: Lens' CreateDataRepositoryTask (Maybe Natural)
- createDataRepositoryTask_clientRequestToken :: Lens' CreateDataRepositoryTask (Maybe Text)
- createDataRepositoryTask_paths :: Lens' CreateDataRepositoryTask (Maybe [Text])
- createDataRepositoryTask_tags :: Lens' CreateDataRepositoryTask (Maybe (NonEmpty Tag))
- createDataRepositoryTask_type :: Lens' CreateDataRepositoryTask DataRepositoryTaskType
- createDataRepositoryTask_fileSystemId :: Lens' CreateDataRepositoryTask Text
- createDataRepositoryTask_report :: Lens' CreateDataRepositoryTask CompletionReport
- data CreateDataRepositoryTaskResponse = CreateDataRepositoryTaskResponse' {}
- newCreateDataRepositoryTaskResponse :: Int -> CreateDataRepositoryTaskResponse
- createDataRepositoryTaskResponse_dataRepositoryTask :: Lens' CreateDataRepositoryTaskResponse (Maybe DataRepositoryTask)
- createDataRepositoryTaskResponse_httpStatus :: Lens' CreateDataRepositoryTaskResponse Int
Creating a Request
data CreateDataRepositoryTask Source #
See: newCreateDataRepositoryTask smart constructor.
Constructors
| CreateDataRepositoryTask' | |
Fields
| |
Instances
newCreateDataRepositoryTask Source #
Arguments
| :: DataRepositoryTaskType | |
| -> Text | |
| -> CompletionReport | |
| -> CreateDataRepositoryTask |
Create a value of CreateDataRepositoryTask 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:
CreateDataRepositoryTask, createDataRepositoryTask_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:clientRequestToken:CreateDataRepositoryTask', createDataRepositoryTask_clientRequestToken - Undocumented member.
CreateDataRepositoryTask, createDataRepositoryTask_paths - A list of paths for the data repository task to use when the task is
processed. If a path that you provide isn't valid, the task fails.
- For export tasks, the list contains paths on the Amazon FSx file
system from which the files are exported to the Amazon S3 bucket.
The default path is the file system root directory. The paths you
provide need to be relative to the mount point of the file system.
If the mount point is
/mnt/fsxand/mnt/fsx/path1is a directory or file on the file system you want to export, then the path to provide ispath1. - For import tasks, the list contains paths in the Amazon S3 bucket
from which POSIX metadata changes are imported to the Amazon FSx
file system. The path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix(wheremyPrefixis optional).
CreateDataRepositoryTask, createDataRepositoryTask_tags - Undocumented member.
CreateDataRepositoryTask, createDataRepositoryTask_type - Specifies the type of data repository task to create.
CreateDataRepositoryTask, createDataRepositoryTask_fileSystemId - Undocumented member.
CreateDataRepositoryTask, createDataRepositoryTask_report - Defines whether or not Amazon FSx provides a CompletionReport once the
task has completed. A CompletionReport provides a detailed report on the
files that Amazon FSx processed that meet the criteria specified by the
Scope parameter. For more information, see
Working with Task Completion Reports.
Request Lenses
createDataRepositoryTask_capacityToRelease :: Lens' CreateDataRepositoryTask (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.
createDataRepositoryTask_clientRequestToken :: Lens' CreateDataRepositoryTask (Maybe Text) Source #
Undocumented member.
createDataRepositoryTask_paths :: Lens' CreateDataRepositoryTask (Maybe [Text]) Source #
A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails.
- For export tasks, the list contains paths on the Amazon FSx file
system from which the files are exported to the Amazon S3 bucket.
The default path is the file system root directory. The paths you
provide need to be relative to the mount point of the file system.
If the mount point is
/mnt/fsxand/mnt/fsx/path1is a directory or file on the file system you want to export, then the path to provide ispath1. - For import tasks, the list contains paths in the Amazon S3 bucket
from which POSIX metadata changes are imported to the Amazon FSx
file system. The path can be an S3 bucket or prefix in the format
s3://myBucket/myPrefix(wheremyPrefixis optional).
createDataRepositoryTask_tags :: Lens' CreateDataRepositoryTask (Maybe (NonEmpty Tag)) Source #
Undocumented member.
createDataRepositoryTask_type :: Lens' CreateDataRepositoryTask DataRepositoryTaskType Source #
Specifies the type of data repository task to create.
createDataRepositoryTask_fileSystemId :: Lens' CreateDataRepositoryTask Text Source #
Undocumented member.
createDataRepositoryTask_report :: Lens' CreateDataRepositoryTask CompletionReport Source #
Defines whether or not Amazon FSx provides a CompletionReport once the
task has completed. A CompletionReport provides a detailed report on the
files that Amazon FSx processed that meet the criteria specified by the
Scope parameter. For more information, see
Working with Task Completion Reports.
Destructuring the Response
data CreateDataRepositoryTaskResponse Source #
See: newCreateDataRepositoryTaskResponse smart constructor.
Constructors
| CreateDataRepositoryTaskResponse' | |
Fields
| |
Instances
newCreateDataRepositoryTaskResponse Source #
Create a value of CreateDataRepositoryTaskResponse 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:dataRepositoryTask:CreateDataRepositoryTaskResponse', createDataRepositoryTaskResponse_dataRepositoryTask - The description of the data repository task that you just created.
$sel:httpStatus:CreateDataRepositoryTaskResponse', createDataRepositoryTaskResponse_httpStatus - The response's http status code.
Response Lenses
createDataRepositoryTaskResponse_dataRepositoryTask :: Lens' CreateDataRepositoryTaskResponse (Maybe DataRepositoryTask) Source #
The description of the data repository task that you just created.
createDataRepositoryTaskResponse_httpStatus :: Lens' CreateDataRepositoryTaskResponse Int Source #
The response's http status code.