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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::Usage

Defined in:

gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

Represents the usage data of a usage plan.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_date ⇒ String

  The ending date of the usage data.

• #items ⇒ Hash<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.

• #position ⇒ String
• #start_date ⇒ String

  The starting date of the usage data.

• #usage_plan_id ⇒ String

  The plan Id associated with this usage data.

Instance Attribute Details

#end_date ⇒ String

The ending date of the usage data.

Returns:

• (String)

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

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

#items ⇒ Hash<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>>>)

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

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

#position ⇒ String

Returns:

• (String)

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

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

#start_date ⇒ String

The starting date of the usage data.

Returns:

• (String)

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

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

#usage_plan_id ⇒ String

The plan Id associated with this usage data.

Returns:

• (String)

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

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