Amazon Storage Gateway #X Amz Target=StorageGateway 20130630.UpdateFileSystemAssociation API

The #X Amz Target=StorageGateway 20130630.UpdateFileSystemAssociation API from Amazon Storage Gateway — 1 operation(s) for #x amz target=storagegateway 20130630.updatefilesystemassociation.

OpenAPI Specification

amazon-storage-gateway-x-amz-target-storagegateway-20130630-updatefilesystemassociation-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: 'Amazon Storage Gateway REST Amazon Storage Gateway REST API #X Amz Target=StorageGateway 20130630.UpdateFileSystemAssociation API'
  description: AWS Storage Gateway is a hybrid cloud storage service that gives you on-premises access to virtually unlimited cloud storage. This API enables management of gateways, volumes, virtual tapes, file shares, and cached storage resources.
  version: '2013-06-30'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://aws.amazon.com/service-terms/
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://storagegateway.{region}.amazonaws.com
  description: Amazon Storage Gateway regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-central-1
      - ap-northeast-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
security:
- sigv4: []
tags:
- name: '#X Amz Target=StorageGateway 20130630.UpdateFileSystemAssociation'
paths:
  /#X-Amz-Target=StorageGateway_20130630.UpdateFileSystemAssociation:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: UpdateFileSystemAssociation
      description: Updates a file system association. This operation is only supported in the FSx File Gateways.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFileSystemAssociationOutput'
        '480':
          description: InvalidGatewayRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidGatewayRequestException'
        '481':
          description: InternalServerError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFileSystemAssociationInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StorageGateway_20130630.UpdateFileSystemAssociation
      tags:
      - '#X Amz Target=StorageGateway 20130630.UpdateFileSystemAssociation'
components:
  schemas:
    InternalServerError: {}
    DomainUserPassword:
      type: string
      pattern: ^[ -~]+$
      minLength: 1
      maxLength: 1024
      format: password
    CacheAttributes:
      type: object
      properties:
        CacheStaleTimeoutInSeconds:
          allOf:
          - $ref: '#/components/schemas/CacheStaleTimeoutInSeconds'
          - description: <p>Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL duration is in seconds.</p> <p>Valid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)</p>
      description: The refresh cache information for the file share or FSx file systems.
    UpdateFileSystemAssociationInput:
      type: object
      required:
      - FileSystemAssociationARN
      title: UpdateFileSystemAssociationInput
      properties:
        FileSystemAssociationARN:
          allOf:
          - $ref: '#/components/schemas/FileSystemAssociationARN'
          - description: The Amazon Resource Name (ARN) of the file system association that you want to update.
        UserName:
          allOf:
          - $ref: '#/components/schemas/DomainUserName'
          - description: The user name of the user credential that has permission to access the root share D$ of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group.
        Password:
          allOf:
          - $ref: '#/components/schemas/DomainUserPassword'
          - description: The password of the user credential.
        AuditDestinationARN:
          allOf:
          - $ref: '#/components/schemas/AuditDestinationARN'
          - description: The Amazon Resource Name (ARN) of the storage used for the audit logs.
        CacheAttributes:
          $ref: '#/components/schemas/CacheAttributes'
    DomainUserName:
      type: string
      pattern: ^\w[\w\.\- ]*$
      minLength: 1
      maxLength: 1024
    UpdateFileSystemAssociationOutput:
      type: object
      properties:
        FileSystemAssociationARN:
          allOf:
          - $ref: '#/components/schemas/FileSystemAssociationARN'
          - description: The ARN of the updated file system association.
    AuditDestinationARN:
      type: string
      maxLength: 1024
    InvalidGatewayRequestException: {}
    FileSystemAssociationARN:
      type: string
      minLength: 50
      maxLength: 500
    CacheStaleTimeoutInSeconds:
      type: integer
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4
externalDocs:
  description: Amazon Storage Gateway API Reference
  url: https://docs.aws.amazon.com/storagegateway/latest/APIReference/Welcome.html