Class: Aws::ServiceQuotas::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb

Overview

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.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    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. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    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
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: 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.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

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

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

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String)

    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.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

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

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean)

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

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

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :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

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

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

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

  • :sdk_ua_app_id (String)

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

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

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ServiceQuotas::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ServiceQuotas::EndpointParameters

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 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.

  • :http_continue_timeout (Float) — default: 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.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    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.

  • :ssl_ca_directory (String)

    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.



395
396
397
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 395

def initialize(*args)
  super
end

Instance Method Details

#associate_service_quota_template(params = {}) ⇒ Struct

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

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



413
414
415
416
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 413

def associate_service_quota_template(params = {}, options = {})
  req = build_request(:associate_service_quota_template, params)
  req.send_request(options)
end

#delete_service_quota_increase_request_from_template(params = {}) ⇒ Struct

Deletes the quota increase request for the specified quota from your quota request 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :quota_code (required, String)

    Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

  • :aws_region (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



448
449
450
451
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 448

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 = {}) ⇒ Struct

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

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



464
465
466
467
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 464

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 = {}) ⇒ Types::GetAssociationForServiceQuotaTemplateResponse

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

Examples:

Response structure


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

Parameters:

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

    ({})

Returns:

See Also:



541
542
543
544
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 541

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 = {}) ⇒ Types::GetAWSDefaultServiceQuotaResponse

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

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 #=> 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
resp.quota.quota_applied_at_level #=> String, one of "ACCOUNT", "RESOURCE", "ALL"
resp.quota.quota_context.context_scope #=> String, one of "RESOURCE", "ACCOUNT"
resp.quota.quota_context.context_scope_type #=> String
resp.quota.quota_context.context_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :quota_code (required, String)

    Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

Returns:

See Also:



521
522
523
524
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 521

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 = {}) ⇒ Types::GetRequestedServiceQuotaChangeResponse

Retrieves information about the specified quota 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", "NOT_APPROVED", "INVALID_REQUEST"
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
resp.requested_quota.quota_requested_at_level #=> String, one of "ACCOUNT", "RESOURCE", "ALL"
resp.requested_quota.quota_context.context_scope #=> String, one of "RESOURCE", "ACCOUNT"
resp.requested_quota.quota_context.context_scope_type #=> String
resp.requested_quota.quota_context.context_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :request_id (required, String)

    Specifies the ID of the quota increase request.

Returns:

See Also:



586
587
588
589
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 586

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 = {}) ⇒ Types::GetServiceQuotaResponse

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.

Examples:

Request syntax with placeholder values


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

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
resp.quota.quota_applied_at_level #=> String, one of "ACCOUNT", "RESOURCE", "ALL"
resp.quota.quota_context.context_scope #=> String, one of "RESOURCE", "ACCOUNT"
resp.quota.quota_context.context_scope_type #=> String
resp.quota.quota_context.context_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :quota_code (required, String)

    Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

  • :context_id (String)

    Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

Returns:

See Also:



650
651
652
653
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 650

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 = {}) ⇒ Types::GetServiceQuotaIncreaseRequestFromTemplateResponse

Retrieves information about the specified quota increase request in your quota request 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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :quota_code (required, String)

    Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

  • :aws_region (required, String)

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

Returns:

See Also:



698
699
700
701
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 698

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 = {}) ⇒ Types::ListAWSDefaultServiceQuotasResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> 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
resp.quotas[0].quota_applied_at_level #=> String, one of "ACCOUNT", "RESOURCE", "ALL"
resp.quotas[0].quota_context.context_scope #=> String, one of "RESOURCE", "ACCOUNT"
resp.quotas[0].quota_context.context_scope_type #=> String
resp.quotas[0].quota_context.context_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :next_token (String)

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

  • :max_results (Integer)

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

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

Returns:

See Also:



778
779
780
781
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 778

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 = {}) ⇒ Types::ListRequestedServiceQuotaChangeHistoryResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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, NOT_APPROVED, INVALID_REQUEST
  next_token: "NextToken",
  max_results: 1,
  quota_requested_at_level: "ACCOUNT", # accepts ACCOUNT, RESOURCE, ALL
})

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", "NOT_APPROVED", "INVALID_REQUEST"
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
resp.requested_quotas[0].quota_requested_at_level #=> String, one of "ACCOUNT", "RESOURCE", "ALL"
resp.requested_quotas[0].quota_context.context_scope #=> String, one of "RESOURCE", "ACCOUNT"
resp.requested_quotas[0].quota_context.context_scope_type #=> String
resp.requested_quotas[0].quota_context.context_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (String)

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

  • :status (String)

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

  • :next_token (String)

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

  • :max_results (Integer)

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

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

  • :quota_requested_at_level (String)

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

Returns:

See Also:



864
865
866
867
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 864

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 = {}) ⇒ Types::ListRequestedServiceQuotaChangeHistoryByQuotaResponse

Retrieves the quota increase requests for the specified quota.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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, NOT_APPROVED, INVALID_REQUEST
  next_token: "NextToken",
  max_results: 1,
  quota_requested_at_level: "ACCOUNT", # accepts ACCOUNT, RESOURCE, ALL
})

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", "NOT_APPROVED", "INVALID_REQUEST"
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
resp.requested_quotas[0].quota_requested_at_level #=> String, one of "ACCOUNT", "RESOURCE", "ALL"
resp.requested_quotas[0].quota_context.context_scope #=> String, one of "RESOURCE", "ACCOUNT"
resp.requested_quotas[0].quota_context.context_scope_type #=> String
resp.requested_quotas[0].quota_context.context_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :quota_code (required, String)

    Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

  • :status (String)

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

  • :next_token (String)

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

  • :max_results (Integer)

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

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

  • :quota_requested_at_level (String)

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

Returns:

See Also:



955
956
957
958
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 955

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 = {}) ⇒ Types::ListServiceQuotaIncreaseRequestsInTemplateResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (String)

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

  • :aws_region (String)

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

  • :next_token (String)

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

  • :max_results (Integer)

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

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

Returns:

See Also:



1026
1027
1028
1029
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1026

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 = {}) ⇒ Types::ListServiceQuotasResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_service_quotas({
  service_code: "ServiceCode", # required
  next_token: "NextToken",
  max_results: 1,
  quota_code: "QuotaCode",
  quota_applied_at_level: "ACCOUNT", # accepts ACCOUNT, RESOURCE, ALL
})

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
resp.quotas[0].quota_applied_at_level #=> String, one of "ACCOUNT", "RESOURCE", "ALL"
resp.quotas[0].quota_context.context_scope #=> String, one of "RESOURCE", "ACCOUNT"
resp.quotas[0].quota_context.context_scope_type #=> String
resp.quotas[0].quota_context.context_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :next_token (String)

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

  • :max_results (Integer)

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

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

  • :quota_code (String)

    Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

  • :quota_applied_at_level (String)

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

Returns:

See Also:



1118
1119
1120
1121
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1118

def list_service_quotas(params = {}, options = {})
  req = build_request(:list_service_quotas, params)
  req.send_request(options)
end

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

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

  • :max_results (Integer)

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

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

Returns:

See Also:



1173
1174
1175
1176
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1173

def list_services(params = {}, options = {})
  req = build_request(:list_services, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

Returns:

See Also:



1212
1213
1214
1215
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1212

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 = {}) ⇒ Types::PutServiceQuotaIncreaseRequestIntoTemplateResponse

Adds a quota increase request to your quota request 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 #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :quota_code (required, String)

    Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

  • :service_code (required, String)

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

  • :aws_region (required, String)

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

  • :desired_value (required, Float)

    Specifies the new, increased value for the quota.

Returns:

See Also:



1263
1264
1265
1266
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1263

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 = {}) ⇒ Types::RequestServiceQuotaIncreaseResponse

Submits a quota increase request for the specified quota.

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
  context_id: "QuotaContextId",
})

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", "NOT_APPROVED", "INVALID_REQUEST"
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
resp.requested_quota.quota_requested_at_level #=> String, one of "ACCOUNT", "RESOURCE", "ALL"
resp.requested_quota.quota_context.context_scope #=> String, one of "RESOURCE", "ACCOUNT"
resp.requested_quota.quota_context.context_scope_type #=> String
resp.requested_quota.quota_context.context_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :quota_code (required, String)

    Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

  • :desired_value (required, Float)

    Specifies the new, increased value for the quota.

  • :context_id (String)

    Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

Returns:

See Also:



1325
1326
1327
1328
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1325

def request_service_quota_increase(params = {}, options = {})
  req = build_request(:request_service_quota_increase, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :tags (required, Array<Types::Tag>)

    The tags that you want to add to the resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1365
1366
1367
1368
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1365

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :tag_keys (required, Array<String>)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1401
1402
1403
1404
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1401

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end