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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #limit ⇒ Integer

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

• #offset ⇒ Integer

  The day that a time period starts.

• #period ⇒ String

  The time period in which the limit applies.

Instance Attribute Details

#limit ⇒ Integer

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

Returns:

• (Integer)

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

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

#offset ⇒ Integer

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)

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

class QuotaSettings < Struct.new(
  :limit,
  :offset,
  :period)
  SENSITIVE = []
  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 6169

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