:doc:`ElasticLoadBalancingv2 <../../elbv2>` / Client / modify_capacity_reservation

***************************
modify_capacity_reservation
***************************



.. py:method:: ElasticLoadBalancingv2.Client.modify_capacity_reservation(**kwargs)

  

  Modifies the capacity reservation of the specified load balancer.

   

  When modifying capacity reservation, you must include at least one ``MinimumLoadBalancerCapacity`` or ``ResetCapacityReservation``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/ModifyCapacityReservation>`_  


  **Request Syntax**
  ::

    response = client.modify_capacity_reservation(
        LoadBalancerArn='string',
        MinimumLoadBalancerCapacity={
            'CapacityUnits': 123
        },
        ResetCapacityReservation=True|False
    )
    
  :type LoadBalancerArn: string
  :param LoadBalancerArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the load balancer.

    

  
  :type MinimumLoadBalancerCapacity: dict
  :param MinimumLoadBalancerCapacity: 

    The minimum load balancer capacity reserved.

    

  
    - **CapacityUnits** *(integer) --* 

      The number of capacity units.

      

    
  
  :type ResetCapacityReservation: boolean
  :param ResetCapacityReservation: 

    Resets the capacity reservation.

    

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

    
    ::

      {
          'LastModifiedTime': datetime(2015, 1, 1),
          'DecreaseRequestsRemaining': 123,
          'MinimumLoadBalancerCapacity': {
              'CapacityUnits': 123
          },
          'CapacityReservationState': [
              {
                  'State': {
                      'Code': 'provisioned'|'pending'|'rebalancing'|'failed',
                      'Reason': 'string'
                  },
                  'AvailabilityZone': 'string',
                  'EffectiveCapacityUnits': 123.0
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **LastModifiedTime** *(datetime) --* 

        The last time the capacity reservation was modified.

        
      

      - **DecreaseRequestsRemaining** *(integer) --* 

        The amount of daily capacity decreases remaining.

        
      

      - **MinimumLoadBalancerCapacity** *(dict) --* 

        The requested minimum capacity reservation for the load balancer

        
        

        - **CapacityUnits** *(integer) --* 

          The number of capacity units.

          
    
      

      - **CapacityReservationState** *(list) --* 

        The state of the capacity reservation.

        
        

        - *(dict) --* 

          The capacity reservation status for each Availability Zone.

          
          

          - **State** *(dict) --* 

            The state of the capacity reservation.

            
            

            - **Code** *(string) --* 

              The status code.

              
            

            - **Reason** *(string) --* 

              The reason code for the status.

              
        
          

          - **AvailabilityZone** *(string) --* 

            Information about the Availability Zone.

            
          

          - **EffectiveCapacityUnits** *(float) --* 

            The number of effective capacity units.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.LoadBalancerNotFoundException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.InvalidConfigurationRequestException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.CapacityUnitsLimitExceededException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.CapacityReservationPendingException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.InsufficientCapacityException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.CapacityDecreaseRequestsLimitExceededException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.PriorRequestNotCompleteException`

  
  *   :py:class:`ElasticLoadBalancingv2.Client.exceptions.OperationNotPermittedException`

  