AWS Redshift #Action=GetReservedNodeExchangeOfferings API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: 'Redshift Data API Service #Action=AcceptReservedNodeExchange #Action=AcceptReservedNodeExchange #Action=GetReservedNodeExchangeOfferings API'
  description: <p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API and CLI usage examples, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Management Guide</i>. </p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: redshift-data
  x-aws-signingName: redshift-data
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/redshift-data-2019-12-20.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://redshift-data.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Redshift Data API Service multi-region endpoint
- url: https://redshift-data.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Redshift Data API Service multi-region endpoint
- url: http://redshift-data.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
- url: https://redshift-data.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Redshift Data API Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=GetReservedNodeExchangeOfferings'
paths:
  /#Action=GetReservedNodeExchangeOfferings:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      x-aws-operation-name: GetReservedNodeExchangeOfferings
      operationId: GET_GetReservedNodeExchangeOfferings
      description: Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetReservedNodeExchangeOfferingsOutputMessage'
        '480':
          description: ReservedNodeNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ReservedNodeNotFoundFault'
        '481':
          description: InvalidReservedNodeStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidReservedNodeStateFault'
        '482':
          description: ReservedNodeAlreadyMigratedFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ReservedNodeAlreadyMigratedFault'
        '483':
          description: ReservedNodeOfferingNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ReservedNodeOfferingNotFoundFault'
        '484':
          description: UnsupportedOperationFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UnsupportedOperationFault'
        '485':
          description: DependentServiceUnavailableFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DependentServiceUnavailableFault'
      parameters:
      - name: ReservedNodeId
        in: query
        required: true
        description: A string representing the node identifier for the DC1 Reserved Node to be exchanged.
        schema:
          type: string
          maxLength: 2147483647
      - name: MaxRecords
        in: query
        required: false
        description: An integer setting the maximum number of ReservedNodeOfferings to retrieve.
        schema:
          type: integer
      - name: Marker
        in: query
        required: false
        description: A value that indicates the starting point for the next set of ReservedNodeOfferings.
        schema:
          type: string
          maxLength: 2147483647
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - GetReservedNodeExchangeOfferings
      - name: Version
        in: query
        required: true
        schema:
          type: string
          enum:
          - '2012-12-01'
      summary: Amazon Redshift - G E T_ Get Reserved Node Exchange Offerings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#Action=GetReservedNodeExchangeOfferings'
    post:
      x-aws-operation-name: GetReservedNodeExchangeOfferings
      operationId: POST_GetReservedNodeExchangeOfferings
      description: Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetReservedNodeExchangeOfferingsOutputMessage'
        '480':
          description: ReservedNodeNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ReservedNodeNotFoundFault'
        '481':
          description: InvalidReservedNodeStateFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidReservedNodeStateFault'
        '482':
          description: ReservedNodeAlreadyMigratedFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ReservedNodeAlreadyMigratedFault'
        '483':
          description: ReservedNodeOfferingNotFoundFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ReservedNodeOfferingNotFoundFault'
        '484':
          description: UnsupportedOperationFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UnsupportedOperationFault'
        '485':
          description: DependentServiceUnavailableFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DependentServiceUnavailableFault'
      requestBody:
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/GetReservedNodeExchangeOfferingsInputMessage'
      parameters:
      - name: MaxRecords
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: Marker
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - GetReservedNodeExchangeOfferings
      - name: Version
        in: query
        required: true
        schema:
          type: string
          enum:
          - '2012-12-01'
      summary: Amazon Redshift - P O S T_ Get Reserved Node Exchange Offerings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#Action=GetReservedNodeExchangeOfferings'
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    GetReservedNodeExchangeOfferingsInputMessage:
      type: object
      required:
      - ReservedNodeId
      title: GetReservedNodeExchangeOfferingsInputMessage
      properties:
        ReservedNodeId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A string representing the node identifier for the DC1 Reserved Node to be exchanged.
        MaxRecords:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: An integer setting the maximum number of ReservedNodeOfferings to retrieve.
        Marker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A value that indicates the starting point for the next set of ReservedNodeOfferings.
      description: <p/>
    ReservedNodeOffering:
      type: object
      properties:
        ReservedNodeOfferingId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The offering identifier.
        NodeType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The node type offered by the reserved node offering.
        Duration:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The duration, in seconds, for which the offering will reserve the node.
        FixedPrice:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: The upfront fixed charge you will pay to purchase the specific reserved node offering.
        UsagePrice:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: The rate you are charged for each hour the cluster that is using the offering is running.
        CurrencyCode:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The currency code for the compute nodes offering.
        OfferingType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The anticipated utilization of the reserved node, as defined in the reserved node offering.
        RecurringCharges:
          allOf:
          - $ref: '#/components/schemas/RecurringChargeList'
          - description: The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.
        ReservedNodeOfferingType:
          allOf:
          - $ref: '#/components/schemas/ReservedNodeOfferingType'
          - description: <p/>
      description: Describes a reserved node offering.
    Double:
      type: number
      format: double
    RecurringCharge:
      type: object
      properties:
        RecurringChargeAmount:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: The amount charged per the period of time specified by the recurring charge frequency.
        RecurringChargeFrequency:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The frequency at which the recurring charge amount is applied.
      description: Describes a recurring charge.
    ReservedNodeOfferingType:
      type: string
      enum:
      - Regular
      - Upgradable
    Integer:
      type: integer
    String:
      type: string
      maxLength: 2147483647
    ReservedNodeOfferingNotFoundFault: {}
    DependentServiceUnavailableFault: {}
    RecurringChargeList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/RecurringCharge'
        - xml:
            name: RecurringCharge
    ReservedNodeAlreadyMigratedFault: {}
    ReservedNodeOfferingList:
      type: array
      items:
        allOf:
        - $ref: '#/components/schemas/ReservedNodeOffering'
        - xml:
            name: ReservedNodeOffering
    GetReservedNodeExchangeOfferingsOutputMessage:
      type: object
      properties:
        Marker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'An optional parameter that specifies the starting point for returning a set of response records. When the results of a <code>GetReservedNodeExchangeOfferings</code> request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request. '
        ReservedNodeOfferings:
          allOf:
          - $ref: '#/components/schemas/ReservedNodeOfferingList'
          - description: Returns an array of <a>ReservedNodeOffering</a> objects.
    IntegerOptional:
      type: integer
    ReservedNodeNotFoundFault: {}
    UnsupportedOperationFault: {}
    InvalidReservedNodeStateFault: {}
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/redshift-data/
x-hasEquivalentPaths: true