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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing QuotaSettings as input to an Aws::Client method, you can use a vanilla Hash:

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

Quotas configured for a usage plan.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

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

Returns:

  • (Integer)

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

#offsetInteger

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

Returns:

  • (Integer)

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

#periodString

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

Possible values:

  • DAY
  • WEEK
  • MONTH

Returns:

  • (String)

    The time period in which the limit applies.