Class: Aws::FSx::Types::DataRepositoryTask

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

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 a linked data repository.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

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

Returns:

  • (Time)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#end_timeTime

The time that Amazon FSx completed processing the task, populated after the task is complete.

Returns:

  • (Time)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#failure_detailsTypes::DataRepositoryTaskFailureDetails

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



3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_idString

The globally unique ID of the file system, assigned by Amazon FSx.

Returns:

  • (String)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#lifecycleString

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.

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.

Returns:

  • (String)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#pathsArray<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.

Returns:

  • (Array<String>)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#reportTypes::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.



3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arnString

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.

Returns:

  • (String)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The time that Amazon FSx began processing the task.

Returns:

  • (Time)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#statusTypes::DataRepositoryTaskStatus

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



3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#task_idString

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

Returns:

  • (String)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of data repository task.

  • The EXPORT_TO_REPOSITORY data repository task exports from your Lustre file system from to a linked S3 bucket.

  • The IMPORT_METADATA_FROM_REPOSITORY data repository task imports metadata changes from a linked S3 bucket to your Lustre file system.

Returns:

  • (String)


3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 3467

class DataRepositoryTask < Struct.new(
  :task_id,
  :lifecycle,
  :type,
  :creation_time,
  :start_time,
  :end_time,
  :resource_arn,
  :tags,
  :file_system_id,
  :paths,
  :failure_details,
  :status,
  :report)
  SENSITIVE = []
  include Aws::Structure
end