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

***************
get_reservation
***************



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

  

  Gets an Amazon Redshift Serverless reservation. A reservation 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 <https://docs.aws.amazon.com/goto/WebAPI/redshift-serverless-2021-04-21/GetReservation>`_  


  **Request Syntax**
  ::

    response = client.get_reservation(
        reservationId='string'
    )
    
  :type reservationId: string
  :param reservationId: **[REQUIRED]** 

    The ID of the reservation to retrieve.

    

  
  
  :rtype: 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 returned reservation object.

        
        

        - **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.ResourceNotFoundException`

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

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

  