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.

CreateDocumentationPartInput

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

type CreateDocumentationPartInput struct { Location *DocumentationPartLocation `locationName:"location" type:"structure" required:"true"` Properties *string `locationName:"properties" type:"string" required:"true"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` }

Creates a new documentation part of a given API.

Location

Specifies the target API entity to which the documentation applies.

Properties

Type: *string

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

Properties is a required field

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

Method

GoString

func (s CreateDocumentationPartInput) GoString() string

GoString returns the string representation

SetLocation

func (s *CreateDocumentationPartInput) SetLocation(v *DocumentationPartLocation) *CreateDocumentationPartInput

SetLocation sets the Location field's value.

SetProperties

func (s *CreateDocumentationPartInput) SetProperties(v string) *CreateDocumentationPartInput

SetProperties sets the Properties field's value.

SetRestApiId

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

SetRestApiId sets the RestApiId field's value.

String

func (s CreateDocumentationPartInput) String() string

String returns the string representation

Validate

func (s *CreateDocumentationPartInput) Validate() error

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

On this page: