| Column Name | Column Data Type |
|---|
filters Input Column
(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. | STRUCT(
"name" VARCHAR,
"values" VARCHAR[]
)[] |
Show child fields- filters[]
Show child fields- filters[].name
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. - filters[].values[]
|
max_results Input Column
The maximum number of resources to return in the response. This value must be an integer greater than zero. | BIGINT |
next_token Input Column
(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. | VARCHAR |
task_ids Input Column
(Optional) IDs of the tasks whose descriptions you want to retrieve (String). | VARCHAR[] |
Show child fields- task_ids[]
|
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
data_repository_tasks
The collection of data repository task descriptions returned. | STRUCT(
"task_id" VARCHAR,
"lifecycle" VARCHAR,
"type" VARCHAR,
"creation_time" TIMESTAMP_S,
"start_time" TIMESTAMP_S,
"end_time" TIMESTAMP_S,
"resource_arn" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"file_system_id" VARCHAR,
"paths" VARCHAR[],
"failure_details" STRUCT(
"message" VARCHAR
),
"status" STRUCT(
"total_count" BIGINT,
"succeeded_count" BIGINT,
"failed_count" BIGINT,
"last_updated_time" TIMESTAMP_S,
"released_capacity" BIGINT
),
"report" STRUCT(
"enabled" BOOLEAN,
"path" VARCHAR,
"format" VARCHAR,
"scope" VARCHAR
),
"capacity_to_release" BIGINT,
"file_cache_id" VARCHAR,
"release_configuration" STRUCT(
"duration_since_last_access" STRUCT(
"unit" VARCHAR,
"value" BIGINT
)
)
)[] |
Show child fields- data_repository_tasks[]
Show child fields- data_repository_tasks[].capacity_to_release
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. - data_repository_tasks[].creation_time
The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. - data_repository_tasks[].end_time
The time the system completed processing the task, populated after the task is complete. - data_repository_tasks[].failure_details
Failure message describing why the task failed, it is populated only when Lifecycle is set to FAILED. Show child fields- data_repository_tasks[].failure_details.message
A detailed error message.
- data_repository_tasks[].file_cache_id
The system-generated, unique ID of the cache. - data_repository_tasks[].file_system_id
The globally unique ID of the file system. - data_repository_tasks[].lifecycle
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. - data_repository_tasks[].paths[]
- data_repository_tasks[].release_configuration
The configuration that specifies the last accessed time criteria for files that will be released from an Amazon FSx for Lustre file system. Show child fields- data_repository_tasks[].release_configuration.duration_since_last_access
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. Show child fields- data_repository_tasks[].release_configuration.duration_since_last_access.unit
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. - data_repository_tasks[].release_configuration.duration_since_last_access.value
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. 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.
- data_repository_tasks[].report
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. Show child fields- data_repository_tasks[].report.enabled
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. - data_repository_tasks[].report.format
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. - data_repository_tasks[].report.path
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://myBucket/myExportPath/optionalPrefix". The report provides the following information for each file in the report: FilePath, FileStatus, and ErrorCode. - data_repository_tasks[].report.scope
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.
- data_repository_tasks[].resource_arn
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. - data_repository_tasks[].start_time
The time the system began processing the task. - data_repository_tasks[].status
Provides the status of the number of files that the task has processed successfully and failed to process. Show child fields- data_repository_tasks[].status.failed_count
A running total of the number of files that the task failed to process. - data_repository_tasks[].status.last_updated_time
The time at which the task status was last updated. - data_repository_tasks[].status.released_capacity
The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache. - data_repository_tasks[].status.succeeded_count
A running total of the number of files that the task has successfully processed. - data_repository_tasks[].status.total_count
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.
- data_repository_tasks[].tags[]
Show child fields- data_repository_tasks[].tags[].key
A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached. - data_repository_tasks[].tags[].value
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.
- data_repository_tasks[].task_id
The system-generated, unique 17-digit ID of the data repository task. - data_repository_tasks[].type
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.
|