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.

DocumentationVersion

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

type DocumentationVersion struct { CreatedDate *time.Time `locationName:"createdDate" type:"timestamp"` Description *string `locationName:"description" type:"string"` Version *string `locationName:"version" type:"string"` }

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.

Documenting an API (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.html), DocumentationPart, DocumentationVersions

CreatedDate

Type: *time.Time

The date when the API documentation snapshot is created.

Description

Type: *string

The description of the API documentation snapshot.

Version

Type: *string

The version identifier of the API documentation snapshot.

Method

GoString

func (s DocumentationVersion) GoString() string

GoString returns the string representation

SetCreatedDate

func (s *DocumentationVersion) SetCreatedDate(v time.Time) *DocumentationVersion

SetCreatedDate sets the CreatedDate field's value.

SetDescription

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

SetDescription sets the Description field's value.

SetVersion

func (s *DocumentationVersion) SetVersion(v string) *DocumentationVersion

SetVersion sets the Version field's value.

String

func (s DocumentationVersion) String() string

String returns the string representation

On this page: