class Aws::ServiceQuotas::Client

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

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Attributes

identifier[R]

@api private

Public Class Methods

errors_module() click to toggle source

@api private

# File lib/aws-sdk-servicequotas/client.rb, line 1192
def errors_module
  Errors
end
new(*args) click to toggle source

@overload initialize(options)

@param [Hash] options
@option options [required, Aws::CredentialProvider] :credentials
  Your AWS credentials. This can be an instance of any one of the
  following classes:

  * `Aws::Credentials` - Used for configuring static, non-refreshing
    credentials.

  * `Aws::SharedCredentials` - Used for loading static credentials from a
    shared file, such as `~/.aws/config`.

  * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.

  * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
    assume a role after providing credentials via the web.

  * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
    access token generated from `aws login`.

  * `Aws::ProcessCredentials` - Used for loading credentials from a
    process that outputs to stdout.

  * `Aws::InstanceProfileCredentials` - Used for loading credentials
    from an EC2 IMDS on an EC2 instance.

  * `Aws::ECSCredentials` - Used for loading credentials from
    instances running in ECS.

  * `Aws::CognitoIdentityCredentials` - Used for loading credentials
    from the Cognito Identity service.

  When `:credentials` are not configured directly, the following
  locations will be searched for credentials:

  * `Aws.config[:credentials]`
  * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
  * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
  * `~/.aws/credentials`
  * `~/.aws/config`
  * EC2/ECS IMDS instance profile - When used by default, the timeouts
    are very aggressive. Construct and pass an instance of
    `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
    enable retries and extended timeouts.

@option options [required, String] :region
  The AWS region to connect to.  The configured `:region` is
  used to determine the service `:endpoint`. When not passed,
  a default `:region` is searched for in the following locations:

  * `Aws.config[:region]`
  * `ENV['AWS_REGION']`
  * `ENV['AMAZON_REGION']`
  * `ENV['AWS_DEFAULT_REGION']`
  * `~/.aws/credentials`
  * `~/.aws/config`

@option options [String] :access_key_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (true)
  Used only in `adaptive` retry mode.  When true, the request will sleep
  until there is sufficent client side capacity to retry the request.
  When false, the request will raise a `RetryCapacityNotAvailableError` and will
  not retry instead of sleeping.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("127.0.0.1")
  Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
  side monitoring agent is running on, where client metrics will be published via UDP.

@option options [Integer] :client_side_monitoring_port (31000)
  Required for publishing client metrics. The port that the client side monitoring
  agent is running on, where client metrics will be published via UDP.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

@option options [String] :endpoint
  The client endpoint is normally constructed from the `:region`
  option. You should only configure an `:endpoint` when connecting
  to test or custom endpoints. This should be a valid HTTP(S) URI.

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (60)
  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.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (3)
  An integer representing the maximum number attempts that will be made for
  a single request, including the initial attempt.  For example,
  setting this value to 5 will result in a request being retried up to
  4 times. Used in `standard` and `adaptive` retry modes.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (:none)
  A delay randomiser function used by the default backoff function.
  Some predefined functions can be referenced by name - :none, :equal, :full,
  otherwise a Proc that takes and returns a number. This option is only used
  in the `legacy` retry mode.

  @see https://www.awsarchitectureblog.com/2015/03/backoff.html

@option options [Integer] :retry_limit (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, auth errors,
  endpoint discovery, and errors from expired credentials.
  This option is only used in the `legacy` retry mode.

@option options [Integer] :retry_max_delay (0)
  The maximum number of seconds to delay between retries (0 for no limit)
  used by the default backoff function. This option is only used in the
  `legacy` retry mode.

@option options [String] :retry_mode ("legacy")
  Specifies which retry algorithm to use. Values are:

  * `legacy` - The pre-existing retry behavior.  This is default value if
    no retry mode is provided.

  * `standard` - A standardized set of retry rules across the AWS SDKs.
    This includes support for retry quotas, which limit the number of
    unsuccessful retries a client can make.

  * `adaptive` - An experimental retry mode that includes all the
    functionality of `standard` mode along with automatic client side
    throttling.  This is a provisional mode that may change behavior
    in the future.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Boolean] :simple_json (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.

@option options [Boolean] :stub_responses (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.

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [URI::HTTP,String] :http_proxy A proxy to send
  requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_open_timeout (15) The number of
  seconds to wait when opening a HTTP session before raising a
  `Timeout::Error`.

@option options [Integer] :http_read_timeout (60) The default
  number of seconds to wait for response data.  This value can
  safely be set per-request on the session.

@option options [Float] :http_idle_timeout (5) The number of
  seconds a connection is allowed to sit idle before it is
  considered stale.  Stale connections are closed and removed
  from the pool before making a request.

@option options [Float] :http_continue_timeout (1) The number of
  seconds to wait for a 100-continue response before sending the
  request body.  This option has no effect unless the request has
  "Expect" header set to "100-continue".  Defaults to `nil` which
  disables this behaviour.  This value can safely be set per
  request on the session.

@option options [Boolean] :http_wire_trace (false) When `true`,
  HTTP debug output will be sent to the `:logger`.

@option options [Boolean] :ssl_verify_peer (true) When `true`,
  SSL peer certificates are verified when establishing a
  connection.

@option options [String] :ssl_ca_bundle Full path to the SSL
  certificate authority bundle file that should be used when
  verifying peer certificates.  If you do not pass
  `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
  will be used if available.

@option options [String] :ssl_ca_directory Full path of the
  directory that contains the unbundled SSL certificate
  authority files for verifying peer certificates.  If you do
  not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
  system default will be used if available.
Calls superclass method
# File lib/aws-sdk-servicequotas/client.rb, line 334
def initialize(*args)
  super
end

Public Instance Methods

associate_service_quota_template(params = {}, options = {}) click to toggle source

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

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/AssociateServiceQuotaTemplate AWS API Documentation

@overload associate_service_quota_template(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 352
def associate_service_quota_template(params = {}, options = {})
  req = build_request(:associate_service_quota_template, params)
  req.send_request(options)
end
build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-servicequotas/client.rb, line 1167
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-servicequotas'
  context[:gem_version] = '1.17.0'
  Seahorse::Client::Request.new(handlers, context)
end
delete_service_quota_increase_request_from_template(params = {}, options = {}) click to toggle source

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

@option params [required, String] :service_code

The service identifier.

@option params [required, String] :quota_code

The quota identifier.

@option params [required, String] :aws_region

The AWS Region.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example 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
})

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/DeleteServiceQuotaIncreaseRequestFromTemplate AWS API Documentation

@overload delete_service_quota_increase_request_from_template(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 383
def delete_service_quota_increase_request_from_template(params = {}, options = {})
  req = build_request(:delete_service_quota_increase_request_from_template, params)
  req.send_request(options)
end
disassociate_service_quota_template(params = {}, options = {}) click to toggle source

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

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/DisassociateServiceQuotaTemplate AWS API Documentation

@overload disassociate_service_quota_template(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 399
def disassociate_service_quota_template(params = {}, options = {})
  req = build_request(:disassociate_service_quota_template, params)
  req.send_request(options)
end
get_association_for_service_quota_template(params = {}, options = {}) click to toggle source

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

@return [Types::GetAssociationForServiceQuotaTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetAssociationForServiceQuotaTemplateResponse#service_quota_template_association_status #service_quota_template_association_status} => String

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/GetAssociationForServiceQuotaTemplate AWS API Documentation

@overload get_association_for_service_quota_template(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 469
def get_association_for_service_quota_template(params = {}, options = {})
  req = build_request(:get_association_for_service_quota_template, params)
  req.send_request(options)
end
get_aws_default_service_quota(params = {}, options = {}) click to toggle source

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

@option params [required, String] :service_code

The service identifier.

@option params [required, String] :quota_code

The quota identifier.

@return [Types::GetAWSDefaultServiceQuotaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetAWSDefaultServiceQuotaResponse#quota #quota} => Types::ServiceQuota

@example Request syntax with placeholder values

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

@example 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 #=> Boolean
resp.quota.global_quota #=> Boolean
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

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/GetAWSDefaultServiceQuota AWS API Documentation

@overload get_aws_default_service_quota(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 449
def get_aws_default_service_quota(params = {}, options = {})
  req = build_request(:get_aws_default_service_quota, params)
  req.send_request(options)
end
get_requested_service_quota_change(params = {}, options = {}) click to toggle source

Retrieves information about the specified quota increase request.

@option params [required, String] :request_id

The ID of the quota increase request.

@return [Types::GetRequestedServiceQuotaChangeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetRequestedServiceQuotaChangeResponse#requested_quota #requested_quota} => Types::RequestedServiceQuotaChange

@example Request syntax with placeholder values

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

@example 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 #=> Boolean
resp.requested_quota.unit #=> String

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/GetRequestedServiceQuotaChange AWS API Documentation

@overload get_requested_service_quota_change(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 510
def get_requested_service_quota_change(params = {}, options = {})
  req = build_request(:get_requested_service_quota_change, params)
  req.send_request(options)
end
get_service_quota(params = {}, options = {}) click to toggle source

Retrieves the applied quota value for the specified quota. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.

@option params [required, String] :service_code

The service identifier.

@option params [required, String] :quota_code

The quota identifier.

@return [Types::GetServiceQuotaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetServiceQuotaResponse#quota #quota} => Types::ServiceQuota

@example Request syntax with placeholder values

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

@example 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 #=> Boolean
resp.quota.global_quota #=> Boolean
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

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/GetServiceQuota AWS API Documentation

@overload get_service_quota(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 561
def get_service_quota(params = {}, options = {})
  req = build_request(:get_service_quota, params)
  req.send_request(options)
end
get_service_quota_increase_request_from_template(params = {}, options = {}) click to toggle source

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

@option params [required, String] :service_code

The service identifier.

@option params [required, String] :quota_code

The quota identifier.

@option params [required, String] :aws_region

The AWS Region.

@return [Types::GetServiceQuotaIncreaseRequestFromTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::GetServiceQuotaIncreaseRequestFromTemplateResponse#service_quota_increase_request_in_template #service_quota_increase_request_in_template} => Types::ServiceQuotaIncreaseRequestInTemplate

@example 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
})

@example 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 #=> Boolean

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/GetServiceQuotaIncreaseRequestFromTemplate AWS API Documentation

@overload get_service_quota_increase_request_from_template(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 605
def get_service_quota_increase_request_from_template(params = {}, options = {})
  req = build_request(:get_service_quota_increase_request_from_template, params)
  req.send_request(options)
end
list_aws_default_service_quotas(params = {}, options = {}) click to toggle source

Lists the default values for the quotas for the specified AWS service. A default value does not reflect any quota increases.

@option params [required, String] :service_code

The service identifier.

@option params [String] :next_token

The token for the next page of results.

@option params [Integer] :max_results

The maximum number of results to return with a single call. To
retrieve the remaining results, if any, make another call with the
token returned from this call.

@return [Types::ListAWSDefaultServiceQuotasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListAWSDefaultServiceQuotasResponse#next_token #next_token} => String
* {Types::ListAWSDefaultServiceQuotasResponse#quotas #quotas} => Array<Types::ServiceQuota>

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

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

@example 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 #=> Boolean
resp.quotas[0].global_quota #=> Boolean
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

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListAWSDefaultServiceQuotas AWS API Documentation

@overload list_aws_default_service_quotas(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 666
def list_aws_default_service_quotas(params = {}, options = {})
  req = build_request(:list_aws_default_service_quotas, params)
  req.send_request(options)
end
list_requested_service_quota_change_history(params = {}, options = {}) click to toggle source

Retrieves the quota increase requests for the specified service.

@option params [String] :service_code

The service identifier.

@option params [String] :status

The status of the quota increase request.

@option params [String] :next_token

The token for the next page of results.

@option params [Integer] :max_results

The maximum number of results to return with a single call. To
retrieve the remaining results, if any, make another call with the
token returned from this call.

@return [Types::ListRequestedServiceQuotaChangeHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListRequestedServiceQuotaChangeHistoryResponse#next_token #next_token} => String
* {Types::ListRequestedServiceQuotaChangeHistoryResponse#requested_quotas #requested_quotas} => Array<Types::RequestedServiceQuotaChange>

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example 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,
})

@example 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 #=> Boolean
resp.requested_quotas[0].unit #=> String

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListRequestedServiceQuotaChangeHistory AWS API Documentation

@overload list_requested_service_quota_change_history(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 726
def list_requested_service_quota_change_history(params = {}, options = {})
  req = build_request(:list_requested_service_quota_change_history, params)
  req.send_request(options)
end
list_requested_service_quota_change_history_by_quota(params = {}, options = {}) click to toggle source

Retrieves the quota increase requests for the specified quota.

@option params [required, String] :service_code

The service identifier.

@option params [required, String] :quota_code

The quota identifier.

@option params [String] :status

The status value of the quota increase request.

@option params [String] :next_token

The token for the next page of results.

@option params [Integer] :max_results

The maximum number of results to return with a single call. To
retrieve the remaining results, if any, make another call with the
token returned from this call.

@return [Types::ListRequestedServiceQuotaChangeHistoryByQuotaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListRequestedServiceQuotaChangeHistoryByQuotaResponse#next_token #next_token} => String
* {Types::ListRequestedServiceQuotaChangeHistoryByQuotaResponse#requested_quotas #requested_quotas} => Array<Types::RequestedServiceQuotaChange>

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example 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,
})

@example 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 #=> Boolean
resp.requested_quotas[0].unit #=> String

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListRequestedServiceQuotaChangeHistoryByQuota AWS API Documentation

@overload list_requested_service_quota_change_history_by_quota(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 790
def list_requested_service_quota_change_history_by_quota(params = {}, options = {})
  req = build_request(:list_requested_service_quota_change_history_by_quota, params)
  req.send_request(options)
end
list_service_quota_increase_requests_in_template(params = {}, options = {}) click to toggle source

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

@option params [String] :service_code

The service identifier.

@option params [String] :aws_region

The AWS Region.

@option params [String] :next_token

The token for the next page of results.

@option params [Integer] :max_results

The maximum number of results to return with a single call. To
retrieve the remaining results, if any, make another call with the
token returned from this call.

@return [Types::ListServiceQuotaIncreaseRequestsInTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListServiceQuotaIncreaseRequestsInTemplateResponse#service_quota_increase_request_in_template_list #service_quota_increase_request_in_template_list} => Array<Types::ServiceQuotaIncreaseRequestInTemplate>
* {Types::ListServiceQuotaIncreaseRequestsInTemplateResponse#next_token #next_token} => String

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example 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,
})

@example 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 #=> Boolean
resp.next_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListServiceQuotaIncreaseRequestsInTemplate AWS API Documentation

@overload list_service_quota_increase_requests_in_template(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 845
def list_service_quota_increase_requests_in_template(params = {}, options = {})
  req = build_request(:list_service_quota_increase_requests_in_template, params)
  req.send_request(options)
end
list_service_quotas(params = {}, options = {}) click to toggle source

Lists the applied quota values for the specified AWS service. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.

@option params [required, String] :service_code

The service identifier.

@option params [String] :next_token

The token for the next page of results.

@option params [Integer] :max_results

The maximum number of results to return with a single call. To
retrieve the remaining results, if any, make another call with the
token returned from this call.

@return [Types::ListServiceQuotasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListServiceQuotasResponse#next_token #next_token} => String
* {Types::ListServiceQuotasResponse#quotas #quotas} => Array<Types::ServiceQuota>

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

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

@example 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 #=> Boolean
resp.quotas[0].global_quota #=> Boolean
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

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListServiceQuotas AWS API Documentation

@overload list_service_quotas(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 907
def list_service_quotas(params = {}, options = {})
  req = build_request(:list_service_quotas, params)
  req.send_request(options)
end
list_services(params = {}, options = {}) click to toggle source

Lists the names and codes for the services integrated with Service Quotas.

@option params [String] :next_token

The token for the next page of results.

@option params [Integer] :max_results

The maximum number of results to return with a single call. To
retrieve the remaining results, if any, make another call with the
token returned from this call.

@return [Types::ListServicesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListServicesResponse#next_token #next_token} => String
* {Types::ListServicesResponse#services #services} => Array<Types::ServiceInfo>

The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.

@example Request syntax with placeholder values

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

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListServices AWS API Documentation

@overload list_services(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 948
def list_services(params = {}, options = {})
  req = build_request(:list_services, params)
  req.send_request(options)
end
list_tags_for_resource(params = {}, options = {}) click to toggle source

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

@option params [required, String] :resource_arn

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

[1]: https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html
[2]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html

@return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>

@example Request syntax with placeholder values

resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

@example Response structure

resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/ListTagsForResource AWS API Documentation

@overload list_tags_for_resource(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 987
def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end
put_service_quota_increase_request_into_template(params = {}, options = {}) click to toggle source

Adds a quota increase request to your quota request template.

@option params [required, String] :quota_code

The quota identifier.

@option params [required, String] :service_code

The service identifier.

@option params [required, String] :aws_region

The AWS Region.

@option params [required, Float] :desired_value

The new, increased value for the quota.

@return [Types::PutServiceQuotaIncreaseRequestIntoTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::PutServiceQuotaIncreaseRequestIntoTemplateResponse#service_quota_increase_request_in_template #service_quota_increase_request_in_template} => Types::ServiceQuotaIncreaseRequestInTemplate

@example 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
})

@example 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 #=> Boolean

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/PutServiceQuotaIncreaseRequestIntoTemplate AWS API Documentation

@overload put_service_quota_increase_request_into_template(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 1034
def put_service_quota_increase_request_into_template(params = {}, options = {})
  req = build_request(:put_service_quota_increase_request_into_template, params)
  req.send_request(options)
end
request_service_quota_increase(params = {}, options = {}) click to toggle source

Submits a quota increase request for the specified quota.

@option params [required, String] :service_code

The service identifier.

@option params [required, String] :quota_code

The quota identifier.

@option params [required, Float] :desired_value

The new, increased value for the quota.

@return [Types::RequestServiceQuotaIncreaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::RequestServiceQuotaIncreaseResponse#requested_quota #requested_quota} => Types::RequestedServiceQuotaChange

@example Request syntax with placeholder values

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

@example 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 #=> Boolean
resp.requested_quota.unit #=> String

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/RequestServiceQuotaIncrease AWS API Documentation

@overload request_service_quota_increase(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 1083
def request_service_quota_increase(params = {}, options = {})
  req = build_request(:request_service_quota_increase, params)
  req.send_request(options)
end
tag_resource(params = {}, options = {}) click to toggle source

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

@option params [required, String] :resource_arn

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

[1]: https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html
[2]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html

@option params [required, Array<Types::Tag>] :tags

The tags that you want to add to the resource.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/TagResource AWS API Documentation

@overload tag_resource(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 1123
def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end
untag_resource(params = {}, options = {}) click to toggle source

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

@option params [required, String] :resource_arn

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

[1]: https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html
[2]: https://docs.aws.amazon.com/servicequotas/2019-06-24/apireference/API_ListServiceQuotas.html

@option params [required, Array<String>] :tag_keys

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

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

@see docs.aws.amazon.com/goto/WebAPI/service-quotas-2019-06-24/UntagResource AWS API Documentation

@overload untag_resource(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-servicequotas/client.rb, line 1158
def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end
waiter_names() click to toggle source

@api private @deprecated

# File lib/aws-sdk-servicequotas/client.rb, line 1182
def waiter_names
  []
end