Amazon Outposts Outposts Quotes API

openapi: 3.2.0
info:
  title: AWS Outposts Quotes API
  version: '2019-12-03'
  description: Generated from AWS's published Smithy model for AWS Outposts. 5 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: Quotes
paths:
  /quotes:
    post:
      operationId: CreateQuote
      summary: Create Quote
      description: Creates a quote for an Outpost. A quote provides pricing and configuration options based on the requested capacity. You can optionally associate the quote with an existing Outpost or create a standalone quote by specifying only the country code and requested capacities.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateQuoteOutput'
        '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/CreateQuoteInput'
      tags:
      - Quotes
    get:
      operationId: ListQuotes
      summary: List Quotes
      description: Lists the quotes for your Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQuotesOutput'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListQuotesInput'
      tags:
      - Quotes
  /quotes/{QuoteIdentifier}:
    delete:
      operationId: DeleteQuote
      summary: Delete Quote
      description: Deletes the specified quote.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteQuoteOutput'
        '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/DeleteQuoteInput'
      tags:
      - Quotes
    get:
      operationId: GetQuote
      summary: Get Quote
      description: Gets information about the specified quote.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQuoteOutput'
        '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/GetQuoteInput'
      tags:
      - Quotes
    patch:
      operationId: UpdateQuote
      summary: Update Quote
      description: Updates the specified quote. You can modify the requested capacities, constraints, payment options, payment terms, or Outpost association.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateQuoteOutput'
        '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/UpdateQuoteInput'
      tags:
      - Quotes
components:
  schemas:
    UpdateQuoteInput:
      type: object
      properties:
        QuoteIdentifier:
          type: string
          description: The ID of the quote.
        OutpostIdentifier:
          type: string
          description: The ID or ARN of the Outpost to associate with the quote. Specify an empty string to remove the Outpost association.
        CountryCode:
          type: string
          description: The country code for the Outpost site location.
        RequestedCapacities:
          type: array
          items:
            $ref: '#/components/schemas/QuoteCapacity'
          description: The updated capacity requirements for the quote.
        RequestedConstraints:
          type: array
          items:
            $ref: '#/components/schemas/QuoteConstraint'
          description: The updated physical constraints for the quote.
        RequestedPaymentOptions:
          type: array
          items:
            type: string
            enum:
            - ALL_UPFRONT
            - NO_UPFRONT
            - PARTIAL_UPFRONT
          description: The updated payment options to include in the quote pricing.
        RequestedPaymentTerms:
          type: array
          items:
            type: string
            enum:
            - THREE_YEARS
            - ONE_YEAR
            - FIVE_YEARS
          description: The updated payment terms to include in the quote pricing.
        Description:
          type: string
          description: A description for the quote.
      required:
      - QuoteIdentifier
    QuoteSummary:
      type: object
      properties:
        QuoteId:
          type: string
          description: The ID of the quote.
        AccountId:
          type: string
          description: The ID of the account that owns the quote.
        QuoteStatus:
          type: string
          enum:
          - CREATED
          - ORDER_SUBMITTED
          - EXPIRED
          description: The status of the quote.
        StatusMessage:
          type: string
          description: A message about the status of the quote.
        OutpostArn:
          type: string
          description: The ARN of the Outpost associated with the quote.
        CountryCode:
          type: string
          description: The country code for the Outpost site location.
        RequestedCapacities:
          type: array
          items:
            $ref: '#/components/schemas/QuoteCapacity'
          description: The capacity requirements specified in the quote request.
        RequestedConstraints:
          type: array
          items:
            $ref: '#/components/schemas/QuoteConstraint'
          description: The physical constraints specified in the quote request.
        RequestedPaymentOptions:
          type: array
          items:
            type: string
            enum:
            - ALL_UPFRONT
            - NO_UPFRONT
            - PARTIAL_UPFRONT
          description: The payment options specified in the quote request.
        RequestedPaymentTerms:
          type: array
          items:
            type: string
            enum:
            - THREE_YEARS
            - ONE_YEAR
            - FIVE_YEARS
          description: The payment terms specified in the quote request.
        QuoteOptions:
          type: array
          items:
            $ref: '#/components/schemas/QuoteOption'
          description: The configuration and pricing options for the quote.
        SubmittedOrderId:
          type: string
          description: The ID of the order submitted for the quote.
        CreatedDate:
          type: string
          format: date-time
          description: The date the quote was created.
        ExpirationDate:
          type: string
          format: date-time
          description: The date the quote expires.
        Description:
          type: string
          description: The description of the quote.
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    GetQuoteInput:
      type: object
      properties:
        QuoteIdentifier:
          type: string
          description: The ID of the quote.
      required:
      - QuoteIdentifier
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ListQuotesInput:
      type: object
      properties:
        NextToken:
          type: string
          description: The pagination token.
        MaxResults:
          type: integer
          description: The maximum page size.
    QuoteCapacity:
      type: object
      properties:
        QuoteCapacityType:
          type: string
          enum:
          - EC2
          - EBS
          - S3
          description: The type of capacity. Valid values are EC2, EBS, and S3.
        Unit:
          type: string
          description: The unit of measurement for the capacity. For Amazon EC2, this is the instance type (for example, c5.24xlarge). For Amazon EBS and Amazon S3, this is the storage unit (for example, TiB for tebibytes).
        Quantity:
          type: number
          description: The quantity of the specified capacity unit. For Amazon EC2, this is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, this is the total desired end-state capacity of the Outpost.
    OrderingRequirement:
      type: object
      properties:
        StatusMessage:
          type: string
          description: A message about the ordering requirement.
        OrderingRequirementType:
          type: string
          enum:
          - OUTPOST_ACTIVE_CHECK_ERROR
          - MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR
          - VALID_ZIP_CODE_CHECK_ERROR
          - RACK_PHYSICAL_PROPERTIES_CHECK_ERROR
          - OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR
          - SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR
          - COUNTRY_CODE_MISMATCH_CHECK_ERROR
          - OUTPOST_GENERATION_MISMATCH_ERROR
          - UNSUPPORTED
          - OUTPOST_ID_MISSING_ON_QUOTE_ERROR
          - ENTERPRISE_SUPPORT_ERROR
          - SHIPPING_ADDRESS_MISSING_CONTACT_NAME_ERROR
          - SHIPPING_ADDRESS_MISSING_CONTACT_NUMBER_ERROR
          - SHIPPING_ADDRESS_MISSING_CONTACT_INFO_ERROR
          - OUTPOST_STATE_CHANGED_ERROR
          - OUTPOST_NOT_FOUND_ERROR
          - OUTPOST_RENEWAL_REQUIRED_ERROR
          description: 'The type of ordering requirement. Indicates which check failed or passed. OUTPOST_ACTIVE_CHECK_ERROR - The Outpost must be in an active state. MAXIMUM_ALLOWED_ORDERS_CHECK_ERROR - The maximum number of allowed orders has been reached. VALID_ZIP_CODE_CHECK_ERROR - The site address must have a valid zip code. RACK_PHYSICAL_PROPERTIES_CHECK_ERROR - The rack physical properties do not meet requirements. OPERATING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have an operating address. SHIPPING_ADDRESS_EXISTENCE_CHECK_ERROR - The site must have a shipping address. COUNTRY_CODE_MISMATCH_CHECK_ERROR '
        Status:
          type: string
          enum:
          - PASS
          - FAIL
          - EXEMPT
          description: The status of the ordering requirement. Valid values are PASS, FAIL, and EXEMPT.
    SubscriptionPricingDetails:
      type: object
      properties:
        PaymentOption:
          type: string
          enum:
          - ALL_UPFRONT
          - NO_UPFRONT
          - PARTIAL_UPFRONT
          description: The payment option.
        PaymentTerm:
          type: string
          enum:
          - THREE_YEARS
          - ONE_YEAR
          - FIVE_YEARS
          description: The payment term.
        UpfrontPrice:
          type: number
          description: The upfront price.
        MonthlyRecurringPrice:
          type: number
          description: The monthly recurring price.
        Currency:
          type: string
          enum:
          - USD
          description: The currency of the price. Currently only USD is supported.
    DeleteQuoteOutput:
      type: object
      properties: {}
    PricingOption:
      type: object
      properties:
        PricingType:
          type: string
          enum:
          - SUBSCRIPTION
          description: The type of pricing model.
        SubscriptionPricingDetails:
          $ref: '#/components/schemas/SubscriptionPricingDetails'
    QuoteConstraint:
      type: object
      properties:
        QuoteConstraintType:
          type: string
          enum:
          - RACK_MAXIMUM
          - RACK_MAX_POWER_KVA
          - RACK_MAX_WEIGHT_LBS
          - RACK_SPACE_CONSTRAINED
          description: The type of constraint. Valid values are RACK_MAXIMUM, RACK_MAX_POWER_KVA, RACK_MAX_WEIGHT_LBS, and RACK_SPACE_CONSTRAINED.
        Value:
          type: string
          description: The value of the constraint.
    Quote:
      type: object
      properties:
        QuoteId:
          type: string
          description: The ID of the quote.
        AccountId:
          type: string
          description: The ID of the account that owns the quote.
        QuoteStatus:
          type: string
          enum:
          - CREATED
          - ORDER_SUBMITTED
          - EXPIRED
          description: The status of the quote. CREATED - The quote has been created and is available for review. ORDER_SUBMITTED - An order has been submitted for the quote. EXPIRED - The quote has expired and can no longer be used to submit an order.
        StatusMessage:
          type: string
          description: A message about the status of the quote.
        OutpostArn:
          type: string
          description: The ARN of the Outpost associated with the quote.
        CountryCode:
          type: string
          description: The country code for the Outpost site location.
        RequestedCapacities:
          type: array
          items:
            $ref: '#/components/schemas/QuoteCapacity'
          description: The capacity requirements specified in the quote request.
        RequestedConstraints:
          type: array
          items:
            $ref: '#/components/schemas/QuoteConstraint'
          description: The physical constraints specified in the quote request.
        RequestedPaymentOptions:
          type: array
          items:
            type: string
            enum:
            - ALL_UPFRONT
            - NO_UPFRONT
            - PARTIAL_UPFRONT
          description: The payment options specified in the quote request.
        RequestedPaymentTerms:
          type: array
          items:
            type: string
            enum:
            - THREE_YEARS
            - ONE_YEAR
            - FIVE_YEARS
          description: The payment terms specified in the quote request.
        QuoteOptions:
          type: array
          items:
            $ref: '#/components/schemas/QuoteOption'
          description: The configuration and pricing options for the quote. Each option includes capacity details, physical specifications, and pricing information.
        OrderingRequirements:
          type: array
          items:
            $ref: '#/components/schemas/OrderingRequirement'
          description: The requirements that must be met before an order can be submitted for the quote.
        SubmittedOrderId:
          type: string
          description: The ID of the order submitted for the quote.
        CreatedDate:
          type: string
          format: date-time
          description: The date the quote was created.
        ExpirationDate:
          type: string
          format: date-time
          description: The date the quote expires.
        Description:
          type: string
          description: The description of the quote.
    ServerSpecificationDetails:
      type: object
      properties:
        ServerPowerDrawKva:
          type: number
          description: The maximum power draw of the server in kVA.
        ServerWeightLbs:
          type: number
          description: The weight of the server in pounds.
        ServerHeightInches:
          type: number
          description: The height of the server in inches.
        ServerWidthInches:
          type: number
          description: The width of the server in inches.
        ServerDepthInches:
          type: number
          description: The depth of the server in inches.
        RackUnitHeight:
          type: string
          enum:
          - HEIGHT_42U
          - HEIGHT_2U
          - HEIGHT_1U
          description: The rack unit height of the server. HEIGHT_2U - 2 rack units. HEIGHT_1U - 1 rack unit.
        EC2Capacities:
          type: array
          items:
            $ref: '#/components/schemas/EC2Capacity'
          description: The Amazon EC2 capacities for the server.
    ListQuotesOutput:
      type: object
      properties:
        Quotes:
          type: array
          items:
            $ref: '#/components/schemas/QuoteSummary'
          description: Information about the quotes.
        NextToken:
          type: string
          description: The pagination token.
    ValidationException:
      type: object
      properties:
        Message:
          type: string
    CreateQuoteOutput:
      type: object
      properties:
        Quote:
          $ref: '#/components/schemas/Quote'
    QuoteOption:
      type: object
      properties:
        QuoteOptionIdentifier:
          type: string
          description: The ID of the quote option.
        Capacities:
          type: array
          items:
            $ref: '#/components/schemas/QuoteCapacity'
          description: The capacities included in this quote option.
        CapacitySummary:
          $ref: '#/components/schemas/CapacitySummary'
        Specifications:
          type: array
          items:
            $ref: '#/components/schemas/QuoteSpecification'
          description: The physical specifications for the racks or servers in this quote option.
        PricingOptions:
          type: array
          items:
            $ref: '#/components/schemas/PricingOption'
          description: The pricing options for this quote option.
    CapacitySummary:
      type: object
      properties:
        ExistingCapacities:
          type: array
          items:
            $ref: '#/components/schemas/QuoteCapacity'
          description: The existing capacities on the Outpost before the quote is fulfilled.
        FinalCapacities:
          type: array
          items:
            $ref: '#/components/schemas/QuoteCapacity'
          description: The final capacities on the Outpost after the quote is fulfilled.
        CapacityChange:
          type: array
          items:
            $ref: '#/components/schemas/QuoteCapacity'
          description: The change in capacity between the existing and final state.
    GetQuoteOutput:
      type: object
      properties:
        Quote:
          $ref: '#/components/schemas/Quote'
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    DeleteQuoteInput:
      type: object
      properties:
        QuoteIdentifier:
          type: string
          description: The ID of the quote.
      required:
      - QuoteIdentifier
    UpdateQuoteOutput:
      type: object
      properties:
        Quote:
          $ref: '#/components/schemas/Quote'
    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.
    QuoteSpecification:
      type: object
      properties:
        QuoteSpecificationType:
          type: string
          enum:
          - UPDATED_RACK
          - NEW_RACK
          - EXISTING_RACK
          - SERVER
          description: The type of specification. Valid values are NEW_RACK, UPDATED_RACK, EXISTING_RACK, and SERVER.
        ExistingRackSpecificationDetails:
          $ref: '#/components/schemas/RackSpecificationDetails'
        FinalRackSpecificationDetails:
          $ref: '#/components/schemas/RackSpecificationDetails'
        ServerSpecificationDetails:
          $ref: '#/components/schemas/ServerSpecificationDetails'
    CreateQuoteInput:
      type: object
      properties:
        OutpostIdentifier:
          type: string
          description: The ID or ARN of the Outpost to associate with the quote. If not specified, the quote is created without an Outpost association.
        CountryCode:
          type: string
          description: The country code for the Outpost site location.
        RequestedCapacities:
          type: array
          items:
            $ref: '#/components/schemas/QuoteCapacity'
          description: The capacity requirements for the quote. Each entry specifies a capacity type (such as Amazon EC2), the unit, and the quantity. For Amazon EC2, the quantity is the number of additional instances to add to the Outpost. For Amazon EBS and Amazon S3, the quantity is the total desired end-state capacity of the Outpost.
        RequestedConstraints:
          type: array
          items:
            $ref: '#/components/schemas/QuoteConstraint'
          description: The physical constraints for the quote, such as maximum number of racks, maximum power draw per rack, or maximum weight per rack.
        RequestedPaymentOptions:
          type: array
          items:
            type: string
            enum:
            - ALL_UPFRONT
            - NO_UPFRONT
            - PARTIAL_UPFRONT
          description: The payment options to include in the quote pricing. If not specified, all available payment options are returned.
        RequestedPaymentTerms:
          type: array
          items:
            type: string
            enum:
            - THREE_YEARS
            - ONE_YEAR
            - FIVE_YEARS
          description: The payment terms to include in the quote pricing. If not specified, all available payment terms are returned.
        Description:
          type: string
          description: A description for the quote.
      required:
      - CountryCode
      - RequestedCapacities
    RackSpecificationDetails:
      type: object
      properties:
        RackId:
          type: string
          description: The ID of the rack.
        RackUse:
          type: string
          enum:
          - NETWORKING
          - COMPUTE
          description: The use of the rack. Valid values are COMPUTE and NETWORKING.
        RackPowerDrawKva:
          type: number
          description: The maximum power draw of the rack in kVA.
        RackWeightLbs:
          type: number
          description: The weight of the rack in pounds.
        RackHeightInches:
          type: number
          description: The height of the rack in inches.
        RackWidthInches:
          type: number
          description: The width of the rack in inches.
        RackDepthInches:
          type: number
          description: The depth of the rack in inches.
        RackUnitHeight:
          type: string
          enum:
          - HEIGHT_42U
          - HEIGHT_2U
          - HEIGHT_1U
          description: The rack unit height. HEIGHT_42U - 42 rack units. HEIGHT_2U - 2 rack units. HEIGHT_1U - 1 rack unit.
        EC2Capacities:
          type: array
          items:
            $ref: '#/components/schemas/EC2Capacity'
          description: The Amazon EC2 capacities for the rack.
  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)