Class: Aws::APIGateway::Types::GetUsageRequest

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#end_dateString

The ending date (e.g., 2016-12-31) of the usage data.

Returns:

  • (String)


3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3108

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

#key_idString

The Id of the API key associated with the resultant usage data.

Returns:

  • (String)


3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3108

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

#limitInteger

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

  • (Integer)


3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3108

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

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3108

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

#start_dateString

The starting date (e.g., 2016-01-01) of the usage data.

Returns:

  • (String)


3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3108

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

#usage_plan_idString

The Id of the usage plan associated with the usage data.

Returns:

  • (String)


3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3108

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