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.

<div class=“remarks”></div>

<div class=“seeAlso” markdown=“1”>

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

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html [2]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-console.html#api-gateway-usage-plan-manage-usage

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_date ⇒ String

The ending date of the usage data.

Returns:

  • (String) 


8080
8081
8082
8083
8084
8085
8086
8087
8088
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8080

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>>>) 


8080
8081
8082
8083
8084
8085
8086
8087
8088
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8080

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

#position ⇒ String

Returns:

  • (String) 


8080
8081
8082
8083
8084
8085
8086
8087
8088
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8080

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) 


8080
8081
8082
8083
8084
8085
8086
8087
8088
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8080

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) 


8080
8081
8082
8083
8084
8085
8086
8087
8088
 
# File 'lib/aws-sdk-apigateway/types.rb', line 8080

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