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

Class: Aws::APIGateway::Types::ThrottleSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass ThrottleSettings data as a hash:

{
  burst_limit: 1,
  rate_limit: 1.0,
}

The API request rate limits.

Instance Attribute Summary collapse

Instance Attribute Details

#burst_limitInteger

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

Returns:

  • (Integer)


5795
5796
5797
5798
5799
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5795

class ThrottleSettings < Struct.new(
  :burst_limit,
  :rate_limit)
  include Aws::Structure
end

#rate_limitFloat

The API request steady-state rate limit.

Returns:

  • (Float)


5795
5796
5797
5798
5799
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5795

class ThrottleSettings < Struct.new(
  :burst_limit,
  :rate_limit)
  include Aws::Structure
end