Skip to content

DataRepositoryTask

Source code in docs_src/capo_fsx/types/data_repository_task.py
class DataRepositoryTask(TypedDict, closed=True):
    task_id: NotRequired["capo_fsx.types.task_id.TaskId"]
    """<p>The system-generated, unique 17-digit ID of the data repository task.</p>"""
    lifecycle: NotRequired[
        "capo_fsx.types.data_repository_task_lifecycle.DataRepositoryTaskLifecycle"
    ]
    """<p>The lifecycle status of the data repository task, as follows:</p> <ul> <li> <p> <code>PENDING</code> - The task has not started.</p> </li> <li> <p> <code>EXECUTING</code> - The task is in process.</p> </li> <li> <p> <code>FAILED</code> - The task was not able to be completed. For example, there may be files the task failed to process. The <a>DataRepositoryTaskFailureDetails</a> property provides more information about task failures.</p> </li> <li> <p> <code>SUCCEEDED</code> - The task has completed successfully.</p> </li> <li> <p> <code>CANCELED</code> - The task was canceled and it did not complete.</p> </li> <li> <p> <code>CANCELING</code> - The task is in process of being canceled.</p> </li> </ul> <note> <p>You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the <code>PENDING</code> or <code>EXECUTING</code> states. Please retry when the data repository task is finished (with a status of <code>CANCELED</code>, <code>SUCCEEDED</code>, or <code>FAILED</code>). You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.</p> </note>"""
    type: NotRequired["capo_fsx.types.data_repository_task_type.DataRepositoryTaskType"]
    """<p>The type of data repository task.</p> <ul> <li> <p> <code>EXPORT_TO_REPOSITORY</code> tasks export from your Amazon FSx for Lustre file system to a linked data repository.</p> </li> <li> <p> <code>IMPORT_METADATA_FROM_REPOSITORY</code> tasks import metadata changes from a linked S3 bucket to your Amazon FSx for Lustre file system.</p> </li> <li> <p> <code>RELEASE_DATA_FROM_FILESYSTEM</code> 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.</p> </li> <li> <p> <code>AUTO_RELEASE_DATA</code> tasks automatically release files from an Amazon File Cache resource.</p> </li> </ul>"""
    creation_time: NotRequired["capo_fsx.types.creation_time.CreationTime"]
    start_time: NotRequired["capo_fsx.types.start_time.StartTime"]
    """<p>The time the system began processing the task.</p>"""
    end_time: NotRequired["capo_fsx.types.end_time.EndTime"]
    """<p>The time the system completed processing the task, populated after the task is complete.</p>"""
    resource_arn: NotRequired["capo_fsx.types.resource_arn.ResourceARN"]
    tags: NotRequired["capo_fsx.types.tags.Tags"]
    file_system_id: NotRequired["capo_fsx.types.file_system_id.FileSystemId"]
    """<p>The globally unique ID of the file system.</p>"""
    paths: NotRequired[
        "capo_fsx.types.data_repository_task_paths.DataRepositoryTaskPaths"
    ]
    """<p>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.</p> <p>(Default) If <code>Paths</code> is not specified, Amazon FSx uses the file system root directory.</p>"""
    failure_details: NotRequired[
        "capo_fsx.types.data_repository_task_failure_details.DataRepositoryTaskFailureDetails"
    ]
    """<p>Failure message describing why the task failed, it is populated only when <code>Lifecycle</code> is set to <code>FAILED</code>.</p>"""
    status: NotRequired[
        "capo_fsx.types.data_repository_task_status.DataRepositoryTaskStatus"
    ]
    """<p>Provides the status of the number of files that the task has processed successfully and failed to process.</p>"""
    report: NotRequired["capo_fsx.types.completion_report.CompletionReport"]
    capacity_to_release: NotRequired[
        "capo_fsx.types.capacity_to_release.CapacityToRelease"
    ]
    """<p>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.</p>"""
    file_cache_id: NotRequired["capo_fsx.types.file_cache_id.FileCacheId"]
    """<p>The system-generated, unique ID of the cache.</p>"""
    release_configuration: NotRequired[
        "capo_fsx.types.release_configuration.ReleaseConfiguration"
    ]
    """<p>The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system.</p>"""

capacity_to_release instance-attribute

capacity_to_release: NotRequired[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.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

end_time instance-attribute

end_time: NotRequired[EndTime]

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

failure_details instance-attribute

failure_details: NotRequired[DataRepositoryTaskFailureDetails]

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

file_cache_id instance-attribute

file_cache_id: NotRequired[FileCacheId]

The system-generated, unique ID of the cache.

file_system_id instance-attribute

file_system_id: NotRequired[FileSystemId]

The globally unique ID of the file system.

lifecycle instance-attribute

lifecycle: NotRequired[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.

paths instance-attribute

paths: NotRequired[DataRepositoryTaskPaths]

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.

release_configuration instance-attribute

release_configuration: NotRequired[ReleaseConfiguration]

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

report instance-attribute

report: NotRequired[CompletionReport]

resource_arn instance-attribute

resource_arn: NotRequired[ResourceARN]

start_time instance-attribute

start_time: NotRequired[StartTime]

The time the system began processing the task.

status instance-attribute

status: NotRequired[DataRepositoryTaskStatus]

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

tags instance-attribute

tags: NotRequired[Tags]

task_id instance-attribute

task_id: NotRequired[TaskId]

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

type instance-attribute

type: NotRequired[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.