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.

PutGatewayResponseInput

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

type PutGatewayResponseInput struct { ResponseParameters map[string]*string `locationName:"responseParameters" type:"map"` ResponseTemplates map[string]*string `locationName:"responseTemplates" type:"map"` ResponseType *string `location:"uri" locationName:"response_type" type:"string" required:"true" enum:"GatewayResponseType"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` StatusCode *string `locationName:"statusCode" type:"string"` }

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

ResponseParameters

Type: map[string]*string

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

ResponseTemplates

Type: map[string]*string

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

ResponseType

Type: *string

[Required] The response type of the associated GatewayResponse. Valid values are ACCESS_DENIED API_CONFIGURATION_ERROR AUTHORIZER_FAILURE AUTHORIZER_CONFIGURATION_ERROR BAD_REQUEST_PARAMETERS BAD_REQUEST_BODY DEFAULT_4XX DEFAULT_5XX EXPIRED_TOKEN INVALID_SIGNATURE INTEGRATION_FAILURE INTEGRATION_TIMEOUT INVALID_API_KEY MISSING_AUTHENTICATION_TOKEN QUOTA_EXCEEDED REQUEST_TOO_LARGE RESOURCE_NOT_FOUND THROTTLED UNAUTHORIZED UNSUPPORTED_MEDIA_TYPE

ResponseType is a required field

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

StatusCode

Type: *string

The HTTP status code of the GatewayResponse

Method

GoString

func (s PutGatewayResponseInput) GoString() string

GoString returns the string representation

SetResponseParameters

func (s *PutGatewayResponseInput) SetResponseParameters(v map[string]*string) *PutGatewayResponseInput

SetResponseParameters sets the ResponseParameters field's value.

SetResponseTemplates

func (s *PutGatewayResponseInput) SetResponseTemplates(v map[string]*string) *PutGatewayResponseInput

SetResponseTemplates sets the ResponseTemplates field's value.

SetResponseType

func (s *PutGatewayResponseInput) SetResponseType(v string) *PutGatewayResponseInput

SetResponseType sets the ResponseType field's value.

SetRestApiId

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

SetRestApiId sets the RestApiId field's value.

SetStatusCode

func (s *PutGatewayResponseInput) SetStatusCode(v string) *PutGatewayResponseInput

SetStatusCode sets the StatusCode field's value.

String

func (s PutGatewayResponseInput) String() string

String returns the string representation

Validate

func (s *PutGatewayResponseInput) Validate() error

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

On this page: