AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask
operation will fail if a data repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your FSx for Lustre 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.
You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre 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 .
See also: AWS API Documentation
create-data-repository-task
--type <value>
[--paths <value>]
--file-system-id <value>
--report <value>
[--client-request-token <value>]
[--tags <value>]
[--capacity-to-release <value>]
[--release-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--type
(string)
Specifies the type of data repository task to create.
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.RELEASE_DATA_FROM_FILESYSTEM
tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.Possible values:
EXPORT_TO_REPOSITORY
IMPORT_METADATA_FROM_REPOSITORY
RELEASE_DATA_FROM_FILESYSTEM
AUTO_RELEASE_DATA
--paths
(list)
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. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks).
- For export tasks, the list contains paths on the FSx for Lustre 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/fsx
and/mnt/fsx/path1
is 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 FSx for Lustre file system. The path can be an S3 bucket or prefix in the format
s3://bucket-name/prefix
(whereprefix
is optional).- For release tasks, the list contains directory or file paths on the FSx for Lustre file system from which to release exported files. If a directory is specified, files within the directory are released. If a file path is specified, only that file is released. To release all exported files in the file system, specify a forward slash (/) as the path.
Note
A file must also meet the last accessed time criteria specified in for the file to be released.(string)
Syntax:
"string" "string" ...
--file-system-id
(string)
The globally unique ID of the file system, assigned by Amazon FSx.
--report
(structure)
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 .Enabled -> (boolean)
SetEnabled
toTrue
to generate aCompletionReport
when the task completes. If set totrue
, then you need to provide a reportScope
,Path
, andFormat
. SetEnabled
toFalse
if you do not want aCompletionReport
generated when the task completes.Path -> (string)
Required ifEnabled
is set totrue
. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. ThePath
you provide must be located within the file system’s ExportPath. An examplePath
value is "s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.Format -> (string)
Required ifEnabled
is set totrue
. Specifies the format of theCompletionReport
.REPORT_CSV_20191124
is the only format currently supported. WhenFormat
is set toREPORT_CSV_20191124
, theCompletionReport
is provided in CSV format, and is delivered to{path}/task-{id}/failures.csv
.Scope -> (string)
Required ifEnabled
is set totrue
. Specifies the scope of theCompletionReport
;FAILED_FILES_ONLY
is the only scope currently supported. WhenScope
is set toFAILED_FILES_ONLY
, theCompletionReport
only contains information about files that the data repository task failed to process.
Shorthand Syntax:
Enabled=boolean,Path=string,Format=string,Scope=string
JSON Syntax:
{
"Enabled": true|false,
"Path": "string",
"Format": "REPORT_CSV_20191124",
"Scope": "FAILED_FILES_ONLY"
}
--client-request-token
(string)
(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
--tags
(list)
A list of
Tag
values, with a maximum of 50 elements.(structure)
Specifies a key-value pair for a resource tag.
Key -> (string)
A value that specifies theTagKey
, the name of the tag. Tag keys must be unique for the resource to which they are attached.Value -> (string)
A value that specifies theTagValue
, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set offinances : April
and also ofpayroll : April
.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--capacity-to-release
(long)
Specifies the amount of data to release, in GiB, by an Amazon File CacheAUTO_RELEASE_DATA
task that automatically releases files from the cache.
--release-configuration
(structure)
The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.
DurationSinceLastAccess -> (structure)
Defines the point-in-time since an exported file was last accessed, in order for that file to be eligible for release. Only files that were last accessed before this point-in-time are eligible to be released from the file system.
Unit -> (string)
The unit of time used by theValue
parameter to determine if a file can be released, based on when it was last accessed.DAYS
is the only supported value. This is a required parameter.Value -> (long)
An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported files with a
MAX(atime, ctime, mtime)
timestamp that is more than this amount of time in the past (relative to the task create time) will be released. The default ofValue
is0
. This is a required parameter.Note
If an exported file meets the last accessed time criteria, its file or directory path must also be specified in thePaths
parameter of the operation in order for the file to be released.
Shorthand Syntax:
DurationSinceLastAccess={Unit=string,Value=long}
JSON Syntax:
{
"DurationSinceLastAccess": {
"Unit": "DAYS",
"Value": long
}
}
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
DataRepositoryTask -> (structure)
The description of the data repository task that you just created.
TaskId -> (string)
The system-generated, unique 17-digit ID of the data repository task.Lifecycle -> (string)
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.Note
You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in thePENDING
orEXECUTING
states. Please retry when the data repository task is finished (with a status ofCANCELED
,SUCCEEDED
, orFAILED
). 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 -> (string)
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.RELEASE_DATA_FROM_FILESYSTEM
tasks release files in your Amazon FSx for Lustre file system that have been exported to a linked S3 bucket and that meet your specified release criteria.AUTO_RELEASE_DATA
tasks automatically release files from an Amazon File Cache resource.CreationTime -> (timestamp)
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.StartTime -> (timestamp)
The time the system began processing the task.EndTime -> (timestamp)
The time the system completed processing the task, populated after the task is complete.ResourceARN -> (string)
The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .Tags -> (list)
A list of
Tag
values, with a maximum of 50 elements.(structure)
Specifies a key-value pair for a resource tag.
Key -> (string)
A value that specifies theTagKey
, the name of the tag. Tag keys must be unique for the resource to which they are attached.Value -> (string)
A value that specifies theTagValue
, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set offinances : April
and also ofpayroll : April
.FileSystemId -> (string)
The globally unique ID of the file system.Paths -> (list)
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.(string)
FailureDetails -> (structure)
Failure message describing why the task failed, it is populated only when
Lifecycle
is set toFAILED
.Message -> (string)
A detailed error message.Status -> (structure)
Provides the status of the number of files that the task has processed successfully and failed to process.
TotalCount -> (long)
The total number of files that the task will process. While a task is executing, the sum ofSucceededCount
plusFailedCount
may not equalTotalCount
. When the task is complete,TotalCount
equals the sum ofSucceededCount
plusFailedCount
.SucceededCount -> (long)
A running total of the number of files that the task has successfully processed.FailedCount -> (long)
A running total of the number of files that the task failed to process.LastUpdatedTime -> (timestamp)
The time at which the task status was last updated.ReleasedCapacity -> (long)
The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.Report -> (structure)
Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report
Scope
parameter. FSx delivers the report to the file system's linked data repository in Amazon S3, using the path specified in the reportPath
parameter. You can specify whether or not a report gets generated for a task using theEnabled
parameter.Enabled -> (boolean)
SetEnabled
toTrue
to generate aCompletionReport
when the task completes. If set totrue
, then you need to provide a reportScope
,Path
, andFormat
. SetEnabled
toFalse
if you do not want aCompletionReport
generated when the task completes.Path -> (string)
Required ifEnabled
is set totrue
. Specifies the location of the report on the file system's linked S3 data repository. An absolute path that defines where the completion report will be stored in the destination location. ThePath
you provide must be located within the file system’s ExportPath. An examplePath
value is "s3://amzn-s3-demo-bucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode.Format -> (string)
Required ifEnabled
is set totrue
. Specifies the format of theCompletionReport
.REPORT_CSV_20191124
is the only format currently supported. WhenFormat
is set toREPORT_CSV_20191124
, theCompletionReport
is provided in CSV format, and is delivered to{path}/task-{id}/failures.csv
.Scope -> (string)
Required ifEnabled
is set totrue
. Specifies the scope of theCompletionReport
;FAILED_FILES_ONLY
is the only scope currently supported. WhenScope
is set toFAILED_FILES_ONLY
, theCompletionReport
only contains information about files that the data repository task failed to process.CapacityToRelease -> (long)
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.FileCacheId -> (string)
The system-generated, unique ID of the cache.ReleaseConfiguration -> (structure)
The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.
DurationSinceLastAccess -> (structure)
Defines the point-in-time since an exported file was last accessed, in order for that file to be eligible for release. Only files that were last accessed before this point-in-time are eligible to be released from the file system.
Unit -> (string)
The unit of time used by theValue
parameter to determine if a file can be released, based on when it was last accessed.DAYS
is the only supported value. This is a required parameter.Value -> (long)
An integer that represents the minimum amount of time (in days) since a file was last accessed in the file system. Only exported files with a
MAX(atime, ctime, mtime)
timestamp that is more than this amount of time in the past (relative to the task create time) will be released. The default ofValue
is0
. This is a required parameter.Note
If an exported file meets the last accessed time criteria, its file or directory path must also be specified in thePaths
parameter of the operation in order for the file to be released.