ServiceQuotas / Client / get_quota_utilization_report

get_quota_utilization_report

ServiceQuotas.Client.get_quota_utilization_report(**kwargs)

Retrieves the quota utilization report for your Amazon Web Services account. This operation returns paginated results showing your quota usage across all Amazon Web Services services, sorted by utilization percentage in descending order (highest utilization first).

You must first initiate a report using the StartQuotaUtilizationReport operation. The report generation process is asynchronous and may take several seconds to complete. Poll this operation periodically to check the status and retrieve results when the report is ready.

Each report contains up to 1,000 quota records per page. Use the NextToken parameter to retrieve additional pages of results. Reports are automatically deleted after 15 minutes.

See also: AWS API Documentation

Request Syntax

response = client.get_quota_utilization_report(
    ReportId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • ReportId (string) –

    [REQUIRED]

    The unique identifier for the quota utilization report. This identifier is returned by the StartQuotaUtilizationReport operation.

  • NextToken (string) – A token that indicates the next page of results to retrieve. This token is returned in the response when there are more results available. Omit this parameter for the first request.

  • MaxResults (integer) – The maximum number of results to return per page. The default value is 1,000 and the maximum allowed value is 1,000.

Return type:

dict

Returns:

Response Syntax

{
    'ReportId': 'string',
    'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
    'GeneratedAt': datetime(2015, 1, 1),
    'TotalCount': 123,
    'Quotas': [
        {
            'QuotaCode': 'string',
            'ServiceCode': 'string',
            'QuotaName': 'string',
            'Namespace': 'string',
            'Utilization': 123.0,
            'DefaultValue': 123.0,
            'AppliedValue': 123.0,
            'ServiceName': 'string',
            'Adjustable': True|False
        },
    ],
    'NextToken': 'string',
    'ErrorCode': 'string',
    'ErrorMessage': 'string'
}

Response Structure

  • (dict) –

    • ReportId (string) –

      The unique identifier for the quota utilization report.

    • Status (string) –

      The current status of the report generation. Possible values are:

      • PENDING - The report generation is in progress. Retry this operation after a few seconds.

      • IN_PROGRESS - The report is being processed. Continue polling until the status changes to COMPLETED.

      • COMPLETED - The report is ready and quota utilization data is available in the response.

      • FAILED - The report generation failed. Check the ErrorCode and ErrorMessage fields for details.

    • GeneratedAt (datetime) –

      The timestamp when the report was generated, in ISO 8601 format.

    • TotalCount (integer) –

      The total number of quotas included in the report across all pages.

    • Quotas (list) –

      A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page.

      • (dict) –

        Information about a quota’s utilization, including the quota code, service information, current usage, and applied limits.

        • QuotaCode (string) –

          The quota identifier.

        • ServiceCode (string) –

          The service identifier.

        • QuotaName (string) –

          The quota name.

        • Namespace (string) –

          The namespace of the metric used to track quota usage.

        • Utilization (float) –

          The utilization percentage of the quota, calculated as (current usage / applied value) × 100. Values range from 0.0 to 100.0 or higher if usage exceeds the quota limit.

        • DefaultValue (float) –

          The default value of the quota.

        • AppliedValue (float) –

          The applied value of the quota, which may be higher than the default value if a quota increase has been requested and approved.

        • ServiceName (string) –

          The service name.

        • Adjustable (boolean) –

          Indicates whether the quota value can be increased.

    • NextToken (string) –

      A token that indicates more results are available. Include this token in the next request to retrieve the next page of results. If this field is not present, you have retrieved all available results.

    • ErrorCode (string) –

      An error code indicating the reason for failure when the report status is FAILED. This field is only present when the status is FAILED.

    • ErrorMessage (string) –

      A detailed error message describing the failure when the report status is FAILED. This field is only present when the status is FAILED.

Exceptions