list-service-quotas¶

Description¶

Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you’ll see the default values are the values that AWS provides for the quotas.

Note

Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

Synopsis¶

  list-service-quotas
--service-code <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--service-code (string)

The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.

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

--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. 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 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 in the response, this value indicates there’s more output available that what’s included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null ).

Quotas -> (list)

The response information for a quota lists all attribute information for the quota.

(structure)

A structure that contains the full set of details that define the service 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.

Table of Contents

Feedback

User Guide