StartQuotaUtilizationReport - Service Quotas
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

StartQuotaUtilizationReport

Initiates the generation of a quota utilization report for your Amazon Web Services account. This asynchronous operation analyzes your quota usage across all Amazon Web Services services and returns a unique report identifier that you can use to retrieve the results.

The report generation process may take several seconds to complete, depending on the number of quotas in your account. Use the GetQuotaUtilizationReport operation to check the status and retrieve the results when the report is ready.

Related Actions

Response Syntax

{ "Message": "string", "ReportId": "string", "Status": "string" }

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.

Message

An optional message providing additional information about the report generation status. This field may contain details about the report initiation or indicate if an existing recent report is being reused.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 350.

Pattern: ^.{0,350}$

ReportId

A unique identifier for the quota utilization report. Use this identifier with the GetQuotaUtilizationReport operation to retrieve the report results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [0-9a-zA-Z][a-zA-Z0-9-]{1,128}

Status

The current status of the report generation. The status will be PENDING when the report is first initiated.

Type: String

Valid Values: PENDING | IN_PROGRESS | COMPLETED | FAILED

Errors

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

AccessDeniedException

You do not have sufficient permission to perform this action.

HTTP Status Code: 400

IllegalArgumentException

Invalid input was provided.

HTTP Status Code: 400

InvalidPaginationTokenException

Invalid input was provided.

HTTP Status Code: 400

NoSuchResourceException

The specified resource does not exist.

HTTP Status Code: 400

ServiceException

Something went wrong.

HTTP Status Code: 500

TooManyRequestsException

Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.

HTTP Status Code: 400

See Also

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