Skip to content

Get Service Quota

servicequotas_get_service_quota R Documentation

Retrieves the applied quota value for the specified account-level or resource-level quota

Description

Retrieves the applied quota value for the specified account-level or resource-level quota. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.

Usage

servicequotas_get_service_quota(ServiceCode, QuotaCode, ContextId)

Arguments

ServiceCode

[required] Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the list_services operation.

QuotaCode

[required] Specifies the quota identifier. To find the quota code for a specific quota, use the list_service_quotas operation, and look for the QuotaCode response in the output for the quota you want.

ContextId

Specifies the resource with an Amazon Resource Name (ARN).

Value

A list with the following syntax:

list(
  Quota = list(
    ServiceCode = "string",
    ServiceName = "string",
    QuotaArn = "string",
    QuotaCode = "string",
    QuotaName = "string",
    Value = 123.0,
    Unit = "string",
    Adjustable = TRUE|FALSE,
    GlobalQuota = TRUE|FALSE,
    UsageMetric = list(
      MetricNamespace = "string",
      MetricName = "string",
      MetricDimensions = list(
        "string"
      ),
      MetricStatisticRecommendation = "string"
    ),
    Period = list(
      PeriodValue = 123,
      PeriodUnit = "MICROSECOND"|"MILLISECOND"|"SECOND"|"MINUTE"|"HOUR"|"DAY"|"WEEK"
    ),
    ErrorReason = list(
      ErrorCode = "DEPENDENCY_ACCESS_DENIED_ERROR"|"DEPENDENCY_THROTTLING_ERROR"|"DEPENDENCY_SERVICE_ERROR"|"SERVICE_QUOTA_NOT_AVAILABLE_ERROR",
      ErrorMessage = "string"
    ),
    QuotaAppliedAtLevel = "ACCOUNT"|"RESOURCE"|"ALL",
    QuotaContext = list(
      ContextScope = "RESOURCE"|"ACCOUNT",
      ContextScopeType = "string",
      ContextId = "string"
    ),
    Description = "string"
  )
)

Request syntax

svc$get_service_quota(
  ServiceCode = "string",
  QuotaCode = "string",
  ContextId = "string"
)