:doc:`RedshiftServerless <../../redshift-serverless>` / Client / list_reservations

*****************
list_reservations
*****************



.. py:method:: RedshiftServerless.Client.list_reservations(**kwargs)

  

  Returns a list of Reservation objects.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/ListReservations>`_  


  **Request Syntax**
  ::

    response = client.list_reservations(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    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.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of items to return. (You received this token from a previous call.)

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'nextToken': 'string',
          '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'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        The token to use when requesting the next set of items.

        
      

      - **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 created the reservation.

            
          

          - **status** *(string) --* 

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

             

            
            * ``payment-pending``
             
            * ``active``
             
            * ``payment-failed``
             
            * ``retired``
            

            
      
    
  
  **Exceptions**
  
  *   :py:class:`RedshiftServerless.Client.exceptions.InternalServerException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ValidationException`

  
  *   :py:class:`RedshiftServerless.Client.exceptions.ThrottlingException`

  