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

Service Quotas is a web service that you can use to manage many of your AWS service quotas. Quotas, also referred to as limits, are the maximum values for a resource, item, or operation. This guide provide descriptions of the Service Quotas actions that you can call from an API. For the Service Quotas user guide, which explains how to use Service Quotas from the console, see What is Service Quotas.

Note: AWS provides SDKs that consist of libraries and sample code for programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc...,). The SDKs provide a convenient way to create programmatic access to Service Quotas and AWS. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

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)

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

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

Property Details

endpointAWS.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 the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the 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

Removes a service quota increase request from the Service Quotas template.

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 code for the service that you want to delete.

    • QuotaCode — (String)

      Specifies the code for the quota that you want to delete.

    • AwsRegion — (String)

      Specifies the AWS Region for the quota that you want to delete.

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 the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template.

Related operations

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 ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.

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)

        Specifies whether the template is ASSOCIATED or DISASSOCIATED. If the template is ASSOCIATED, then it requests service quota increases for all new accounts created 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 service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..

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 that you want to use.

    • QuotaCode — (String)

      Identifies the service quota you want to select.

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)

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

        • ServiceCode — (String)

          Specifies the service that you want to use.

        • ServiceName — (String)

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

        • QuotaArn — (String)

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

        • QuotaCode — (String)

          The code identifier for the service quota specified.

        • QuotaName — (String)

          The name identifier of the service quota.

        • Value — (Float)

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

          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<String>)

            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.

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

          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.

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

          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.

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

            The error message that provides more detail.

Returns:

  • (AWS.Request)

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

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

Retrieves the details for a particular 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)

      Identifies 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)

        Returns the RequestedServiceQuotaChange object for the specific increase request.

        • Id — (String)

          The unique identifier of a requested service quota change.

        • CaseId — (String)

          The case Id for the service quota increase request.

        • ServiceCode — (String)

          Specifies the service that you want to use.

        • ServiceName — (String)

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

        • QuotaCode — (String)

          Specifies the service quota that you want to use.

        • QuotaName — (String)

          Name of the service quota.

        • DesiredValue — (Float)

          New increased value for the service quota.

        • Status — (String)

          State of the service quota increase request.

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

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

        • LastUpdated — (Date)

          The date and time of the most recent change in the service quota increase request.

        • Requester — (String)

          The IAM identity who submitted the service quota increase request.

        • QuotaArn — (String)

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

        • GlobalQuota — (Boolean)

          Identifies if the quota is global.

        • Unit — (String)

          Specifies the unit used for the quota.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the getServiceQuota operation

var params = {
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE' /* required */
};
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 that you want to use.

    • QuotaCode — (String)

      Identifies the service quota you want to select.

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)

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

        • ServiceCode — (String)

          Specifies the service that you want to use.

        • ServiceName — (String)

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

        • QuotaArn — (String)

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

        • QuotaCode — (String)

          The code identifier for the service quota specified.

        • QuotaName — (String)

          The name identifier of the service quota.

        • Value — (Float)

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

          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<String>)

            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.

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

          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.

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

          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.

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

            The error message that provides more detail.

Returns:

  • (AWS.Request)

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

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

Returns the details of the service quota increase request in your template.

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 that you want to use.

    • QuotaCode — (String)

      Specifies the quota you want.

    • AwsRegion — (String)

      Specifies the AWS Region for the quota that you want to use.

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)

        This object contains the details about the quota increase request.

        • ServiceCode — (String)

          The code identifier for the AWS service specified in the increase request.

        • ServiceName — (String)

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

        • QuotaCode — (String)

          The code identifier for the service quota specified in the increase request.

        • QuotaName — (String)

          The name of the service quota in the increase request.

        • DesiredValue — (Float)

          Identifies the new, increased value of the service quota in the increase request.

        • AwsRegion — (String)

          The AWS Region where the increase request occurs.

        • Unit — (String)

          The unit of measure for the increase request.

        • GlobalQuota — (Boolean)

          Specifies if the quota is a global quota.

Returns:

  • (AWS.Request)

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

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

Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each 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.

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 that you want to use.

    • NextToken — (String)

      (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

    • MaxResults — (Integer)

      (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. 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)

        (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

      • Quotas — (Array<map>)

        A list of the quotas in the account with the AWS default values.

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

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

          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<String>)

            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.

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

          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.

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

          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.

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

            The error message that provides more detail.

Returns:

  • (AWS.Request)

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

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

Requests a list of the changes to quotas for a service.

Examples:

Calling the listRequestedServiceQuotaChangeHistory operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ServiceCode: 'STRING_VALUE',
  Status: PENDING | CASE_OPENED | APPROVED | DENIED | CASE_CLOSED
};
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 that you want to use.

    • Status — (String)

      Specifies the status value of the quota increase request.

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

      (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. 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 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).

      • RequestedQuotas — (Array<map>)

        Returns a list of service quota requests.

        • Id — (String)

          The unique identifier of a requested service quota change.

        • CaseId — (String)

          The case Id for the service quota increase request.

        • ServiceCode — (String)

          Specifies the service that you want to use.

        • ServiceName — (String)

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

        • QuotaCode — (String)

          Specifies the service quota that you want to use.

        • QuotaName — (String)

          Name of the service quota.

        • DesiredValue — (Float)

          New increased value for the service quota.

        • Status — (String)

          State of the service quota increase request.

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

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

        • LastUpdated — (Date)

          The date and time of the most recent change in the service quota increase request.

        • Requester — (String)

          The IAM identity who submitted the service quota increase request.

        • QuotaArn — (String)

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

        • GlobalQuota — (Boolean)

          Identifies if the quota is global.

        • Unit — (String)

          Specifies the unit used for the quota.

Returns:

  • (AWS.Request)

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

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

Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, the history has been kept for 90 days.

Examples:

Calling the listRequestedServiceQuotaChangeHistoryByQuota operation

var params = {
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: PENDING | CASE_OPENED | APPROVED | DENIED | CASE_CLOSED
};
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 that you want to use.

    • QuotaCode — (String)

      Specifies the service quota that you want to use

    • Status — (String)

      Specifies the status value of the quota increase request.

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

      (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. 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 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).

      • RequestedQuotas — (Array<map>)

        Returns a list of service quota requests.

        • Id — (String)

          The unique identifier of a requested service quota change.

        • CaseId — (String)

          The case Id for the service quota increase request.

        • ServiceCode — (String)

          Specifies the service that you want to use.

        • ServiceName — (String)

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

        • QuotaCode — (String)

          Specifies the service quota that you want to use.

        • QuotaName — (String)

          Name of the service quota.

        • DesiredValue — (Float)

          New increased value for the service quota.

        • Status — (String)

          State of the service quota increase request.

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

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

        • LastUpdated — (Date)

          The date and time of the most recent change in the service quota increase request.

        • Requester — (String)

          The IAM identity who submitted the service quota increase request.

        • QuotaArn — (String)

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

        • GlobalQuota — (Boolean)

          Identifies if the quota is global.

        • Unit — (String)

          Specifies the unit used for the quota.

Returns:

  • (AWS.Request)

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

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

Returns a list of the quota increase requests in the template.

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)

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

    • AwsRegion — (String)

      Specifies the AWS Region for the quota that you want to use.

    • NextToken — (String)

      (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. 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>)

        Returns the list of values of the quota increase request in the template.

        • ServiceCode — (String)

          The code identifier for the AWS service specified in the increase request.

        • ServiceName — (String)

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

        • QuotaCode — (String)

          The code identifier for the service quota specified in the increase request.

        • QuotaName — (String)

          The name of the service quota in the increase request.

        • DesiredValue — (Float)

          Identifies the new, increased value of the service quota in the increase request.

        • AwsRegion — (String)

          The AWS Region where the increase request occurs.

        • Unit — (String)

          The unit of measure for the increase request.

        • GlobalQuota — (Boolean)

          Specifies if the quota is a global quota.

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

Returns:

  • (AWS.Request)

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

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

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.

Service Reference:

Examples:

Calling the listServiceQuotas operation

var params = {
  ServiceCode: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: '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)

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

    • NextToken — (String)

      (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. 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 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 — (Array<map>)

        The response information for a quota lists all attribute information for the 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 — (Float)

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

          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<String>)

            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.

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

          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.

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

          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.

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

            The error message that provides more detail.

Returns:

  • (AWS.Request)

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

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

Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.

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)

      (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • MaxResults — (Integer)

      (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. 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 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).

      • Services — (Array<map>)

        Returns a list of services.

        • ServiceCode — (String)

          Specifies the service that you want to use.

        • ServiceName — (String)

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

Returns:

  • (AWS.Request)

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

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

Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the ServiceCode, QuotaCode, AwsRegion, and DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the template.

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 service quota that you want to use.

    • ServiceCode — (String)

      Specifies the service that you want to use.

    • AwsRegion — (String)

      Specifies the AWS Region for the quota.

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

        A structure that contains information about one service quota increase request.

        • ServiceCode — (String)

          The code identifier for the AWS service specified in the increase request.

        • ServiceName — (String)

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

        • QuotaCode — (String)

          The code identifier for the service quota specified in the increase request.

        • QuotaName — (String)

          The name of the service quota in the increase request.

        • DesiredValue — (Float)

          Identifies the new, increased value of the service quota in the increase request.

        • AwsRegion — (String)

          The AWS Region where the increase request occurs.

        • Unit — (String)

          The unit of measure for the increase request.

        • GlobalQuota — (Boolean)

          Specifies if the quota is a global quota.

Returns:

  • (AWS.Request)

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

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

Retrieves the details of a service quota increase request. The response to this command provides the details in the RequestedServiceQuotaChange object.

Service Reference:

Examples:

Calling the requestServiceQuotaIncrease operation

var params = {
  DesiredValue: 'NUMBER_VALUE', /* required */
  QuotaCode: 'STRING_VALUE', /* required */
  ServiceCode: 'STRING_VALUE' /* required */
};
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 that you want to use.

    • QuotaCode — (String)

      Specifies the service quota that you want to use.

    • DesiredValue — (Float)

      Specifies the value submitted in the service 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)

        Returns a list of service quota requests.

        • Id — (String)

          The unique identifier of a requested service quota change.

        • CaseId — (String)

          The case Id for the service quota increase request.

        • ServiceCode — (String)

          Specifies the service that you want to use.

        • ServiceName — (String)

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

        • QuotaCode — (String)

          Specifies the service quota that you want to use.

        • QuotaName — (String)

          Name of the service quota.

        • DesiredValue — (Float)

          New increased value for the service quota.

        • Status — (String)

          State of the service quota increase request.

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

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

        • LastUpdated — (Date)

          The date and time of the most recent change in the service quota increase request.

        • Requester — (String)

          The IAM identity who submitted the service quota increase request.

        • QuotaArn — (String)

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

        • GlobalQuota — (Boolean)

          Identifies if the quota is global.

        • Unit — (String)

          Specifies the unit used for the quota.

Returns:

  • (AWS.Request)

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