Class: Aws::APIGateway::Types::GetUsageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetUsageRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
The GET request to get the usage data of a usage plan in a specified time interval.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#end_date ⇒ String
The ending date (e.g., 2016-12-31) of the usage data.
-
#key_id ⇒ String
The Id of the API key associated with the resultant usage data.
-
#limit ⇒ Integer
The maximum number of returned results per page.
-
#position ⇒ String
The current pagination position in the paged result set.
-
#start_date ⇒ String
The starting date (e.g., 2016-01-01) of the usage data.
-
#usage_plan_id ⇒ String
The Id of the usage plan associated with the usage data.
Instance Attribute Details
#end_date ⇒ String
The ending date (e.g., 2016-12-31) of the usage data.
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3121 class GetUsageRequest < Struct.new( :usage_plan_id, :key_id, :start_date, :end_date, :position, :limit) SENSITIVE = [] include Aws::Structure end |
#key_id ⇒ String
The Id of the API key associated with the resultant usage data.
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3121 class GetUsageRequest < Struct.new( :usage_plan_id, :key_id, :start_date, :end_date, :position, :limit) SENSITIVE = [] include Aws::Structure end |
#limit ⇒ Integer
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3121 class GetUsageRequest < Struct.new( :usage_plan_id, :key_id, :start_date, :end_date, :position, :limit) SENSITIVE = [] include Aws::Structure end |
#position ⇒ String
The current pagination position in the paged result set.
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3121 class GetUsageRequest < Struct.new( :usage_plan_id, :key_id, :start_date, :end_date, :position, :limit) SENSITIVE = [] include Aws::Structure end |
#start_date ⇒ String
The starting date (e.g., 2016-01-01) of the usage data.
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3121 class GetUsageRequest < Struct.new( :usage_plan_id, :key_id, :start_date, :end_date, :position, :limit) SENSITIVE = [] include Aws::Structure end |
#usage_plan_id ⇒ String
The Id of the usage plan associated with the usage data.
3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3121 class GetUsageRequest < Struct.new( :usage_plan_id, :key_id, :start_date, :end_date, :position, :limit) SENSITIVE = [] include Aws::Structure end |