Amazon FSx Fsx Data Repository Task API

openapi: 3.2.0
info:
  title: Amazon FSx Data Repository Task API
  version: '2018-03-01'
  description: Generated from AWS's published Smithy model for Amazon FSx. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://fsx.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Data Repository Task
paths:
  /#CancelDataRepositoryTask:
    post:
      operationId: CancelDataRepositoryTask
      summary: Cancel Data Repository Task
      description: Cancels an existing Amazon FSx for Lustre data repository task if that task is in either the PENDING or EXECUTING state. When you cancel an export task, Amazon FSx does the following. Any files that FSx has already exported are not reverted. FSx continues to export any files that are in-flight when the cancel operation is received. FSx does not export any files that have not yet been exported. For a release task, Amazon FSx will stop releasing files upon cancellation. Any files that have already been released will remain in the released state.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CancelDataRepositoryTaskResponse'
        '400':
          description: BadRequest; DataRepositoryTaskEnded; DataRepositoryTaskNotFound; UnsupportedOperation
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSSimbaAPIService_v20180301.CancelDataRepositoryTask
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CancelDataRepositoryTaskRequest'
      tags:
      - Data Repository Task
  /#CreateDataRepositoryTask:
    post:
      operationId: CreateDataRepositoryTask
      summary: Create Data Repository Task
      description: Creates an Amazon FSx for Lustre data repository task. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. You use import and export data repository tasks to perform bulk operations between your FSx for Lustre file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository. You use release data repository tasks to release data from your file system for files that are exported to S3. The metadata of released files remains on the file system so users or applications can still access released files by reading the files again, which will restore data from Amazon S3 to the FSx for Lustre file system. To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDataRepositoryTaskResponse'
        '400':
          description: BadRequest; DataRepositoryTaskExecuting; FileSystemNotFound; IncompatibleParameterError; ServiceLimitExceeded; UnsupportedOperation
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSSimbaAPIService_v20180301.CreateDataRepositoryTask
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDataRepositoryTaskRequest'
      tags:
      - Data Repository Task
  /#DescribeDataRepositoryTasks:
    post:
      operationId: DescribeDataRepositoryTasks
      summary: Describe Data Repository Tasks
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDataRepositoryTasksResponse'
        '400':
          description: BadRequest; DataRepositoryTaskNotFound; FileSystemNotFound
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSSimbaAPIService_v20180301.DescribeDataRepositoryTasks
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDataRepositoryTasksRequest'
      tags:
      - Data Repository Task
components:
  schemas:
    DescribeDataRepositoryTasksResponse:
      type: object
      properties:
        DataRepositoryTasks:
          type: array
          items:
            $ref: '#/components/schemas/DataRepositoryTask'
          description: The collection of data repository task descriptions returned.
        NextToken:
          type: string
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    DataRepositoryTask:
      type: object
      properties:
        TaskId:
          type: string
          description: The system-generated, unique 17-digit ID of the data repository task.
        Lifecycle:
          type: string
          enum:
          - PENDING
          - EXECUTING
          - FAILED
          - SUCCEEDED
          - CANCELED
          - CANCELING
          description: '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 i'
        Type:
          type: string
          enum:
          - EXPORT_TO_REPOSITORY
          - IMPORT_METADATA_FROM_REPOSITORY
          - RELEASE_DATA_FROM_FILESYSTEM
          - AUTO_RELEASE_DATA
          description: 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:
          type: string
          format: date-time
        StartTime:
          type: string
          format: date-time
          description: The time the system began processing the task.
        EndTime:
          type: string
          format: date-time
          description: The time the system completed processing the task, populated after the task is complete.
        ResourceARN:
          type: string
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        FileSystemId:
          type: string
          description: The globally unique ID of the file system.
        Paths:
          type: array
          items:
            type: string
          description: 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.
        FailureDetails:
          $ref: '#/components/schemas/DataRepositoryTaskFailureDetails'
        Status:
          $ref: '#/components/schemas/DataRepositoryTaskStatus'
        Report:
          $ref: '#/components/schemas/CompletionReport'
        CapacityToRelease:
          type: integer
          description: 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:
          type: string
          description: The system-generated, unique ID of the cache.
        ReleaseConfiguration:
          $ref: '#/components/schemas/ReleaseConfiguration'
      required:
      - TaskId
      - Lifecycle
      - Type
      - CreationTime
    CreateDataRepositoryTaskRequest:
      type: object
      properties:
        Type:
          type: string
          enum:
          - EXPORT_TO_REPOSITORY
          - IMPORT_METADATA_FROM_REPOSITORY
          - RELEASE_DATA_FROM_FILESYSTEM
          - AUTO_RELEASE_DATA
          description: Specifies the type of data repository task to create. 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.
        Paths:
          type: array
          items:
            type: string
          description: A list of paths for the data repository task to use when the task is processed. If a path that you provide isn't valid, the task fails. If you don't provide paths, the default behavior is to export all files to S3 (for export tasks), import all files from S3 (for import tasks), or release all exported files that meet the last accessed time criteria (for release tasks). For export tasks, the list contains paths on the FSx for Lustre file system from which the files are exported to the Amazon S3 bucket. The default path is the file system root directory. The paths you provide need to be relative
        FileSystemId:
          type: string
        Report:
          $ref: '#/components/schemas/CompletionReport'
        ClientRequestToken:
          type: string
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        CapacityToRelease:
          type: integer
          description: 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.
        ReleaseConfiguration:
          $ref: '#/components/schemas/ReleaseConfiguration'
      required:
      - Type
      - FileSystemId
      - Report
    DataRepositoryTaskFilter:
      type: object
      properties:
        Name:
          type: string
          enum:
          - file-system-id
          - task-lifecycle
          - data-repository-association-id
          - file-cache-id
          description: '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:
          type: array
          items:
            type: string
          description: Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.
    DataRepositoryTaskStatus:
      type: object
      properties:
        TotalCount:
          type: integer
          description: 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:
          type: integer
          description: A running total of the number of files that the task has successfully processed.
        FailedCount:
          type: integer
          description: A running total of the number of files that the task failed to process.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The time at which the task status was last updated.
        ReleasedCapacity:
          type: integer
          description: The total amount of data, in GiB, released by an Amazon File Cache AUTO_RELEASE_DATA task that automatically releases files from the cache.
    CreateDataRepositoryTaskResponse:
      type: object
      properties:
        DataRepositoryTask:
          $ref: '#/components/schemas/DataRepositoryTask'
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 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:
          type: string
          description: '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.'
      required:
      - Key
      - Value
    BadRequest:
      type: object
      properties:
        Message:
          type: string
    DescribeDataRepositoryTasksRequest:
      type: object
      properties:
        TaskIds:
          type: array
          items:
            type: string
          description: (Optional) IDs of the tasks whose descriptions you want to retrieve (String).
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/DataRepositoryTaskFilter'
          description: (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.
        MaxResults:
          type: integer
        NextToken:
          type: string
    DataRepositoryTaskFailureDetails:
      type: object
      properties:
        Message:
          type: string
    CancelDataRepositoryTaskResponse:
      type: object
      properties:
        Lifecycle:
          type: string
          enum:
          - PENDING
          - EXECUTING
          - FAILED
          - SUCCEEDED
          - CANCELED
          - CANCELING
          description: '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.'
        TaskId:
          type: string
          description: The ID of the task being canceled.
    CancelDataRepositoryTaskRequest:
      type: object
      properties:
        TaskId:
          type: string
          description: Specifies the data repository task to cancel.
      required:
      - TaskId
    DurationSinceLastAccess:
      type: object
      properties:
        Unit:
          type: string
          enum:
          - DAYS
          description: 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:
          type: integer
          description: 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.
    CompletionReport:
      type: object
      properties:
        Enabled:
          type: boolean
          description: 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:
          type: string
          description: '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:
          type: string
          enum:
          - REPORT_CSV_20191124
          description: 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:
          type: string
          enum:
          - FAILED_FILES_ONLY
          description: 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.
      required:
      - Enabled
    ReleaseConfiguration:
      type: object
      properties:
        DurationSinceLastAccess:
          $ref: '#/components/schemas/DurationSinceLastAccess'
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: fsx
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/fsx/service/2018-03-01/fsx-2018-03-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)