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

Class: Aws::APIGateway::Types::GetDocumentationVersionsRequest

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

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

Gets the documentation versions of an API.

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)


3198
3199
3200
3201
3202
3203
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3198

class GetDocumentationVersionsRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  include Aws::Structure
end

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3198
3199
3200
3201
3202
3203
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3198

class GetDocumentationVersionsRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  include Aws::Structure
end

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)


3198
3199
3200
3201
3202
3203
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3198

class GetDocumentationVersionsRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  include Aws::Structure
end