ServiceQuotas / Client / start_quota_utilization_report

start_quota_utilization_report

ServiceQuotas.Client.start_quota_utilization_report()

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.

See also: AWS API Documentation

Request Syntax

response = client.start_quota_utilization_report()
Return type:

dict

Returns:

Response Syntax

{
    'ReportId': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'Message': 'string'
}

Response Structure

  • (dict) –

    • ReportId (string) –

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

    • Status (string) –

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

    • Message (string) –

      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.

Exceptions