openapi: 3.1.0
info:
  title: 'Amazon Storage Gateway REST Amazon Storage Gateway REST API #X Amz Target=StorageGateway 20130630.ListGateways 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.ListGateways'
paths:
  /#X-Amz-Target=StorageGateway_20130630.ListGateways:
    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: ListGateways
      description: <p>Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).</p> <p>By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.</p> <p>If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.</p>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGatewaysOutput'
        '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/ListGatewaysInput'
      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.ListGateways
      tags:
      - '#X Amz Target=StorageGateway 20130630.ListGateways'
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:
    GatewayType:
      type: string
      minLength: 2
      maxLength: 20
    Gateways:
      type: array
      items:
        $ref: '#/components/schemas/GatewayInfo'
    Marker:
      type: string
      minLength: 1
      maxLength: 1000
    GatewayInfo:
      type: object
      properties:
        GatewayId:
          allOf:
          - $ref: '#/components/schemas/GatewayId'
          - description: The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
        GatewayARN:
          allOf:
          - $ref: '#/components/schemas/GatewayARN'
          - 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.
        GatewayType:
          allOf:
          - $ref: '#/components/schemas/GatewayType'
          - description: The type of the gateway.
        GatewayOperationalState:
          allOf:
          - $ref: '#/components/schemas/GatewayOperationalState'
          - description: '<p>The state of the gateway.</p> <p>Valid Values: <code>DISABLED</code> | <code>ACTIVE</code> </p>'
        GatewayName:
          allOf:
          - $ref: '#/components/schemas/string'
          - description: The name of the gateway.
        Ec2InstanceId:
          allOf:
          - $ref: '#/components/schemas/Ec2InstanceId'
          - description: The ID of the Amazon EC2 instance that was used to launch the gateway.
        Ec2InstanceRegion:
          allOf:
          - $ref: '#/components/schemas/Ec2InstanceRegion'
          - description: The Amazon Web Services Region where the Amazon EC2 instance is located.
        HostEnvironment:
          allOf:
          - $ref: '#/components/schemas/HostEnvironment'
          - description: The type of hardware or software platform on which the gateway is running.
        HostEnvironmentId:
          allOf:
          - $ref: '#/components/schemas/HostEnvironmentId'
          - description: A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
      description: Describes a gateway object.
    HostEnvironment:
      type: string
      enum:
      - VMWARE
      - HYPER-V
      - EC2
      - KVM
      - OTHER
      - SNOWBALL
    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: {}
    GatewayOperationalState:
      type: string
      minLength: 2
      maxLength: 25
    PositiveIntObject:
      type: integer
      minimum: 1
    HostEnvironmentId:
      type: string
      minLength: 1
      maxLength: 1024
    Ec2InstanceId:
      type: string
    ListGatewaysInput:
      type: object
      title: ListGatewaysInput
      properties:
        Marker:
          allOf:
          - $ref: '#/components/schemas/Marker'
          - description: An opaque string that indicates the position at which to begin the returned list of gateways.
        Limit:
          allOf:
          - $ref: '#/components/schemas/PositiveIntObject'
          - description: Specifies that the list of gateways returned be limited to the specified number of items.
      description: <p>A JSON object containing zero or more of the following fields:</p> <ul> <li> <p> <a>ListGatewaysInput$Limit</a> </p> </li> <li> <p> <a>ListGatewaysInput$Marker</a> </p> </li> </ul>
    string:
      type: string
    ListGatewaysOutput:
      type: object
      example:
        Gateways:
        - GatewayARN: arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B
        - GatewayARN: arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C
        Marker: '1'
      properties:
        Gateways:
          allOf:
          - $ref: '#/components/schemas/Gateways'
          - description: An array of <a>GatewayInfo</a> objects.
        Marker:
          allOf:
          - $ref: '#/components/schemas/Marker'
          - description: Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.
    InternalServerError: {}
    Ec2InstanceRegion:
      type: string
    GatewayId:
      type: string
      minLength: 12
      maxLength: 30
  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