Amazon Storage Gateway Storage Gateway Cache Report API

openapi: 3.2.0
info:
  title: AWS Storage Gateway Cache Report API
  version: '2013-06-30'
  description: Generated from AWS's published Smithy model for AWS Storage Gateway. 5 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: Cache Report
paths:
  /#CancelCacheReport:
    post:
      operationId: CancelCacheReport
      summary: Cancel Cache Report
      description: Cancels generation of a specified cache report. You can use this operation to manually cancel an IN-PROGRESS report for any reason. This action changes the report status from IN-PROGRESS to CANCELLED. You can only cancel in-progress reports. If the the report you attempt to cancel is in FAILED, ERROR, or COMPLETED state, the cancel operation returns an error.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CancelCacheReportOutput'
        '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.CancelCacheReport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CancelCacheReportInput'
      tags:
      - Cache Report
  /#DeleteCacheReport:
    post:
      operationId: DeleteCacheReport
      summary: Delete Cache Report
      description: Deletes the specified cache report and any associated tags from the Storage Gateway database. You can only delete completed reports. If the status of the report you attempt to delete still IN-PROGRESS, the delete operation returns an error. You can use CancelCacheReport to cancel an IN-PROGRESS report. DeleteCacheReport does not delete the report object from your Amazon S3 bucket.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteCacheReportOutput'
        '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.DeleteCacheReport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteCacheReportInput'
      tags:
      - Cache Report
  /#DescribeCacheReport:
    post:
      operationId: DescribeCacheReport
      summary: Describe Cache Report
      description: Returns information about the specified cache report, including completion status and generation progress.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeCacheReportOutput'
        '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.DescribeCacheReport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeCacheReportInput'
      tags:
      - Cache Report
  /#ListCacheReports:
    post:
      operationId: ListCacheReports
      summary: List Cache Reports
      description: Returns a list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the DescribeCacheReport action, such as report name, status, completion progress, start time, end time, filters, and tags.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListCacheReportsOutput'
        '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.ListCacheReports
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListCacheReportsInput'
      tags:
      - Cache Report
  /#StartCacheReport:
    post:
      operationId: StartCacheReport
      summary: Start Cache Report
      description: 'Starts generating a report of the file metadata currently cached by an S3 File Gateway for a specific file share. You can use this report to identify and resolve issues if you have files failing upload from your gateway to Amazon S3. The report is a CSV file containing a list of files which match the set of filter parameters you specify in the request. The Files Failing Upload flag is reset every 24 hours and during gateway reboot. If this report captures the files after the reset, but before they become flagged again, they will not be reported as Files Failing Upload. The following requirements must be met to successfully generate a cache report: You must have s3:PutObject and s3:AbortMultipartUpload permissions for the Amazon S3 bucket where you want to store the cache report. No other cache reports can currently be in-progress for the specified file share. There must be fewer than 10 existing cache reports for the specified file share. The gateway must be online and connected to Amazon Web Services. The root disk must have at least 20GB of free space when report generation starts. You must specify at least one value for InclusionFilters or ExclusionFilters in the request.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartCacheReportOutput'
        '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.StartCacheReport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartCacheReportInput'
      tags:
      - Cache Report
components:
  schemas:
    CacheReportInfo:
      type: object
      properties:
        CacheReportARN:
          type: string
          description: The Amazon Resource Name (ARN) of the cache report you want to describe.
        CacheReportStatus:
          type: string
          enum:
          - IN_PROGRESS
          - COMPLETED
          - CANCELED
          - FAILED
          - ERROR
          description: The status of the specified cache report.
        ReportCompletionPercent:
          type: integer
          description: The percentage of the report generation process that has been completed at time of inquiry.
        EndTime:
          type: string
          format: date-time
          description: The time at which the gateway stopped generating the cache report.
        Role:
          type: string
        FileShareARN:
          type: string
        LocationARN:
          type: string
          description: The ARN of the Amazon S3 bucket location where the cache report is saved.
        StartTime:
          type: string
          format: date-time
          description: The time at which the gateway started generating the cache report.
        InclusionFilters:
          type: array
          items:
            $ref: '#/components/schemas/CacheReportFilter'
          description: The list of filters and parameters that determine which files are included in the report.
        ExclusionFilters:
          type: array
          items:
            $ref: '#/components/schemas/CacheReportFilter'
          description: The list of filters and parameters that determine which files are excluded from the report.
        ReportName:
          type: string
          description: The file name of the completed cache report object stored in Amazon S3.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The list of key/value tags associated with the report.
    DescribeCacheReportOutput:
      type: object
      properties:
        CacheReportInfo:
          $ref: '#/components/schemas/CacheReportInfo'
    StartCacheReportInput:
      type: object
      properties:
        FileShareARN:
          type: string
        Role:
          type: string
          description: The ARN of the IAM role used when saving the cache report to Amazon S3.
        LocationARN:
          type: string
          description: The ARN of the Amazon S3 bucket where you want to save the cache report. We do not recommend saving the cache report to the same Amazon S3 bucket for which you are generating the report. This field does not accept access point ARNs.
        BucketRegion:
          type: string
          description: The Amazon Web Services Region of the Amazon S3 bucket where you want to save the cache report.
        VPCEndpointDNSName:
          type: string
          description: The DNS name of the VPC endpoint associated with the Amazon S3 where you want to save the cache report. Optional.
        InclusionFilters:
          type: array
          items:
            $ref: '#/components/schemas/CacheReportFilter'
          description: The list of filters and parameters that determine which files are included in the report. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.
        ExclusionFilters:
          type: array
          items:
            $ref: '#/components/schemas/CacheReportFilter'
          description: The list of filters and parameters that determine which files are excluded from the report. You must specify at least one value for InclusionFilters or ExclusionFilters in a StartCacheReport request.
        ClientToken:
          type: string
          description: A unique identifier that you use to ensure idempotent report generation if you need to retry an unsuccessful StartCacheReport request. If you retry a request, use the same ClientToken you specified in the initial request.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of up to 50 key/value tags that you can assign to the cache report. Using tags can help you categorize your reports and more easily locate them in search results.
      required:
      - FileShareARN
      - Role
      - LocationARN
      - BucketRegion
      - ClientToken
    DescribeCacheReportInput:
      type: object
      properties:
        CacheReportARN:
          type: string
          description: The Amazon Resource Name (ARN) of the cache report you want to describe.
      required:
      - CacheReportARN
    ListCacheReportsOutput:
      type: object
      properties:
        CacheReportList:
          type: array
          items:
            $ref: '#/components/schemas/CacheReportInfo'
          description: A list of existing cache reports for all file shares associated with your Amazon Web Services account. This list includes all information provided by the DescribeCacheReport action, such as report status, completion progress, start time, end time, filters, and tags.
        Marker:
          type: string
          description: If the request includes Marker, the response returns that value in this field.
    CacheReportFilter:
      type: object
      properties:
        Name:
          type: string
          enum:
          - UploadState
          - UploadFailureReason
          description: 'The parameter name for a filter that determines which files are included or excluded from a cache report. Valid Names: UploadFailureReason | UploadState'
        Values:
          type: array
          items:
            type: string
          description: 'The parameter value for a filter that determines which files are included or excluded from a cache report. Valid UploadFailureReason Values: InaccessibleStorageClass | InvalidObjectState | ObjectMissing | S3AccessDenied Valid UploadState Values: FailingUpload'
      required:
      - Name
      - Values
    DeleteCacheReportInput:
      type: object
      properties:
        CacheReportARN:
          type: string
          description: The Amazon Resource Name (ARN) of the cache report you want to delete.
      required:
      - CacheReportARN
    StartCacheReportOutput:
      type: object
      properties:
        CacheReportARN:
          type: string
          description: The Amazon Resource Name (ARN) of the cache report generated by the StartCacheReport request.
    CancelCacheReportInput:
      type: object
      properties:
        CacheReportARN:
          type: string
          description: The Amazon Resource Name (ARN) of the cache report you want to cancel.
      required:
      - CacheReportARN
    DeleteCacheReportOutput:
      type: object
      properties:
        CacheReportARN:
          type: string
          description: The Amazon Resource Name (ARN) of the cache report you want to delete.
    InternalServerError:
      type: object
      properties:
        message:
          type: string
          description: A human-readable message describing the error that occurred.
        error:
          $ref: '#/components/schemas/StorageGatewayError'
    ListCacheReportsInput:
      type: object
      properties:
        Marker:
          type: string
          description: Opaque pagination token returned from a previous ListCacheReports operation. If present, Marker specifies where to continue the list from after a previous call to ListCacheReports. Optional.
    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.
    CancelCacheReportOutput:
      type: object
      properties:
        CacheReportARN:
          type: string
          description: The Amazon Resource Name (ARN) of the cache report you want to cancel.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: Tag key. The key can't start with aws:.
        Value:
          type: string
          description: Value of the tag key.
      required:
      - Key
      - Value
  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)