GetMinuteUsage - AWS Ground Station

GetMinuteUsage

Returns the number of minutes used by account.

Request Syntax

POST /minute-usage HTTP/1.1 Content-type: application/json { "month": number, "year": number }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

month

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

Type: Integer

Required: Yes

year

The year being requested, in the format of YYYY.

Type: Integer

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "estimatedMinutesRemaining": number, "isReservedMinutesCustomer": boolean, "totalReservedMinuteAllocation": number, "totalScheduledMinutes": number, "upcomingMinutesScheduled": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

estimatedMinutesRemaining

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

Type: Integer

isReservedMinutesCustomer

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

Type: Boolean

totalReservedMinuteAllocation

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

Type: Integer

totalScheduledMinutes

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

Type: Integer

upcomingMinutesScheduled

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

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

DependencyException

Dependency encountered an error.

HTTP Status Code: 531

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 431

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 434

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: