find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amazon-outposts:amazon-outposts-capacity-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS Outposts Capacity API
  version: '2019-12-03'
  description: Generated from AWS's published Smithy model for AWS Outposts. 4 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: []
tags:
- name: Capacity
paths:
  /outposts/{OutpostIdentifier}/capacity/{CapacityTaskId}:
    post:
      operationId: CancelCapacityTask
      summary: Cancel Capacity Task
      description: Cancels the capacity task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelCapacityTaskOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/CancelCapacityTaskInput'
      tags:
      - Capacity
    get:
      operationId: GetCapacityTask
      summary: Get Capacity Task
      description: Gets details of the specified capacity task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCapacityTaskOutput'
        '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/GetCapacityTaskInput'
      tags:
      - Capacity
  /capacity/tasks:
    get:
      operationId: ListCapacityTasks
      summary: List Capacity Tasks
      description: Lists the capacity tasks for your Amazon Web Services account. 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/ListCapacityTasksOutput'
        '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/ListCapacityTasksInput'
      tags:
      - Capacity
  /outposts/{OutpostIdentifier}/capacity:
    post:
      operationId: StartCapacityTask
      summary: Start Capacity Task
      description: Starts the specified capacity task. You can have one active capacity task for each order and each Outpost.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartCapacityTaskOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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/StartCapacityTaskInput'
      tags:
      - Capacity
components:
  schemas:
    StartCapacityTaskOutput:
      type: object
      properties:
        CapacityTaskId:
          type: string
          description: ID of the capacity task that you want to start.
        OutpostId:
          type: string
          description: ID of the Outpost associated with the capacity task.
        OrderId:
          type: string
          description: ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
        AssetId:
          type: string
          description: The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
        RequestedInstancePools:
          type: array
          items:
            $ref: '#/components/schemas/InstanceTypeCapacity'
          description: List of the instance pools requested in the specified capacity task.
        InstancesToExclude:
          $ref: '#/components/schemas/InstancesToExclude'
        DryRun:
          type: boolean
          description: Results of the dry run showing if the specified capacity task is above or below the available instance capacity.
        CapacityTaskStatus:
          type: string
          enum:
          - REQUESTED
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          - WAITING_FOR_EVACUATION
          - CANCELLATION_IN_PROGRESS
          - CANCELLED
          description: Status of the specified capacity task.
        Failed:
          $ref: '#/components/schemas/CapacityTaskFailure'
        CreationDate:
          type: string
          format: date-time
          description: Date that the specified capacity task was created.
        CompletionDate:
          type: string
          format: date-time
          description: Date that the specified capacity task ran successfully.
        LastModifiedDate:
          type: string
          format: date-time
          description: Date that the specified capacity task was last modified.
        TaskActionOnBlockingInstances:
          type: string
          enum:
          - WAIT_FOR_EVACUATION
          - FAIL_TASK
          description: User-specified option in case an instance is blocking the capacity task from running. WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task. FAIL_TASK - The capacity task fails.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
    StartCapacityTaskInput:
      type: object
      properties:
        OutpostIdentifier:
          type: string
          description: The ID or ARN of the Outposts associated with the specified capacity task.
        OrderId:
          type: string
          description: The ID of the Amazon Web Services Outposts order associated with the specified capacity task.
        AssetId:
          type: string
          description: The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
        InstancePools:
          type: array
          items:
            $ref: '#/components/schemas/InstanceTypeCapacity'
          description: The instance pools specified in the capacity task.
        InstancesToExclude:
          $ref: '#/components/schemas/InstancesToExclude'
        DryRun:
          type: boolean
          description: You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.
        TaskActionOnBlockingInstances:
          type: string
          enum:
          - WAIT_FOR_EVACUATION
          - FAIL_TASK
          description: Specify one of the following options in case an instance is blocking the capacity task from running. WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task. FAIL_TASK - The capacity task fails.
      required:
      - OutpostIdentifier
      - InstancePools
    InstancesToExclude:
      type: object
      properties:
        Instances:
          type: array
          items:
            type: string
          description: List of user-specified instances that must not be stopped.
        AccountIds:
          type: array
          items:
            type: string
          description: IDs of the accounts that own each instance that must not be stopped.
        Services:
          type: array
          items:
            type: string
            enum:
            - AWS
            - EC2
            - EKS
            - ELASTICACHE
            - ELB
            - RDS
            - ROUTE53
          description: Names of the services that own each instance that must not be stopped in order to free up the capacity needed to run the capacity task.
    ListCapacityTasksInput:
      type: object
      properties:
        OutpostIdentifierFilter:
          type: string
          description: Filters the results by an Outpost ID or an Outpost ARN.
        MaxResults:
          type: integer
        NextToken:
          type: string
        CapacityTaskStatusFilter:
          type: array
          items:
            type: string
            enum:
            - REQUESTED
            - IN_PROGRESS
            - FAILED
            - COMPLETED
            - WAITING_FOR_EVACUATION
            - CANCELLATION_IN_PROGRESS
            - CANCELLED
          description: A list of statuses. For example, REQUESTED or WAITING_FOR_EVACUATION.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        ResourceId:
          type: string
          description: The ID of the resource causing the conflict.
        ResourceType:
          type: string
          enum:
          - OUTPOST
          - ORDER
          description: The type of the resource causing the conflict.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    CancelCapacityTaskOutput:
      type: object
      properties: {}
    ListCapacityTasksOutput:
      type: object
      properties:
        CapacityTasks:
          type: array
          items:
            $ref: '#/components/schemas/CapacityTaskSummary'
          description: Lists all the capacity tasks.
        NextToken:
          type: string
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    CapacityTaskSummary:
      type: object
      properties:
        CapacityTaskId:
          type: string
          description: The ID of the specified capacity task.
        OutpostId:
          type: string
          description: The ID of the Outpost associated with the specified capacity task.
        OrderId:
          type: string
          description: The ID of the Amazon Web Services Outposts order of the host associated with the capacity task.
        AssetId:
          type: string
          description: The ID of the asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
        CapacityTaskStatus:
          type: string
          enum:
          - REQUESTED
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          - WAITING_FOR_EVACUATION
          - CANCELLATION_IN_PROGRESS
          - CANCELLED
          description: The status of the capacity task.
        CreationDate:
          type: string
          format: date-time
          description: The date that the specified capacity task was created.
        CompletionDate:
          type: string
          format: date-time
          description: The date that the specified capacity task successfully ran.
        LastModifiedDate:
          type: string
          format: date-time
          description: The date that the specified capacity was last modified.
    InstanceTypeCapacity:
      type: object
      properties:
        InstanceType:
          type: string
          description: The instance type of the hosts.
        Count:
          type: integer
          description: The number of instances for the specified instance type.
      required:
      - InstanceType
      - Count
    CancelCapacityTaskInput:
      type: object
      properties:
        CapacityTaskId:
          type: string
          description: ID of the capacity task that you want to cancel.
        OutpostIdentifier:
          type: string
          description: ID or ARN of the Outpost associated with the capacity task that you want to cancel.
      required:
      - CapacityTaskId
      - OutpostIdentifier
    GetCapacityTaskInput:
      type: object
      properties:
        CapacityTaskId:
          type: string
          description: ID of the capacity task.
        OutpostIdentifier:
          type: string
          description: ID or ARN of the Outpost associated with the specified capacity task.
      required:
      - CapacityTaskId
      - OutpostIdentifier
    GetCapacityTaskOutput:
      type: object
      properties:
        CapacityTaskId:
          type: string
          description: ID of the capacity task.
        OutpostId:
          type: string
          description: ID of the Outpost associated with the specified capacity task.
        OrderId:
          type: string
          description: ID of the Amazon Web Services Outposts order associated with the specified capacity task.
        AssetId:
          type: string
          description: The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.
        RequestedInstancePools:
          type: array
          items:
            $ref: '#/components/schemas/InstanceTypeCapacity'
          description: List of instance pools requested in the capacity task.
        InstancesToExclude:
          $ref: '#/components/schemas/InstancesToExclude'
        DryRun:
          type: boolean
          description: Performs a dry run to determine if you are above or below instance capacity.
        CapacityTaskStatus:
          type: string
          enum:
          - REQUESTED
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          - WAITING_FOR_EVACUATION
          - CANCELLATION_IN_PROGRESS
          - CANCELLED
          description: 'Status of the capacity task. A capacity task can have one of the following statuses: REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts. IN_PROGRESS - The capacity task is running and cannot be cancelled. FAILED - The capacity task could not be completed. COMPLETED - The capacity task has completed successfully. WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run. CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is '
        Failed:
          $ref: '#/components/schemas/CapacityTaskFailure'
        CreationDate:
          type: string
          format: date-time
          description: The date the capacity task was created.
        CompletionDate:
          type: string
          format: date-time
          description: The date the capacity task ran successfully.
        LastModifiedDate:
          type: string
          format: date-time
          description: The date the capacity task was last modified.
        TaskActionOnBlockingInstances:
          type: string
          enum:
          - WAIT_FOR_EVACUATION
          - FAIL_TASK
          description: 'User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options: WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task. FAIL_TASK - The capacity task fails.'
    CapacityTaskFailure:
      type: object
      properties:
        Reason:
          type: string
          description: The reason that the specified capacity task failed.
        Type:
          type: string
          enum:
          - UNSUPPORTED_CAPACITY_CONFIGURATION
          - UNEXPECTED_ASSET_STATE
          - BLOCKING_INSTANCES_NOT_EVACUATED
          - INTERNAL_SERVER_ERROR
          - RESOURCE_NOT_FOUND
          description: The type of failure.
      required:
      - Reason
  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
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/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)