Amazon Storage Gateway Storage Gateway Operations API

openapi: 3.2.0
info:
  title: AWS Storage Gateway Operations API
  version: '2013-06-30'
  description: Generated from AWS's published Smithy model for AWS Storage Gateway. 9 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://storagegateway.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /#EvictFilesFailingUpload:
    post:
      operationId: EvictFilesFailingUpload
      summary: Evict Files Failing Upload
      description: Starts a process that cleans the specified file share's cache of file entries that are failing upload to Amazon S3. This API operation reports success if the request is received with valid arguments, and there are no other cache clean operations currently in-progress for the specified file share. After a successful request, the cache clean operation occurs asynchronously and reports progress using CloudWatch logs and notifications. If ForceRemove is set to True, the cache clean operation will delete file data from the gateway which might otherwise be recoverable. We recommend using this operation only after all other methods to clear files failing upload have been exhausted, and if your business need outweighs the potential data loss.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EvictFilesFailingUploadOutput'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidGatewayRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidGatewayRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StorageGateway_20130630.EvictFilesFailingUpload
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/EvictFilesFailingUploadInput'
      tags:
      - Operations
components:
  schemas:
    EvictFilesFailingUploadInput:
      type: object
      properties:
        FileShareARN:
          type: string
          description: The Amazon Resource Name (ARN) of the file share for which you want to start the cache clean operation.
        ForceRemove:
          type: boolean
          description: 'Specifies whether cache entries with full or partial file data currently stored on the gateway will be forcibly removed by the cache clean operation. Valid arguments: False - The cache clean operation skips cache entries failing upload if they are associated with data currently stored on the gateway. This preserves the cached data. True - The cache clean operation removes cache entries failing upload even if they are associated with data currently stored on the gateway. This deletes the cached data. If ForceRemove is set to True, the cache clean operation will delete file data from the gateway'
      required:
      - FileShareARN
    EvictFilesFailingUploadOutput:
      type: object
      properties:
        NotificationId:
          type: string
          description: The randomly generated ID of the CloudWatch notification associated with the cache clean operation. This ID is in UUID format.
    InternalServerError:
      type: object
      properties:
        message:
          type: string
          description: A human-readable message describing the error that occurred.
        error:
          $ref: '#/components/schemas/StorageGatewayError'
    InvalidGatewayRequestException:
      type: object
      properties:
        message:
          type: string
          description: A human-readable message describing the error that occurred.
        error:
          $ref: '#/components/schemas/StorageGatewayError'
    StorageGatewayError:
      type: object
      properties:
        errorCode:
          type: string
          enum:
          - ActivationKeyExpired
          - ActivationKeyInvalid
          - ActivationKeyNotFound
          - GatewayInternalError
          - GatewayNotConnected
          - GatewayNotFound
          - GatewayProxyNetworkConnectionBusy
          - AuthenticationFailure
          - BandwidthThrottleScheduleNotFound
          - Blocked
          - CannotExportSnapshot
          - ChapCredentialNotFound
          - DiskAlreadyAllocated
          - DiskDoesNotExist
          - DiskSizeGreaterThanVolumeMaxSize
          - DiskSizeLessThanVolumeSize
          - DiskSizeNotGigAligned
          - DuplicateCertificateInfo
          - DuplicateSchedule
          - EndpointNotFound
          - IAMNotSupported
          - InitiatorInvalid
          - InitiatorNotFound
          - InternalError
          - InvalidGateway
          - InvalidEndpoint
          - InvalidParameters
          - InvalidSchedule
          - LocalStorageLimitExceeded
          - 'LunAlreadyAllocated '
          - LunInvalid
          - JoinDomainInProgress
          - MaximumContentLengthExceeded
          - MaximumTapeCartridgeCountExceeded
          - MaximumVolumeCountExceeded
          - NetworkConfigurationChanged
          - NoDisksAvailable
          - NotImplemented
          - NotSupported
          - OperationAborted
          - OutdatedGateway
          - ParametersNotImplemented
          - RegionInvalid
          - RequestTimeout
          - ServiceUnavailable
          - SnapshotDeleted
          - SnapshotIdInvalid
          - SnapshotInProgress
          - SnapshotNotFound
          - SnapshotScheduleNotFound
          - StagingAreaFull
          - StorageFailure
          - TapeCartridgeNotFound
          - TargetAlreadyExists
          - TargetInvalid
          - TargetNotFound
          - UnauthorizedOperation
          - VolumeAlreadyExists
          - VolumeIdInvalid
          - VolumeInUse
          - VolumeNotFound
          - VolumeNotReady
          description: Additional information about the error.
        errorDetails:
          type: object
          additionalProperties:
            type: string
          description: Human-readable text that provides detail about the error that occurred.
  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: storagegateway
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/storage-gateway/service/2013-06-30/storage-gateway-2013-06-30.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)