You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::FSx::Types::DataRepositoryTask
- Inherits:
-
Struct
- Object
- Struct
- Aws::FSx::Types::DataRepositoryTask
- Defined in:
- (unknown)
Overview
A description of the data repository task. You use data repository tasks to perform bulk transfer operations between your Amazon FSx file system and its linked data repository.
Returned by:
Instance Attribute Summary collapse
-
#creation_time ⇒ Time
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
.
-
#end_time ⇒ Time
The time that Amazon FSx completed processing the task, populated after the task is complete.
-
#failure_details ⇒ Types::DataRepositoryTaskFailureDetails
Failure message describing why the task failed, it is populated only when
Lifecycle
is set toFAILED
. -
#file_system_id ⇒ String
The globally unique ID of the file system, assigned by Amazon FSx.
.
-
#lifecycle ⇒ String
The lifecycle status of the data repository task, as follows:.
-
#paths ⇒ Array<String>
An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to process.
-
#report ⇒ Types::CompletionReport
Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report
Scope
parameter. -
#resource_arn ⇒ String
The Amazon Resource Name (ARN) for a given resource.
-
#start_time ⇒ Time
The time that Amazon FSx began processing the task.
-
#status ⇒ Types::DataRepositoryTaskStatus
Provides the status of the number of files that the task has processed successfully and failed to process.
-
#tags ⇒ Array<Types::Tag>
A list of
Tag
values, with a maximum of 50 elements..
-
#task_id ⇒ String
The system-generated, unique 17-digit ID of the data repository task.
-
#type ⇒ String
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
Instance Attribute Details
#creation_time ⇒ Time
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
#end_time ⇒ Time
The time that Amazon FSx completed processing the task, populated after the task is complete.
#failure_details ⇒ Types::DataRepositoryTaskFailureDetails
Failure message describing why the task failed, it is populated only
when Lifecycle
is set to FAILED
.
#file_system_id ⇒ String
The globally unique ID of the file system, assigned by Amazon FSx.
#lifecycle ⇒ String
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.
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.
Possible values:
- PENDING
- EXECUTING
- FAILED
- SUCCEEDED
- CANCELED
- CANCELING
#paths ⇒ Array<String>
An array of paths on the Amazon FSx for Lustre file system 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 ⇒ Types::CompletionReport
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 report Path
parameter. You can specify whether or not a report gets generated for a task using the Enabled
parameter.
#resource_arn ⇒ String
The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
#start_time ⇒ Time
The time that Amazon FSx began processing the task.
#status ⇒ Types::DataRepositoryTaskStatus
Provides the status of the number of files that the task has processed successfully and failed to process.
#tags ⇒ Array<Types::Tag>
A list of Tag
values, with a maximum of 50 elements.
#task_id ⇒ String
The system-generated, unique 17-digit ID of the data repository task.
#type ⇒ String
The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
Possible values:
- EXPORT_TO_REPOSITORY