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.

GetExportInput

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

type GetExportInput struct { Accepts *string `location:"header" locationName:"Accept" type:"string"` ExportType *string `location:"uri" locationName:"export_type" type:"string" required:"true"` Parameters map[string]*string `location:"querystring" locationName:"parameters" type:"map"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` StageName *string `location:"uri" locationName:"stage_name" type:"string" required:"true"` }

Request a new export of a RestApi for a particular Stage.

Accepts

Type: *string

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

ExportType

Type: *string

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

ExportType is a required field

Parameters

Type: map[string]*string

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportTypeoas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

StageName

Type: *string

[Required] The name of the Stage that will be exported.

StageName is a required field

Method

GoString

func (s GetExportInput) GoString() string

GoString returns the string representation

SetAccepts

func (s *GetExportInput) SetAccepts(v string) *GetExportInput

SetAccepts sets the Accepts field's value.

SetExportType

func (s *GetExportInput) SetExportType(v string) *GetExportInput

SetExportType sets the ExportType field's value.

SetParameters

func (s *GetExportInput) SetParameters(v map[string]*string) *GetExportInput

SetParameters sets the Parameters field's value.

SetRestApiId

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

SetRestApiId sets the RestApiId field's value.

SetStageName

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

SetStageName sets the StageName field's value.

String

func (s GetExportInput) String() string

String returns the string representation

Validate

func (s *GetExportInput) Validate() error

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

On this page: