You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass GetUsageRequest data as a hash:

{
  usage_plan_id: "String", # required
  key_id: "String",
  start_date: "String", # required
  end_date: "String", # required
  position: "String",
  limit: 1,
}

The GET request to get the usage data of a usage plan in a specified time interval.

Instance Attribute Summary collapse

Instance Attribute Details

#end_dateString

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

Returns:

  • (String)


3672
3673
3674
3675
3676
3677
3678
3679
3680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3672

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

#key_idString

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

Returns:

  • (String)


3672
3673
3674
3675
3676
3677
3678
3679
3680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3672

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

#limitInteger

The maximum number of returned results per page.

Returns:

  • (Integer)


3672
3673
3674
3675
3676
3677
3678
3679
3680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3672

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

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3672
3673
3674
3675
3676
3677
3678
3679
3680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3672

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

#start_dateString

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

Returns:

  • (String)


3672
3673
3674
3675
3676
3677
3678
3679
3680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3672

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

#usage_plan_idString

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

Returns:

  • (String)


3672
3673
3674
3675
3676
3677
3678
3679
3680
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3672

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