Documentation

Overview

    Package apigatewaymanagementapi provides the API client, operations, and parameter types for 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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-11-29"
    View Source
    const ServiceID = "ApiGatewayManagementApi"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

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

            Client provides the API client to make operations call for AmazonApiGatewayManagementApi.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) DeleteConnection

                func (c *Client) DeleteConnection(ctx context.Context, params *DeleteConnectionInput, optFns ...func(*Options)) (*DeleteConnectionOutput, error)

                  Delete the connection with the provided id.

                  func (*Client) GetConnection

                  func (c *Client) GetConnection(ctx context.Context, params *GetConnectionInput, optFns ...func(*Options)) (*GetConnectionOutput, error)

                    Get information about the connection with the provided id.

                    func (*Client) PostToConnection

                    func (c *Client) PostToConnection(ctx context.Context, params *PostToConnectionInput, optFns ...func(*Options)) (*PostToConnectionOutput, error)

                      Sends the provided data to the specified connection.

                      type DeleteConnectionInput

                      type DeleteConnectionInput struct {
                      
                      	// This member is required.
                      	ConnectionId *string
                      }

                      type DeleteConnectionOutput

                      type DeleteConnectionOutput struct {
                      	// Metadata pertaining to the operation's result.
                      	ResultMetadata middleware.Metadata
                      }

                      type EndpointResolver

                      type EndpointResolver interface {
                      	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                      }

                        EndpointResolver interface for resolving service endpoints.

                        func EndpointResolverFromURL

                        func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                          EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                          type EndpointResolverFunc

                          type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                            EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                            func (EndpointResolverFunc) ResolveEndpoint

                            func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                            type EndpointResolverOptions

                            type EndpointResolverOptions = internalendpoints.Options

                              EndpointResolverOptions is the service endpoint resolver options

                              type GetConnectionInput

                              type GetConnectionInput struct {
                              
                              	// This member is required.
                              	ConnectionId *string
                              }

                              type GetConnectionOutput

                              type GetConnectionOutput struct {
                              
                              	// The time in ISO 8601 format for when the connection was established.
                              	ConnectedAt *time.Time
                              
                              	Identity *types.Identity
                              
                              	// The time in ISO 8601 format for when the connection was last active.
                              	LastActiveAt *time.Time
                              
                              	// Metadata pertaining to the operation's result.
                              	ResultMetadata middleware.Metadata
                              }

                              type HTTPClient

                              type HTTPClient interface {
                              	Do(*http.Request) (*http.Response, error)
                              }

                              type HTTPSignerV4

                              type HTTPSignerV4 interface {
                              	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                              }

                              type Options

                              type Options struct {
                              	// Set of options to modify how an operation is invoked. These apply to all
                              	// operations invoked for this client. Use functional options on operation call to
                              	// modify this list for per operation behavior.
                              	APIOptions []func(*middleware.Stack) error
                              
                              	// Configures the events that will be sent to the configured logger.
                              	ClientLogMode aws.ClientLogMode
                              
                              	// The credentials object to use when signing requests.
                              	Credentials aws.CredentialsProvider
                              
                              	// The endpoint options to be used when attempting to resolve an endpoint.
                              	EndpointOptions EndpointResolverOptions
                              
                              	// The service endpoint resolver.
                              	EndpointResolver EndpointResolver
                              
                              	// Signature Version 4 (SigV4) Signer
                              	HTTPSignerV4 HTTPSignerV4
                              
                              	// The logger writer interface to write logging messages to.
                              	Logger logging.Logger
                              
                              	// The region to send requests to. (Required)
                              	Region string
                              
                              	// Retryer guides how HTTP requests should be retried in case of recoverable
                              	// failures. When nil the API client will use a default retryer.
                              	Retryer aws.Retryer
                              
                              	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                              	// implementation if nil.
                              	HTTPClient HTTPClient
                              }

                              func (Options) Copy

                              func (o Options) Copy() Options

                                Copy creates a clone where the APIOptions list is deep copied.

                                type PostToConnectionInput

                                type PostToConnectionInput struct {
                                
                                	// The identifier of the connection that a specific client is using.
                                	//
                                	// This member is required.
                                	ConnectionId *string
                                
                                	// The data to be sent to the client specified by its connection id.
                                	//
                                	// This member is required.
                                	Data []byte
                                }

                                type PostToConnectionOutput

                                type PostToConnectionOutput struct {
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type ResolveEndpoint

                                type ResolveEndpoint struct {
                                	Resolver EndpointResolver
                                	Options  EndpointResolverOptions
                                }

                                func (*ResolveEndpoint) HandleSerialize

                                func (*ResolveEndpoint) ID

                                func (*ResolveEndpoint) ID() string

                                Directories

                                Path Synopsis
                                internal