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

openapi: 3.1.0
info:
  title: 'Amazon Storage Gateway REST Amazon Storage Gateway REST API #X Amz Target=StorageGateway 20130630.DescribeTapes 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.DescribeTapes'
paths:
  /#X-Amz-Target=StorageGateway_20130630.DescribeTapes:
    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: DescribeTapes
      description: Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a <code>TapeARN</code> is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeTapesOutput'
        '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/DescribeTapesInput'
      parameters:
      - name: Limit
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: Marker
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - StorageGateway_20130630.DescribeTapes
      tags:
      - '#X Amz Target=StorageGateway 20130630.DescribeTapes'
components:
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      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-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    PoolId:
      type: string
      minLength: 1
      maxLength: 100
    DescribeTapesInput:
      type: object
      required:
      - GatewayARN
      title: DescribeTapesInput
      properties:
        GatewayARN:
          $ref: '#/components/schemas/GatewayARN'
        TapeARNs:
          allOf:
          - $ref: '#/components/schemas/TapeARNs'
          - description: Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.
        Marker:
          allOf:
          - $ref: '#/components/schemas/Marker'
          - description: <p>A marker value, obtained in a previous call to <code>DescribeTapes</code>. This marker indicates which page of results to retrieve.</p> <p>If not specified, the first page of results is retrieved.</p>
        Limit:
          allOf:
          - $ref: '#/components/schemas/PositiveIntObject'
          - description: <p>Specifies that the number of virtual tapes described be limited to the specified number.</p> <note> <p>Amazon Web Services may impose its own limit, if this field is not set.</p> </note>
      description: DescribeTapesInput
    Marker:
      type: string
      minLength: 1
      maxLength: 1000
    TapeStatus:
      type: string
    GatewayARN:
      type: string
      description: The Amazon Resource Name (ARN) of the gateway. Use the <a>ListGateways</a> operation to return a list of gateways for your account and Amazon Web Services Region.
      minLength: 50
      maxLength: 500
    InvalidGatewayRequestException: {}
    TapeARN:
      type: string
      pattern: ^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\-0-9]+:[0-9]+:tape\/[0-9A-Z]{5,16}$
      minLength: 50
      maxLength: 500
    DoubleObject:
      type: number
      format: double
    KMSKey:
      type: string
      pattern: (^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)
      description: The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when <code>KMSEncrypted</code> is <code>true</code>. Optional.
      minLength: 7
      maxLength: 2048
    PositiveIntObject:
      type: integer
      minimum: 1
    Tapes:
      type: array
      items:
        $ref: '#/components/schemas/Tape'
    Tape:
      type: object
      properties:
        TapeARN:
          allOf:
          - $ref: '#/components/schemas/TapeARN'
          - description: The Amazon Resource Name (ARN) of the virtual tape.
        TapeBarcode:
          allOf:
          - $ref: '#/components/schemas/TapeBarcode'
          - description: The barcode that identifies a specific virtual tape.
        TapeCreatedDate:
          allOf:
          - $ref: '#/components/schemas/Time'
          - description: The date the virtual tape was created.
        TapeSizeInBytes:
          allOf:
          - $ref: '#/components/schemas/TapeSize'
          - description: The size, in bytes, of the virtual tape capacity.
        TapeStatus:
          allOf:
          - $ref: '#/components/schemas/TapeStatus'
          - description: The current state of the virtual tape.
        VTLDevice:
          allOf:
          - $ref: '#/components/schemas/VTLDeviceARN'
          - description: The virtual tape library (VTL) device that the virtual tape is associated with.
        Progress:
          allOf:
          - $ref: '#/components/schemas/DoubleObject'
          - description: '<p>For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.</p> <p>Range: 0 (not started) to 100 (complete).</p>'
        TapeUsedInBytes:
          allOf:
          - $ref: '#/components/schemas/TapeUsage'
          - description: <p>The size, in bytes, of data stored on the virtual tape.</p> <note> <p>This value is not available for tapes created prior to May 13, 2015.</p> </note>
        KMSKey:
          $ref: '#/components/schemas/KMSKey'
        PoolId:
          allOf:
          - $ref: '#/components/schemas/PoolId'
          - description: The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
        Worm:
          allOf:
          - $ref: '#/components/schemas/boolean'
          - description: If the tape is archived as write-once-read-many (WORM), this value is <code>true</code>.
        RetentionStartDate:
          allOf:
          - $ref: '#/components/schemas/Time'
          - description: The date that the tape is first archived with tape retention lock enabled.
        PoolEntryDate:
          allOf:
          - $ref: '#/components/schemas/Time'
          - description: The date that the tape enters a custom tape pool.
      description: Describes a virtual tape object.
    TapeSize:
      type: integer
    TapeBarcode:
      type: string
      pattern: ^[A-Z0-9]*$
      minLength: 5
      maxLength: 16
    TapeARNs:
      type: array
      description: The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.
      items:
        $ref: '#/components/schemas/TapeARN'
    InternalServerError: {}
    boolean:
      type: boolean
    Time:
      type: string
      format: date-time
    TapeUsage:
      type: integer
    VTLDeviceARN:
      type: string
      minLength: 50
      maxLength: 500
    DescribeTapesOutput:
      type: object
      example:
        Marker: '1'
        Tapes:
        - TapeARN: arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1
          TapeBarcode: TEST04A2A1
          TapeSizeInBytes: 107374182400
          TapeStatus: AVAILABLE
        - TapeARN: arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0
          TapeBarcode: TEST05A2A0
          TapeSizeInBytes: 107374182400
          TapeStatus: AVAILABLE
      properties:
        Tapes:
          allOf:
          - $ref: '#/components/schemas/Tapes'
          - description: An array of virtual tape descriptions.
        Marker:
          allOf:
          - $ref: '#/components/schemas/Marker'
          - description: <p>An opaque string that can be used as part of a subsequent <code>DescribeTapes</code> call to retrieve the next page of results.</p> <p>If a response does not contain a marker, then there are no more results to be retrieved.</p>
      description: DescribeTapesOutput
  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