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.

CreateDocumentationVersionInput

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

type CreateDocumentationVersionInput struct { Description *string `locationName:"description" type:"string"` DocumentationVersion *string `locationName:"documentationVersion" type:"string" required:"true"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` StageName *string `locationName:"stageName" type:"string"` }

Creates a new documentation version of a given API.

Description

Type: *string

A description about the new documentation snapshot.

DocumentationVersion

Type: *string

[Required] The version identifier of the new snapshot.

DocumentationVersion is a required field

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

StageName

Type: *string

The stage name to be associated with the new documentation snapshot.

Method

GoString

func (s CreateDocumentationVersionInput) GoString() string

GoString returns the string representation

SetDescription

func (s *CreateDocumentationVersionInput) SetDescription(v string) *CreateDocumentationVersionInput

SetDescription sets the Description field's value.

SetDocumentationVersion

func (s *CreateDocumentationVersionInput) SetDocumentationVersion(v string) *CreateDocumentationVersionInput

SetDocumentationVersion sets the DocumentationVersion field's value.

SetRestApiId

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

SetRestApiId sets the RestApiId field's value.

SetStageName

func (s *CreateDocumentationVersionInput) SetStageName(v string) *CreateDocumentationVersionInput

SetStageName sets the StageName field's value.

String

func (s CreateDocumentationVersionInput) String() string

String returns the string representation

Validate

func (s *CreateDocumentationVersionInput) Validate() error

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

On this page: