Amazon Redshift

Amazon Redshift Redshift Reservation API

The Redshift Reservation API from Amazon Redshift — 3 operation(s) for redshift reservation.

Documentation GitHub OpenAPI

Operations 3

POST /#CreateReservation Create Reservation #

POST /#GetReservation Get Reservation #

POST /#ListReservations List Reservations #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

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-redshift:amazon-redshift-reservation-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.1.0
info:
  title: Amazon Redshift Reservation API
  version: '2012-12-01'
  description: Generated from AWS's published Smithy model for Amazon Redshift. 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://redshift-serverless.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateReservation:
    post:
      operationId: CreateReservation
      summary: Create Reservation
      description: Creates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified
        number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateReservationResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: TooManyTagsException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/TooManyTagsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RedshiftServerless.CreateReservation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateReservationRequest'
      tags:
      - Reservation
  /#GetReservation:
    post:
      operationId: GetReservation
      summary: Get Reservation
      description: Gets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified
        number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetReservationResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessInternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RedshiftServerless.GetReservation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetReservationRequest'
      tags:
      - Reservation
  /#ListReservations:
    post:
      operationId: ListReservations
      summary: List Reservations
      description: Returns a list of Reservation objects.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListReservationsResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessInternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/RedshiftServerlessValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - RedshiftServerless.ListReservations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListReservationsRequest'
      tags:
      - Reservation
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: redshift-serverless
  schemas:
    ConflictException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateReservationRequest:
      type: object
      properties:
        capacity:
          type: integer
          description: The number of Redshift Processing Units (RPUs) to reserve.
        offeringId:
          type: string
          description: The ID of the offering associated with the reservation. The offering determines the payment schedule
            for the reservation.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
            provided, the Amazon Web Services SDK populates this field. This token must be a valid UUIDv4 value. For more
            information about idempotency, see Making retries safe with idempotent APIs .
      required:
      - capacity
      - offeringId
    CreateReservationResponse:
      type: object
      properties:
        reservation:
          $ref: '#/components/schemas/Reservation'
    GetReservationRequest:
      type: object
      properties:
        reservationId:
          type: string
          description: The ID of the reservation to retrieve.
      required:
      - reservationId
    GetReservationResponse:
      type: object
      properties:
        reservation:
          $ref: '#/components/schemas/Reservation'
      required:
      - reservation
    ListReservationsRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: The token for the next set of items to return. (You received this token from a previous call.)
        maxResults:
          type: integer
          description: The maximum number of items to return for this call. The call also returns a token that you can specify
            in a subsequent call to get the next set of results.
    ListReservationsResponse:
      type: object
      properties:
        reservationsList:
          type: array
          items:
            $ref: '#/components/schemas/Reservation'
          description: The serverless reservations returned by the request.
        nextToken:
          type: string
          description: The token to use when requesting the next set of items.
      required:
      - reservationsList
    RedshiftServerlessInternalServerException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    RedshiftServerlessResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The name of the resource that could not be found.
      required:
      - message
    RedshiftServerlessValidationException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    Reservation:
      type: object
      properties:
        reservationId:
          type: string
          description: The identifier that uniquely identifies the serverless reservation.
        reservationArn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation.
        startDate:
          type: string
          description: The start date for the serverless reservation. This is the date you created the reservation.
        endDate:
          type: string
          description: The end date for the serverless reservation. This date is one year after the start date that you specify.
        capacity:
          type: integer
          description: The number of Redshift Processing Units (RPUs) to reserve.
        offering:
          $ref: '#/components/schemas/ReservationOffering'
        status:
          type: string
          description: 'The status of the reservation. Possible values include the following: payment-pending active payment-failed
            retired'
    ReservationOffering:
      type: object
      properties:
        offeringId:
          type: string
          description: The offering identifier.
        duration:
          type: integer
          description: The duration, in seconds, for which the reservation reserves the RPUs.
        upfrontCharge:
          type: number
          description: The up-front price you are charged for the reservation.
        hourlyCharge:
          type: number
          description: The rate you are charged for each hour the reservation is active.
        currencyCode:
          type: string
          description: The currency code for the offering.
        offeringType:
          type: string
          description: Determines the payment schedule for the reservation.
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
    TooManyTagsException:
      type: object
      properties:
        message:
          type: string
        resourceName:
          type: string
          description: The name of the resource that exceeded the number of tags allowed for a resource.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/redshift-serverless/service/2021-04-21/redshift-serverless-2021-04-21.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)