Class: Aws::ServiceQuotas::Types::GetQuotaUtilizationReportResponse

Inherits:

Struct

• Object
• Struct
• Aws::ServiceQuotas::Types::GetQuotaUtilizationReportResponse

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-servicequotas/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #error_code ⇒ String

  An error code indicating the reason for failure when the report status is ‘FAILED`.

• #error_message ⇒ String

  A detailed error message describing the failure when the report status is ‘FAILED`.

• #generated_at ⇒ Time

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

• #next_token ⇒ String

  A token that indicates more results are available.

• #quotas ⇒ Array<Types::QuotaUtilizationInfo>

  A list of quota utilization records, sorted by utilization percentage in descending order.

• #report_id ⇒ String

  The unique identifier for the quota utilization report.

• #status ⇒ String

  The current status of the report generation.

• #total_count ⇒ Integer

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

Instance Attribute Details

#error_code ⇒ 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`.

Returns:

• (String)

# File 'lib/aws-sdk-servicequotas/types.rb', line 338

class GetQuotaUtilizationReportResponse < Struct.new(
  :report_id,
  :status,
  :generated_at,
  :total_count,
  :quotas,
  :next_token,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-servicequotas/types.rb', line 338

class GetQuotaUtilizationReportResponse < Struct.new(
  :report_id,
  :status,
  :generated_at,
  :total_count,
  :quotas,
  :next_token,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#generated_at ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-servicequotas/types.rb', line 338

class GetQuotaUtilizationReportResponse < Struct.new(
  :report_id,
  :status,
  :generated_at,
  :total_count,
  :quotas,
  :next_token,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-servicequotas/types.rb', line 338

class GetQuotaUtilizationReportResponse < Struct.new(
  :report_id,
  :status,
  :generated_at,
  :total_count,
  :quotas,
  :next_token,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#quotas ⇒ Array<Types::QuotaUtilizationInfo>

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.

Returns:

• (Array<Types::QuotaUtilizationInfo>)

# File 'lib/aws-sdk-servicequotas/types.rb', line 338

class GetQuotaUtilizationReportResponse < Struct.new(
  :report_id,
  :status,
  :generated_at,
  :total_count,
  :quotas,
  :next_token,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#report_id ⇒ String

The unique identifier for the quota utilization report.

Returns:

• (String)

# File 'lib/aws-sdk-servicequotas/types.rb', line 338

class GetQuotaUtilizationReportResponse < Struct.new(
  :report_id,
  :status,
  :generated_at,
  :total_count,
  :quotas,
  :next_token,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-servicequotas/types.rb', line 338

class GetQuotaUtilizationReportResponse < Struct.new(
  :report_id,
  :status,
  :generated_at,
  :total_count,
  :quotas,
  :next_token,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#total_count ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-servicequotas/types.rb', line 338

class GetQuotaUtilizationReportResponse < Struct.new(
  :report_id,
  :status,
  :generated_at,
  :total_count,
  :quotas,
  :next_token,
  :error_code,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end