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

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

Overview

Represents the usage data of a usage plan.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_dateString

The ending date of the usage data.

Returns:

  • (String)

7313
7314
7315
7316
7317
7318
7319
7320
7321
# File 'lib/aws-sdk-apigateway/types.rb', line 7313

class Usage < Struct.new(
  :usage_plan_id,
  :start_date,
  :end_date,
  :position,
  :items)
  SENSITIVE = []
  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>>>)

7313
7314
7315
7316
7317
7318
7319
7320
7321
# File 'lib/aws-sdk-apigateway/types.rb', line 7313

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

#positionString

Returns:

  • (String)

7313
7314
7315
7316
7317
7318
7319
7320
7321
# File 'lib/aws-sdk-apigateway/types.rb', line 7313

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

#start_dateString

The starting date of the usage data.

Returns:

  • (String)

7313
7314
7315
7316
7317
7318
7319
7320
7321
# File 'lib/aws-sdk-apigateway/types.rb', line 7313

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

#usage_plan_idString

The plan Id associated with this usage data.

Returns:

  • (String)

7313
7314
7315
7316
7317
7318
7319
7320
7321
# File 'lib/aws-sdk-apigateway/types.rb', line 7313

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