RedshiftServerless / Client / create_reservation

create_reservation

RedshiftServerless.Client.create_reservation(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_reservation(
    capacity=123,
    clientToken='string',
    offeringId='string'
)
Parameters:

  • capacity (integer) –

    [REQUIRED]

    The number of Redshift Processing Units (RPUs) to reserve.

  • clientToken (string) –

    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.

    This field is autopopulated if not provided.

  • offeringId (string) –

    [REQUIRED]

    The ID of the offering associated with the reservation. The offering determines the payment schedule for the reservation.

Return type:

dict

Returns:

Response Syntax

{
    'reservation': {
        'capacity': 123,
        'endDate': datetime(2015, 1, 1),
        'offering': {
            'currencyCode': 'string',
            'duration': 123,
            'hourlyCharge': 123.0,
            'offeringId': 'string',
            'offeringType': 'ALL_UPFRONT'|'NO_UPFRONT',
            'upfrontCharge': 123.0
        },
        'reservationArn': 'string',
        'reservationId': 'string',
        'startDate': datetime(2015, 1, 1),
        'status': 'string'
    }
}

Response Structure

  • (dict) –

    • reservation (dict) –

      The reservation object that the CreateReservation action created.

      • capacity (integer) –

        The number of Redshift Processing Units (RPUs) to reserve.

      • endDate (datetime) –

        The end date for the serverless reservation. This date is one year after the start date that you specify.

      • offering (dict) –

        The type of offering for the reservation. The offering class determines the payment schedule for the reservation.

        • currencyCode (string) –

          The currency code for the offering.

        • duration (integer) –

          The duration, in seconds, for which the reservation reserves the RPUs.

        • hourlyCharge (float) –

          The rate you are charged for each hour the reservation is active.

        • offeringId (string) –

          The offering identifier.

        • offeringType (string) –

          Determines the payment schedule for the reservation.

        • upfrontCharge (float) –

          The up-front price you are charged for the reservation.

      • reservationArn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation.

      • reservationId (string) –

        The identifier that uniquely identifies the serverless reservation.

      • startDate (datetime) –

        The start date for the serverless reservation. This is the date you specified for the reservation to start when you created the reservation.

      • status (string) –

        The status of the reservation. Possible values include the following:

        • payment-pending

        • active

        • payment-failed

        • retired

Exceptions