Struct aws_sdk_fsx::types::DataRepositoryTask

#[non_exhaustive]
pub struct DataRepositoryTask {

    pub task_id: Option<String>,
    pub lifecycle: Option<DataRepositoryTaskLifecycle>,
    pub type: Option<DataRepositoryTaskType>,
    pub creation_time: Option<DateTime>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub resource_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub file_system_id: Option<String>,
    pub paths: Option<Vec<String>>,
    pub failure_details: Option<DataRepositoryTaskFailureDetails>,
    pub status: Option<DataRepositoryTaskStatus>,
    pub report: Option<CompletionReport>,
    pub capacity_to_release: Option<i64>,
    pub file_cache_id: Option<String>,
    pub release_configuration: Option<ReleaseConfiguration>,
}

A description of the data repository task.

• You use import and export data repository tasks to perform bulk transfer operations between an Amazon FSx for Lustre file system and a linked data repository.

• You use release data repository tasks to release files that have been exported to a linked S3 bucket from your Amazon FSx for Lustre file system.

• An Amazon File Cache resource uses a task to automatically release files from the cache.

To learn more about data repository tasks, see Data Repository Tasks.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

task_id: Option<String>

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

lifecycle: Option<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: Option<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.

• 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.

creation_time: Option<DateTime>

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

start_time: Option<DateTime>

The time the system began processing the task.

end_time: Option<DateTime>

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

resource_arn: Option<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: Option<Vec<Tag>>

A list of Tag values, with a maximum of 50 elements.

file_system_id: Option<String>

The globally unique ID of the file system.

paths: Option<Vec<String>>

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.

failure_details: Option<DataRepositoryTaskFailureDetails>

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

status: Option<DataRepositoryTaskStatus>

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

report: Option<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.

capacity_to_release: Option<i64>

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.

file_cache_id: Option<String>

The system-generated, unique ID of the cache.

release_configuration: Option<ReleaseConfiguration>

The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

Implementations

impl DataRepositoryTask

pub fn task_id(&self) -> Option<&str>

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

pub fn lifecycle(&self) -> Option<&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.

pub fn type(&self) -> Option<&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.

• 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.

pub fn creation_time(&self) -> Option<&DateTime>

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

pub fn start_time(&self) -> Option<&DateTime>

The time the system began processing the task.

pub fn end_time(&self) -> Option<&DateTime>

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

pub fn resource_arn(&self) -> Option<&str>

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.

pub fn tags(&self) -> &[Tag]

A list of Tag values, with a maximum of 50 elements.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn file_system_id(&self) -> Option<&str>

The globally unique ID of the file system.

pub fn paths(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .paths.is_none().

pub fn failure_details(&self) -> Option<&DataRepositoryTaskFailureDetails>

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

pub fn status(&self) -> Option<&DataRepositoryTaskStatus>

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

pub fn report(&self) -> Option<&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.

pub fn capacity_to_release(&self) -> Option<i64>

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.

pub fn file_cache_id(&self) -> Option<&str>

The system-generated, unique ID of the cache.

pub fn release_configuration(&self) -> Option<&ReleaseConfiguration>

The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.

impl DataRepositoryTask

pub fn builder() -> DataRepositoryTaskBuilder

Creates a new builder-style object to manufacture DataRepositoryTask.

Trait Implementations

impl Clone for DataRepositoryTask

fn clone(&self) -> DataRepositoryTask

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataRepositoryTask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DataRepositoryTask

fn eq(&self, other: &DataRepositoryTask) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DataRepositoryTask