Amazon Athena Athena Capacity Reservation API

openapi: 3.2.0
info:
  title: Amazon Athena Capacity Reservation API
  version: '2017-05-18'
  description: Generated from AWS's published Smithy model for Amazon Athena. 6 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://athena.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Capacity Reservation
paths:
  /#CancelCapacityReservation:
    post:
      operationId: CancelCapacityReservation
      summary: Cancel Capacity Reservation
      description: Cancels the capacity reservation with the specified name. Cancelled reservations remain in your account and will be deleted 45 days after cancellation. During the 45 days, you cannot re-purpose or reuse a reservation that has been cancelled, but you can refer to its tags and view it for historical reference.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CancelCapacityReservationOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonAthena.CancelCapacityReservation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CancelCapacityReservationInput'
      tags:
      - Capacity Reservation
  /#CreateCapacityReservation:
    post:
      operationId: CreateCapacityReservation
      summary: Create Capacity Reservation
      description: Creates a capacity reservation with the specified name and number of requested data processing units.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateCapacityReservationOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonAthena.CreateCapacityReservation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateCapacityReservationInput'
      tags:
      - Capacity Reservation
  /#DeleteCapacityReservation:
    post:
      operationId: DeleteCapacityReservation
      summary: Delete Capacity Reservation
      description: Deletes a cancelled capacity reservation. A reservation must be cancelled before it can be deleted. A deleted reservation is immediately removed from your account and can no longer be referenced, including by its ARN. A deleted reservation cannot be called by GetCapacityReservation, and deleted reservations do not appear in the output of ListCapacityReservations.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteCapacityReservationOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonAthena.DeleteCapacityReservation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteCapacityReservationInput'
      tags:
      - Capacity Reservation
  /#GetCapacityReservation:
    post:
      operationId: GetCapacityReservation
      summary: Get Capacity Reservation
      description: Returns information about the capacity reservation with the specified name.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetCapacityReservationOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonAthena.GetCapacityReservation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetCapacityReservationInput'
      tags:
      - Capacity Reservation
  /#ListCapacityReservations:
    post:
      operationId: ListCapacityReservations
      summary: List Capacity Reservations
      description: Lists the capacity reservations for the current account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListCapacityReservationsOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonAthena.ListCapacityReservations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListCapacityReservationsInput'
      tags:
      - Capacity Reservation
  /#UpdateCapacityReservation:
    post:
      operationId: UpdateCapacityReservation
      summary: Update Capacity Reservation
      description: Updates the number of requested data processing units for the capacity reservation with the specified name.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateCapacityReservationOutput'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonAthena.UpdateCapacityReservation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateCapacityReservationInput'
      tags:
      - Capacity Reservation
components:
  schemas:
    CancelCapacityReservationInput:
      type: object
      properties:
        Name:
          type: string
          description: The name of the capacity reservation to cancel.
      required:
      - Name
    GetCapacityReservationInput:
      type: object
      properties:
        Name:
          type: string
          description: The name of the capacity reservation.
      required:
      - Name
    DeleteCapacityReservationInput:
      type: object
      properties:
        Name:
          type: string
          description: The name of the capacity reservation to delete.
      required:
      - Name
    InvalidRequestException:
      type: object
      properties:
        AthenaErrorCode:
          type: string
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.'
        Value:
          type: string
          description: 'A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.'
    CapacityReservation:
      type: object
      properties:
        Name:
          type: string
          description: The name of the capacity reservation.
        Status:
          type: string
          enum:
          - PENDING
          - ACTIVE
          - CANCELLING
          - CANCELLED
          - FAILED
          - UPDATE_PENDING
          description: The status of the capacity reservation.
        TargetDpus:
          type: integer
          description: The number of data processing units requested.
        AllocatedDpus:
          type: integer
          description: The number of data processing units currently allocated.
        LastAllocation:
          $ref: '#/components/schemas/CapacityAllocation'
        LastSuccessfulAllocationTime:
          type: string
          format: date-time
          description: The time of the most recent capacity allocation that succeeded.
        CreationTime:
          type: string
          format: date-time
          description: The time in UTC epoch millis when the capacity reservation was created.
      required:
      - Name
      - Status
      - TargetDpus
      - AllocatedDpus
      - CreationTime
    DeleteCapacityReservationOutput:
      type: object
      properties: {}
    UpdateCapacityReservationInput:
      type: object
      properties:
        TargetDpus:
          type: integer
          description: The new number of requested data processing units.
        Name:
          type: string
          description: The name of the capacity reservation.
      required:
      - TargetDpus
      - Name
    CreateCapacityReservationOutput:
      type: object
      properties: {}
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    CapacityAllocation:
      type: object
      properties:
        Status:
          type: string
          enum:
          - PENDING
          - SUCCEEDED
          - FAILED
          description: The status of the capacity allocation.
        StatusMessage:
          type: string
          description: The status message of the capacity allocation.
        RequestTime:
          type: string
          format: date-time
          description: The time when the capacity allocation was requested.
        RequestCompletionTime:
          type: string
          format: date-time
          description: The time when the capacity allocation request was completed.
      required:
      - Status
      - RequestTime
    ListCapacityReservationsInput:
      type: object
      properties:
        NextToken:
          type: string
          description: A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated.
        MaxResults:
          type: integer
          description: Specifies the maximum number of results to return.
    CancelCapacityReservationOutput:
      type: object
      properties: {}
    CreateCapacityReservationInput:
      type: object
      properties:
        TargetDpus:
          type: integer
          description: The number of requested data processing units.
        Name:
          type: string
          description: The name of the capacity reservation to create.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags for the capacity reservation.
      required:
      - TargetDpus
      - Name
    UpdateCapacityReservationOutput:
      type: object
      properties: {}
    GetCapacityReservationOutput:
      type: object
      properties:
        CapacityReservation:
          $ref: '#/components/schemas/CapacityReservation'
      required:
      - CapacityReservation
    ListCapacityReservationsOutput:
      type: object
      properties:
        NextToken:
          type: string
          description: A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
        CapacityReservations:
          type: array
          items:
            $ref: '#/components/schemas/CapacityReservation'
          description: The capacity reservations for the current account.
      required:
      - CapacityReservations
  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: athena
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/athena/service/2017-05-18/athena-2017-05-18.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)