Get Quota Utilization Report

servicequotas_get_quota_utilization_report

R Documentation

Retrieves the quota utilization report for your Amazon Web Services account¶

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 start_quota_utilization_report 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.

Usage¶

servicequotas_get_quota_utilization_report(ReportId, NextToken,
  MaxResults)

Arguments¶

ReportId

[required] The unique identifier for the quota utilization report. This identifier is returned by the start_quota_utilization_report operation.

NextToken

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

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

Value¶

A list with the following syntax:

list(
  ReportId = "string",
  Status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED",
  GeneratedAt = as.POSIXct(
    "2015-01-01"
  ),
  TotalCount = 123,
  Quotas = list(
    list(
      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"
)

Request syntax¶

svc$get_quota_utilization_report(
  ReportId = "string",
  NextToken = "string",
  MaxResults = 123
)