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 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 ApiGatewayManagementApi for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/apigatewaymanagementapi/#New
Index ¶
Constants ¶
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" )
const ( ServiceName = "execute-api" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApiGatewayManagementApi ¶
ApiGatewayManagementApi provides the API operation methods for making requests to AmazonApiGatewayManagementApi. See this package's package overview docs for details on the service.
ApiGatewayManagementApi 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) *ApiGatewayManagementApi
New creates a new instance of the ApiGatewayManagementApi client with a config.
Example:
// Create a ApiGatewayManagementApi client from just a config. svc := apigatewaymanagementapi.New(myConfig)
func (*ApiGatewayManagementApi) PostToConnectionRequest ¶
func (c *ApiGatewayManagementApi) 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 the PostToConnectionRequest method. 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) GoString ¶
func (s PostToConnectionInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s PostToConnectionOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s PostToConnectionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the PostToConnection API operation.
func (PostToConnectionRequest) Send ¶
func (r PostToConnectionRequest) Send(ctx context.Context) (*PostToConnectionOutput, error)
Send marshals and sends the PostToConnection API request.
Directories ¶
Path | Synopsis |
---|---|
Package apigatewaymanagementapiiface provides an interface to enable mocking the AmazonApiGatewayManagementApi service client for testing your code.
|
Package apigatewaymanagementapiiface provides an interface to enable mocking the AmazonApiGatewayManagementApi service client for testing your code. |