openapi: 3.1.0
info:
  title: 'Amazon Storage Gateway REST Amazon Storage Gateway REST API #X Amz Target=StorageGateway 20130630.ListFileShares 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.ListFileShares'
paths:
  /#X-Amz-Target=StorageGateway_20130630.ListFileShares:
    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: ListFileShares
      description: Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares that belong to the calling user account. This operation is only supported for S3 File Gateways.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFileSharesOutput'
        '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/ListFileSharesInput'
      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.ListFileShares
      tags:
      - '#X Amz Target=StorageGateway 20130630.ListFileShares'
components:
  schemas:
    FileShareId:
      type: string
      description: The ID of the file share.
      minLength: 12
      maxLength: 30
    Marker:
      type: string
      minLength: 1
      maxLength: 1000
    FileShareARN:
      type: string
      description: The Amazon Resource Name (ARN) of the file share.
      minLength: 50
      maxLength: 500
    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: {}
    PositiveIntObject:
      type: integer
      minimum: 1
    FileShareType:
      type: string
      enum:
      - NFS
      - SMB
      description: The type of the file share.
    FileShareInfo:
      type: object
      properties:
        FileShareType:
          $ref: '#/components/schemas/FileShareType'
        FileShareARN:
          $ref: '#/components/schemas/FileShareARN'
        FileShareId:
          $ref: '#/components/schemas/FileShareId'
        FileShareStatus:
          $ref: '#/components/schemas/FileShareStatus'
        GatewayARN:
          $ref: '#/components/schemas/GatewayARN'
      description: Describes a file share. Only supported S3 File Gateway.
    FileShareStatus:
      type: string
      description: '<p>The status of the file share.</p> <p>Valid Values: <code>CREATING</code> | <code>UPDATING</code> | <code>AVAILABLE</code> | <code>DELETING</code> </p>'
      minLength: 3
      maxLength: 50
    ListFileSharesInput:
      type: object
      title: ListFileSharesInput
      properties:
        GatewayARN:
          allOf:
          - $ref: '#/components/schemas/GatewayARN'
          - description: The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.
        Limit:
          allOf:
          - $ref: '#/components/schemas/PositiveIntObject'
          - description: The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.
        Marker:
          allOf:
          - $ref: '#/components/schemas/Marker'
          - description: Opaque pagination token returned from a previous ListFileShares operation. If present, <code>Marker</code> specifies where to continue the list from after a previous call to ListFileShares. Optional.
      description: ListFileShareInput
    ListFileSharesOutput:
      type: object
      properties:
        Marker:
          allOf:
          - $ref: '#/components/schemas/Marker'
          - description: If the request includes <code>Marker</code>, the response returns that value in this field.
        NextMarker:
          allOf:
          - $ref: '#/components/schemas/Marker'
          - description: If a value is present, there are more file shares to return. In a subsequent request, use <code>NextMarker</code> as the value for <code>Marker</code> to retrieve the next set of file shares.
        FileShareInfoList:
          allOf:
          - $ref: '#/components/schemas/FileShareInfoList'
          - description: An array of information about the S3 File Gateway's file shares.
      description: ListFileShareOutput
    InternalServerError: {}
    FileShareInfoList:
      type: array
      items:
        $ref: '#/components/schemas/FileShareInfo'
  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
  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