apigatewaymanagementapi

Documentation

Overview

Package apigatewaymanagementapi provides the client and types for making API requests to AmazonApiGatewayManagementApi.

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

See https://docs.aws.amazon.com/goto/WebAPI/apigatewaymanagementapi-2018-11-29 for more information on this service.

See apigatewaymanagementapi package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/apigatewaymanagementapi/

Using the Client

To use AmazonApiGatewayManagementApi with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AmazonApiGatewayManagementApi client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/apigatewaymanagementapi/#New

Index

• Constants
• type Client
  • func New(config aws.Config) *Client
  • func (c *Client) PostToConnectionRequest(input *PostToConnectionInput) PostToConnectionRequest
• type PostToConnectionInput
  • func (s PostToConnectionInput) MarshalFields(e protocol.FieldEncoder) error
  • func (s PostToConnectionInput) String() string
  • func (s *PostToConnectionInput) Validate() error
• type PostToConnectionOutput
  • func (s PostToConnectionOutput) MarshalFields(e protocol.FieldEncoder) error
  • func (s PostToConnectionOutput) String() string
• type PostToConnectionRequest
  • func (r PostToConnectionRequest) Send(ctx context.Context) (*PostToConnectionResponse, error)
• type PostToConnectionResponse
  • func (r *PostToConnectionResponse) SDKResponseMetdata() *aws.Response

Constants

const (
	ServiceName = "AmazonApiGatewayManagementApi" // Service's name
	ServiceID   = "ApiGatewayManagementApi"       // Service's identifier
	EndpointsID = "execute-api"                   // Service's Endpoint identifier
)

const (

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// The caller is not authorized to invoke this operation.
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeGoneException for service response error code
	// "GoneException".
	//
	// The connection with the provided id no longer exists.
	ErrCodeGoneException = "GoneException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// The client is sending more than the allowed number of requests per unit of
	// time.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodePayloadTooLargeException for service response error code
	// "PayloadTooLargeException".
	//
	// The data has exceeded the maximum size allowed.
	ErrCodePayloadTooLargeException = "PayloadTooLargeException"
)

Types

type Client

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AmazonApiGatewayManagementApi. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := apigatewaymanagementapi.New(myConfig)

func (*Client) PostToConnectionRequest

func (c *Client) PostToConnectionRequest(input *PostToConnectionInput) PostToConnectionRequest

PostToConnectionRequest returns a request value for making API operation for AmazonApiGatewayManagementApi.

Sends the provided data to the specified connection.

// Example sending a request using PostToConnectionRequest.
req := client.PostToConnectionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/apigatewaymanagementapi-2018-11-29/PostToConnection

type PostToConnectionInput

type PostToConnectionInput struct {

	// ConnectionId is a required field
	ConnectionId *string `location:"uri" locationName:"connectionId" type:"string" required:"true"`

	// The data to be sent to the client specified by its connection id.
	//
	// Data is a required field
	Data []byte `type:"blob" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/apigatewaymanagementapi-2018-11-29/PostToConnectionRequest

func (PostToConnectionInput) MarshalFields

func (s PostToConnectionInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PostToConnectionInput) String

func (s PostToConnectionInput) String() string

String returns the string representation

func (*PostToConnectionInput) Validate

func (s *PostToConnectionInput) Validate() error

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

type PostToConnectionOutput

type PostToConnectionOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/apigatewaymanagementapi-2018-11-29/PostToConnectionOutput

func (PostToConnectionOutput) MarshalFields

func (s PostToConnectionOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PostToConnectionOutput) String

func (s PostToConnectionOutput) String() string

String returns the string representation

type PostToConnectionRequest

type PostToConnectionRequest struct {
	*aws.Request
	Input *PostToConnectionInput
	Copy  func(*PostToConnectionInput) PostToConnectionRequest
}

PostToConnectionRequest is the request type for the PostToConnection API operation.

func (PostToConnectionRequest) Send

func (r PostToConnectionRequest) Send(ctx context.Context) (*PostToConnectionResponse, error)

Send marshals and sends the PostToConnection API request.

type PostToConnectionResponse

type PostToConnectionResponse struct {
	*PostToConnectionOutput
	// contains filtered or unexported fields
}

PostToConnectionResponse is the response type for the PostToConnection API operation.

func (*PostToConnectionResponse) SDKResponseMetdata

func (r *PostToConnectionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PostToConnection request.