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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 target maximum number of requests that can be made in a given time period.

Returns:

  • (Integer)

5469
5470
5471
5472
5473
5474
5475
# File 'lib/aws-sdk-apigateway/types.rb', line 5469

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

#offsetInteger

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

Returns:

  • (Integer)

5469
5470
5471
5472
5473
5474
5475
# File 'lib/aws-sdk-apigateway/types.rb', line 5469

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)

5469
5470
5471
5472
5473
5474
5475
# File 'lib/aws-sdk-apigateway/types.rb', line 5469

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