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.

TestInvokeMethodInput

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

type TestInvokeMethodInput struct { Body *string `locationName:"body" type:"string"` ClientCertificateId *string `locationName:"clientCertificateId" type:"string"` Headers map[string]*string `locationName:"headers" type:"map"` HttpMethod *string `location:"uri" locationName:"http_method" type:"string" required:"true"` MultiValueHeaders map[string][]*string `locationName:"multiValueHeaders" type:"map"` PathWithQueryString *string `locationName:"pathWithQueryString" type:"string"` ResourceId *string `location:"uri" locationName:"resource_id" type:"string" required:"true"` RestApiId *string `location:"uri" locationName:"restapi_id" type:"string" required:"true"` StageVariables map[string]*string `locationName:"stageVariables" type:"map"` }

Make a request to simulate the execution of a Method.

Body

Type: *string

The simulated request body of an incoming invocation request.

ClientCertificateId

Type: *string

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

Headers

Type: map[string]*string

A key-value map of headers to simulate an incoming invocation request.

HttpMethod

Type: *string

[Required] Specifies a test invoke method request's HTTP method.

HttpMethod is a required field

MultiValueHeaders

Type: map[string][]*string

The headers as a map from string to list of values to simulate an incoming invocation request.

PathWithQueryString

Type: *string

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

ResourceId

Type: *string

[Required] Specifies a test invoke method request's resource ID.

ResourceId is a required field

RestApiId

Type: *string

[Required] The string identifier of the associated RestApi.

RestApiId is a required field

StageVariables

Type: map[string]*string

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Method

GoString

func (s TestInvokeMethodInput) GoString() string

GoString returns the string representation

SetBody

func (s *TestInvokeMethodInput) SetBody(v string) *TestInvokeMethodInput

SetBody sets the Body field's value.

SetClientCertificateId

func (s *TestInvokeMethodInput) SetClientCertificateId(v string) *TestInvokeMethodInput

SetClientCertificateId sets the ClientCertificateId field's value.

SetHeaders

func (s *TestInvokeMethodInput) SetHeaders(v map[string]*string) *TestInvokeMethodInput

SetHeaders sets the Headers field's value.

SetHttpMethod

func (s *TestInvokeMethodInput) SetHttpMethod(v string) *TestInvokeMethodInput

SetHttpMethod sets the HttpMethod field's value.

SetMultiValueHeaders

func (s *TestInvokeMethodInput) SetMultiValueHeaders(v map[string][]*string) *TestInvokeMethodInput

SetMultiValueHeaders sets the MultiValueHeaders field's value.

SetPathWithQueryString

func (s *TestInvokeMethodInput) SetPathWithQueryString(v string) *TestInvokeMethodInput

SetPathWithQueryString sets the PathWithQueryString field's value.

SetResourceId

func (s *TestInvokeMethodInput) SetResourceId(v string) *TestInvokeMethodInput

SetResourceId sets the ResourceId field's value.

SetRestApiId

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

SetRestApiId sets the RestApiId field's value.

SetStageVariables

func (s *TestInvokeMethodInput) SetStageVariables(v map[string]*string) *TestInvokeMethodInput

SetStageVariables sets the StageVariables field's value.

String

func (s TestInvokeMethodInput) String() string

String returns the string representation

Validate

func (s *TestInvokeMethodInput) Validate() error

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

On this page: