Amazon Outposts List Orders API

openapi: 3.0.0
info:
  version: 2019-12-03
  x-release: v4
  title: AWS Outposts Catalog List Orders API
  description: Amazon Web Services Outposts is a fully managed service that extends Amazon Web Services infrastructure, APIs, and tools to customer premises. By providing local access to Amazon Web Services managed infrastructure, Amazon Web Services Outposts enables customers to build and run applications on premises using the same programming interfaces as in Amazon Web Services Regions, while using local compute and storage resources for lower latency and local data processing needs.
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: outposts
  x-aws-signingName: outposts
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/outposts-2019-12-03.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://outposts.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Outposts multi-region endpoint
- url: https://outposts.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Outposts multi-region endpoint
- url: http://outposts.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Outposts endpoint for China (Beijing) and China (Ningxia)
- url: https://outposts.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Outposts endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: List Orders
paths:
  /list-orders:
    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'
    get:
      operationId: ListOrders
      description: Lists the Outpost orders for your Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrdersOutput'
              examples:
                ListOrders200Example:
                  summary: Default ListOrders 200 response
                  x-microcks-default: true
                  value:
                    Orders: example-string
                    NextToken: example-ref
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      parameters:
      - name: OutpostIdentifierFilter
        in: query
        required: false
        description: ' The ID or the Amazon Resource Name (ARN) of the Outpost. '
        schema:
          type: string
          pattern: ^(arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/)?op-[a-f0-9]{17}$
          minLength: 1
          maxLength: 180
      - name: NextToken
        in: query
        required: false
        description: ''
        schema:
          type: string
          pattern: ^(\d+)##(\S+)$
          description: The pagination token.
          minLength: 1
          maxLength: 2048
      - name: MaxResults
        in: query
        required: false
        description: ''
        schema:
          type: integer
          description: The maximum page size.
          minimum: 1
          maximum: 1000
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon Outposts List Orders
      tags:
      - List Orders
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  schemas:
    LineItemStatusCounts:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/LineItemQuantity'
    LineItemQuantity:
      type: integer
      minimum: 1
      maximum: 20
    OrderStatus:
      type: string
      enum:
      - RECEIVED
      - PENDING
      - PROCESSING
      - INSTALLING
      - FULFILLED
      - CANCELLED
      - PREPARING
      - IN_PROGRESS
      - COMPLETED
      - ERROR
    NotFoundException: {}
    AccessDeniedException: {}
    OutpostIdOnly:
      type: string
      pattern: ^op-[a-f0-9]{17}$
      minLength: 1
      maxLength: 20
    InternalServerException: {}
    ISO8601Timestamp:
      type: string
      format: date-time
    Token:
      type: string
      pattern: ^(\d+)##(\S+)$
      description: The pagination token.
      minLength: 1
      maxLength: 2048
    ListOrdersOutput:
      type: object
      properties:
        Orders:
          allOf:
          - $ref: '#/components/schemas/OrderSummaryListDefinition'
          - description: ' Information about the orders. '
        NextToken:
          $ref: '#/components/schemas/Token'
    OrderSummary:
      type: object
      properties:
        OutpostId:
          allOf:
          - $ref: '#/components/schemas/OutpostIdOnly'
          - description: ' The ID of the Outpost. '
        OrderId:
          allOf:
          - $ref: '#/components/schemas/OrderId'
          - description: ' The ID of the order. '
        OrderType:
          allOf:
          - $ref: '#/components/schemas/OrderType'
          - description: The type of order.
        Status:
          allOf:
          - $ref: '#/components/schemas/OrderStatus'
          - description: '<p>The status of the order.</p> <ul> <li> <p> <code>PREPARING</code> - Order is received and is being prepared.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Order is either being built, shipped, or installed. For more information, see the <code>LineItem</code> status.</p> </li> <li> <p> <code>COMPLETED</code> - Order is complete.</p> </li> <li> <p> <code>CANCELLED</code> - Order is cancelled.</p> </li> <li> <p> <code>ERROR</code> - Customer should contact support.</p> </li> </ul> <note> <p>The following statuses are deprecated: <code>RECEIVED</code>, <code>PENDING</code>, <code>PROCESSING</code>, <code>INSTALLING</code>, and <code>FULFILLED</code>. </p> </note>'
        LineItemCountsByStatus:
          allOf:
          - $ref: '#/components/schemas/LineItemStatusCounts'
          - description: ' The status of all line items in the order. '
        OrderSubmissionDate:
          allOf:
          - $ref: '#/components/schemas/ISO8601Timestamp'
          - description: ' The submission date for the order. '
        OrderFulfilledDate:
          allOf:
          - $ref: '#/components/schemas/ISO8601Timestamp'
          - description: ' The fulfilment date for the order. '
      description: ' A summary of line items in your order. '
    OrderId:
      type: string
      pattern: oo-[a-f0-9]{17}$
      minLength: 1
      maxLength: 20
    OrderType:
      type: string
      enum:
      - OUTPOST
      - REPLACEMENT
    ValidationException: {}
    OrderSummaryListDefinition:
      type: array
      items:
        $ref: '#/components/schemas/OrderSummary'
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/outposts/
x-hasEquivalentPaths: true