Amazon Outposts Catalog API

openapi: 3.1.0
info:
  title: AWS Outposts Catalog API
  version: '2019-12-03'
  description: Generated from AWS's published Smithy model for AWS Outposts. 2 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://outposts.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /catalog/item/{CatalogItemId}:
    get:
      operationId: GetCatalogItem
      summary: Get Catalog Item
      description: Gets information about the specified catalog item.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCatalogItemOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetCatalogItemInput'
      tags:
      - Catalog
  /catalog/items:
    get:
      operationId: ListCatalogItems
      summary: List Catalog Items
      description: Lists the items in the catalog. Use filters to return specific results. If you specify multiple filters,
        the results include only the resources that match all of the specified filters. For a filter where you can specify
        multiple values, the results include items that match any of the values that you specify for the filter.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCatalogItemsOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCatalogItemsInput'
      tags:
      - Catalog
components:
  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: outposts
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    CatalogItem:
      type: object
      properties:
        CatalogItemId:
          type: string
          description: The ID of the catalog item.
        ItemStatus:
          type: string
          enum:
          - AVAILABLE
          - DISCONTINUED
          description: The status of a catalog item.
        EC2Capacities:
          type: array
          items:
            $ref: '#/components/schemas/EC2Capacity'
          description: Information about the EC2 capacity of an item.
        PowerKva:
          type: number
          description: Information about the power draw of an item.
        WeightLbs:
          type: integer
          description: The weight of the item in pounds.
        SupportedUplinkGbps:
          type: array
          items:
            type: integer
          description: The uplink speed this catalog item requires for the connection to the Region.
        SupportedStorage:
          type: array
          items:
            type: string
            enum:
            - EBS
            - S3
          description: The supported storage options for the catalog item.
        RackScalingType:
          type: string
          enum:
          - SINGLE_RACK
          - MULTI_RACK
          description: The rack scaling type supported by the catalog item. Valid values are SINGLE_RACK and MULTI_RACK.
    EC2Capacity:
      type: object
      properties:
        Family:
          type: string
          description: The family of the EC2 capacity.
        MaxSize:
          type: string
          description: The maximum size of the EC2 capacity.
        Quantity:
          type: string
          description: The quantity of the EC2 capacity.
    GetCatalogItemInput:
      type: object
      properties:
        CatalogItemId:
          type: string
          description: The ID of the catalog item.
      required:
      - CatalogItemId
    GetCatalogItemOutput:
      type: object
      properties:
        CatalogItem:
          $ref: '#/components/schemas/CatalogItem'
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListCatalogItemsInput:
      type: object
      properties:
        NextToken:
          type: string
        MaxResults:
          type: integer
        ItemClassFilter:
          type: array
          items:
            type: string
            enum:
            - RACK
            - SERVER
          description: Filters the results by item class.
        SupportedStorageFilter:
          type: array
          items:
            type: string
            enum:
            - EBS
            - S3
          description: Filters the results by storage option.
        EC2FamilyFilter:
          type: array
          items:
            type: string
          description: Filters the results by EC2 family (for example, M5).
    ListCatalogItemsOutput:
      type: object
      properties:
        CatalogItems:
          type: array
          items:
            $ref: '#/components/schemas/CatalogItem'
          description: Information about the catalog items.
        NextToken:
          type: string
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    ValidationException:
      type: object
      properties:
        Message:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/outposts/service/2019-12-03/outposts-2019-12-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)