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

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

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 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.

Instance Attribute Summary collapse

Instance Attribute Details

#api_idString

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

Returns:

  • (String)


249
250
251
252
253
254
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 249

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

#stageString

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

Returns:

  • (String)


249
250
251
252
253
254
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 249

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

#throttleHash<String,Types::ThrottleSettings>

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

Returns:



249
250
251
252
253
254
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 249

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