Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . service-quotas ]
get-aws-default-service-quota¶
Description¶
Retrieves the default value for the specified quota. The default value does not reflect any quota increases.
See also: AWS API Documentation
Synopsis¶
get-aws-default-service-quota
--service-code <value>
--quota-code <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
Options¶
--service-code (string)
The service identifier.
--quota-code (string)
The quota identifier.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command's default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
- json
- text
- table
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To describe a default service quota
The following get-aws-default-service-quota example displays details for the specified quota.
aws service-quotas get-aws-default-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::ec2/L-1216C47A",
"QuotaCode": "L-1216C47A",
"QuotaName": "Running On-Demand Standard (A, C, D, H, I, M, R, T, Z) instances",
"Value": 5.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.