Amazon EC2 Ec2 Reserved Instances Listing API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Reserved Instances Listing API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 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://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Reserved Instances Listing
paths:
  /?Action=CancelReservedInstancesListing:
    post:
      operationId: CancelReservedInstancesListing
      summary: Cancel Reserved Instances Listing
      description: Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CancelReservedInstancesListingResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CancelReservedInstancesListing
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CancelReservedInstancesListingRequest'
      tags:
      - Reserved Instances Listing
  /?Action=CreateReservedInstancesListing:
    post:
      operationId: CreateReservedInstancesListing
      summary: Create Reserved Instances Listing
      description: Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation. Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold. The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReserved
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateReservedInstancesListingResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateReservedInstancesListing
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateReservedInstancesListingRequest'
      tags:
      - Reserved Instances Listing
  /?Action=DescribeReservedInstancesListings:
    post:
      operationId: DescribeReservedInstancesListings
      summary: Describe Reserved Instances Listings
      description: Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. For more information, see Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide. The order of the elements in the response, including those within nested struct
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeReservedInstancesListingsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeReservedInstancesListings
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeReservedInstancesListingsRequest'
      tags:
      - Reserved Instances Listing
components:
  schemas:
    InstanceCount:
      type: object
      properties:
        InstanceCount:
          type: integer
          description: The number of listed Reserved Instances in the state specified by the state.
        State:
          type: string
          enum:
          - available
          - sold
          - cancelled
          - pending
          description: The states of the listed Reserved Instances.
    DescribeReservedInstancesListingsResult:
      type: object
      properties:
        ReservedInstancesListings:
          type: array
          items:
            $ref: '#/components/schemas/ReservedInstancesListing'
          description: Information about the Reserved Instance listing.
    PriceSchedule:
      type: object
      properties:
        Active:
          type: boolean
          description: The current price schedule, as determined by the term remaining for the Reserved Instance in the listing. A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
        CurrencyCode:
          type: string
          enum:
          - USD
          description: The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
        Price:
          type: number
          description: The fixed price for the term.
        Term:
          type: integer
          description: The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
    CreateReservedInstancesListingRequest:
      type: object
      properties:
        ReservedInstancesId:
          type: string
          description: The ID of the active Standard Reserved Instance.
        InstanceCount:
          type: integer
          description: The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
        PriceSchedules:
          type: array
          items:
            $ref: '#/components/schemas/PriceScheduleSpecification'
          description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
      required:
      - ReservedInstancesId
      - InstanceCount
      - PriceSchedules
      - ClientToken
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    CancelReservedInstancesListingResult:
      type: object
      properties:
        ReservedInstancesListings:
          type: array
          items:
            $ref: '#/components/schemas/ReservedInstancesListing'
          description: The Reserved Instance listing.
    ReservedInstancesListing:
      type: object
      properties:
        ClientToken:
          type: string
          description: A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
        CreateDate:
          type: string
          format: date-time
          description: The time the listing was created.
        InstanceCounts:
          type: array
          items:
            $ref: '#/components/schemas/InstanceCount'
          description: The number of instances in this state.
        PriceSchedules:
          type: array
          items:
            $ref: '#/components/schemas/PriceSchedule'
          description: The price of the Reserved Instance listing.
        ReservedInstancesId:
          type: string
          description: The ID of the Reserved Instance.
        ReservedInstancesListingId:
          type: string
          description: The ID of the Reserved Instance listing.
        Status:
          type: string
          enum:
          - active
          - pending
          - cancelled
          - closed
          description: The status of the Reserved Instance listing.
        StatusMessage:
          type: string
          description: The reason for the current status of the Reserved Instance listing. The response can be blank.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags assigned to the resource.
        UpdateDate:
          type: string
          format: date-time
          description: The last modified timestamp of the listing.
    CreateReservedInstancesListingResult:
      type: object
      properties:
        ReservedInstancesListings:
          type: array
          items:
            $ref: '#/components/schemas/ReservedInstancesListing'
          description: Information about the Standard Reserved Instance listing.
    PriceScheduleSpecification:
      type: object
      properties:
        Term:
          type: integer
          description: The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
        Price:
          type: number
          description: The fixed price for the term.
        CurrencyCode:
          type: string
          enum:
          - USD
          description: The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
    DescribeReservedInstancesListingsRequest:
      type: object
      properties:
        ReservedInstancesId:
          type: string
          description: One or more Reserved Instance IDs.
        ReservedInstancesListingId:
          type: string
          description: One or more Reserved Instance listing IDs.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters. reserved-instances-id - The ID of the Reserved Instances. reserved-instances-listing-id - The ID of the Reserved Instances listing. status - The status of the Reserved Instance listing (pending | active | cancelled | closed). status-message - The reason for the status.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    CancelReservedInstancesListingRequest:
      type: object
      properties:
        ReservedInstancesListingId:
          type: string
          description: The ID of the Reserved Instance listing.
      required:
      - ReservedInstancesListingId
  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: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)