:doc:`GroundStation <../../groundstation>` / Client / get_minute_usage

****************
get_minute_usage
****************



.. py:method:: GroundStation.Client.get_minute_usage(**kwargs)

  

  Returns the number of reserved minutes used by account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMinuteUsage>`_  


  **Request Syntax**
  ::

    response = client.get_minute_usage(
        month=123,
        year=123
    )
    
  :type month: integer
  :param month: **[REQUIRED]** 

    The month being requested, with a value of 1-12.

    

  
  :type year: integer
  :param year: **[REQUIRED]** 

    The year being requested, in the format of YYYY.

    

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

    
    ::

      {
          'isReservedMinutesCustomer': True|False,
          'totalReservedMinuteAllocation': 123,
          'upcomingMinutesScheduled': 123,
          'totalScheduledMinutes': 123,
          'estimatedMinutesRemaining': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **isReservedMinutesCustomer** *(boolean) --* 

        Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.

        
      

      - **totalReservedMinuteAllocation** *(integer) --* 

        Total number of reserved minutes allocated, specific to the month being requested.

        
      

      - **upcomingMinutesScheduled** *(integer) --* 

        Upcoming minutes scheduled for an account, specific to the month being requested.

        
      

      - **totalScheduledMinutes** *(integer) --* 

        Total scheduled minutes for an account, specific to the month being requested.

        
      

      - **estimatedMinutesRemaining** *(integer) --* 

        Estimated number of minutes remaining for an account, specific to the month being requested.

        
  
  **Exceptions**
  
  *   :py:class:`GroundStation.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`GroundStation.Client.exceptions.DependencyException`

  
  *   :py:class:`GroundStation.Client.exceptions.ResourceNotFoundException`

  