class Aws::FSx::Types::DataRepositoryTask

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.

@!attribute [rw] task_id

The system-generated, unique 17-digit ID of the data repository
task.
@return [String]

@!attribute [rw] 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.

<note markdown="1"> 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.

 </note>
@return [String]

@!attribute [rw] type

The type of data repository task; EXPORT\_TO\_REPOSITORY is the only
type currently supported.
@return [String]

@!attribute [rw] creation_time

The time that the resource was created, in seconds (since
1970-01-01T00:00:00Z), also known as Unix time.
@return [Time]

@!attribute [rw] start_time

The time that Amazon FSx began processing the task.
@return [Time]

@!attribute [rw] end_time

The time that Amazon FSx completed processing the task, populated
after the task is complete.
@return [Time]

@!attribute [rw] resource_arn

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)][1] in the *Amazon Web Services General Reference*.

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
@return [String]

@!attribute [rw] tags

A list of `Tag` values, with a maximum of 50 elements.
@return [Array<Types::Tag>]

@!attribute [rw] file_system_id

The globally unique ID of the file system, assigned by Amazon FSx.
@return [String]

@!attribute [rw] paths

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.
@return [Array<String>]

@!attribute [rw] failure_details

Failure message describing why the task failed, it is populated only
when `Lifecycle` is set to `FAILED`.
@return [Types::DataRepositoryTaskFailureDetails]

@!attribute [rw] status

Provides the status of the number of files that the task has
processed successfully and failed to process.
@return [Types::DataRepositoryTaskStatus]

@!attribute [rw] report

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.
@return [Types::CompletionReport]

@see docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTask AWS API Documentation

Constants

SENSITIVE