We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.ServiceQuotas

Inherits:
AWS.Service show all
Identifier:
servicequotas
API Version:
2019-06-24
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your Amazon Web Services account. For more information, see the Service Quotas User Guide.

Sending a Request Using ServiceQuotas

var servicequotas = new AWS.ServiceQuotas();
servicequotas.associateServiceQuotaTemplate(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ServiceQuotas object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var servicequotas = new AWS.ServiceQuotas({apiVersion: '2019-06-24'});

You can also set the API version globally in AWS.config.apiVersions using the servicequotas service identifier:

AWS.config.apiVersions = {
  servicequotas: '2019-06-24',
  // other service API versions
};

var servicequotas = new AWS.ServiceQuotas();

Version:

  • 2019-06-24

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ServiceQuotas(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ServiceQuotas object

var servicequotas = new AWS.ServiceQuotas({apiVersion: '2019-06-24'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.ServiceQuotas.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.ServiceQuotas.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.ServiceQuotas.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateServiceQuotaTemplate(params = {}, callback) ⇒ AWS.Request

Associates your quota request template with your organization. When a new Amazon Web Services account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template.

Service Reference:

Examples:

Calling the associateServiceQuotaTemplate operation

var params = {
};
servicequotas.associateServiceQuotaTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteServiceQuotaIncreaseRequestFromTemplate(params = {}, callback) ⇒ AWS.Request

Deletes the quota increase request for the specified quota from your quota request template.

Service Reference:

Examples:

Calling the deleteServiceQuotaIncreaseRequestFromTemplate operation

var params = {
  AwsRegion: 'STRING_VALUE', /* required */
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE' /* required */
};
servicequotas.deleteServiceQuotaIncreaseRequestFromTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

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

    • AwsRegion — (String)

      Specifies the Amazon Web Services Region for which the request was made.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateServiceQuotaTemplate(params = {}, callback) ⇒ AWS.Request

Disables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new Amazon Web Services accounts in your organization. Disabling a quota request template does not apply its quota increase requests.

Service Reference:

Examples:

Calling the disassociateServiceQuotaTemplate operation

var params = {
};
servicequotas.disassociateServiceQuotaTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAssociationForServiceQuotaTemplate(params = {}, callback) ⇒ AWS.Request

Retrieves the status of the association for the quota request template.

Service Reference:

Examples:

Calling the getAssociationForServiceQuotaTemplate operation

var params = {
};
servicequotas.getAssociationForServiceQuotaTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServiceQuotaTemplateAssociationStatus — (String)

        The association status. If the status is ASSOCIATED, the quota increase requests in the template are automatically applied to new Amazon Web Services accounts in your organization.

        Possible values include:
        • "ASSOCIATED"
        • "DISASSOCIATED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAWSDefaultServiceQuota(params = {}, callback) ⇒ AWS.Request

Retrieves the default value for the specified quota. The default value does not reflect any quota increases.

Service Reference:

Examples:

Calling the getAWSDefaultServiceQuota operation

var params = {
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE' /* required */
};
servicequotas.getAWSDefaultServiceQuota(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Quota — (map)

        Information about the 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 — (Float)

          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 — (map)

          Information about the measurement.

          • MetricNamespace — (String)

            The namespace of the metric.

          • MetricName — (String)

            The name of the metric.

          • MetricDimensions — (map<String>)

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

          • MetricStatisticRecommendation — (String)

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

        • Period — (map)

          The period of time.

          • PeriodValue — (Integer)

            The value associated with the reported PeriodUnit.

          • PeriodUnit — (String)

            The time unit.

            Possible values include:
            • "MICROSECOND"
            • "MILLISECOND"
            • "SECOND"
            • "MINUTE"
            • "HOUR"
            • "DAY"
            • "WEEK"
        • ErrorReason — (map)

          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.

            Possible values include:
            • "DEPENDENCY_ACCESS_DENIED_ERROR"
            • "DEPENDENCY_THROTTLING_ERROR"
            • "DEPENDENCY_SERVICE_ERROR"
            • "SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
          • ErrorMessage — (String)

            The error message.

        • QuotaAppliedAtLevel — (String)

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

          Possible values include:
          • "ACCOUNT"
          • "RESOURCE"
          • "ALL"
        • QuotaContext — (map)

          The context for this service quota.

          • ContextScope — (String)

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

            Possible values include:
            • "RESOURCE"
            • "ACCOUNT"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRequestedServiceQuotaChange(params = {}, callback) ⇒ AWS.Request

Retrieves information about the specified quota increase request.

Service Reference:

Examples:

Calling the getRequestedServiceQuotaChange operation

var params = {
  RequestId: 'STRING_VALUE' /* required */
};
servicequotas.getRequestedServiceQuotaChange(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • RequestId — (String)

      Specifies the ID of the quota increase request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestedQuota — (map)

        Information about the quota increase request.

        • Id — (String)

          The unique identifier.

        • CaseId — (String)

          The case ID.

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

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

        • DesiredValue — (Float)

          The new, increased value for the quota.

        • Status — (String)

          The state of the quota increase request.

          Possible values include:
          • "PENDING"
          • "CASE_OPENED"
          • "APPROVED"
          • "DENIED"
          • "CASE_CLOSED"
          • "NOT_APPROVED"
          • "INVALID_REQUEST"
        • Created — (Date)

          The date and time when the quota increase request was received and the case ID was created.

        • LastUpdated — (Date)

          The date and time of the most recent change.

        • Requester — (String)

          The IAM identity of the requester.

        • QuotaArn — (String)

          The Amazon Resource Name (ARN) of the quota.

        • GlobalQuota — (Boolean)

          Indicates whether the quota is global.

        • Unit — (String)

          The unit of measurement.

        • QuotaRequestedAtLevel — (String)

          Specifies at which level within the Amazon Web Services account the quota request applies to.

          Possible values include:
          • "ACCOUNT"
          • "RESOURCE"
          • "ALL"
        • QuotaContext — (map)

          The context for this service quota.

          • ContextScope — (String)

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

            Possible values include:
            • "RESOURCE"
            • "ACCOUNT"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getServiceQuota(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getServiceQuota operation

var params = {
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE', /* required */
  ContextId: 'STRING_VALUE'
};
servicequotas.getServiceQuota(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

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

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Quota — (map)

        Information about the 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 — (Float)

          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 — (map)

          Information about the measurement.

          • MetricNamespace — (String)

            The namespace of the metric.

          • MetricName — (String)

            The name of the metric.

          • MetricDimensions — (map<String>)

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

          • MetricStatisticRecommendation — (String)

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

        • Period — (map)

          The period of time.

          • PeriodValue — (Integer)

            The value associated with the reported PeriodUnit.

          • PeriodUnit — (String)

            The time unit.

            Possible values include:
            • "MICROSECOND"
            • "MILLISECOND"
            • "SECOND"
            • "MINUTE"
            • "HOUR"
            • "DAY"
            • "WEEK"
        • ErrorReason — (map)

          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.

            Possible values include:
            • "DEPENDENCY_ACCESS_DENIED_ERROR"
            • "DEPENDENCY_THROTTLING_ERROR"
            • "DEPENDENCY_SERVICE_ERROR"
            • "SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
          • ErrorMessage — (String)

            The error message.

        • QuotaAppliedAtLevel — (String)

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

          Possible values include:
          • "ACCOUNT"
          • "RESOURCE"
          • "ALL"
        • QuotaContext — (map)

          The context for this service quota.

          • ContextScope — (String)

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

            Possible values include:
            • "RESOURCE"
            • "ACCOUNT"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getServiceQuotaIncreaseRequestFromTemplate(params = {}, callback) ⇒ AWS.Request

Retrieves information about the specified quota increase request in your quota request template.

Service Reference:

Examples:

Calling the getServiceQuotaIncreaseRequestFromTemplate operation

var params = {
  AwsRegion: 'STRING_VALUE', /* required */
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE' /* required */
};
servicequotas.getServiceQuotaIncreaseRequestFromTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

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

    • AwsRegion — (String)

      Specifies the Amazon Web Services Region for which you made the request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServiceQuotaIncreaseRequestInTemplate — (map)

        Information about the quota increase request.

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

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

        • DesiredValue — (Float)

          The new, increased value of the quota.

        • AwsRegion — (String)

          The Amazon Web Services Region.

        • Unit — (String)

          The unit of measurement.

        • GlobalQuota — (Boolean)

          Indicates whether the quota is global.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listAWSDefaultServiceQuotas(params = {}, callback) ⇒ AWS.Request

Lists the default values for the quotas for the specified Amazon Web Service. A default value does not reflect any quota increases.

Service Reference:

Examples:

Calling the listAWSDefaultServiceQuotas operation

var params = {
  ServiceCode: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
servicequotas.listAWSDefaultServiceQuotas(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

    • NextToken — (String)

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      Note: An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about the quotas.

        • 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 — (Float)

          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 — (map)

          Information about the measurement.

          • MetricNamespace — (String)

            The namespace of the metric.

          • MetricName — (String)

            The name of the metric.

          • MetricDimensions — (map<String>)

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

          • MetricStatisticRecommendation — (String)

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

        • Period — (map)

          The period of time.

          • PeriodValue — (Integer)

            The value associated with the reported PeriodUnit.

          • PeriodUnit — (String)

            The time unit.

            Possible values include:
            • "MICROSECOND"
            • "MILLISECOND"
            • "SECOND"
            • "MINUTE"
            • "HOUR"
            • "DAY"
            • "WEEK"
        • ErrorReason — (map)

          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.

            Possible values include:
            • "DEPENDENCY_ACCESS_DENIED_ERROR"
            • "DEPENDENCY_THROTTLING_ERROR"
            • "DEPENDENCY_SERVICE_ERROR"
            • "SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
          • ErrorMessage — (String)

            The error message.

        • QuotaAppliedAtLevel — (String)

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

          Possible values include:
          • "ACCOUNT"
          • "RESOURCE"
          • "ALL"
        • QuotaContext — (map)

          The context for this service quota.

          • ContextScope — (String)

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

            Possible values include:
            • "RESOURCE"
            • "ACCOUNT"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRequestedServiceQuotaChangeHistory(params = {}, callback) ⇒ AWS.Request

Retrieves the quota increase requests for the specified Amazon Web Service.

Service Reference:

Examples:

Calling the listRequestedServiceQuotaChangeHistory operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  QuotaRequestedAtLevel: ACCOUNT | RESOURCE | ALL,
  ServiceCode: 'STRING_VALUE',
  Status: PENDING | CASE_OPENED | APPROVED | DENIED | CASE_CLOSED | NOT_APPROVED | INVALID_REQUEST
};
servicequotas.listRequestedServiceQuotaChangeHistory(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

    • Status — (String)

      Specifies that you want to filter the results to only the requests with the matching status.

      Possible values include:
      • "PENDING"
      • "CASE_OPENED"
      • "APPROVED"
      • "DENIED"
      • "CASE_CLOSED"
      • "NOT_APPROVED"
      • "INVALID_REQUEST"
    • NextToken — (String)

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      Note: An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
    • QuotaRequestedAtLevel — (String)

      Specifies at which level within the Amazon Web Services account the quota request applies to.

      Possible values include:
      • "ACCOUNT"
      • "RESOURCE"
      • "ALL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • RequestedQuotas — (Array<map>)

        Information about the quota increase requests.

        • Id — (String)

          The unique identifier.

        • CaseId — (String)

          The case ID.

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

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

        • DesiredValue — (Float)

          The new, increased value for the quota.

        • Status — (String)

          The state of the quota increase request.

          Possible values include:
          • "PENDING"
          • "CASE_OPENED"
          • "APPROVED"
          • "DENIED"
          • "CASE_CLOSED"
          • "NOT_APPROVED"
          • "INVALID_REQUEST"
        • Created — (Date)

          The date and time when the quota increase request was received and the case ID was created.

        • LastUpdated — (Date)

          The date and time of the most recent change.

        • Requester — (String)

          The IAM identity of the requester.

        • QuotaArn — (String)

          The Amazon Resource Name (ARN) of the quota.

        • GlobalQuota — (Boolean)

          Indicates whether the quota is global.

        • Unit — (String)

          The unit of measurement.

        • QuotaRequestedAtLevel — (String)

          Specifies at which level within the Amazon Web Services account the quota request applies to.

          Possible values include:
          • "ACCOUNT"
          • "RESOURCE"
          • "ALL"
        • QuotaContext — (map)

          The context for this service quota.

          • ContextScope — (String)

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

            Possible values include:
            • "RESOURCE"
            • "ACCOUNT"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRequestedServiceQuotaChangeHistoryByQuota(params = {}, callback) ⇒ AWS.Request

Retrieves the quota increase requests for the specified quota.

Service Reference:

Examples:

Calling the listRequestedServiceQuotaChangeHistoryByQuota operation

var params = {
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  QuotaRequestedAtLevel: ACCOUNT | RESOURCE | ALL,
  Status: PENDING | CASE_OPENED | APPROVED | DENIED | CASE_CLOSED | NOT_APPROVED | INVALID_REQUEST
};
servicequotas.listRequestedServiceQuotaChangeHistoryByQuota(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

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

    • Status — (String)

      Specifies that you want to filter the results to only the requests with the matching status.

      Possible values include:
      • "PENDING"
      • "CASE_OPENED"
      • "APPROVED"
      • "DENIED"
      • "CASE_CLOSED"
      • "NOT_APPROVED"
      • "INVALID_REQUEST"
    • NextToken — (String)

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      Note: An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
    • QuotaRequestedAtLevel — (String)

      Specifies at which level within the Amazon Web Services account the quota request applies to.

      Possible values include:
      • "ACCOUNT"
      • "RESOURCE"
      • "ALL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • RequestedQuotas — (Array<map>)

        Information about the quota increase requests.

        • Id — (String)

          The unique identifier.

        • CaseId — (String)

          The case ID.

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

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

        • DesiredValue — (Float)

          The new, increased value for the quota.

        • Status — (String)

          The state of the quota increase request.

          Possible values include:
          • "PENDING"
          • "CASE_OPENED"
          • "APPROVED"
          • "DENIED"
          • "CASE_CLOSED"
          • "NOT_APPROVED"
          • "INVALID_REQUEST"
        • Created — (Date)

          The date and time when the quota increase request was received and the case ID was created.

        • LastUpdated — (Date)

          The date and time of the most recent change.

        • Requester — (String)

          The IAM identity of the requester.

        • QuotaArn — (String)

          The Amazon Resource Name (ARN) of the quota.

        • GlobalQuota — (Boolean)

          Indicates whether the quota is global.

        • Unit — (String)

          The unit of measurement.

        • QuotaRequestedAtLevel — (String)

          Specifies at which level within the Amazon Web Services account the quota request applies to.

          Possible values include:
          • "ACCOUNT"
          • "RESOURCE"
          • "ALL"
        • QuotaContext — (map)

          The context for this service quota.

          • ContextScope — (String)

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

            Possible values include:
            • "RESOURCE"
            • "ACCOUNT"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listServiceQuotaIncreaseRequestsInTemplate(params = {}, callback) ⇒ AWS.Request

Lists the quota increase requests in the specified quota request template.

Service Reference:

Examples:

Calling the listServiceQuotaIncreaseRequestsInTemplate operation

var params = {
  AwsRegion: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ServiceCode: 'STRING_VALUE'
};
servicequotas.listServiceQuotaIncreaseRequestsInTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

    • AwsRegion — (String)

      Specifies the Amazon Web Services Region for which you made the request.

    • NextToken — (String)

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      Note: An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServiceQuotaIncreaseRequestInTemplateList — (Array<map>)

        Information about the quota increase requests.

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

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

        • DesiredValue — (Float)

          The new, increased value of the quota.

        • AwsRegion — (String)

          The Amazon Web Services Region.

        • Unit — (String)

          The unit of measurement.

        • GlobalQuota — (Boolean)

          Indicates whether the quota is global.

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listServiceQuotas(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listServiceQuotas operation

var params = {
  ServiceCode: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  QuotaAppliedAtLevel: ACCOUNT | RESOURCE | ALL,
  QuotaCode: 'STRING_VALUE'
};
servicequotas.listServiceQuotas(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

    • NextToken — (String)

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      Note: An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
    • 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.

    • QuotaAppliedAtLevel — (String)

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

      Possible values include:
      • "ACCOUNT"
      • "RESOURCE"
      • "ALL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        Information about the quotas.

        • 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 — (Float)

          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 — (map)

          Information about the measurement.

          • MetricNamespace — (String)

            The namespace of the metric.

          • MetricName — (String)

            The name of the metric.

          • MetricDimensions — (map<String>)

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

          • MetricStatisticRecommendation — (String)

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

        • Period — (map)

          The period of time.

          • PeriodValue — (Integer)

            The value associated with the reported PeriodUnit.

          • PeriodUnit — (String)

            The time unit.

            Possible values include:
            • "MICROSECOND"
            • "MILLISECOND"
            • "SECOND"
            • "MINUTE"
            • "HOUR"
            • "DAY"
            • "WEEK"
        • ErrorReason — (map)

          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.

            Possible values include:
            • "DEPENDENCY_ACCESS_DENIED_ERROR"
            • "DEPENDENCY_THROTTLING_ERROR"
            • "DEPENDENCY_SERVICE_ERROR"
            • "SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
          • ErrorMessage — (String)

            The error message.

        • QuotaAppliedAtLevel — (String)

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

          Possible values include:
          • "ACCOUNT"
          • "RESOURCE"
          • "ALL"
        • QuotaContext — (map)

          The context for this service quota.

          • ContextScope — (String)

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

            Possible values include:
            • "RESOURCE"
            • "ACCOUNT"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listServices(params = {}, callback) ⇒ AWS.Request

Lists the names and codes for the Amazon Web Services integrated with Service Quotas.

Service Reference:

Examples:

Calling the listServices operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
servicequotas.listServices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

      Note: An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • Services — (Array<map>)

        The list of the Amazon Web Service names and service codes.

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Returns a list of the tags assigned to the specified applied quota.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
servicequotas.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) for the applied quota for which you want to list tags. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas CLI command or the ListServiceQuotas Amazon Web Services API operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        A complex data type that contains zero or more tag elements.

        • Key — required — (String)

          A string that contains a tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

        • Value — required — (String)

          A string that contains an optional tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putServiceQuotaIncreaseRequestIntoTemplate(params = {}, callback) ⇒ AWS.Request

Adds a quota increase request to your quota request template.

Service Reference:

Examples:

Calling the putServiceQuotaIncreaseRequestIntoTemplate operation

var params = {
  AwsRegion: 'STRING_VALUE', /* required */
  DesiredValue: 'NUMBER_VALUE', /* required */
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE' /* required */
};
servicequotas.putServiceQuotaIncreaseRequestIntoTemplate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • 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.

    • ServiceCode — (String)

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

    • AwsRegion — (String)

      Specifies the Amazon Web Services Region to which the template applies.

    • DesiredValue — (Float)

      Specifies the new, increased value for the quota.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ServiceQuotaIncreaseRequestInTemplate — (map)

        Information about the quota increase request.

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

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

        • DesiredValue — (Float)

          The new, increased value of the quota.

        • AwsRegion — (String)

          The Amazon Web Services Region.

        • Unit — (String)

          The unit of measurement.

        • GlobalQuota — (Boolean)

          Indicates whether the quota is global.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

requestServiceQuotaIncrease(params = {}, callback) ⇒ AWS.Request

Submits a quota increase request for the specified quota.

Service Reference:

Examples:

Calling the requestServiceQuotaIncrease operation

var params = {
  DesiredValue: 'NUMBER_VALUE', /* required */
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE', /* required */
  ContextId: 'STRING_VALUE'
};
servicequotas.requestServiceQuotaIncrease(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ServiceCode — (String)

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

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

    • DesiredValue — (Float)

      Specifies the new, increased value for the quota.

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RequestedQuota — (map)

        Information about the quota increase request.

        • Id — (String)

          The unique identifier.

        • CaseId — (String)

          The case ID.

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

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

        • DesiredValue — (Float)

          The new, increased value for the quota.

        • Status — (String)

          The state of the quota increase request.

          Possible values include:
          • "PENDING"
          • "CASE_OPENED"
          • "APPROVED"
          • "DENIED"
          • "CASE_CLOSED"
          • "NOT_APPROVED"
          • "INVALID_REQUEST"
        • Created — (Date)

          The date and time when the quota increase request was received and the case ID was created.

        • LastUpdated — (Date)

          The date and time of the most recent change.

        • Requester — (String)

          The IAM identity of the requester.

        • QuotaArn — (String)

          The Amazon Resource Name (ARN) of the quota.

        • GlobalQuota — (Boolean)

          Indicates whether the quota is global.

        • Unit — (String)

          The unit of measurement.

        • QuotaRequestedAtLevel — (String)

          Specifies at which level within the Amazon Web Services account the quota request applies to.

          Possible values include:
          • "ACCOUNT"
          • "RESOURCE"
          • "ALL"
        • QuotaContext — (map)

          The context for this service quota.

          • ContextScope — (String)

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

            Possible values include:
            • "RESOURCE"
            • "ACCOUNT"
          • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds tags to the specified applied quota. You can include one or more tags to add to the quota.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
servicequotas.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) for the applied quota. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas CLI command or the ListServiceQuotas Amazon Web Services API operation.

    • Tags — (Array<map>)

      The tags that you want to add to the resource.

      • Key — required — (String)

        A string that contains a tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Value — required — (String)

        A string that contains an optional tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from the specified applied quota. You can specify one or more tags to remove.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
servicequotas.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) for the applied quota that you want to untag. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas CLI command or the ListServiceQuotas Amazon Web Services API operation.

    • TagKeys — (Array<String>)

      The keys of the tags that you want to remove from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.