Amazon FSx Fsx File Cache API

openapi: 3.2.0
info:
  title: Amazon FSx File Cache 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: File Cache
paths:
  /#CreateFileCache:
    post:
      operationId: CreateFileCache
      summary: Create File Cache
      description: 'Creates a new Amazon File Cache resource. You can use this operation with a client request token in the request that Amazon File Cache uses to ensure idempotent creation. If a cache with the specified client request token exists and the parameters match, CreateFileCache returns the description of the existing cache. If a cache with the specified client request token exists and the parameters don''t match, this call returns IncompatibleParameterError. If a file cache with the specified client request token doesn''t exist, CreateFileCache does the following: Creates a new, empty Amazon File Cache resource with an assigned ID, and an initial lifecycle state of CREATING. Returns the description of the cache in JSON format. The CreateFileCache call returns while the cache''s lifecycle state is still CREATING. You can check the cache creation status by calling the DescribeFileCaches operation, which returns the cache state along with other information.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateFileCacheResponse'
        '400':
          description: BadRequest; IncompatibleParameterError; InvalidNetworkSettings; InvalidPerUnitStorageThroughput; MissingFileCacheConfiguration; 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.CreateFileCache
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateFileCacheRequest'
      tags:
      - File Cache
  /#DeleteFileCache:
    post:
      operationId: DeleteFileCache
      summary: Delete File Cache
      description: Deletes an Amazon File Cache resource. After deletion, the cache no longer exists, and its data is gone. The DeleteFileCache operation returns while the cache has the DELETING status. You can check the cache deletion status by calling the DescribeFileCaches operation, which returns a list of caches in your account. If you pass the cache ID for a deleted cache, the DescribeFileCaches operation returns a FileCacheNotFound error. The data in a deleted cache is also deleted and can't be recovered by any means.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteFileCacheResponse'
        '400':
          description: BadRequest; FileCacheNotFound; 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.DeleteFileCache
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteFileCacheRequest'
      tags:
      - File Cache
  /#DescribeFileCaches:
    post:
      operationId: DescribeFileCaches
      summary: Describe File Caches
      description: 'Returns the description of a specific Amazon File Cache resource, if a FileCacheIds value is provided for that cache. Otherwise, it returns descriptions of all caches owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you''re calling. When retrieving all cache descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more cache descriptions remain, the operation returns a NextToken value 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. This operation is used in an iterative process to retrieve a list of your cache descriptions. DescribeFileCaches is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken. When using this operation, keep the following in mind: The implementation might return fewer than MaxResults cache descriptions while still including a NextToken value. The order of caches returned in the response of one DescribeFileCaches call and the'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeFileCachesResponse'
        '400':
          description: BadRequest; FileCacheNotFound
          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.DescribeFileCaches
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeFileCachesRequest'
      tags:
      - File Cache
  /#UpdateFileCache:
    post:
      operationId: UpdateFileCache
      summary: Update File Cache
      description: Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateFileCacheResponse'
        '400':
          description: BadRequest; FileCacheNotFound; IncompatibleParameterError; MissingFileCacheConfiguration; 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.UpdateFileCache
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateFileCacheRequest'
      tags:
      - File Cache
components:
  schemas:
    UpdateFileCacheResponse:
      type: object
      properties:
        FileCache:
          $ref: '#/components/schemas/FileCache'
    DescribeFileCachesResponse:
      type: object
      properties:
        FileCaches:
          type: array
          items:
            $ref: '#/components/schemas/FileCache'
          description: The response object for the DescribeFileCaches operation.
        NextToken:
          type: string
    UpdateFileCacheLustreConfiguration:
      type: object
      properties:
        WeeklyMaintenanceStartTime:
          type: string
    FileCacheCreating:
      type: object
      properties:
        OwnerId:
          type: string
        CreationTime:
          type: string
          format: date-time
        FileCacheId:
          type: string
          description: The system-generated, unique ID of the cache.
        FileCacheType:
          type: string
          enum:
          - LUSTRE
          description: The type of cache, which must be LUSTRE.
        FileCacheTypeVersion:
          type: string
          description: The Lustre version of the cache, which must be 2.12.
        Lifecycle:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - DELETING
          - UPDATING
          - FAILED
          description: 'The lifecycle status of the cache. The following are the possible values and what they mean: AVAILABLE - The cache is in a healthy state, and is reachable and available for use. CREATING - The new cache is being created. DELETING - An existing cache is being deleted. UPDATING - The cache is undergoing a customer-initiated update. FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.'
        FailureDetails:
          $ref: '#/components/schemas/FileCacheFailureDetails'
        StorageCapacity:
          type: integer
          description: The storage capacity of the cache in gibibytes (GiB).
        VpcId:
          type: string
        SubnetIds:
          type: array
          items:
            type: string
        NetworkInterfaceIds:
          type: array
          items:
            type: string
        DNSName:
          type: string
          description: The Domain Name System (DNS) name for the cache.
        KmsKeyId:
          type: string
          description: Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
        ResourceARN:
          type: string
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        CopyTagsToDataRepositoryAssociations:
          type: boolean
          description: A boolean flag indicating whether tags for the cache should be copied to data repository associations.
        LustreConfiguration:
          $ref: '#/components/schemas/FileCacheLustreConfiguration'
        DataRepositoryAssociationIds:
          type: array
          items:
            type: string
          description: A list of IDs of data repository associations that are associated with this cache.
    DeleteFileCacheRequest:
      type: object
      properties:
        FileCacheId:
          type: string
          description: The ID of the cache that's being deleted.
        ClientRequestToken:
          type: string
      required:
      - FileCacheId
    CreateFileCacheResponse:
      type: object
      properties:
        FileCache:
          $ref: '#/components/schemas/FileCacheCreating'
    CreateFileCacheRequest:
      type: object
      properties:
        ClientRequestToken:
          type: string
          description: An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK. By using the idempotent operation, you can retry a CreateFileCache operation without the risk of creating an extra cache. This approach can be useful when an initial call fails in a way that makes it unclear whether a cache was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call create
        FileCacheType:
          type: string
          enum:
          - LUSTRE
          description: The type of cache that you're creating, which must be LUSTRE.
        FileCacheTypeVersion:
          type: string
          description: Sets the Lustre version for the cache that you're creating, which must be 2.12.
        StorageCapacity:
          type: integer
          description: The storage capacity of the cache in gibibytes (GiB). Valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
        SubnetIds:
          type: array
          items:
            type: string
        SecurityGroupIds:
          type: array
          items:
            type: string
          description: A list of IDs specifying the security groups to apply to all network interfaces created for Amazon File Cache access. This list isn't returned in later requests to describe the cache.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        CopyTagsToDataRepositoryAssociations:
          type: boolean
          description: A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false.
        KmsKeyId:
          type: string
          description: Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
        LustreConfiguration:
          $ref: '#/components/schemas/CreateFileCacheLustreConfiguration'
        DataRepositoryAssociations:
          type: array
          items:
            $ref: '#/components/schemas/FileCacheDataRepositoryAssociation'
          description: 'A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can''t link to different data repository types at the same time. An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automati'
      required:
      - FileCacheType
      - FileCacheTypeVersion
      - StorageCapacity
      - SubnetIds
    UpdateFileCacheRequest:
      type: object
      properties:
        FileCacheId:
          type: string
          description: The ID of the cache that you are updating.
        ClientRequestToken:
          type: string
        LustreConfiguration:
          $ref: '#/components/schemas/UpdateFileCacheLustreConfiguration'
      required:
      - FileCacheId
    LustreLogConfiguration:
      type: object
      properties:
        Level:
          type: string
          enum:
          - DISABLED
          - WARN_ONLY
          - ERROR_ONLY
          - WARN_ERROR
          description: The data repository events that are logged by Amazon FSx. WARN_ONLY - only warning events are logged. ERROR_ONLY - only error events are logged. WARN_ERROR - both warning events and error events are logged. DISABLED - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of WARN_ERROR, which can't be changed.
        Destination:
          type: string
          description: The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system.
      required:
      - Level
    BadRequest:
      type: object
      properties:
        Message:
          type: string
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    FileCache:
      type: object
      properties:
        OwnerId:
          type: string
        CreationTime:
          type: string
          format: date-time
        FileCacheId:
          type: string
          description: The system-generated, unique ID of the cache.
        FileCacheType:
          type: string
          enum:
          - LUSTRE
          description: The type of cache, which must be LUSTRE.
        FileCacheTypeVersion:
          type: string
          description: The Lustre version of the cache, which must be 2.12.
        Lifecycle:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - DELETING
          - UPDATING
          - FAILED
          description: 'The lifecycle status of the cache. The following are the possible values and what they mean: AVAILABLE - The cache is in a healthy state, and is reachable and available for use. CREATING - The new cache is being created. DELETING - An existing cache is being deleted. UPDATING - The cache is undergoing a customer-initiated update. FAILED - An existing cache has experienced an unrecoverable failure. When creating a new cache, the cache was unable to be created.'
        FailureDetails:
          $ref: '#/components/schemas/FileCacheFailureDetails'
        StorageCapacity:
          type: integer
          description: The storage capacity of the cache in gibibytes (GiB).
        VpcId:
          type: string
        SubnetIds:
          type: array
          items:
            type: string
        NetworkInterfaceIds:
          type: array
          items:
            type: string
        DNSName:
          type: string
          description: The Domain Name System (DNS) name for the cache.
        KmsKeyId:
          type: string
          description: Specifies the ID of the Key Management Service (KMS) key to use for encrypting data on an Amazon File Cache. If a KmsKeyId isn't specified, the Amazon FSx-managed KMS key for your account is used. For more information, see Encrypt in the Key Management Service API Reference.
        ResourceARN:
          type: string
        LustreConfiguration:
          $ref: '#/components/schemas/FileCacheLustreConfiguration'
        DataRepositoryAssociationIds:
          type: array
          items:
            type: string
          description: A list of IDs of data repository associations that are associated with this cache.
    FileCacheLustreConfiguration:
      type: object
      properties:
        PerUnitStorageThroughput:
          type: integer
          description: Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. Cache throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). The only supported value is 1000.
        DeploymentType:
          type: string
          enum:
          - CACHE_1
          description: The deployment type of the Amazon File Cache resource, which must be CACHE_1.
        MountName:
          type: string
          description: You use the MountName value when mounting the cache. If you pass a cache ID to the DescribeFileCaches operation, it returns the the MountName value as part of the cache's description.
        WeeklyMaintenanceStartTime:
          type: string
        MetadataConfiguration:
          $ref: '#/components/schemas/FileCacheLustreMetadataConfiguration'
        LogConfiguration:
          $ref: '#/components/schemas/LustreLogConfiguration'
    DeleteFileCacheResponse:
      type: object
      properties:
        FileCacheId:
          type: string
          description: The ID of the cache that's being deleted.
        Lifecycle:
          type: string
          enum:
          - AVAILABLE
          - CREATING
          - DELETING
          - UPDATING
          - FAILED
          description: The cache lifecycle for the deletion request. If the DeleteFileCache operation is successful, this status is DELETING.
    FileCacheFailureDetails:
      type: object
      properties:
        Message:
          type: string
          description: A message describing any failures that occurred.
    CreateFileCacheLustreConfiguration:
      type: object
      properties:
        PerUnitStorageThroughput:
          type: integer
          description: Provisions the amount of read and write throughput for each 1 tebibyte (TiB) of cache storage capacity, in MB/s/TiB. The only supported value is 1000.
        DeploymentType:
          type: string
          enum:
          - CACHE_1
          description: Specifies the cache deployment type, which must be CACHE_1.
        WeeklyMaintenanceStartTime:
          type: string
        MetadataConfiguration:
          $ref: '#/components/schemas/FileCacheLustreMetadataConfiguration'
      required:
      - PerUnitStorageThroughput
      - DeploymentType
      - MetadataConfiguration
    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
    DescribeFileCachesRequest:
      type: object
      properties:
        FileCacheIds:
          type: array
          items:
            type: string
          description: IDs of the caches whose descriptions you want to retrieve (String).
        MaxResults:
          type: integer
        NextToken:
          type: string
    FileCacheNFSConfiguration:
      type: object
      properties:
        Version:
          type: string
          enum:
          - NFS3
          description: The version of the NFS (Network File System) protocol of the NFS data repository. 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.
      required:
      - Version
    FileCacheDataRepositoryAssociation:
      type: object
      properties:
        FileCachePath:
          type: string
          description: A path on the 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 name 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 where in your cache files will be exported from. This cache directory can be linked to only one data repository, and no data repository other can be linked
        DataRepositoryPath:
          type: string
          description: 'The path to the S3 or NFS data repository that links to the cache. You must provide one of the following paths: The path can be an NFS data repository that links 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 nfs://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 the'
        DataRepositorySubdirectories:
          type: array
          items:
            type: string
          description: A list of NFS Exports that will be linked with this data repository association. 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/FileCacheNFSConfiguration'
      required:
      - FileCachePath
      - DataRepositoryPath
    FileCacheLustreMetadataConfiguration:
      type: object
      properties:
        StorageCapacity:
          type: integer
          description: The storage capacity of the Lustre MDT (Metadata Target) storage volume in gibibytes (GiB). The only supported value is 2400 GiB.
      required:
      - StorageCapacity
  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)