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

  • :disable_host_prefix_injection (Boolean) — default: false

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

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

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

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

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

  • :validate_params (Boolean) — default: true

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

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

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



334
335
336
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#associate_service_quota_template(params = {}) ⇒ Struct

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

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



353
354
355
356
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 353

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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :quota_code (required, String)

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

  • :aws_region (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



384
385
386
387
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 384

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

Related operations

  • To enable the quota template, call AssociateServiceQuotaTemplate.

  • To delete a specific service quota from the template, use DeleteServiceQuotaIncreaseRequestFromTemplate.

Parameters:

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

    ({})

Returns:

  • (Struct)

    Returns an empty response.

See Also:



407
408
409
410
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 407

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

Examples:

Response structure


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

Parameters:

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

    ({})

Returns:

See Also:



479
480
481
482
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 479

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 service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..

Examples:

Request syntax with placeholder values


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

Response structure


resp.quota.service_code #=> String
resp.quota.service_name #=> String
resp.quota.quota_arn #=> String
resp.quota.quota_code #=> String
resp.quota.quota_name #=> String
resp.quota.value #=> Float
resp.quota.unit #=> String
resp.quota.adjustable #=> 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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

    Specifies the service that you want to use.

  • :quota_code (required, String)

    Identifies the service quota you want to select.

Returns:

See Also:



458
459
460
461
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 458

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 the details for a particular increase request.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :request_id (required, String)

    Identifies the quota increase request.

Returns:

See Also:



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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.quota.service_code #=> String
resp.quota.service_name #=> String
resp.quota.quota_arn #=> String
resp.quota.quota_code #=> String
resp.quota.quota_name #=> String
resp.quota.value #=> Float
resp.quota.unit #=> String
resp.quota.adjustable #=> 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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

    Specifies the service that you want to use.

  • :quota_code (required, String)

    Identifies the service quota you want to select.

Returns:

See Also:



573
574
575
576
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 573

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

    Specifies the service that you want to use.

  • :quota_code (required, String)

    Specifies the quota you want.

  • :aws_region (required, String)

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

Returns:

See Also:



617
618
619
620
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 617

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

Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

    Specifies the service that you want to use.

  • :next_token (String) — default: Optional

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

  • :max_results (Integer) — default: Optional

    Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



705
706
707
708
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 705

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

Requests a list of the changes to quotas for a 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
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (String)

    Specifies the service that you want to use.

  • :status (String)

    Specifies the status value of the quota increase request.

  • :next_token (String) — default: Optional

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

  • :max_results (Integer) — default: Optional

    Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



774
775
776
777
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 774

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

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

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
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

    Specifies the service that you want to use.

  • :quota_code (required, String)

    Specifies the service quota that you want to use

  • :status (String)

    Specifies the status value of the quota increase request.

  • :next_token (String) — default: Optional

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

  • :max_results (Integer) — default: Optional

    Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



851
852
853
854
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 851

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

Returns a list of the quota increase requests in the 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)

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

  • :aws_region (String)

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

  • :next_token (String) — default: Optional

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

  • :max_results (Integer) — default: Optional

    Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



915
916
917
918
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 915

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 all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you'll see the default values are the values that AWS provides for the quotas.

Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

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

  • :next_token (String) — default: Optional

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

  • :max_results (Integer) — default: Optional

    Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



996
997
998
999
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 996

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 AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.

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) — default: Optional

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

  • :max_results (Integer) — default: Optional

    Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

See Also:



1047
1048
1049
1050
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1047

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :quota_code (required, String)

    Specifies the service quota that you want to use.

  • :service_code (required, String)

    Specifies the service that you want to use.

  • :aws_region (required, String)

    Specifies the AWS Region for the quota.

  • :desired_value (required, Float)

    Specifies the new, increased value for the quota.

Returns:

See Also:



1098
1099
1100
1101
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1098

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :service_code (required, String)

    Specifies the service that you want to use.

  • :quota_code (required, String)

    Specifies the service quota that you want to use.

  • :desired_value (required, Float)

    Specifies the value submitted in the service quota increase request.

Returns:

See Also:



1149
1150
1151
1152
# File 'gems/aws-sdk-servicequotas/lib/aws-sdk-servicequotas/client.rb', line 1149

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