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

Class: Aws::APIGateway::Types::QuotaSettings

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 QuotaSettings data as a hash:

{
  limit: 1,
  offset: 1,
  period: "DAY", # accepts DAY, WEEK, MONTH
}

Quotas configured for a usage plan.

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The maximum number of requests that can be made in a given time period.

Returns:

  • (Integer)


5129
5130
5131
5132
5133
5134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5129

class QuotaSettings < Struct.new(
  :limit,
  :offset,
  :period)
  include Aws::Structure
end

#offsetInteger

The number of requests subtracted from the given limit in the initial time period.

Returns:

  • (Integer)


5129
5130
5131
5132
5133
5134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5129

class QuotaSettings < Struct.new(
  :limit,
  :offset,
  :period)
  include Aws::Structure
end

#periodString

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

Returns:

  • (String)


5129
5130
5131
5132
5133
5134
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 5129

class QuotaSettings < Struct.new(
  :limit,
  :offset,
  :period)
  include Aws::Structure
end