[ aws . service-quotas ]

get-service-quota

Description

Returns the details for the specified service quota. This operation provides a different Value than the GetAWSDefaultServiceQuota operation. This operation returns the applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS value for each quota.

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>]
[--cli-auto-prompt <value>]

Options

--service-code (string)

Specifies the service that you want to use.

--quota-code (string)

Identifies the service quota you want to select.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

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)

Returns the ServiceQuota object which contains all values for a quota.

ServiceCode -> (string)

Specifies the service that you want to use.

ServiceName -> (string)

The name of the AWS service specified in the increase request.

QuotaArn -> (string)

The Amazon Resource Name (ARN) of the service quota.

QuotaCode -> (string)

The code identifier for the service quota specified.

QuotaName -> (string)

The name identifier of the service quota.

Value -> (double)

The value of service quota.

Unit -> (string)

The unit of measurement for the value of the service quota.

Adjustable -> (boolean)

Specifies if the quota value can be increased.

GlobalQuota -> (boolean)

Specifies if the quota is global.

UsageMetric -> (structure)

Specifies the details about the measurement.

MetricNamespace -> (string)

The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

MetricName -> (string)

The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

MetricDimensions -> (map)

A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

key -> (string)

value -> (string)

MetricStatisticRecommendation -> (string)

Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

Period -> (structure)

Identifies the unit and value of how time is measured.

PeriodValue -> (integer)

The value of a period.

PeriodUnit -> (string)

The time unit of a period.

ErrorReason -> (structure)

Specifies the ErrorCode and ErrorMessage when success isn’t achieved.

ErrorCode -> (string)

Service Quotas returns the following error values.

DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

ErrorMessage -> (string)

The error message that provides more detail.