FSx / Client / describe_data_repository_tasks

describe_data_repository_tasks

FSx.Client.describe_data_repository_tasks(**kwargs)

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you’re calling.

When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

See also: AWS API Documentation

Request Syntax

response = client.describe_data_repository_tasks(
    TaskIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'file-system-id'|'task-lifecycle'|'data-repository-association-id'|'file-cache-id',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• TaskIds (list) –

  (Optional) IDs of the tasks whose descriptions you want to retrieve (String).

  • (string) –

• Filters (list) –

  (Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just tasks for specific file systems, or tasks in a specific lifecycle state.

  • (dict) –

    (Optional) An array of filter objects you can use to filter the response of data repository tasks you will see in the the response. You can filter the tasks returned in the response by one or more file system IDs, task lifecycles, and by task type. A filter object consists of a filter Name, and one or more Values for the filter.

    • Name (string) –

      Name of the task property to use in filtering the tasks returned in the response.

      • Use file-system-id to retrieve data repository tasks for specific file systems.

      • Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.

    • Values (list) –

      Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.

      • (string) –

• MaxResults (integer) – The maximum number of resources to return in the response. This value must be an integer greater than zero.

• NextToken (string) – (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

Return type:

dict

Returns:

Response Syntax

{
    'DataRepositoryTasks': [
        {
            'TaskId': 'string',
            'Lifecycle': 'PENDING'|'EXECUTING'|'FAILED'|'SUCCEEDED'|'CANCELED'|'CANCELING',
            'Type': 'EXPORT_TO_REPOSITORY'|'IMPORT_METADATA_FROM_REPOSITORY'|'RELEASE_DATA_FROM_FILESYSTEM'|'AUTO_RELEASE_DATA',
            'CreationTime': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'ResourceARN': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'FileSystemId': 'string',
            'Paths': [
                'string',
            ],
            'FailureDetails': {
                'Message': 'string'
            },
            'Status': {
                'TotalCount': 123,
                'SucceededCount': 123,
                'FailedCount': 123,
                'LastUpdatedTime': datetime(2015, 1, 1),
                'ReleasedCapacity': 123
            },
            'Report': {
                'Enabled': True|False,
                'Path': 'string',
                'Format': 'REPORT_CSV_20191124',
                'Scope': 'FAILED_FILES_ONLY'
            },
            'CapacityToRelease': 123,
            'FileCacheId': 'string',
            'ReleaseConfiguration': {
                'DurationSinceLastAccess': {
                    'Unit': 'DAYS',
                    'Value': 123
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • DataRepositoryTasks (list) –

    The collection of data repository task descriptions returned.

    • (dict) –

      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.

      • 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 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 (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 (datetime) –

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

      • StartTime (datetime) –

        The time the system began processing the task.

      • EndTime (datetime) –

        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.

        • (dict) –

          Specifies a key-value pair for a resource tag.

          • Key (string) –

            A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

          • Value (string) –

            A value that specifies the TagValue, 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 of finances : April and also of payroll : 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 (dict) –

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

        • Message (string) –

          A detailed error message.

      • Status (dict) –

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

        • TotalCount (integer) –

          The total number of files that the task will process. While a task is executing, the sum of SucceededCount plus FailedCount may not equal TotalCount. When the task is complete, TotalCount equals the sum of SucceededCount plus FailedCount.

        • SucceededCount (integer) –

          A running total of the number of files that the task has successfully processed.

        • FailedCount (integer) –

          A running total of the number of files that the task failed to process.

        • LastUpdatedTime (datetime) –

          The time at which the task status was last updated.

        • ReleasedCapacity (integer) –

          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 (dict) –

        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.

        • Enabled (boolean) –

          Set Enabled to True to generate a CompletionReport when the task completes. If set to true, then you need to provide a report Scope, Path, and Format. Set Enabled to False if you do not want a CompletionReport generated when the task completes.

        • Path (string) –

          Required if Enabled is set to true. 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. The Path you provide must be located within the file system’s ExportPath. An example Path 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 if Enabled is set to true. Specifies the format of the CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When Format is set to REPORT_CSV_20191124, the CompletionReport is provided in CSV format, and is delivered to {path}/task-{id}/failures.csv.

        • Scope (string) –

          Required if Enabled is set to true. Specifies the scope of the CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains information about files that the data repository task failed to process.

      • CapacityToRelease (integer) –

        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 (dict) –

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

        • DurationSinceLastAccess (dict) –

          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 the Value 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 (integer) –

            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 of Value is 0. 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 the Paths parameter of the operation in order for the file to be released.

  • NextToken (string) –

    (Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

Exceptions

• FSx.Client.exceptions.BadRequest

• FSx.Client.exceptions.FileSystemNotFound

• FSx.Client.exceptions.DataRepositoryTaskNotFound

• FSx.Client.exceptions.InternalServerError