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

Class: Aws::APIGateway::Types::Usage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Represents the usage data of a usage plan.

[Create and Use Usage Plans][1], [Manage Usage in a Usage Plan][2]

Instance Attribute Summary collapse

Instance Attribute Details

#end_dateString

The ending date of the usage data.

Returns:

  • (String)


6731
6732
6733
6734
6735
6736
6737
6738
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6731

class Usage < Struct.new(
  :usage_plan_id,
  :start_date,
  :end_date,
  :position,
  :items)
  include Aws::Structure
end

#itemsHash<String,Array<Array<Integer>>>

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, \{..., "values" : \{ "\{api_key\}" : [ [0, 100], [10, 90], [100, 10]]\}, where \{api_key\} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

Returns:

  • (Hash<String,Array<Array<Integer>>>)


6731
6732
6733
6734
6735
6736
6737
6738
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6731

class Usage < Struct.new(
  :usage_plan_id,
  :start_date,
  :end_date,
  :position,
  :items)
  include Aws::Structure
end

#positionString

Returns:

  • (String)


6731
6732
6733
6734
6735
6736
6737
6738
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6731

class Usage < Struct.new(
  :usage_plan_id,
  :start_date,
  :end_date,
  :position,
  :items)
  include Aws::Structure
end

#start_dateString

The starting date of the usage data.

Returns:

  • (String)


6731
6732
6733
6734
6735
6736
6737
6738
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6731

class Usage < Struct.new(
  :usage_plan_id,
  :start_date,
  :end_date,
  :position,
  :items)
  include Aws::Structure
end

#usage_plan_idString

The plan Id associated with this usage data.

Returns:

  • (String)


6731
6732
6733
6734
6735
6736
6737
6738
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 6731

class Usage < Struct.new(
  :usage_plan_id,
  :start_date,
  :end_date,
  :position,
  :items)
  include Aws::Structure
end