AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetDocumentationPartsInput

import "github.com/aws/aws-sdk-go/service/apigateway"

type GetDocumentationPartsInput struct { Limit *int64 `location:"querystring" locationName:"limit" type:"integer"` LocationStatus *string `location:"querystring" locationName:"locationStatus" type:"string" enum:"LocationStatusType"` NameQuery *string `location:"querystring" locationName:"name" type:"string"` Path *string `location:"querystring" locationName:"path" type:"string"` Position *string `location:"querystring" locationName:"position" type:"string"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` Type *string `location:"querystring" locationName:"type" type:"string" enum:"DocumentationPartType"` }

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Limit

Type: *int64

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

LocationStatus

Type: *string

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

Type: *string

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

Path

Type: *string

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

Position

Type: *string

The current pagination position in the paged result set.

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

Type

Type: *string

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

Method

GoString

func (s GetDocumentationPartsInput) GoString() string

GoString returns the string representation

SetLimit

func (s *GetDocumentationPartsInput) SetLimit(v int64) *GetDocumentationPartsInput

SetLimit sets the Limit field's value.

SetLocationStatus

func (s *GetDocumentationPartsInput) SetLocationStatus(v string) *GetDocumentationPartsInput

SetLocationStatus sets the LocationStatus field's value.

SetNameQuery

func (s *GetDocumentationPartsInput) SetNameQuery(v string) *GetDocumentationPartsInput

SetNameQuery sets the NameQuery field's value.

SetPath

func (s *GetDocumentationPartsInput) SetPath(v string) *GetDocumentationPartsInput

SetPath sets the Path field's value.

SetPosition

func (s *GetDocumentationPartsInput) SetPosition(v string) *GetDocumentationPartsInput

SetPosition sets the Position field's value.

SetRestApiId

func (s *GetDocumentationPartsInput) SetRestApiId(v string) *GetDocumentationPartsInput

SetRestApiId sets the RestApiId field's value.

SetType

func (s *GetDocumentationPartsInput) SetType(v string) *GetDocumentationPartsInput

SetType sets the Type field's value.

String

func (s GetDocumentationPartsInput) String() string

String returns the string representation

Validate

func (s *GetDocumentationPartsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: