Amazon FSx Fsx Data Repository Association API

openapi: 3.2.0
info:
  title: Amazon FSx Data Repository Association API
  version: '2018-03-01'
  description: Generated from AWS's published Smithy model for Amazon FSx. 4 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 Association
paths:
  /#CreateDataRepositoryAssociation:
    post:
      operationId: CreateDataRepositoryAssociation
      summary: Create Data Repository Association
      description: Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type. Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket. CreateDataRepositoryAssociation isn't supported on Amazon File Cache resources. To create a DRA on Amazon File Cache, use the CreateFileCache operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDataRepositoryAssociationResponse'
        '400':
          description: BadRequest; 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.CreateDataRepositoryAssociation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDataRepositoryAssociationRequest'
      tags:
      - Data Repository Association
  /#DeleteDataRepositoryAssociation:
    post:
      operationId: DeleteDataRepositoryAssociation
      summary: Delete Data Repository Association
      description: Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteDataRepositoryAssociationResponse'
        '400':
          description: BadRequest; DataRepositoryAssociationNotFound; IncompatibleParameterError; ServiceLimitExceeded
          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.DeleteDataRepositoryAssociation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDataRepositoryAssociationRequest'
      tags:
      - Data Repository Association
  /#DescribeDataRepositoryAssociations:
    post:
      operationId: DescribeDataRepositoryAssociations
      summary: Describe Data Repository Associations
      description: Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository associations, if one or more AssociationIds values are provided in the request, or if filters are used in the request. Data repository associations are supported on Amazon File Cache resources and all FSx for Lustre 2.12 and 2,15 file systems, excluding scratch_1 deployment type. You can use filters to narrow the response to include just data repository associations for specific file systems (use the file-system-id filter with the ID of the file system) or caches (use the file-cache-id filter with the ID of the cache), or data repository associations for a specific repository type (use the data-repository-type filter with a value of S3 or NFS). If you don't use filters, the response returns all data repository associations owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling. When retrieving all data repository associations, you can paginate the response by using the optional MaxResults parameter to limit the number of data repository associations returned in a response. If more data repository associations remain, a NextToken val
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDataRepositoryAssociationsResponse'
        '400':
          description: BadRequest; DataRepositoryAssociationNotFound; FileSystemNotFound; InvalidDataRepositoryType
          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.DescribeDataRepositoryAssociations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDataRepositoryAssociationsRequest'
      tags:
      - Data Repository Association
  /#UpdateDataRepositoryAssociation:
    post:
      operationId: UpdateDataRepositoryAssociation
      summary: Update Data Repository Association
      description: Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateDataRepositoryAssociationResponse'
        '400':
          description: BadRequest; DataRepositoryAssociationNotFound; IncompatibleParameterError; ServiceLimitExceeded
          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.UpdateDataRepositoryAssociation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateDataRepositoryAssociationRequest'
      tags:
      - Data Repository Association
components:
  schemas:
    DataRepositoryFailureDetails:
      type: object
      properties:
        Message:
          type: string
    Filter:
      type: object
      properties:
        Name:
          type: string
          enum:
          - file-system-id
          - backup-type
          - file-system-type
          - volume-id
          - data-repository-type
          - file-cache-id
          - file-cache-type
          description: The name for this filter.
        Values:
          type: array
          items:
            type: string
          description: The values of the filter. These are all the values for any of the applied filters.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    UpdateDataRepositoryAssociationRequest:
      type: object
      properties:
        AssociationId:
          type: string
          description: The ID of the data repository association that you are updating.
        ClientRequestToken:
          type: string
        ImportedFileChunkSize:
          type: integer
          description: For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
        S3:
          $ref: '#/components/schemas/S3DataRepositoryConfiguration'
      required:
      - AssociationId
    UpdateDataRepositoryAssociationResponse:
      type: object
      properties:
        Association:
          $ref: '#/components/schemas/DataRepositoryAssociation'
    DeleteDataRepositoryAssociationRequest:
      type: object
      properties:
        AssociationId:
          type: string
          description: The ID of the data repository association that you want to delete.
        ClientRequestToken:
          type: string
        DeleteDataInFileSystem:
          type: boolean
          description: Set to true to delete the data in the file system that corresponds to the data repository association.
      required:
      - AssociationId
    DescribeDataRepositoryAssociationsRequest:
      type: object
      properties:
        AssociationIds:
          type: array
          items:
            type: string
          description: IDs of the data repository associations whose descriptions you want to retrieve (String).
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
        MaxResults:
          type: integer
          description: The maximum number of resources to return in the response. This value must be an integer greater than zero.
        NextToken:
          type: string
    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
    AutoExportPolicy:
      type: object
      properties:
        Events:
          type: array
          items:
            type: string
            enum:
            - NEW
            - CHANGED
            - DELETED
          description: 'The AutoExportPolicy can have the following event values: NEW - New files and directories are automatically exported to the data repository as they are added to the file system. CHANGED - Changes to files and directories on the file system are automatically exported to the data repository. DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your AutoExportPolicy.'
    BadRequest:
      type: object
      properties:
        Message:
          type: string
    DescribeDataRepositoryAssociationsResponse:
      type: object
      properties:
        Associations:
          type: array
          items:
            $ref: '#/components/schemas/DataRepositoryAssociation'
          description: An array of one or more data repository association descriptions.
        NextToken:
          type: string
    DataRepositoryAssociation:
      type: object
      properties:
        AssociationId:
          type: string
          description: The system-generated, unique ID of the data repository association.
        ResourceARN:
          type: string
        FileSystemId:
          type: string
        Lifecycle:
          type: string
          enum:
          - CREATING
          - AVAILABLE
          - MISCONFIGURED
          - UPDATING
          - DELETING
          - FAILED
          description: 'Describes the state of a data repository association. The lifecycle can have the following values: CREATING - The data repository association between the file system or cache and the data repository is being created. The data repository is unavailable. AVAILABLE - The data repository association is available for use. MISCONFIGURED - The data repository association is misconfigured. Until the configuration is corrected, automatic import and automatic export will not work (only for Amazon FSx for Lustre). UPDATING - The data repository association is undergoing a customer initiated update that m'
        FailureDetails:
          $ref: '#/components/schemas/DataRepositoryFailureDetails'
        FileSystemPath:
          type: string
          description: A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2. This path specifies where in your file system files will be exported from or imported to. This file system directory can be linke
        DataRepositoryPath:
          type: string
          description: 'The path to the data repository that will be linked to the cache or file system. For Amazon File Cache, the path can be an NFS data repository that will be linked to the cache. The path can be in one of two formats: If you are not using the DataRepositorySubdirectories parameter, the path is to an NFS Export directory (or one of its subdirectories) in the format nsf://nfs-domain-name/exportpath. You can therefore link a single NFS Export to a single data repository association. If you are using the DataRepositorySubdirectories parameter, the path is the domain name of the NFS file system in th'
        BatchImportMetaDataOnCreate:
          type: boolean
          description: A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. The task runs if this flag is set to true. BatchImportMetaDataOnCreate is not supported for data repositories linked to an Amazon File Cache resource.
        ImportedFileChunkSize:
          type: integer
          description: For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
        S3:
          $ref: '#/components/schemas/S3DataRepositoryConfiguration'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        CreationTime:
          type: string
          format: date-time
        FileCacheId:
          type: string
          description: The globally unique ID of the Amazon File Cache resource.
        FileCachePath:
          type: string
          description: A path on the Amazon File Cache that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the path is required. Two data repository associations cannot have overlapping cache paths. For example, if a data repository is associated with cache path /ns1/, then you cannot link another data repository with cache path /ns1/ns2. This path specifies the directory in your cache where files will be exported from. This cache directory can be linked to only one data repository (S3 or NFS) and n
        DataRepositorySubdirectories:
          type: array
          items:
            type: string
          description: For Amazon File Cache, a list of NFS Exports that will be linked with an NFS data repository association. All the subdirectories must be on a single NFS file system. The Export paths are in the format /exportpath1. To use this parameter, you must configure DataRepositoryPath as the domain name of the NFS file system. The NFS file system domain name in effect is the root of the subdirectories. Note that DataRepositorySubdirectories is not supported for S3 data repositories.
        NFS:
          $ref: '#/components/schemas/NFSDataRepositoryConfiguration'
    CreateDataRepositoryAssociationRequest:
      type: object
      properties:
        FileSystemId:
          type: string
        FileSystemPath:
          type: string
          description: A path on the file system that points to a high-level directory (such as /ns1/) or subdirectory (such as /ns1/subdir/) that will be mapped 1-1 with DataRepositoryPath. The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/, then you cannot link another data repository with file system path /ns1/ns2. This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S
        DataRepositoryPath:
          type: string
          description: The path to the Amazon S3 data repository that will be linked to the file system. The path can be an S3 bucket or prefix in the format s3://bucket-name/prefix/ (where prefix is optional). This path specifies where in the S3 data repository files will be imported from or exported to.
        BatchImportMetaDataOnCreate:
          type: boolean
          description: Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Default is false.
        ImportedFileChunkSize:
          type: integer
          description: For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
        S3:
          $ref: '#/components/schemas/S3DataRepositoryConfiguration'
        ClientRequestToken:
          type: string
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
      required:
      - FileSystemId
      - DataRepositoryPath
    S3DataRepositoryConfiguration:
      type: object
      properties:
        AutoImportPolicy:
          $ref: '#/components/schemas/AutoImportPolicy'
        AutoExportPolicy:
          $ref: '#/components/schemas/AutoExportPolicy'
    AutoImportPolicy:
      type: object
      properties:
        Events:
          type: array
          items:
            type: string
            enum:
            - NEW
            - CHANGED
            - DELETED
          description: 'The AutoImportPolicy can have the following event values: NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. You can define any combination of event types for your AutoImportPolicy.'
    NFSDataRepositoryConfiguration:
      type: object
      properties:
        Version:
          type: string
          enum:
          - NFS3
          description: The version of the NFS (Network File System) protocol of the NFS data repository. Currently, the only supported value is NFS3, which indicates that the data repository must support the NFSv3 protocol.
        DnsIps:
          type: array
          items:
            type: string
          description: A list of up to 2 IP addresses of DNS servers used to resolve the NFS file system domain name. The provided IP addresses can either be the IP addresses of a DNS forwarder or resolver that the customer manages and runs inside the customer VPC, or the IP addresses of the on-premises DNS servers.
        AutoExportPolicy:
          $ref: '#/components/schemas/AutoExportPolicy'
      required:
      - Version
    CreateDataRepositoryAssociationResponse:
      type: object
      properties:
        Association:
          $ref: '#/components/schemas/DataRepositoryAssociation'
    DeleteDataRepositoryAssociationResponse:
      type: object
      properties:
        AssociationId:
          type: string
          description: The ID of the data repository association being deleted.
        Lifecycle:
          type: string
          enum:
          - CREATING
          - AVAILABLE
          - MISCONFIGURED
          - UPDATING
          - DELETING
          - FAILED
          description: Describes the lifecycle state of the data repository association being deleted.
        DeleteDataInFileSystem:
          type: boolean
          description: Indicates whether data in the file system that corresponds to the data repository association is being deleted. Default is false.
  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)