Class: Aws::APIGateway::Types::GetDeploymentsRequest

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 GetDeploymentsRequest data as a hash:

{
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
}

Requests API Gateway to get information about a Deployments collection.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

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

Returns:

  • (Integer)


3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3311

class GetDeploymentsRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3311

class GetDeploymentsRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)


3311
3312
3313
3314
3315
3316
3317
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3311

class GetDeploymentsRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  SENSITIVE = []
  include Aws::Structure
end