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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::QuotaSettings

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.

Instance Attribute Summary

• #limit ⇒ Integer

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

• #offset ⇒ Integer

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

• #period ⇒ String

  The time period in which the limit applies.

Instance Attribute Details

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-apigateway/types.rb', line 5129

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

#offset ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-apigateway/types.rb', line 5129

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

#period ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 5129

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