AWS CLI Command Reference

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 ]

list-service-quotas

Description

Lists the applied quota values for the specified Amazon Web Service. 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

list-service-quotas is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Quotas

Synopsis

  list-service-quotas
--service-code <value>
[--quota-code <value>]
[--quota-applied-at-level <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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)

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

--quota-code (string)

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

--quota-applied-at-level (string)

Specifies at which level of granularity that the quota value is applied.

Possible values:

  • ACCOUNT
  • RESOURCE
  • ALL

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--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 list the quotas for a service

The following list-service-quotas example displays details about the quotas for AWS CloudFormation.

aws service-quotas list-service-quotas \
    --service-code cloudformation

Output:

{
    "Quotas": [
        {
            "ServiceCode": "cloudformation",
            "ServiceName": "AWS CloudFormation",
            "QuotaArn": "arn:aws:servicequotas:us-east-2:123456789012:cloudformation/L-87D14FB7",
            "QuotaCode": "L-87D14FB7",
            "QuotaName": "Output count in CloudFormation template",
            "Value": 60.0,
            "Unit": "None",
            "Adjustable": false,
            "GlobalQuota": false
        },
        {
            "ServiceCode": "cloudformation",
            "ServiceName": "AWS CloudFormation",
            "QuotaArn": "arn:aws:servicequotas:us-east-2:123456789012:cloudformation/L-0485CB21",
            "QuotaCode": "L-0485CB21",
            "QuotaName": "Stack count",
            "Value": 200.0,
            "Unit": "None",
            "Adjustable": true,
            "GlobalQuota": false
        }
    ]
}

Output

NextToken -> (string)

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null .

Quotas -> (list)

Information about the quotas.

(structure)

Information about a quota.

ServiceCode -> (string)

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

ServiceName -> (string)

Specifies the service name.

QuotaArn -> (string)

The Amazon Resource Name (ARN) of the quota.

QuotaCode -> (string)

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

QuotaName -> (string)

Specifies 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 associated with the reported PeriodUnit .

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 Amazon Web Service or quota.
  • DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling Service Quotas.
  • DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available.
  • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

ErrorMessage -> (string)

The error message.

QuotaAppliedAtLevel -> (string)

Specifies at which level of granularity that the quota value is applied.

QuotaContext -> (structure)

The context for this service quota.

ContextScope -> (string)

Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

ContextScopeType -> (string)

When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

ContextId -> (string)

Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.