Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_minute_usage

get_minute_usage(**kwargs)

Returns the number of minutes used by account.

See also: AWS API Documentation

Request Syntax

response = client.get_minute_usage(
    month=123,
    year=123
)
Parameters
  • month (integer) --

    [REQUIRED]

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

  • year (integer) --

    [REQUIRED]

    The year being requested, in the format of YYYY.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • estimatedMinutesRemaining (integer) --

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

    • 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.

    • totalScheduledMinutes (integer) --

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

    • upcomingMinutesScheduled (integer) --

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

Exceptions

  • GroundStation.Client.exceptions.InvalidParameterException
  • GroundStation.Client.exceptions.DependencyException
  • GroundStation.Client.exceptions.ResourceNotFoundException