GetDocumentationPartsRequest

public struct GetDocumentationPartsRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let limit: Int?

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

    Declaration

    Swift

    public let locationStatus: LocationStatusType?

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

    Declaration

    Swift

    public let nameQuery: String?

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

    Declaration

    Swift

    public let path: String?

  • The current pagination position in the paged result set.

    Declaration

    Swift

    public let position: String?

  • [Required] The string identifier of the associated RestApi.

    Declaration

    Swift

    public let restApiId: String

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

    Declaration

    Swift

    public let type: DocumentationPartType?

  • Undocumented

    Declaration

    Swift

    public init(limit: Int? = nil, locationStatus: LocationStatusType? = nil, nameQuery: String? = nil, path: String? = nil, position: String? = nil, restApiId: String, type: DocumentationPartType? = nil)