You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ServiceQuotas::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Service Quotas. To construct a client, you need to configure a :region and :credentials.

servicequotas = Aws::ServiceQuotas::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::ServiceQuotas::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::ServiceQuotas::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#associate_service_quota_template(options = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.associate_service_quota_template()

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_service_quota_increase_request_from_template(options = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_service_quota_increase_request_from_template({
  service_code: "ServiceCode", # required
  quota_code: "QuotaCode", # required
  aws_region: "AwsRegion", # required
})

Options Hash (options):

  • :service_code (required, String) —

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

  • :quota_code (required, String) —

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

  • :aws_region (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#disassociate_service_quota_template(options = {}) ⇒ Struct

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:

Request syntax with placeholder values


resp = client.disassociate_service_quota_template()

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#get_association_for_service_quota_template(options = {}) ⇒ Types::GetAssociationForServiceQuotaTemplateResponse

Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.

Examples:

Request syntax with placeholder values


resp = client.get_association_for_service_quota_template()

Response structure


resp.service_quota_template_association_status #=> String, one of "ASSOCIATED", "DISASSOCIATED"

Returns:

See Also:

#get_aws_default_service_quota(options = {}) ⇒ Types::GetAWSDefaultServiceQuotaResponse

Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..

Examples:

Request syntax with placeholder values


resp = client.get_aws_default_service_quota({
  service_code: "ServiceCode", # required
  quota_code: "QuotaCode", # required
})

Response structure


resp.quota.service_code #=> String
resp.quota.service_name #=> String
resp.quota.quota_arn #=> String
resp.quota.quota_code #=> String
resp.quota.quota_name #=> String
resp.quota.value #=> Float
resp.quota.unit #=> String
resp.quota.adjustable #=> true/false
resp.quota.global_quota #=> true/false
resp.quota.usage_metric.metric_namespace #=> String
resp.quota.usage_metric.metric_name #=> String
resp.quota.usage_metric.metric_dimensions #=> Hash
resp.quota.usage_metric.metric_dimensions["MetricDimensionName"] #=> String
resp.quota.usage_metric.metric_statistic_recommendation #=> String
resp.quota.period.period_value #=> Integer
resp.quota.period.period_unit #=> String, one of "MICROSECOND", "MILLISECOND", "SECOND", "MINUTE", "HOUR", "DAY", "WEEK"
resp.quota.error_reason.error_code #=> String, one of "DEPENDENCY_ACCESS_DENIED_ERROR", "DEPENDENCY_THROTTLING_ERROR", "DEPENDENCY_SERVICE_ERROR", "SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
resp.quota.error_reason.error_message #=> String

Options Hash (options):

  • :service_code (required, String) —

    Specifies the service that you want to use.

  • :quota_code (required, String) —

    Identifies the service quota you want to select.

Returns:

See Also:

#get_requested_service_quota_change(options = {}) ⇒ Types::GetRequestedServiceQuotaChangeResponse

Retrieves the details for a particular increase request.

Examples:

Request syntax with placeholder values


resp = client.get_requested_service_quota_change({
  request_id: "RequestId", # required
})

Response structure


resp.requested_quota.id #=> String
resp.requested_quota.case_id #=> String
resp.requested_quota.service_code #=> String
resp.requested_quota.service_name #=> String
resp.requested_quota.quota_code #=> String
resp.requested_quota.quota_name #=> String
resp.requested_quota.desired_value #=> Float
resp.requested_quota.status #=> String, one of "PENDING", "CASE_OPENED", "APPROVED", "DENIED", "CASE_CLOSED"
resp.requested_quota.created #=> Time
resp.requested_quota.last_updated #=> Time
resp.requested_quota.requester #=> String
resp.requested_quota.quota_arn #=> String
resp.requested_quota.global_quota #=> true/false
resp.requested_quota.unit #=> String

Options Hash (options):

  • :request_id (required, String) —

    Identifies the quota increase request.

Returns:

See Also:

#get_service_quota(options = {}) ⇒ Types::GetServiceQuotaResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_service_quota({
  service_code: "ServiceCode", # required
  quota_code: "QuotaCode", # required
})

Response structure


resp.quota.service_code #=> String
resp.quota.service_name #=> String
resp.quota.quota_arn #=> String
resp.quota.quota_code #=> String
resp.quota.quota_name #=> String
resp.quota.value #=> Float
resp.quota.unit #=> String
resp.quota.adjustable #=> true/false
resp.quota.global_quota #=> true/false
resp.quota.usage_metric.metric_namespace #=> String
resp.quota.usage_metric.metric_name #=> String
resp.quota.usage_metric.metric_dimensions #=> Hash
resp.quota.usage_metric.metric_dimensions["MetricDimensionName"] #=> String
resp.quota.usage_metric.metric_statistic_recommendation #=> String
resp.quota.period.period_value #=> Integer
resp.quota.period.period_unit #=> String, one of "MICROSECOND", "MILLISECOND", "SECOND", "MINUTE", "HOUR", "DAY", "WEEK"
resp.quota.error_reason.error_code #=> String, one of "DEPENDENCY_ACCESS_DENIED_ERROR", "DEPENDENCY_THROTTLING_ERROR", "DEPENDENCY_SERVICE_ERROR", "SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
resp.quota.error_reason.error_message #=> String

Options Hash (options):

  • :service_code (required, String) —

    Specifies the service that you want to use.

  • :quota_code (required, String) —

    Identifies the service quota you want to select.

Returns:

See Also:

#get_service_quota_increase_request_from_template(options = {}) ⇒ Types::GetServiceQuotaIncreaseRequestFromTemplateResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_service_quota_increase_request_from_template({
  service_code: "ServiceCode", # required
  quota_code: "QuotaCode", # required
  aws_region: "AwsRegion", # required
})

Response structure


resp.service_quota_increase_request_in_template.service_code #=> String
resp.service_quota_increase_request_in_template.service_name #=> String
resp.service_quota_increase_request_in_template.quota_code #=> String
resp.service_quota_increase_request_in_template.quota_name #=> String
resp.service_quota_increase_request_in_template.desired_value #=> Float
resp.service_quota_increase_request_in_template.aws_region #=> String
resp.service_quota_increase_request_in_template.unit #=> String
resp.service_quota_increase_request_in_template.global_quota #=> true/false

Options Hash (options):

  • :service_code (required, String) —

    Specifies the service that you want to use.

  • :quota_code (required, String) —

    Specifies the quota you want.

  • :aws_region (required, String) —

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

Returns:

See Also:

#list_aws_default_service_quotas(options = {}) ⇒ Types::ListAWSDefaultServiceQuotasResponse

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.

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.

Examples:

Request syntax with placeholder values


resp = client.list_aws_default_service_quotas({
  service_code: "ServiceCode", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.quotas #=> Array
resp.quotas[0].service_code #=> String
resp.quotas[0].service_name #=> String
resp.quotas[0].quota_arn #=> String
resp.quotas[0].quota_code #=> String
resp.quotas[0].quota_name #=> String
resp.quotas[0].value #=> Float
resp.quotas[0].unit #=> String
resp.quotas[0].adjustable #=> true/false
resp.quotas[0].global_quota #=> true/false
resp.quotas[0].usage_metric.metric_namespace #=> String
resp.quotas[0].usage_metric.metric_name #=> String
resp.quotas[0].usage_metric.metric_dimensions #=> Hash
resp.quotas[0].usage_metric.metric_dimensions["MetricDimensionName"] #=> String
resp.quotas[0].usage_metric.metric_statistic_recommendation #=> String
resp.quotas[0].period.period_value #=> Integer
resp.quotas[0].period.period_unit #=> String, one of "MICROSECOND", "MILLISECOND", "SECOND", "MINUTE", "HOUR", "DAY", "WEEK"
resp.quotas[0].error_reason.error_code #=> String, one of "DEPENDENCY_ACCESS_DENIED_ERROR", "DEPENDENCY_THROTTLING_ERROR", "DEPENDENCY_SERVICE_ERROR", "SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
resp.quotas[0].error_reason.error_message #=> String

Options Hash (options):

  • :service_code (required, String) —

    Specifies the service that you want to use.

  • :next_token (String) — default: 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.

  • :max_results (Integer) — default: 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.

Returns:

See Also:

#list_requested_service_quota_change_history(options = {}) ⇒ Types::ListRequestedServiceQuotaChangeHistoryResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_requested_service_quota_change_history({
  service_code: "ServiceCode",
  status: "PENDING", # accepts PENDING, CASE_OPENED, APPROVED, DENIED, CASE_CLOSED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.requested_quotas #=> Array
resp.requested_quotas[0].id #=> String
resp.requested_quotas[0].case_id #=> String
resp.requested_quotas[0].service_code #=> String
resp.requested_quotas[0].service_name #=> String
resp.requested_quotas[0].quota_code #=> String
resp.requested_quotas[0].quota_name #=> String
resp.requested_quotas[0].desired_value #=> Float
resp.requested_quotas[0].status #=> String, one of "PENDING", "CASE_OPENED", "APPROVED", "DENIED", "CASE_CLOSED"
resp.requested_quotas[0].created #=> Time
resp.requested_quotas[0].last_updated #=> Time
resp.requested_quotas[0].requester #=> String
resp.requested_quotas[0].quota_arn #=> String
resp.requested_quotas[0].global_quota #=> true/false
resp.requested_quotas[0].unit #=> String

Options Hash (options):

  • :service_code (String) —

    Specifies the service that you want to use.

  • :status (String) —

    Specifies the status value of the quota increase request.

  • :next_token (String) — default: 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.

  • :max_results (Integer) — default: 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.

Returns:

See Also:

#list_requested_service_quota_change_history_by_quota(options = {}) ⇒ Types::ListRequestedServiceQuotaChangeHistoryByQuotaResponse

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:

Request syntax with placeholder values


resp = client.list_requested_service_quota_change_history_by_quota({
  service_code: "ServiceCode", # required
  quota_code: "QuotaCode", # required
  status: "PENDING", # accepts PENDING, CASE_OPENED, APPROVED, DENIED, CASE_CLOSED
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.requested_quotas #=> Array
resp.requested_quotas[0].id #=> String
resp.requested_quotas[0].case_id #=> String
resp.requested_quotas[0].service_code #=> String
resp.requested_quotas[0].service_name #=> String
resp.requested_quotas[0].quota_code #=> String
resp.requested_quotas[0].quota_name #=> String
resp.requested_quotas[0].desired_value #=> Float
resp.requested_quotas[0].status #=> String, one of "PENDING", "CASE_OPENED", "APPROVED", "DENIED", "CASE_CLOSED"
resp.requested_quotas[0].created #=> Time
resp.requested_quotas[0].last_updated #=> Time
resp.requested_quotas[0].requester #=> String
resp.requested_quotas[0].quota_arn #=> String
resp.requested_quotas[0].global_quota #=> true/false
resp.requested_quotas[0].unit #=> String

Options Hash (options):

  • :service_code (required, String) —

    Specifies the service that you want to use.

  • :quota_code (required, String) —

    Specifies the service quota that you want to use

  • :status (String) —

    Specifies the status value of the quota increase request.

  • :next_token (String) — default: 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.

  • :max_results (Integer) — default: 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.

Returns:

See Also:

#list_service_quota_increase_requests_in_template(options = {}) ⇒ Types::ListServiceQuotaIncreaseRequestsInTemplateResponse

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

Examples:

Request syntax with placeholder values


resp = client.list_service_quota_increase_requests_in_template({
  service_code: "ServiceCode",
  aws_region: "AwsRegion",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.service_quota_increase_request_in_template_list #=> Array
resp.service_quota_increase_request_in_template_list[0].service_code #=> String
resp.service_quota_increase_request_in_template_list[0].service_name #=> String
resp.service_quota_increase_request_in_template_list[0].quota_code #=> String
resp.service_quota_increase_request_in_template_list[0].quota_name #=> String
resp.service_quota_increase_request_in_template_list[0].desired_value #=> Float
resp.service_quota_increase_request_in_template_list[0].aws_region #=> String
resp.service_quota_increase_request_in_template_list[0].unit #=> String
resp.service_quota_increase_request_in_template_list[0].global_quota #=> true/false
resp.next_token #=> String

Options Hash (options):

  • :service_code (String) —

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

  • :aws_region (String) —

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

  • :next_token (String) — default: 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.

  • :max_results (Integer) — default: 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.

Returns:

See Also:

#list_service_quotas(options = {}) ⇒ Types::ListServiceQuotasResponse

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.

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.

Examples:

Request syntax with placeholder values


resp = client.list_service_quotas({
  service_code: "ServiceCode", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.quotas #=> Array
resp.quotas[0].service_code #=> String
resp.quotas[0].service_name #=> String
resp.quotas[0].quota_arn #=> String
resp.quotas[0].quota_code #=> String
resp.quotas[0].quota_name #=> String
resp.quotas[0].value #=> Float
resp.quotas[0].unit #=> String
resp.quotas[0].adjustable #=> true/false
resp.quotas[0].global_quota #=> true/false
resp.quotas[0].usage_metric.metric_namespace #=> String
resp.quotas[0].usage_metric.metric_name #=> String
resp.quotas[0].usage_metric.metric_dimensions #=> Hash
resp.quotas[0].usage_metric.metric_dimensions["MetricDimensionName"] #=> String
resp.quotas[0].usage_metric.metric_statistic_recommendation #=> String
resp.quotas[0].period.period_value #=> Integer
resp.quotas[0].period.period_unit #=> String, one of "MICROSECOND", "MILLISECOND", "SECOND", "MINUTE", "HOUR", "DAY", "WEEK"
resp.quotas[0].error_reason.error_code #=> String, one of "DEPENDENCY_ACCESS_DENIED_ERROR", "DEPENDENCY_THROTTLING_ERROR", "DEPENDENCY_SERVICE_ERROR", "SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
resp.quotas[0].error_reason.error_message #=> String

Options Hash (options):

  • :service_code (required, String) —

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

  • :next_token (String) — default: 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.

  • :max_results (Integer) — default: 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.

Returns:

See Also:

#list_services(options = {}) ⇒ Types::ListServicesResponse

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.

Examples:

Request syntax with placeholder values


resp = client.list_services({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.next_token #=> String
resp.services #=> Array
resp.services[0].service_code #=> String
resp.services[0].service_name #=> String

Options Hash (options):

  • :next_token (String) — default: 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.

  • :max_results (Integer) — default: 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.

Returns:

See Also:

#put_service_quota_increase_request_into_template(options = {}) ⇒ Types::PutServiceQuotaIncreaseRequestIntoTemplateResponse

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:

Request syntax with placeholder values


resp = client.put_service_quota_increase_request_into_template({
  quota_code: "QuotaCode", # required
  service_code: "ServiceCode", # required
  aws_region: "AwsRegion", # required
  desired_value: 1.0, # required
})

Response structure


resp.service_quota_increase_request_in_template.service_code #=> String
resp.service_quota_increase_request_in_template.service_name #=> String
resp.service_quota_increase_request_in_template.quota_code #=> String
resp.service_quota_increase_request_in_template.quota_name #=> String
resp.service_quota_increase_request_in_template.desired_value #=> Float
resp.service_quota_increase_request_in_template.aws_region #=> String
resp.service_quota_increase_request_in_template.unit #=> String
resp.service_quota_increase_request_in_template.global_quota #=> true/false

Options Hash (options):

  • :quota_code (required, String) —

    Specifies the service quota that you want to use.

  • :service_code (required, String) —

    Specifies the service that you want to use.

  • :aws_region (required, String) —

    Specifies the AWS Region for the quota.

  • :desired_value (required, Float) —

    Specifies the new, increased value for the quota.

Returns:

See Also:

#request_service_quota_increase(options = {}) ⇒ Types::RequestServiceQuotaIncreaseResponse

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

Examples:

Request syntax with placeholder values


resp = client.request_service_quota_increase({
  service_code: "ServiceCode", # required
  quota_code: "QuotaCode", # required
  desired_value: 1.0, # required
})

Response structure


resp.requested_quota.id #=> String
resp.requested_quota.case_id #=> String
resp.requested_quota.service_code #=> String
resp.requested_quota.service_name #=> String
resp.requested_quota.quota_code #=> String
resp.requested_quota.quota_name #=> String
resp.requested_quota.desired_value #=> Float
resp.requested_quota.status #=> String, one of "PENDING", "CASE_OPENED", "APPROVED", "DENIED", "CASE_CLOSED"
resp.requested_quota.created #=> Time
resp.requested_quota.last_updated #=> Time
resp.requested_quota.requester #=> String
resp.requested_quota.quota_arn #=> String
resp.requested_quota.global_quota #=> true/false
resp.requested_quota.unit #=> String

Options Hash (options):

  • :service_code (required, String) —

    Specifies the service that you want to use.

  • :quota_code (required, String) —

    Specifies the service quota that you want to use.

  • :desired_value (required, Float) —

    Specifies the value submitted in the service quota increase request.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {}) —

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.