[ aws . service-quotas ]

get-service-quota

Description

Retrieves the applied quota value for the specified 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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-service-quota
--service-code <value>
--quota-code <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--service-code (string)

The service identifier.

--quota-code (string)

The quota identifier.

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

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a service quota

The following get-service-quota example displays details about the specified quota.

aws service-quotas get-service-quota \
    --service-code ec2 \
    --quota-code L-1216C47A

Output:

{
    "Quota": {
        "ServiceCode": "ec2",
        "ServiceName": "Amazon Elastic Compute Cloud (Amazon EC2)",
        "QuotaArn": "arn:aws:servicequotas:us-east-2:123456789012:ec2/L-1216C47A",
        "QuotaCode": "L-1216C47A",
        "QuotaName": "Running On-Demand Standard (A, C, D, H, I, M, R, T, Z) instances",
        "Value": 1920.0,
        "Unit": "None",
        "Adjustable": true,
        "GlobalQuota": false,
        "UsageMetric": {
            "MetricNamespace": "AWS/Usage",
            "MetricName": "ResourceCount",
            "MetricDimensions": {
                "Class": "Standard/OnDemand",
                "Resource": "vCPU",
                "Service": "EC2",
                "Type": "Resource"
            },
            "MetricStatisticRecommendation": "Maximum"
        }
    }
}

Output

Quota -> (structure)

Information about the quota.

ServiceCode -> (string)

The service identifier.

ServiceName -> (string)

The service name.

QuotaArn -> (string)

The Amazon Resource Name (ARN) of the quota.

QuotaCode -> (string)

The quota identifier.

QuotaName -> (string)

The quota name.

Value -> (double)

The quota value.

Unit -> (string)

The unit of measurement.

Adjustable -> (boolean)

Indicates whether the quota value can be increased.

GlobalQuota -> (boolean)

Indicates whether the quota is global.

UsageMetric -> (structure)

Information about the measurement.

MetricNamespace -> (string)

The namespace of the metric.

MetricName -> (string)

The name of the metric.

MetricDimensions -> (map)

The metric dimension. This is a name/value pair that is part of the identity of a metric.

key -> (string)

value -> (string)

MetricStatisticRecommendation -> (string)

The metric statistic that we recommend you use when determining quota usage.

Period -> (structure)

The period of time.

PeriodValue -> (integer)

The value.

PeriodUnit -> (string)

The time unit.

ErrorReason -> (structure)

The error code and error reason.

ErrorCode -> (string)

Service Quotas returns the following error values:

• DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required permissions to complete the action. To resolve the error, you must have permission to access the service or quota.

• DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas.

• DEPENDENCY_SERVICE_ERROR - The service is not available.

• SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

ErrorMessage -> (string)

The error message.