[ aws . service-quotas ]

get-quota-utilization-report

Description

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

Synopsis

  get-quota-utilization-report
--report-id <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--report-id (string) [required]

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

Constraints:

• min: 1
• max: 128
• pattern: [0-9a-zA-Z][a-zA-Z0-9-]{1,128}

--next-token (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.

Constraints:

• max: 2048
• pattern: ^[a-zA-Z0-9/+]*={0,2}$

--max-results (integer)

The maximum number of results to return per page. The default value is 1,000 and the maximum allowed value is 1,000.

Constraints:

• min: 1
• max: 1000

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ReportId -> (string)

The unique identifier for the quota utilization report.

Constraints:

• min: 1
• max: 128
• pattern: [0-9a-zA-Z][a-zA-Z0-9-]{1,128}

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.

Possible values:

• PENDING
• IN_PROGRESS
• COMPLETED
• FAILED

GeneratedAt -> (timestamp)

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.

Constraints:

• min: 0
• max: 2147483647

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.

Constraints:

• max: 1000

(structure)

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

QuotaCode -> (string)

The quota identifier.

Constraints:

• min: 1
• max: 128
• pattern: [a-zA-Z][a-zA-Z0-9-]{1,128}

ServiceCode -> (string)

The service identifier.

Constraints:

• min: 1
• max: 63
• pattern: [a-zA-Z][a-zA-Z0-9-]{1,63}

QuotaName -> (string)

The quota name.

Namespace -> (string)

The namespace of the metric used to track quota usage.

Utilization -> (double)

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 -> (double)

The default value of the quota.

Constraints:

• min: 0
• max: 10000000000

AppliedValue -> (double)

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

Constraints:

• min: 0
• max: 10000000000

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.

Constraints:

• max: 2048
• pattern: ^[a-zA-Z0-9/+]*={0,2}$

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 .

Constraints:

• min: 1
• max: 128
• pattern: [a-zA-Z][a-zA-Z0-9]*

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 .

Constraints:

• min: 0
• max: 1024
• pattern: ^.*$