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

Inherits:

Struct

Object
Struct
Aws::FSx::Types::DataRepositoryTask

show all

Includes:: Structure

Defined in:: lib/aws-sdk-fsx/types.rb

Overview

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

[1]: docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#capacity_to_release ⇒ 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.
#creation_time ⇒ Time

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

The time the system completed processing the task, populated after the task is complete.
#failure_details ⇒ Types::DataRepositoryTaskFailureDetails

Failure message describing why the task failed, it is populated only when ‘Lifecycle` is set to `FAILED`.
#file_cache_id ⇒ String

The system-generated, unique ID of the cache.
#file_system_id ⇒ String

The globally unique ID of the file system.
#lifecycle ⇒ String

The lifecycle status of the data repository task, as follows:.
#paths ⇒ Array<String>

An array of paths that specify the data for the data repository task to process.
#release_configuration ⇒ Types::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 ⇒ Types::CompletionReport

Provides a report detailing the data repository task results of the files processed that match the criteria specified in the report ‘Scope` parameter.
#resource_arn ⇒ String

The Amazon Resource Name (ARN) for a given resource.
#start_time ⇒ Time

The time the system began processing the task.
#status ⇒ Types::DataRepositoryTaskStatus

Provides the status of the number of files that the task has processed successfully and failed to process.
#tags ⇒ Array<Types::Tag>

A list of ‘Tag` values, with a maximum of 50 elements.
#task_id ⇒ String

The system-generated, unique 17-digit ID of the data repository task.
#type ⇒ String

The type of data repository task.

Instance Attribute Details

#capacity_to_release ⇒ `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.

Returns:

(Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#failure_details ⇒ `Types::DataRepositoryTaskFailureDetails`

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

Returns:

(Types::DataRepositoryTaskFailureDetails)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#file_cache_id ⇒ `String`

The system-generated, unique ID of the cache.

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_id ⇒ `String`

The globally unique ID of the file system.

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#paths ⇒ `Array<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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#release_configuration ⇒ `Types::ReleaseConfiguration`

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

Returns:

(Types::ReleaseConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#report ⇒ `Types::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.

Returns:

(Types::CompletionReport)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ `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*.

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ `Time`

The time the system began processing the task.

Returns:

(Time)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `Types::DataRepositoryTaskStatus`

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

Returns:

(Types::DataRepositoryTaskStatus)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

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

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#task_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 4064

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,
  :capacity_to_release,
  :file_cache_id,
  :release_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_to_release ⇒ Integer

#creation_time ⇒ Time

#end_time ⇒ Time

#failure_details ⇒ Types::DataRepositoryTaskFailureDetails

#file_cache_id ⇒ String

#file_system_id ⇒ String

#lifecycle ⇒ String

#paths ⇒ Array<String>

#release_configuration ⇒ Types::ReleaseConfiguration

#report ⇒ Types::CompletionReport

#resource_arn ⇒ String

#start_time ⇒ Time

#status ⇒ Types::DataRepositoryTaskStatus

#tags ⇒ Array<Types::Tag>

#task_id ⇒ String

#type ⇒ String

#capacity_to_release ⇒ `Integer`

#creation_time ⇒ `Time`

#end_time ⇒ `Time`

#failure_details ⇒ `Types::DataRepositoryTaskFailureDetails`

#file_cache_id ⇒ `String`

#file_system_id ⇒ `String`

#lifecycle ⇒ `String`

#paths ⇒ `Array<String>`

#release_configuration ⇒ `Types::ReleaseConfiguration`

#report ⇒ `Types::CompletionReport`

#resource_arn ⇒ `String`

#start_time ⇒ `Time`

#status ⇒ `Types::DataRepositoryTaskStatus`

#tags ⇒ `Array<Types::Tag>`

#task_id ⇒ `String`

#type ⇒ `String`