apigateway/aws.sdk.kotlin.services.apigateway.model/GetDocumentationPartsRequest/Builder

Builder

Properties

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

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

nameQuery

var nameQuery: String?

The name of API entities of the to-be-retrieved documentation parts.

path

var path: String?

The path of API entities of the to-be-retrieved documentation parts.

position

var position: String?

The current pagination position in the paged result set.

restApiId

var restApiId: String?

The string identifier of the associated RestApi.

type

var type: DocumentationPartType?

The type of API entities of the to-be-retrieved documentation parts.