Class: Aws::APIGateway::Types::ApiStage

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

Overview

Note:

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

{
  api_id: "String",
  stage: "String",
  throttle: {
    "String" => {
      burst_limit: 1,
      rate_limit: 1.0,
    },
  },
}

API stage name of the associated API stage in a usage plan.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

API Id of the associated API stage in a usage plan.

Returns:

  • (String)


259
260
261
262
263
264
265
# File 'lib/aws-sdk-apigateway/types.rb', line 259

class ApiStage < Struct.new(
  :api_id,
  :stage,
  :throttle)
  SENSITIVE = []
  include Aws::Structure
end

#stageString

API stage name of the associated API stage in a usage plan.

Returns:

  • (String)


259
260
261
262
263
264
265
# File 'lib/aws-sdk-apigateway/types.rb', line 259

class ApiStage < Struct.new(
  :api_id,
  :stage,
  :throttle)
  SENSITIVE = []
  include Aws::Structure
end

#throttleHash<String,Types::ThrottleSettings>

Map containing method level throttling information for API stage in a usage plan.

Returns:



259
260
261
262
263
264
265
# File 'lib/aws-sdk-apigateway/types.rb', line 259

class ApiStage < Struct.new(
  :api_id,
  :stage,
  :throttle)
  SENSITIVE = []
  include Aws::Structure
end