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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

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

Returns:

  • (Integer)


6167
6168
6169
6170
6171
6172
6173
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6167

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

#offsetInteger

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

Returns:

  • (Integer)


6167
6168
6169
6170
6171
6172
6173
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6167

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

#periodString

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

Returns:

  • (String)


6167
6168
6169
6170
6171
6172
6173
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6167

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