RedshiftServerless / Paginator / ListReservations

ListReservations¶

class RedshiftServerless.Paginator.ListReservations¶

paginator = client.get_paginator('list_reservations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from RedshiftServerless.Client.list_reservations().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'reservationsList': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- reservationsList (list) –
  
  The serverless reservations returned by the request.
  - (dict) –
    
    Represents 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.
    - 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
- NextToken (string) –
  
  A token to resume pagination.