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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetUsageRequest

Includes:

Structure

Defined in:

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_date ⇒ String

  [Required] 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

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

• #usage_plan_id ⇒ String

  [Required] The Id of the usage plan associated with the usage data.

Instance Attribute Details

#end_date ⇒ String

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

Returns:

• (String)

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

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.

Returns:

• (String)

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

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.

Returns:

• (Integer)

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

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.

Returns:

• (String)

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

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

#start_date ⇒ String

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

Returns:

• (String)

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

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

#usage_plan_id ⇒ String

[Required] The Id of the usage plan associated with the usage data.

Returns:

• (String)

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

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