package apigatewayv2
import "github.com/aws/aws-sdk-go-v2/service/apigatewayv2"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CreateApi(ctx context.Context, params *CreateApiInput, optFns ...func(*Options)) (*CreateApiOutput, error)
- func (c *Client) CreateApiMapping(ctx context.Context, params *CreateApiMappingInput, optFns ...func(*Options)) (*CreateApiMappingOutput, error)
- func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerInput, optFns ...func(*Options)) (*CreateAuthorizerOutput, error)
- func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error)
- func (c *Client) CreateDomainName(ctx context.Context, params *CreateDomainNameInput, optFns ...func(*Options)) (*CreateDomainNameOutput, error)
- func (c *Client) CreateIntegration(ctx context.Context, params *CreateIntegrationInput, optFns ...func(*Options)) (*CreateIntegrationOutput, error)
- func (c *Client) CreateIntegrationResponse(ctx context.Context, params *CreateIntegrationResponseInput, optFns ...func(*Options)) (*CreateIntegrationResponseOutput, error)
- func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optFns ...func(*Options)) (*CreateModelOutput, error)
- func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optFns ...func(*Options)) (*CreateRouteOutput, error)
- func (c *Client) CreateRouteResponse(ctx context.Context, params *CreateRouteResponseInput, optFns ...func(*Options)) (*CreateRouteResponseOutput, error)
- func (c *Client) CreateStage(ctx context.Context, params *CreateStageInput, optFns ...func(*Options)) (*CreateStageOutput, error)
- func (c *Client) CreateVpcLink(ctx context.Context, params *CreateVpcLinkInput, optFns ...func(*Options)) (*CreateVpcLinkOutput, error)
- func (c *Client) DeleteAccessLogSettings(ctx context.Context, params *DeleteAccessLogSettingsInput, optFns ...func(*Options)) (*DeleteAccessLogSettingsOutput, error)
- func (c *Client) DeleteApi(ctx context.Context, params *DeleteApiInput, optFns ...func(*Options)) (*DeleteApiOutput, error)
- func (c *Client) DeleteApiMapping(ctx context.Context, params *DeleteApiMappingInput, optFns ...func(*Options)) (*DeleteApiMappingOutput, error)
- func (c *Client) DeleteAuthorizer(ctx context.Context, params *DeleteAuthorizerInput, optFns ...func(*Options)) (*DeleteAuthorizerOutput, error)
- func (c *Client) DeleteCorsConfiguration(ctx context.Context, params *DeleteCorsConfigurationInput, optFns ...func(*Options)) (*DeleteCorsConfigurationOutput, error)
- func (c *Client) DeleteDeployment(ctx context.Context, params *DeleteDeploymentInput, optFns ...func(*Options)) (*DeleteDeploymentOutput, error)
- func (c *Client) DeleteDomainName(ctx context.Context, params *DeleteDomainNameInput, optFns ...func(*Options)) (*DeleteDomainNameOutput, error)
- func (c *Client) DeleteIntegration(ctx context.Context, params *DeleteIntegrationInput, optFns ...func(*Options)) (*DeleteIntegrationOutput, error)
- func (c *Client) DeleteIntegrationResponse(ctx context.Context, params *DeleteIntegrationResponseInput, optFns ...func(*Options)) (*DeleteIntegrationResponseOutput, error)
- func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optFns ...func(*Options)) (*DeleteModelOutput, error)
- func (c *Client) DeleteRoute(ctx context.Context, params *DeleteRouteInput, optFns ...func(*Options)) (*DeleteRouteOutput, error)
- func (c *Client) DeleteRouteRequestParameter(ctx context.Context, params *DeleteRouteRequestParameterInput, optFns ...func(*Options)) (*DeleteRouteRequestParameterOutput, error)
- func (c *Client) DeleteRouteResponse(ctx context.Context, params *DeleteRouteResponseInput, optFns ...func(*Options)) (*DeleteRouteResponseOutput, error)
- func (c *Client) DeleteRouteSettings(ctx context.Context, params *DeleteRouteSettingsInput, optFns ...func(*Options)) (*DeleteRouteSettingsOutput, error)
- func (c *Client) DeleteStage(ctx context.Context, params *DeleteStageInput, optFns ...func(*Options)) (*DeleteStageOutput, error)
- func (c *Client) DeleteVpcLink(ctx context.Context, params *DeleteVpcLinkInput, optFns ...func(*Options)) (*DeleteVpcLinkOutput, error)
- func (c *Client) ExportApi(ctx context.Context, params *ExportApiInput, optFns ...func(*Options)) (*ExportApiOutput, error)
- func (c *Client) GetApi(ctx context.Context, params *GetApiInput, optFns ...func(*Options)) (*GetApiOutput, error)
- func (c *Client) GetApiMapping(ctx context.Context, params *GetApiMappingInput, optFns ...func(*Options)) (*GetApiMappingOutput, error)
- func (c *Client) GetApiMappings(ctx context.Context, params *GetApiMappingsInput, optFns ...func(*Options)) (*GetApiMappingsOutput, error)
- func (c *Client) GetApis(ctx context.Context, params *GetApisInput, optFns ...func(*Options)) (*GetApisOutput, error)
- func (c *Client) GetAuthorizer(ctx context.Context, params *GetAuthorizerInput, optFns ...func(*Options)) (*GetAuthorizerOutput, error)
- func (c *Client) GetAuthorizers(ctx context.Context, params *GetAuthorizersInput, optFns ...func(*Options)) (*GetAuthorizersOutput, error)
- func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error)
- func (c *Client) GetDeployments(ctx context.Context, params *GetDeploymentsInput, optFns ...func(*Options)) (*GetDeploymentsOutput, error)
- func (c *Client) GetDomainName(ctx context.Context, params *GetDomainNameInput, optFns ...func(*Options)) (*GetDomainNameOutput, error)
- func (c *Client) GetDomainNames(ctx context.Context, params *GetDomainNamesInput, optFns ...func(*Options)) (*GetDomainNamesOutput, error)
- func (c *Client) GetIntegration(ctx context.Context, params *GetIntegrationInput, optFns ...func(*Options)) (*GetIntegrationOutput, error)
- func (c *Client) GetIntegrationResponse(ctx context.Context, params *GetIntegrationResponseInput, optFns ...func(*Options)) (*GetIntegrationResponseOutput, error)
- func (c *Client) GetIntegrationResponses(ctx context.Context, params *GetIntegrationResponsesInput, optFns ...func(*Options)) (*GetIntegrationResponsesOutput, error)
- func (c *Client) GetIntegrations(ctx context.Context, params *GetIntegrationsInput, optFns ...func(*Options)) (*GetIntegrationsOutput, error)
- func (c *Client) GetModel(ctx context.Context, params *GetModelInput, optFns ...func(*Options)) (*GetModelOutput, error)
- func (c *Client) GetModelTemplate(ctx context.Context, params *GetModelTemplateInput, optFns ...func(*Options)) (*GetModelTemplateOutput, error)
- func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns ...func(*Options)) (*GetModelsOutput, error)
- func (c *Client) GetRoute(ctx context.Context, params *GetRouteInput, optFns ...func(*Options)) (*GetRouteOutput, error)
- func (c *Client) GetRouteResponse(ctx context.Context, params *GetRouteResponseInput, optFns ...func(*Options)) (*GetRouteResponseOutput, error)
- func (c *Client) GetRouteResponses(ctx context.Context, params *GetRouteResponsesInput, optFns ...func(*Options)) (*GetRouteResponsesOutput, error)
- func (c *Client) GetRoutes(ctx context.Context, params *GetRoutesInput, optFns ...func(*Options)) (*GetRoutesOutput, error)
- func (c *Client) GetStage(ctx context.Context, params *GetStageInput, optFns ...func(*Options)) (*GetStageOutput, error)
- func (c *Client) GetStages(ctx context.Context, params *GetStagesInput, optFns ...func(*Options)) (*GetStagesOutput, error)
- func (c *Client) GetTags(ctx context.Context, params *GetTagsInput, optFns ...func(*Options)) (*GetTagsOutput, error)
- func (c *Client) GetVpcLink(ctx context.Context, params *GetVpcLinkInput, optFns ...func(*Options)) (*GetVpcLinkOutput, error)
- func (c *Client) GetVpcLinks(ctx context.Context, params *GetVpcLinksInput, optFns ...func(*Options)) (*GetVpcLinksOutput, error)
- func (c *Client) ImportApi(ctx context.Context, params *ImportApiInput, optFns ...func(*Options)) (*ImportApiOutput, error)
- func (c *Client) ReimportApi(ctx context.Context, params *ReimportApiInput, optFns ...func(*Options)) (*ReimportApiOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateApi(ctx context.Context, params *UpdateApiInput, optFns ...func(*Options)) (*UpdateApiOutput, error)
- func (c *Client) UpdateApiMapping(ctx context.Context, params *UpdateApiMappingInput, optFns ...func(*Options)) (*UpdateApiMappingOutput, error)
- func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerInput, optFns ...func(*Options)) (*UpdateAuthorizerOutput, error)
- func (c *Client) UpdateDeployment(ctx context.Context, params *UpdateDeploymentInput, optFns ...func(*Options)) (*UpdateDeploymentOutput, error)
- func (c *Client) UpdateDomainName(ctx context.Context, params *UpdateDomainNameInput, optFns ...func(*Options)) (*UpdateDomainNameOutput, error)
- func (c *Client) UpdateIntegration(ctx context.Context, params *UpdateIntegrationInput, optFns ...func(*Options)) (*UpdateIntegrationOutput, error)
- func (c *Client) UpdateIntegrationResponse(ctx context.Context, params *UpdateIntegrationResponseInput, optFns ...func(*Options)) (*UpdateIntegrationResponseOutput, error)
- func (c *Client) UpdateModel(ctx context.Context, params *UpdateModelInput, optFns ...func(*Options)) (*UpdateModelOutput, error)
- func (c *Client) UpdateRoute(ctx context.Context, params *UpdateRouteInput, optFns ...func(*Options)) (*UpdateRouteOutput, error)
- func (c *Client) UpdateRouteResponse(ctx context.Context, params *UpdateRouteResponseInput, optFns ...func(*Options)) (*UpdateRouteResponseOutput, error)
- func (c *Client) UpdateStage(ctx context.Context, params *UpdateStageInput, optFns ...func(*Options)) (*UpdateStageOutput, error)
- func (c *Client) UpdateVpcLink(ctx context.Context, params *UpdateVpcLinkInput, optFns ...func(*Options)) (*UpdateVpcLinkOutput, error)
- type CreateApiInput
- type CreateApiMappingInput
- type CreateApiMappingOutput
- type CreateApiOutput
- type CreateAuthorizerInput
- type CreateAuthorizerOutput
- type CreateDeploymentInput
- type CreateDeploymentOutput
- type CreateDomainNameInput
- type CreateDomainNameOutput
- type CreateIntegrationInput
- type CreateIntegrationOutput
- type CreateIntegrationResponseInput
- type CreateIntegrationResponseOutput
- type CreateModelInput
- type CreateModelOutput
- type CreateRouteInput
- type CreateRouteOutput
- type CreateRouteResponseInput
- type CreateRouteResponseOutput
- type CreateStageInput
- type CreateStageOutput
- type CreateVpcLinkInput
- type CreateVpcLinkOutput
- type DeleteAccessLogSettingsInput
- type DeleteAccessLogSettingsOutput
- type DeleteApiInput
- type DeleteApiMappingInput
- type DeleteApiMappingOutput
- type DeleteApiOutput
- type DeleteAuthorizerInput
- type DeleteAuthorizerOutput
- type DeleteCorsConfigurationInput
- type DeleteCorsConfigurationOutput
- type DeleteDeploymentInput
- type DeleteDeploymentOutput
- type DeleteDomainNameInput
- type DeleteDomainNameOutput
- type DeleteIntegrationInput
- type DeleteIntegrationOutput
- type DeleteIntegrationResponseInput
- type DeleteIntegrationResponseOutput
- type DeleteModelInput
- type DeleteModelOutput
- type DeleteRouteInput
- type DeleteRouteOutput
- type DeleteRouteRequestParameterInput
- type DeleteRouteRequestParameterOutput
- type DeleteRouteResponseInput
- type DeleteRouteResponseOutput
- type DeleteRouteSettingsInput
- type DeleteRouteSettingsOutput
- type DeleteStageInput
- type DeleteStageOutput
- type DeleteVpcLinkInput
- type DeleteVpcLinkOutput
- type EndpointResolver
- type EndpointResolverFunc
- type ExportApiInput
- type ExportApiOutput
- type GetApiInput
- type GetApiMappingInput
- type GetApiMappingOutput
- type GetApiMappingsInput
- type GetApiMappingsOutput
- type GetApiOutput
- type GetApisInput
- type GetApisOutput
- type GetAuthorizerInput
- type GetAuthorizerOutput
- type GetAuthorizersInput
- type GetAuthorizersOutput
- type GetDeploymentInput
- type GetDeploymentOutput
- type GetDeploymentsInput
- type GetDeploymentsOutput
- type GetDomainNameInput
- type GetDomainNameOutput
- type GetDomainNamesInput
- type GetDomainNamesOutput
- type GetIntegrationInput
- type GetIntegrationOutput
- type GetIntegrationResponseInput
- type GetIntegrationResponseOutput
- type GetIntegrationResponsesInput
- type GetIntegrationResponsesOutput
- type GetIntegrationsInput
- type GetIntegrationsOutput
- type GetModelInput
- type GetModelOutput
- type GetModelTemplateInput
- type GetModelTemplateOutput
- type GetModelsInput
- type GetModelsOutput
- type GetRouteInput
- type GetRouteOutput
- type GetRouteResponseInput
- type GetRouteResponseOutput
- type GetRouteResponsesInput
- type GetRouteResponsesOutput
- type GetRoutesInput
- type GetRoutesOutput
- type GetStageInput
- type GetStageOutput
- type GetStagesInput
- type GetStagesOutput
- type GetTagsInput
- type GetTagsOutput
- type GetVpcLinkInput
- type GetVpcLinkOutput
- type GetVpcLinksInput
- type GetVpcLinksOutput
- type HTTPClient
- type HTTPSignerV4
- type ImportApiInput
- type ImportApiOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type ReimportApiInput
- type ReimportApiOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateApiInput
- type UpdateApiMappingInput
- type UpdateApiMappingOutput
- type UpdateApiOutput
- type UpdateAuthorizerInput
- type UpdateAuthorizerOutput
- type UpdateDeploymentInput
- type UpdateDeploymentOutput
- type UpdateDomainNameInput
- type UpdateDomainNameOutput
- type UpdateIntegrationInput
- type UpdateIntegrationOutput
- type UpdateIntegrationResponseInput
- type UpdateIntegrationResponseOutput
- type UpdateModelInput
- type UpdateModelOutput
- type UpdateRouteInput
- type UpdateRouteOutput
- type UpdateRouteResponseInput
- type UpdateRouteResponseOutput
- type UpdateStageInput
- type UpdateStageOutput
- type UpdateVpcLinkInput
- type UpdateVpcLinkOutput
Constants ¶
const ServiceAPIVersion = "2018-11-29"
const ServiceID = "ApiGatewayV2"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Amazon API Gateway V2
func New ¶
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 ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateApi ¶
func (c *Client) CreateApi(ctx context.Context, params *CreateApiInput, optFns ...func(*Options)) (*CreateApiOutput, error)
Creates an Api resource.
func (*Client) CreateApiMapping ¶
func (c *Client) CreateApiMapping(ctx context.Context, params *CreateApiMappingInput, optFns ...func(*Options)) (*CreateApiMappingOutput, error)
Creates an API mapping.
func (*Client) CreateAuthorizer ¶
func (c *Client) CreateAuthorizer(ctx context.Context, params *CreateAuthorizerInput, optFns ...func(*Options)) (*CreateAuthorizerOutput, error)
Creates an Authorizer for an API.
func (*Client) CreateDeployment ¶
func (c *Client) CreateDeployment(ctx context.Context, params *CreateDeploymentInput, optFns ...func(*Options)) (*CreateDeploymentOutput, error)
Creates a Deployment for an API.
func (*Client) CreateDomainName ¶
func (c *Client) CreateDomainName(ctx context.Context, params *CreateDomainNameInput, optFns ...func(*Options)) (*CreateDomainNameOutput, error)
Creates a domain name.
func (*Client) CreateIntegration ¶
func (c *Client) CreateIntegration(ctx context.Context, params *CreateIntegrationInput, optFns ...func(*Options)) (*CreateIntegrationOutput, error)
Creates an Integration.
func (*Client) CreateIntegrationResponse ¶
func (c *Client) CreateIntegrationResponse(ctx context.Context, params *CreateIntegrationResponseInput, optFns ...func(*Options)) (*CreateIntegrationResponseOutput, error)
Creates an IntegrationResponses.
func (*Client) CreateModel ¶
func (c *Client) CreateModel(ctx context.Context, params *CreateModelInput, optFns ...func(*Options)) (*CreateModelOutput, error)
Creates a Model for an API.
func (*Client) CreateRoute ¶
func (c *Client) CreateRoute(ctx context.Context, params *CreateRouteInput, optFns ...func(*Options)) (*CreateRouteOutput, error)
Creates a Route for an API.
func (*Client) CreateRouteResponse ¶
func (c *Client) CreateRouteResponse(ctx context.Context, params *CreateRouteResponseInput, optFns ...func(*Options)) (*CreateRouteResponseOutput, error)
Creates a RouteResponse for a Route.
func (*Client) CreateStage ¶
func (c *Client) CreateStage(ctx context.Context, params *CreateStageInput, optFns ...func(*Options)) (*CreateStageOutput, error)
Creates a Stage for an API.
func (*Client) CreateVpcLink ¶
func (c *Client) CreateVpcLink(ctx context.Context, params *CreateVpcLinkInput, optFns ...func(*Options)) (*CreateVpcLinkOutput, error)
Creates a VPC link.
func (*Client) DeleteAccessLogSettings ¶
func (c *Client) DeleteAccessLogSettings(ctx context.Context, params *DeleteAccessLogSettingsInput, optFns ...func(*Options)) (*DeleteAccessLogSettingsOutput, error)
Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
func (*Client) DeleteApi ¶
func (c *Client) DeleteApi(ctx context.Context, params *DeleteApiInput, optFns ...func(*Options)) (*DeleteApiOutput, error)
Deletes an Api resource.
func (*Client) DeleteApiMapping ¶
func (c *Client) DeleteApiMapping(ctx context.Context, params *DeleteApiMappingInput, optFns ...func(*Options)) (*DeleteApiMappingOutput, error)
Deletes an API mapping.
func (*Client) DeleteAuthorizer ¶
func (c *Client) DeleteAuthorizer(ctx context.Context, params *DeleteAuthorizerInput, optFns ...func(*Options)) (*DeleteAuthorizerOutput, error)
Deletes an Authorizer.
func (*Client) DeleteCorsConfiguration ¶
func (c *Client) DeleteCorsConfiguration(ctx context.Context, params *DeleteCorsConfigurationInput, optFns ...func(*Options)) (*DeleteCorsConfigurationOutput, error)
Deletes a CORS configuration.
func (*Client) DeleteDeployment ¶
func (c *Client) DeleteDeployment(ctx context.Context, params *DeleteDeploymentInput, optFns ...func(*Options)) (*DeleteDeploymentOutput, error)
Deletes a Deployment.
func (*Client) DeleteDomainName ¶
func (c *Client) DeleteDomainName(ctx context.Context, params *DeleteDomainNameInput, optFns ...func(*Options)) (*DeleteDomainNameOutput, error)
Deletes a domain name.
func (*Client) DeleteIntegration ¶
func (c *Client) DeleteIntegration(ctx context.Context, params *DeleteIntegrationInput, optFns ...func(*Options)) (*DeleteIntegrationOutput, error)
Deletes an Integration.
func (*Client) DeleteIntegrationResponse ¶
func (c *Client) DeleteIntegrationResponse(ctx context.Context, params *DeleteIntegrationResponseInput, optFns ...func(*Options)) (*DeleteIntegrationResponseOutput, error)
Deletes an IntegrationResponses.
func (*Client) DeleteModel ¶
func (c *Client) DeleteModel(ctx context.Context, params *DeleteModelInput, optFns ...func(*Options)) (*DeleteModelOutput, error)
Deletes a Model.
func (*Client) DeleteRoute ¶
func (c *Client) DeleteRoute(ctx context.Context, params *DeleteRouteInput, optFns ...func(*Options)) (*DeleteRouteOutput, error)
Deletes a Route.
func (*Client) DeleteRouteRequestParameter ¶
func (c *Client) DeleteRouteRequestParameter(ctx context.Context, params *DeleteRouteRequestParameterInput, optFns ...func(*Options)) (*DeleteRouteRequestParameterOutput, error)
Deletes a route request parameter.
func (*Client) DeleteRouteResponse ¶
func (c *Client) DeleteRouteResponse(ctx context.Context, params *DeleteRouteResponseInput, optFns ...func(*Options)) (*DeleteRouteResponseOutput, error)
Deletes a RouteResponse.
func (*Client) DeleteRouteSettings ¶
func (c *Client) DeleteRouteSettings(ctx context.Context, params *DeleteRouteSettingsInput, optFns ...func(*Options)) (*DeleteRouteSettingsOutput, error)
Deletes the RouteSettings for a stage.
func (*Client) DeleteStage ¶
func (c *Client) DeleteStage(ctx context.Context, params *DeleteStageInput, optFns ...func(*Options)) (*DeleteStageOutput, error)
Deletes a Stage.
func (*Client) DeleteVpcLink ¶
func (c *Client) DeleteVpcLink(ctx context.Context, params *DeleteVpcLinkInput, optFns ...func(*Options)) (*DeleteVpcLinkOutput, error)
Deletes a VPC link.
func (*Client) ExportApi ¶
func (c *Client) ExportApi(ctx context.Context, params *ExportApiInput, optFns ...func(*Options)) (*ExportApiOutput, error)
func (*Client) GetApi ¶
func (c *Client) GetApi(ctx context.Context, params *GetApiInput, optFns ...func(*Options)) (*GetApiOutput, error)
Gets an Api resource.
func (*Client) GetApiMapping ¶
func (c *Client) GetApiMapping(ctx context.Context, params *GetApiMappingInput, optFns ...func(*Options)) (*GetApiMappingOutput, error)
Gets an API mapping.
func (*Client) GetApiMappings ¶
func (c *Client) GetApiMappings(ctx context.Context, params *GetApiMappingsInput, optFns ...func(*Options)) (*GetApiMappingsOutput, error)
Gets API mappings.
func (*Client) GetApis ¶
func (c *Client) GetApis(ctx context.Context, params *GetApisInput, optFns ...func(*Options)) (*GetApisOutput, error)
Gets a collection of Api resources.
func (*Client) GetAuthorizer ¶
func (c *Client) GetAuthorizer(ctx context.Context, params *GetAuthorizerInput, optFns ...func(*Options)) (*GetAuthorizerOutput, error)
Gets an Authorizer.
func (*Client) GetAuthorizers ¶
func (c *Client) GetAuthorizers(ctx context.Context, params *GetAuthorizersInput, optFns ...func(*Options)) (*GetAuthorizersOutput, error)
Gets the Authorizers for an API.
func (*Client) GetDeployment ¶
func (c *Client) GetDeployment(ctx context.Context, params *GetDeploymentInput, optFns ...func(*Options)) (*GetDeploymentOutput, error)
Gets a Deployment.
func (*Client) GetDeployments ¶
func (c *Client) GetDeployments(ctx context.Context, params *GetDeploymentsInput, optFns ...func(*Options)) (*GetDeploymentsOutput, error)
Gets the Deployments for an API.
func (*Client) GetDomainName ¶
func (c *Client) GetDomainName(ctx context.Context, params *GetDomainNameInput, optFns ...func(*Options)) (*GetDomainNameOutput, error)
Gets a domain name.
func (*Client) GetDomainNames ¶
func (c *Client) GetDomainNames(ctx context.Context, params *GetDomainNamesInput, optFns ...func(*Options)) (*GetDomainNamesOutput, error)
Gets the domain names for an AWS account.
func (*Client) GetIntegration ¶
func (c *Client) GetIntegration(ctx context.Context, params *GetIntegrationInput, optFns ...func(*Options)) (*GetIntegrationOutput, error)
Gets an Integration.
func (*Client) GetIntegrationResponse ¶
func (c *Client) GetIntegrationResponse(ctx context.Context, params *GetIntegrationResponseInput, optFns ...func(*Options)) (*GetIntegrationResponseOutput, error)
Gets an IntegrationResponses.
func (*Client) GetIntegrationResponses ¶
func (c *Client) GetIntegrationResponses(ctx context.Context, params *GetIntegrationResponsesInput, optFns ...func(*Options)) (*GetIntegrationResponsesOutput, error)
Gets the IntegrationResponses for an Integration.
func (*Client) GetIntegrations ¶
func (c *Client) GetIntegrations(ctx context.Context, params *GetIntegrationsInput, optFns ...func(*Options)) (*GetIntegrationsOutput, error)
Gets the Integrations for an API.
func (*Client) GetModel ¶
func (c *Client) GetModel(ctx context.Context, params *GetModelInput, optFns ...func(*Options)) (*GetModelOutput, error)
Gets a Model.
func (*Client) GetModelTemplate ¶
func (c *Client) GetModelTemplate(ctx context.Context, params *GetModelTemplateInput, optFns ...func(*Options)) (*GetModelTemplateOutput, error)
Gets a model template.
func (*Client) GetModels ¶
func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns ...func(*Options)) (*GetModelsOutput, error)
Gets the Models for an API.
func (*Client) GetRoute ¶
func (c *Client) GetRoute(ctx context.Context, params *GetRouteInput, optFns ...func(*Options)) (*GetRouteOutput, error)
Gets a Route.
func (*Client) GetRouteResponse ¶
func (c *Client) GetRouteResponse(ctx context.Context, params *GetRouteResponseInput, optFns ...func(*Options)) (*GetRouteResponseOutput, error)
Gets a RouteResponse.
func (*Client) GetRouteResponses ¶
func (c *Client) GetRouteResponses(ctx context.Context, params *GetRouteResponsesInput, optFns ...func(*Options)) (*GetRouteResponsesOutput, error)
Gets the RouteResponses for a Route.
func (*Client) GetRoutes ¶
func (c *Client) GetRoutes(ctx context.Context, params *GetRoutesInput, optFns ...func(*Options)) (*GetRoutesOutput, error)
Gets the Routes for an API.
func (*Client) GetStage ¶
func (c *Client) GetStage(ctx context.Context, params *GetStageInput, optFns ...func(*Options)) (*GetStageOutput, error)
Gets a Stage.
func (*Client) GetStages ¶
func (c *Client) GetStages(ctx context.Context, params *GetStagesInput, optFns ...func(*Options)) (*GetStagesOutput, error)
Gets the Stages for an API.
func (*Client) GetTags ¶
func (c *Client) GetTags(ctx context.Context, params *GetTagsInput, optFns ...func(*Options)) (*GetTagsOutput, error)
Gets a collection of Tag resources.
func (*Client) GetVpcLink ¶
func (c *Client) GetVpcLink(ctx context.Context, params *GetVpcLinkInput, optFns ...func(*Options)) (*GetVpcLinkOutput, error)
Gets a VPC link.
func (*Client) GetVpcLinks ¶
func (c *Client) GetVpcLinks(ctx context.Context, params *GetVpcLinksInput, optFns ...func(*Options)) (*GetVpcLinksOutput, error)
Gets a collection of VPC links.
func (*Client) ImportApi ¶
func (c *Client) ImportApi(ctx context.Context, params *ImportApiInput, optFns ...func(*Options)) (*ImportApiOutput, error)
Imports an API.
func (*Client) ReimportApi ¶
func (c *Client) ReimportApi(ctx context.Context, params *ReimportApiInput, optFns ...func(*Options)) (*ReimportApiOutput, error)
Puts an Api resource.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Creates a new Tag resource to represent a tag.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Deletes a Tag.
func (*Client) UpdateApi ¶
func (c *Client) UpdateApi(ctx context.Context, params *UpdateApiInput, optFns ...func(*Options)) (*UpdateApiOutput, error)
Updates an Api resource.
func (*Client) UpdateApiMapping ¶
func (c *Client) UpdateApiMapping(ctx context.Context, params *UpdateApiMappingInput, optFns ...func(*Options)) (*UpdateApiMappingOutput, error)
The API mapping.
func (*Client) UpdateAuthorizer ¶
func (c *Client) UpdateAuthorizer(ctx context.Context, params *UpdateAuthorizerInput, optFns ...func(*Options)) (*UpdateAuthorizerOutput, error)
Updates an Authorizer.
func (*Client) UpdateDeployment ¶
func (c *Client) UpdateDeployment(ctx context.Context, params *UpdateDeploymentInput, optFns ...func(*Options)) (*UpdateDeploymentOutput, error)
Updates a Deployment.
func (*Client) UpdateDomainName ¶
func (c *Client) UpdateDomainName(ctx context.Context, params *UpdateDomainNameInput, optFns ...func(*Options)) (*UpdateDomainNameOutput, error)
Updates a domain name.
func (*Client) UpdateIntegration ¶
func (c *Client) UpdateIntegration(ctx context.Context, params *UpdateIntegrationInput, optFns ...func(*Options)) (*UpdateIntegrationOutput, error)
Updates an Integration.
func (*Client) UpdateIntegrationResponse ¶
func (c *Client) UpdateIntegrationResponse(ctx context.Context, params *UpdateIntegrationResponseInput, optFns ...func(*Options)) (*UpdateIntegrationResponseOutput, error)
Updates an IntegrationResponses.
func (*Client) UpdateModel ¶
func (c *Client) UpdateModel(ctx context.Context, params *UpdateModelInput, optFns ...func(*Options)) (*UpdateModelOutput, error)
Updates a Model.
func (*Client) UpdateRoute ¶
func (c *Client) UpdateRoute(ctx context.Context, params *UpdateRouteInput, optFns ...func(*Options)) (*UpdateRouteOutput, error)
Updates a Route.
func (*Client) UpdateRouteResponse ¶
func (c *Client) UpdateRouteResponse(ctx context.Context, params *UpdateRouteResponseInput, optFns ...func(*Options)) (*UpdateRouteResponseOutput, error)
Updates a RouteResponse.
func (*Client) UpdateStage ¶
func (c *Client) UpdateStage(ctx context.Context, params *UpdateStageInput, optFns ...func(*Options)) (*UpdateStageOutput, error)
Updates a Stage.
func (*Client) UpdateVpcLink ¶
func (c *Client) UpdateVpcLink(ctx context.Context, params *UpdateVpcLinkInput, optFns ...func(*Options)) (*UpdateVpcLinkOutput, error)
Updates a VPC link.
type CreateApiInput ¶
type CreateApiInput struct { // A CORS configuration. Supported only for HTTP APIs. See Configuring CORS // (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) // for more information. CorsConfiguration *types.Cors // This property is part of quick create. It specifies the credentials required for // the integration, if any. For a Lambda integration, three options are available. // To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource // Name (ARN). To require that the caller's identity be passed through from the // request, specify arn:aws:iam::*:user/*. To use resource-based permissions on // supported AWS services, specify null. Currently, this property is not used for // HTTP integrations. Supported only for HTTP APIs. CredentialsArn *string // A version identifier for the API. Version *string // The description of the API. Description *string // This property is part of quick create. If you don't specify a routeKey, a // default route of $default is created. The $default route acts as a catch-all for // any request made to your API, for a particular stage. The $default route key // can't be modified. You can add routes after creating the API, and you can update // the route keys of additional routes. Supported only for HTTP APIs. RouteKey *string // This property is part of quick create. Quick create produces an API with an // integration, a default catch-all route, and a default stage which is configured // to automatically deploy changes. For HTTP integrations, specify a fully // qualified URL. For Lambda integrations, specify a function ARN. The type of the // integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for // HTTP APIs. Target *string // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string // The name of the API. // // This member is required. Name *string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not // provided, this will be the default for HTTP APIs. This property is required for // WebSocket APIs. RouteSelectionExpression *string // The API protocol. // // This member is required. ProtocolType types.ProtocolType }
Creates a new Api resource to represent an API.
type CreateApiMappingInput ¶
type CreateApiMappingInput struct { // The API mapping key. ApiMappingKey *string // The domain name. // // This member is required. DomainName *string // The API identifier. // // This member is required. ApiId *string // The API stage. // // This member is required. Stage *string }
Creates a new ApiMapping resource to represent an API mapping.
type CreateApiMappingOutput ¶
type CreateApiMappingOutput struct { // The API identifier. ApiId *string // The API stage. Stage *string // The API mapping key. ApiMappingKey *string // The API mapping identifier. ApiMappingId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateApiOutput ¶
type CreateApiOutput struct { // The name of the API. Name *string // The API protocol. ProtocolType types.ProtocolType // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not // provided, this will be the default for HTTP APIs. This property is required for // WebSocket APIs. RouteSelectionExpression *string // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The // stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool // The validation information during API import. This may include particular // properties of your OpenAPI definition which are ignored during import. Supported // only for HTTP APIs. ImportInfo []*string // The description of the API. Description *string // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string // The API ID. ApiId *string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string // A version identifier for the API. Version *string // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors // A collection of tags associated with the API. Tags map[string]*string // The timestamp when the API was created. CreatedDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateAuthorizerInput ¶
type CreateAuthorizerInput struct { // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web // Tokens. // // This member is required. AuthorizerType types.AuthorizerType // The API identifier. // // This member is required. ApiId *string // This parameter is not used. IdentityValidationExpression *string // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source // can be headers, query string parameters, stage variables, and context // parameters. For example, if an Auth header and a Name query string parameter are // defined as identity sources, this value is route.request.header.Auth, // route.request.querystring.Name. These parameters will be used to perform runtime // validation for Lambda-based authorizers by verifying all of the identity-related // request parameters are present in the request, not null, and non-empty. Only // when this is true does the authorizer invoke the authorizer Lambda function. // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For JWT, a single entry that specifies where to extract the JSON Web // Token (JWT )from inbound requests. Currently only header-based and query // parameter-based selections are supported, for example // "$request.header.Authorization". // // This member is required. IdentitySource []*string // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration // The name of the authorizer. // // This member is required. Name *string // Authorizer caching is not currently supported. Don't specify this value for // authorizers. AuthorizerResultTtlInSeconds *int32 // The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, // this must be a well-formed Lambda function URI, for example, // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form: // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, // including the initial /. For Lambda functions, this is usually of the form // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST // authorizers. AuthorizerUri *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda // function, specify null. Supported only for REQUEST authorizers. AuthorizerCredentialsArn *string }
Creates a new Authorizer resource to represent an authorizer.
type CreateAuthorizerOutput ¶
type CreateAuthorizerOutput struct { // The validation expression does not apply to the REQUEST authorizer. IdentityValidationExpression *string // The authorizer identifier. AuthorizerId *string // Authorizer caching is not currently supported. Don't specify this value for // authorizers. AuthorizerResultTtlInSeconds *int32 // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this // must be a well-formed Lambda function URI, for example, // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form: // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, // including the initial /. For Lambda functions, this is usually of the form // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST // authorizers. AuthorizerUri *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda // function, specify null. Supported only for REQUEST authorizers. AuthorizerCredentialsArn *string // The name of the authorizer. Name *string // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source // can be headers, query string parameters, stage variables, and context // parameters. For example, if an Auth header and a Name query string parameter are // defined as identity sources, this value is route.request.header.Auth, // route.request.querystring.Name. These parameters will be used to perform runtime // validation for Lambda-based authorizers by verifying all of the identity-related // request parameters are present in the request, not null, and non-empty. Only // when this is true does the authorizer invoke the authorizer Lambda function. // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For JWT, a single entry that specifies where to extract the JSON Web // Token (JWT) from inbound requests. Currently only header-based and query // parameter-based selections are supported, for example // "$request.header.Authorization". IdentitySource []*string // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web // Tokens. AuthorizerType types.AuthorizerType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateDeploymentInput ¶
type CreateDeploymentInput struct { // The name of the Stage resource for the Deployment resource to create. StageName *string // The description for the deployment resource. Description *string // The API identifier. // // This member is required. ApiId *string }
Creates a new Deployment resource to represent a deployment.
type CreateDeploymentOutput ¶
type CreateDeploymentOutput struct { // Specifies whether a deployment was automatically released. AutoDeployed *bool // The date and time when the Deployment resource was created. CreatedDate *time.Time // May contain additional feedback on the status of an API deployment. DeploymentStatusMessage *string // The identifier for the deployment. DeploymentId *string // The status of the deployment: PENDING, FAILED, or SUCCEEDED. DeploymentStatus types.DeploymentStatus // The description for the deployment. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateDomainNameInput ¶
type CreateDomainNameInput struct { // The domain name. // // This member is required. DomainName *string // The domain name configurations. DomainNameConfigurations []*types.DomainNameConfiguration // The collection of tags associated with a domain name. Tags map[string]*string }
Creates a new DomainName resource to represent a domain name.
type CreateDomainNameOutput ¶
type CreateDomainNameOutput struct { // The collection of tags associated with a domain name. Tags map[string]*string // The domain name configurations. DomainNameConfigurations []*types.DomainNameConfiguration // The name of the DomainName resource. DomainName *string // The API mapping selection expression. ApiMappingSelectionExpression *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateIntegrationInput ¶
type CreateIntegrationInput struct { // For a Lambda integration, specify the URI of a Lambda function. For an HTTP // integration, specify a fully-qualified URL. For an HTTP API private integration, // specify the ARN of an Application Load Balancer listener, Network Load Balancer // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see // DiscoverInstances // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). // For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // The API identifier. // // This member is required. ApiId *string // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the value. // Supported only for WebSocket APIs. RequestTemplates map[string]*string // Specifies the credentials required for the integration, if any. For AWS // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS // services, specify null. CredentialsArn *string // Specifies the format of the payload sent to an integration. Required for HTTP // APIs. PayloadFormatVersion *string // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // Specifies the integration's HTTP method type. IntegrationMethod *string // The description of the integration. Description *string // The type of the network connection to the integration endpoint. Specify INTERNET // for connections through the public routable internet or VPC_LINK for private // connections between API Gateway and resources in a VPC. The default value is // INTERNET. ConnectionType types.ConnectionType // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped // content types through to the integration backend without transformation. NEVER // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media // Type response. PassthroughBehavior types.PassthroughBehavior // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including // the Lambda function-invoking action. With the Lambda function-invoking action, // this is referred to as the Lambda custom integration. With any other AWS service // action, this is known as AWS integration. Supported only for WebSocket APIs. // AWS_PROXY: for integrating the route or method request with the Lambda // function-invoking action with the client request passed through as-is. This // integration is also referred to as Lambda proxy integration. HTTP: for // integrating the route or method request with an HTTP endpoint. This integration // is also referred to as the HTTP custom integration. Supported only for WebSocket // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP // endpoint, with the client request passed through as-is. This is also referred to // as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY // integration. MOCK: for integrating the route or method request with API Gateway // as a "loopback" endpoint without invoking any backend. Supported only for // WebSocket APIs. // // This member is required. IntegrationType types.IntegrationType // The TLS configuration for a private integration. If you specify a TLS // configuration, private integration traffic uses the HTTPS protocol. Supported // only for HTTP APIs. TlsConfig *types.TlsConfigInput // The template selection expression for the integration. TemplateSelectionExpression *string // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for // WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis *int32 // A key-value map specifying request parameters that are passed from the method // request to the backend. The key is an integration request parameter name and the // associated value is a method request parameter value or static value that must // be enclosed within single quotes and pre-encoded as required by the backend. The // method request parameter value must match the pattern of // method.request.{location}.{name} , where {location} is querystring, path, or // header; and {name} must be a valid and unique method request parameter name. // Supported only for WebSocket APIs. RequestParameters map[string]*string }
Creates a new Integration resource to represent an integration.
type CreateIntegrationOutput ¶
type CreateIntegrationOutput struct { // Represents the identifier of an integration. IntegrationId *string // Specifies the credentials required for the integration, if any. For AWS // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS // services, specify null. CredentialsArn *string // For a Lambda integration, specify the URI of a Lambda function. For an HTTP // integration, specify a fully-qualified URL. For an HTTP API private integration, // specify the ARN of an Application Load Balancer listener, Network Load Balancer // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see // DiscoverInstances // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). // For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the value. // Supported only for WebSocket APIs. RequestTemplates map[string]*string // The integration response selection expression for the integration. Supported // only for WebSocket APIs. See Integration Response Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). IntegrationResponseSelectionExpression *string // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for // WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis *int32 // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including // the Lambda function-invoking action. With the Lambda function-invoking action, // this is referred to as the Lambda custom integration. With any other AWS service // action, this is known as AWS integration. Supported only for WebSocket APIs. // AWS_PROXY: for integrating the route or method request with the Lambda // function-invoking action with the client request passed through as-is. This // integration is also referred to as Lambda proxy integration. HTTP: for // integrating the route or method request with an HTTP endpoint. This integration // is also referred to as the HTTP custom integration. Supported only for WebSocket // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP // endpoint, with the client request passed through as-is. This is also referred to // as HTTP proxy integration. MOCK: for integrating the route or method request // with API Gateway as a "loopback" endpoint without invoking any backend. // Supported only for WebSocket APIs. IntegrationType types.IntegrationType // The TLS configuration for a private integration. If you specify a TLS // configuration, private integration traffic uses the HTTPS protocol. Supported // only for HTTP APIs. TlsConfig *types.TlsConfig // The type of the network connection to the integration endpoint. Specify INTERNET // for connections through the public routable internet or VPC_LINK for private // connections between API Gateway and resources in a VPC. The default value is // INTERNET. ConnectionType types.ConnectionType // Specifies the integration's HTTP method type. IntegrationMethod *string // Represents the description of an integration. Description *string // Specifies whether an integration is managed by API Gateway. If you created an // API using using quick create, the resulting integration is managed by API // Gateway. You can update a managed integration, but you can't delete it. ApiGatewayManaged *bool // Specifies the format of the payload sent to an integration. Required for HTTP // APIs. PayloadFormatVersion *string // A key-value map specifying request parameters that are passed from the method // request to the backend. The key is an integration request parameter name and the // associated value is a method request parameter value or static value that must // be enclosed within single quotes and pre-encoded as required by the backend. The // method request parameter value must match the pattern of // method.request.{location}.{name} , where {location} is querystring, path, or // header; and {name} must be a valid and unique method request parameter name. // Supported only for WebSocket APIs. RequestParameters map[string]*string // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped // content types through to the integration backend without transformation. NEVER // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media // Type response. PassthroughBehavior types.PassthroughBehavior // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateIntegrationResponseInput ¶
type CreateIntegrationResponseInput struct { // The template selection expression for the integration response. Supported only // for WebSocket APIs. TemplateSelectionExpression *string // The API identifier. // // This member is required. ApiId *string // The collection of response templates for the integration response as a // string-to-string map of key-value pairs. Response templates are represented as a // key/value map, with a content-type as the key and a template as the value. ResponseTemplates map[string]*string // The integration response key. // // This member is required. IntegrationResponseKey *string // Specifies how to handle response payload content type conversions. Supported // values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: // CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to // the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from // a binary blob to a Base64-encoded string. If this property is not defined, the // response payload will be passed through from the integration response to the // route response or method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // The integration ID. // // This member is required. IntegrationId *string // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of // method.response.header.{name}, where {name} is a valid and unique header name. // The mapped non-static value must match the pattern of // integration.response.header.{name} or // integration.response.body.{JSON-expression}, where {name} is a valid and unique // response header name and {JSON-expression} is a valid JSON expression without // the $ prefix. ResponseParameters map[string]*string }
Creates a new IntegrationResponse resource to represent an integration response.
type CreateIntegrationResponseOutput ¶
type CreateIntegrationResponseOutput struct { // The integration response key. IntegrationResponseKey *string // The template selection expressions for the integration response. TemplateSelectionExpression *string // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. The // mapped non-static value must match the pattern of // integration.response.header.{name} or // integration.response.body.{JSON-expression}, where name is a valid and unique // response header name and JSON-expression is a valid JSON expression without the // $ prefix. ResponseParameters map[string]*string // The integration response ID. IntegrationResponseId *string // The collection of response templates for the integration response as a // string-to-string map of key-value pairs. Response templates are represented as a // key/value map, with a content-type as the key and a template as the value. ResponseTemplates map[string]*string // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateModelInput ¶
type CreateModelInput struct { // The name of the model. Must be alphanumeric. // // This member is required. Name *string // The API identifier. // // This member is required. ApiId *string // The content-type for the model, for example, "application/json". ContentType *string // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. // // This member is required. Schema *string // The description of the model. Description *string }
Creates a new Model.
type CreateModelOutput ¶
type CreateModelOutput struct { // The name of the model. Must be alphanumeric. Name *string // The model identifier. ModelId *string // The content-type for the model, for example, "application/json". ContentType *string // The description of the model. Description *string // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. Schema *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateRouteInput ¶
type CreateRouteInput struct { // The route key for the route. // // This member is required. RouteKey *string // The operation name for the route. OperationName *string // The API identifier. // // This member is required. ApiId *string // The model selection expression for the route. Supported only for WebSocket APIs. ModelSelectionExpression *string // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string // The request parameters for the route. Supported only for WebSocket APIs. RequestParameters map[string]*types.ParameterConstraints // The route response selection expression for the route. Supported only for // WebSocket APIs. RouteResponseSelectionExpression *string // The authorization type for the route. For WebSocket APIs, valid values are NONE // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT // for using JSON Web Tokens. AuthorizationType types.AuthorizationType // Specifies whether an API key is required for the route. Supported only for // WebSocket APIs. ApiKeyRequired *bool // The authorization scopes supported by this route. AuthorizationScopes []*string // The target for the route. Target *string // The request models for the route. Supported only for WebSocket APIs. RequestModels map[string]*string }
Creates a new Route resource to represent a route.
type CreateRouteOutput ¶
type CreateRouteOutput struct { // The target for the route. Target *string // The request parameters for the route. Supported only for WebSocket APIs. RequestParameters map[string]*types.ParameterConstraints // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string // The route ID. RouteId *string // The request models for the route. Supported only for WebSocket APIs. RequestModels map[string]*string // Specifies whether a route is managed by API Gateway. If you created an API using // quick create, the $default route is managed by API Gateway. You can't modify the // $default route key. ApiGatewayManaged *bool // The operation name for the route. OperationName *string // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired *bool // A list of authorization scopes configured on a route. The scopes are used with a // JWT authorizer to authorize the method invocation. The authorization works by // matching the route scopes against the scopes parsed from the access token in the // incoming request. The method invocation is authorized if any route scope matches // a claimed scope in the access token. Otherwise, the invocation is not // authorized. When the route scope is configured, the client must provide an // access token instead of an identity token for authorization purposes. AuthorizationScopes []*string // The route key for the route. RouteKey *string // The route response selection expression for the route. Supported only for // WebSocket APIs. RouteResponseSelectionExpression *string // The model selection expression for the route. Supported only for WebSocket APIs. ModelSelectionExpression *string // The authorization type for the route. For WebSocket APIs, valid values are NONE // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT // for using JSON Web Tokens. AuthorizationType types.AuthorizationType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateRouteResponseInput ¶
type CreateRouteResponseInput struct { // The route response parameters. ResponseParameters map[string]*types.ParameterConstraints // The route response key. // // This member is required. RouteResponseKey *string // The response models for the route response. ResponseModels map[string]*string // The API identifier. // // This member is required. ApiId *string // The route ID. // // This member is required. RouteId *string // The model selection expression for the route response. Supported only for // WebSocket APIs. ModelSelectionExpression *string }
Creates a new RouteResponse resource to represent a route response.
type CreateRouteResponseOutput ¶
type CreateRouteResponseOutput struct { // Represents the response models of a route response. ResponseModels map[string]*string // Represents the identifier of a route response. RouteResponseId *string // Represents the response parameters of a route response. ResponseParameters map[string]*types.ParameterConstraints // Represents the route response key of a route response. RouteResponseKey *string // Represents the model selection expression of a route response. Supported only // for WebSocket APIs. ModelSelectionExpression *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateStageInput ¶
type CreateStageInput struct { // A map that defines the stage variables for a Stage. Variable names can have // alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string // The description for the API stage. Description *string // The name of the stage. // // This member is required. StageName *string // The deployment identifier of the API stage. DeploymentId *string // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings // Route settings for the stage, by routeKey. RouteSettings map[string]*types.RouteSettings // The default route settings for the stage. DefaultRouteSettings *types.RouteSettings // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy *bool // The API identifier. // // This member is required. ApiId *string // The identifier of a client certificate for a Stage. Supported only for WebSocket // APIs. ClientCertificateId *string }
Creates a new Stage resource to represent a stage.
type CreateStageOutput ¶
type CreateStageOutput struct { // Route settings for the stage, by routeKey. RouteSettings map[string]*types.RouteSettings // The timestamp when the stage was created. CreatedDate *time.Time // The identifier of the Deployment that the Stage is associated with. Can't be // updated if autoDeploy is enabled. DeploymentId *string // The timestamp when the stage was last updated. LastUpdatedDate *time.Time // Specifies whether a stage is managed by API Gateway. If you created an API using // quick create, the $default stage is managed by API Gateway. You can't modify the // $default stage. ApiGatewayManaged *bool // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy *bool // Describes the status of the last deployment of a stage. Supported only for // stages with autoDeploy enabled. LastDeploymentStatusMessage *string // Default route settings for the stage. DefaultRouteSettings *types.RouteSettings // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings // The name of the stage. StageName *string // A map that defines the stage variables for a stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string // The identifier of a client certificate for a Stage. Supported only for WebSocket // APIs. ClientCertificateId *string // The description of the stage. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateVpcLinkInput ¶
type CreateVpcLinkInput struct { // The name of the VPC link. // // This member is required. Name *string // A list of subnet IDs to include in the VPC link. // // This member is required. SubnetIds []*string // A list of tags. Tags map[string]*string // A list of security group IDs for the VPC link. SecurityGroupIds []*string }
Creates a VPC link
type CreateVpcLinkOutput ¶
type CreateVpcLinkOutput struct { // The status of the VPC link. VpcLinkStatus types.VpcLinkStatus // The version of the VPC link. VpcLinkVersion types.VpcLinkVersion // The name of the VPC link. Name *string // The timestamp when the VPC link was created. CreatedDate *time.Time // The ID of the VPC link. VpcLinkId *string // A list of subnet IDs to include in the VPC link. SubnetIds []*string // Tags for the VPC link. Tags map[string]*string // A list of security group IDs for the VPC link. SecurityGroupIds []*string // A message summarizing the cause of the status of the VPC link. VpcLinkStatusMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAccessLogSettingsInput ¶
type DeleteAccessLogSettingsInput struct { // The stage name. Stage names can only contain alphanumeric characters, hyphens, // and underscores. Maximum length is 128 characters. // // This member is required. StageName *string // The API identifier. // // This member is required. ApiId *string }
type DeleteAccessLogSettingsOutput ¶
type DeleteAccessLogSettingsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApiInput ¶
type DeleteApiInput struct { // The API identifier. // // This member is required. ApiId *string }
type DeleteApiMappingInput ¶
type DeleteApiMappingInput struct { // The domain name. // // This member is required. DomainName *string // The API mapping identifier. // // This member is required. ApiMappingId *string }
type DeleteApiMappingOutput ¶
type DeleteApiMappingOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteApiOutput ¶
type DeleteApiOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAuthorizerInput ¶
type DeleteAuthorizerInput struct { // The API identifier. // // This member is required. ApiId *string // The authorizer identifier. // // This member is required. AuthorizerId *string }
type DeleteAuthorizerOutput ¶
type DeleteAuthorizerOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteCorsConfigurationInput ¶
type DeleteCorsConfigurationInput struct { // The API identifier. // // This member is required. ApiId *string }
type DeleteCorsConfigurationOutput ¶
type DeleteCorsConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDeploymentInput ¶
type DeleteDeploymentInput struct { // The API identifier. // // This member is required. ApiId *string // The deployment ID. // // This member is required. DeploymentId *string }
type DeleteDeploymentOutput ¶
type DeleteDeploymentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDomainNameInput ¶
type DeleteDomainNameInput struct { // The domain name. // // This member is required. DomainName *string }
type DeleteDomainNameOutput ¶
type DeleteDomainNameOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteIntegrationInput ¶
type DeleteIntegrationInput struct { // The API identifier. // // This member is required. ApiId *string // The integration ID. // // This member is required. IntegrationId *string }
type DeleteIntegrationOutput ¶
type DeleteIntegrationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteIntegrationResponseInput ¶
type DeleteIntegrationResponseInput struct { // The integration ID. // // This member is required. IntegrationId *string // The integration response ID. // // This member is required. IntegrationResponseId *string // The API identifier. // // This member is required. ApiId *string }
type DeleteIntegrationResponseOutput ¶
type DeleteIntegrationResponseOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteModelInput ¶
type DeleteModelInput struct { // The model ID. // // This member is required. ModelId *string // The API identifier. // // This member is required. ApiId *string }
type DeleteModelOutput ¶
type DeleteModelOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteRouteInput ¶
type DeleteRouteInput struct { // The API identifier. // // This member is required. ApiId *string // The route ID. // // This member is required. RouteId *string }
type DeleteRouteOutput ¶
type DeleteRouteOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteRouteRequestParameterInput ¶
type DeleteRouteRequestParameterInput struct { // The route ID. // // This member is required. RouteId *string // The route request parameter key. // // This member is required. RequestParameterKey *string // The API identifier. // // This member is required. ApiId *string }
type DeleteRouteRequestParameterOutput ¶
type DeleteRouteRequestParameterOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteRouteResponseInput ¶
type DeleteRouteResponseInput struct { // The route response ID. // // This member is required. RouteResponseId *string // The API identifier. // // This member is required. ApiId *string // The route ID. // // This member is required. RouteId *string }
type DeleteRouteResponseOutput ¶
type DeleteRouteResponseOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteRouteSettingsInput ¶
type DeleteRouteSettingsInput struct { // The route key. // // This member is required. RouteKey *string // The stage name. Stage names can only contain alphanumeric characters, hyphens, // and underscores. Maximum length is 128 characters. // // This member is required. StageName *string // The API identifier. // // This member is required. ApiId *string }
type DeleteRouteSettingsOutput ¶
type DeleteRouteSettingsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteStageInput ¶
type DeleteStageInput struct { // The stage name. Stage names can only contain alphanumeric characters, hyphens, // and underscores. Maximum length is 128 characters. // // This member is required. StageName *string // The API identifier. // // This member is required. ApiId *string }
type DeleteStageOutput ¶
type DeleteStageOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteVpcLinkInput ¶
type DeleteVpcLinkInput struct { // The ID of the VPC link. // // This member is required. VpcLinkId *string }
type DeleteVpcLinkOutput ¶
type DeleteVpcLinkOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)
type ExportApiInput ¶
type ExportApiInput struct { // The version of the API Gateway export algorithm. API Gateway uses the latest // version by default. Currently, the only supported version is 1.0. ExportVersion *string // The output type of the exported definition file. Valid values are JSON and YAML. // // This member is required. OutputType *string // The name of the API stage to export. If you don't specify this property, a // representation of the latest API configuration is exported. StageName *string // The API identifier. // // This member is required. ApiId *string // Specifies whether to include API Gateway extensions // (https://docs.aws.amazon.com//apigateway/latest/developerguide/api-gateway-swagger-extensions.html) // in the exported API definition. API Gateway extensions are included by default. IncludeExtensions *bool // The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only // supported value. // // This member is required. Specification *string }
type ExportApiOutput ¶
type ExportApiOutput struct { // Represents an exported definition of an API in a particular output format, for // example, YAML. The API is serialized to the requested specification, for // example, OpenAPI 3.0. Body []byte // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetApiInput ¶
type GetApiInput struct { // The API identifier. // // This member is required. ApiId *string }
type GetApiMappingInput ¶
type GetApiMappingInput struct { // The domain name. // // This member is required. DomainName *string // The API mapping identifier. // // This member is required. ApiMappingId *string }
type GetApiMappingOutput ¶
type GetApiMappingOutput struct { // The API mapping identifier. ApiMappingId *string // The API identifier. ApiId *string // The API mapping key. ApiMappingKey *string // The API stage. Stage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetApiMappingsInput ¶
type GetApiMappingsInput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The maximum number of elements to be returned for this resource. MaxResults *string // The domain name. // // This member is required. DomainName *string }
type GetApiMappingsOutput ¶
type GetApiMappingsOutput struct { // The elements from this collection. Items []*types.ApiMapping // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetApiOutput ¶
type GetApiOutput struct { // The validation information during API import. This may include particular // properties of your OpenAPI definition which are ignored during import. Supported // only for HTTP APIs. ImportInfo []*string // The description of the API. Description *string // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not // provided, this will be the default for HTTP APIs. This property is required for // WebSocket APIs. RouteSelectionExpression *string // The API protocol. ProtocolType types.ProtocolType // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool // The name of the API. Name *string // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The // stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string // The timestamp when the API was created. CreatedDate *time.Time // A version identifier for the API. Version *string // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors // The API ID. ApiId *string // A collection of tags associated with the API. Tags map[string]*string // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetApisInput ¶
type GetApisInput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The maximum number of elements to be returned for this resource. MaxResults *string }
type GetApisOutput ¶
type GetApisOutput struct { // The elements from this collection. Items []*types.Api // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetAuthorizerInput ¶
type GetAuthorizerInput struct { // The authorizer identifier. // // This member is required. AuthorizerId *string // The API identifier. // // This member is required. ApiId *string }
type GetAuthorizerOutput ¶
type GetAuthorizerOutput struct { // The name of the authorizer. Name *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda // function, specify null. Supported only for REQUEST authorizers. AuthorizerCredentialsArn *string // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this // must be a well-formed Lambda function URI, for example, // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form: // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, // including the initial /. For Lambda functions, this is usually of the form // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST // authorizers. AuthorizerUri *string // The authorizer identifier. AuthorizerId *string // The validation expression does not apply to the REQUEST authorizer. IdentityValidationExpression *string // Authorizer caching is not currently supported. Don't specify this value for // authorizers. AuthorizerResultTtlInSeconds *int32 // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source // can be headers, query string parameters, stage variables, and context // parameters. For example, if an Auth header and a Name query string parameter are // defined as identity sources, this value is route.request.header.Auth, // route.request.querystring.Name. These parameters will be used to perform runtime // validation for Lambda-based authorizers by verifying all of the identity-related // request parameters are present in the request, not null, and non-empty. Only // when this is true does the authorizer invoke the authorizer Lambda function. // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For JWT, a single entry that specifies where to extract the JSON Web // Token (JWT) from inbound requests. Currently only header-based and query // parameter-based selections are supported, for example // "$request.header.Authorization". IdentitySource []*string // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web // Tokens. AuthorizerType types.AuthorizerType // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetAuthorizersInput ¶
type GetAuthorizersInput struct { // The maximum number of elements to be returned for this resource. MaxResults *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The API identifier. // // This member is required. ApiId *string }
type GetAuthorizersOutput ¶
type GetAuthorizersOutput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The elements from this collection. Items []*types.Authorizer // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDeploymentInput ¶
type GetDeploymentInput struct { // The deployment ID. // // This member is required. DeploymentId *string // The API identifier. // // This member is required. ApiId *string }
type GetDeploymentOutput ¶
type GetDeploymentOutput struct { // The identifier for the deployment. DeploymentId *string // The date and time when the Deployment resource was created. CreatedDate *time.Time // The status of the deployment: PENDING, FAILED, or SUCCEEDED. DeploymentStatus types.DeploymentStatus // Specifies whether a deployment was automatically released. AutoDeployed *bool // May contain additional feedback on the status of an API deployment. DeploymentStatusMessage *string // The description for the deployment. Description *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDeploymentsInput ¶
type GetDeploymentsInput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The maximum number of elements to be returned for this resource. MaxResults *string // The API identifier. // // This member is required. ApiId *string }
type GetDeploymentsOutput ¶
type GetDeploymentsOutput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The elements from this collection. Items []*types.Deployment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDomainNameInput ¶
type GetDomainNameInput struct { // The domain name. // // This member is required. DomainName *string }
type GetDomainNameOutput ¶
type GetDomainNameOutput struct { // The collection of tags associated with a domain name. Tags map[string]*string // The domain name configurations. DomainNameConfigurations []*types.DomainNameConfiguration // The name of the DomainName resource. DomainName *string // The API mapping selection expression. ApiMappingSelectionExpression *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDomainNamesInput ¶
type GetDomainNamesInput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The maximum number of elements to be returned for this resource. MaxResults *string }
type GetDomainNamesOutput ¶
type GetDomainNamesOutput struct { // The elements from this collection. Items []*types.DomainName // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetIntegrationInput ¶
type GetIntegrationInput struct { // The integration ID. // // This member is required. IntegrationId *string // The API identifier. // // This member is required. ApiId *string }
type GetIntegrationOutput ¶
type GetIntegrationOutput struct { // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including // the Lambda function-invoking action. With the Lambda function-invoking action, // this is referred to as the Lambda custom integration. With any other AWS service // action, this is known as AWS integration. Supported only for WebSocket APIs. // AWS_PROXY: for integrating the route or method request with the Lambda // function-invoking action with the client request passed through as-is. This // integration is also referred to as Lambda proxy integration. HTTP: for // integrating the route or method request with an HTTP endpoint. This integration // is also referred to as the HTTP custom integration. Supported only for WebSocket // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP // endpoint, with the client request passed through as-is. This is also referred to // as HTTP proxy integration. MOCK: for integrating the route or method request // with API Gateway as a "loopback" endpoint without invoking any backend. // Supported only for WebSocket APIs. IntegrationType types.IntegrationType // Represents the description of an integration. Description *string // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped // content types through to the integration backend without transformation. NEVER // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media // Type response. PassthroughBehavior types.PassthroughBehavior // Specifies the integration's HTTP method type. IntegrationMethod *string // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string // The type of the network connection to the integration endpoint. Specify INTERNET // for connections through the public routable internet or VPC_LINK for private // connections between API Gateway and resources in a VPC. The default value is // INTERNET. ConnectionType types.ConnectionType // Specifies whether an integration is managed by API Gateway. If you created an // API using using quick create, the resulting integration is managed by API // Gateway. You can update a managed integration, but you can't delete it. ApiGatewayManaged *bool // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for // WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis *int32 // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // The TLS configuration for a private integration. If you specify a TLS // configuration, private integration traffic uses the HTTPS protocol. Supported // only for HTTP APIs. TlsConfig *types.TlsConfig // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the value. // Supported only for WebSocket APIs. RequestTemplates map[string]*string // For a Lambda integration, specify the URI of a Lambda function. For an HTTP // integration, specify a fully-qualified URL. For an HTTP API private integration, // specify the ARN of an Application Load Balancer listener, Network Load Balancer // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see // DiscoverInstances // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). // For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string // Specifies the credentials required for the integration, if any. For AWS // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS // services, specify null. CredentialsArn *string // The integration response selection expression for the integration. Supported // only for WebSocket APIs. See Integration Response Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). IntegrationResponseSelectionExpression *string // Represents the identifier of an integration. IntegrationId *string // A key-value map specifying request parameters that are passed from the method // request to the backend. The key is an integration request parameter name and the // associated value is a method request parameter value or static value that must // be enclosed within single quotes and pre-encoded as required by the backend. The // method request parameter value must match the pattern of // method.request.{location}.{name} , where {location} is querystring, path, or // header; and {name} must be a valid and unique method request parameter name. // Supported only for WebSocket APIs. RequestParameters map[string]*string // Specifies the format of the payload sent to an integration. Required for HTTP // APIs. PayloadFormatVersion *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetIntegrationResponseInput ¶
type GetIntegrationResponseInput struct { // The API identifier. // // This member is required. ApiId *string // The integration ID. // // This member is required. IntegrationId *string // The integration response ID. // // This member is required. IntegrationResponseId *string }
type GetIntegrationResponseOutput ¶
type GetIntegrationResponseOutput struct { // The integration response ID. IntegrationResponseId *string // The collection of response templates for the integration response as a // string-to-string map of key-value pairs. Response templates are represented as a // key/value map, with a content-type as the key and a template as the value. ResponseTemplates map[string]*string // The template selection expressions for the integration response. TemplateSelectionExpression *string // The integration response key. IntegrationResponseKey *string // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. The // mapped non-static value must match the pattern of // integration.response.header.{name} or // integration.response.body.{JSON-expression}, where name is a valid and unique // response header name and JSON-expression is a valid JSON expression without the // $ prefix. ResponseParameters map[string]*string // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetIntegrationResponsesInput ¶
type GetIntegrationResponsesInput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The maximum number of elements to be returned for this resource. MaxResults *string // The integration ID. // // This member is required. IntegrationId *string // The API identifier. // // This member is required. ApiId *string }
type GetIntegrationResponsesOutput ¶
type GetIntegrationResponsesOutput struct { // The elements from this collection. Items []*types.IntegrationResponse // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetIntegrationsInput ¶
type GetIntegrationsInput struct { // The API identifier. // // This member is required. ApiId *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The maximum number of elements to be returned for this resource. MaxResults *string }
type GetIntegrationsOutput ¶
type GetIntegrationsOutput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The elements from this collection. Items []*types.Integration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetModelInput ¶
type GetModelInput struct { // The API identifier. // // This member is required. ApiId *string // The model ID. // // This member is required. ModelId *string }
type GetModelOutput ¶
type GetModelOutput struct { // The name of the model. Must be alphanumeric. Name *string // The description of the model. Description *string // The content-type for the model, for example, "application/json". ContentType *string // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. Schema *string // The model identifier. ModelId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetModelTemplateInput ¶
type GetModelTemplateInput struct { // The API identifier. // // This member is required. ApiId *string // The model ID. // // This member is required. ModelId *string }
type GetModelTemplateOutput ¶
type GetModelTemplateOutput struct { // The template value. Value *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetModelsInput ¶
type GetModelsInput struct { // The maximum number of elements to be returned for this resource. MaxResults *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The API identifier. // // This member is required. ApiId *string }
type GetModelsOutput ¶
type GetModelsOutput struct { // The elements from this collection. Items []*types.Model // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRouteInput ¶
type GetRouteInput struct { // The API identifier. // // This member is required. ApiId *string // The route ID. // // This member is required. RouteId *string }
type GetRouteOutput ¶
type GetRouteOutput struct { // Specifies whether a route is managed by API Gateway. If you created an API using // quick create, the $default route is managed by API Gateway. You can't modify the // $default route key. ApiGatewayManaged *bool // The request parameters for the route. Supported only for WebSocket APIs. RequestParameters map[string]*types.ParameterConstraints // A list of authorization scopes configured on a route. The scopes are used with a // JWT authorizer to authorize the method invocation. The authorization works by // matching the route scopes against the scopes parsed from the access token in the // incoming request. The method invocation is authorized if any route scope matches // a claimed scope in the access token. Otherwise, the invocation is not // authorized. When the route scope is configured, the client must provide an // access token instead of an identity token for authorization purposes. AuthorizationScopes []*string // The target for the route. Target *string // The request models for the route. Supported only for WebSocket APIs. RequestModels map[string]*string // The route ID. RouteId *string // The route response selection expression for the route. Supported only for // WebSocket APIs. RouteResponseSelectionExpression *string // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string // The route key for the route. RouteKey *string // The operation name for the route. OperationName *string // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired *bool // The model selection expression for the route. Supported only for WebSocket APIs. ModelSelectionExpression *string // The authorization type for the route. For WebSocket APIs, valid values are NONE // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT // for using JSON Web Tokens. AuthorizationType types.AuthorizationType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRouteResponseInput ¶
type GetRouteResponseInput struct { // The route response ID. // // This member is required. RouteResponseId *string // The route ID. // // This member is required. RouteId *string // The API identifier. // // This member is required. ApiId *string }
type GetRouteResponseOutput ¶
type GetRouteResponseOutput struct { // Represents the model selection expression of a route response. Supported only // for WebSocket APIs. ModelSelectionExpression *string // Represents the response models of a route response. ResponseModels map[string]*string // Represents the route response key of a route response. RouteResponseKey *string // Represents the identifier of a route response. RouteResponseId *string // Represents the response parameters of a route response. ResponseParameters map[string]*types.ParameterConstraints // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRouteResponsesInput ¶
type GetRouteResponsesInput struct { // The maximum number of elements to be returned for this resource. MaxResults *string // The route ID. // // This member is required. RouteId *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The API identifier. // // This member is required. ApiId *string }
type GetRouteResponsesOutput ¶
type GetRouteResponsesOutput struct { // The elements from this collection. Items []*types.RouteResponse // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetRoutesInput ¶
type GetRoutesInput struct { // The API identifier. // // This member is required. ApiId *string // The maximum number of elements to be returned for this resource. MaxResults *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string }
type GetRoutesOutput ¶
type GetRoutesOutput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The elements from this collection. Items []*types.Route // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetStageInput ¶
type GetStageInput struct { // The stage name. Stage names can only contain alphanumeric characters, hyphens, // and underscores. Maximum length is 128 characters. // // This member is required. StageName *string // The API identifier. // // This member is required. ApiId *string }
type GetStageOutput ¶
type GetStageOutput struct { // Specifies whether a stage is managed by API Gateway. If you created an API using // quick create, the $default stage is managed by API Gateway. You can't modify the // $default stage. ApiGatewayManaged *bool // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy *bool // The timestamp when the stage was last updated. LastUpdatedDate *time.Time // The description of the stage. Description *string // The timestamp when the stage was created. CreatedDate *time.Time // Default route settings for the stage. DefaultRouteSettings *types.RouteSettings // The identifier of the Deployment that the Stage is associated with. Can't be // updated if autoDeploy is enabled. DeploymentId *string // Describes the status of the last deployment of a stage. Supported only for // stages with autoDeploy enabled. LastDeploymentStatusMessage *string // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string // The identifier of a client certificate for a Stage. Supported only for WebSocket // APIs. ClientCertificateId *string // The name of the stage. StageName *string // A map that defines the stage variables for a stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string // Route settings for the stage, by routeKey. RouteSettings map[string]*types.RouteSettings // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetStagesInput ¶
type GetStagesInput struct { // The API identifier. // // This member is required. ApiId *string // The maximum number of elements to be returned for this resource. MaxResults *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string }
type GetStagesOutput ¶
type GetStagesOutput struct { // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // The elements from this collection. Items []*types.Stage // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetTagsInput ¶
type GetTagsInput struct { // The resource ARN for the tag. // // This member is required. ResourceArn *string }
type GetTagsOutput ¶
type GetTagsOutput struct { // Represents a collection of tags associated with the resource. Tags map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetVpcLinkInput ¶
type GetVpcLinkInput struct { // The ID of the VPC link. // // This member is required. VpcLinkId *string }
type GetVpcLinkOutput ¶
type GetVpcLinkOutput struct { // A list of security group IDs for the VPC link. SecurityGroupIds []*string // A list of subnet IDs to include in the VPC link. SubnetIds []*string // The name of the VPC link. Name *string // A message summarizing the cause of the status of the VPC link. VpcLinkStatusMessage *string // The ID of the VPC link. VpcLinkId *string // Tags for the VPC link. Tags map[string]*string // The status of the VPC link. VpcLinkStatus types.VpcLinkStatus // The timestamp when the VPC link was created. CreatedDate *time.Time // The version of the VPC link. VpcLinkVersion types.VpcLinkVersion // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetVpcLinksInput ¶
type GetVpcLinksInput struct { // The maximum number of elements to be returned for this resource. MaxResults *string // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string }
type GetVpcLinksOutput ¶
type GetVpcLinksOutput struct { // A collection of VPC links. Items []*types.VpcLink // The next page of elements from this collection. Not valid for the last element // of the collection. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ImportApiInput ¶
type ImportApiInput struct { // Specifies how to interpret the base path of the API during import. Valid values // are ignore, prepend, and split. The default value is ignore. To learn more, see // Set the OpenAPI basePath Property // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). // Supported only for HTTP APIs. Basepath *string // The OpenAPI definition. Supported only for HTTP APIs. // // This member is required. Body *string // Specifies whether to rollback the API creation when a warning is encountered. By // default, API creation continues if a warning is encountered. FailOnWarnings *bool }
type ImportApiOutput ¶
type ImportApiOutput struct { // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string // The name of the API. Name *string // A version identifier for the API. Version *string // The validation information during API import. This may include particular // properties of your OpenAPI definition which are ignored during import. Supported // only for HTTP APIs. ImportInfo []*string // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string // The timestamp when the API was created. CreatedDate *time.Time // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors // A collection of tags associated with the API. Tags map[string]*string // The API ID. ApiId *string // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The // stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string // The description of the API. Description *string // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not // provided, this will be the default for HTTP APIs. This property is required for // WebSocket APIs. RouteSelectionExpression *string // The API protocol. ProtocolType types.ProtocolType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // 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 retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type ReimportApiInput ¶
type ReimportApiInput struct { // The OpenAPI definition. Supported only for HTTP APIs. // // This member is required. Body *string // Specifies whether to rollback the API creation when a warning is encountered. By // default, API creation continues if a warning is encountered. FailOnWarnings *bool // Specifies how to interpret the base path of the API during import. Valid values // are ignore, prepend, and split. The default value is ignore. To learn more, see // Set the OpenAPI basePath Property // (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). // Supported only for HTTP APIs. Basepath *string // The API identifier. // // This member is required. ApiId *string }
type ReimportApiOutput ¶
type ReimportApiOutput struct { // The validation information during API import. This may include particular // properties of your OpenAPI definition which are ignored during import. Supported // only for HTTP APIs. ImportInfo []*string // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool // A collection of tags associated with the API. Tags map[string]*string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string // The API ID. ApiId *string // The description of the API. Description *string // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not // provided, this will be the default for HTTP APIs. This property is required for // WebSocket APIs. RouteSelectionExpression *string // The API protocol. ProtocolType types.ProtocolType // The timestamp when the API was created. CreatedDate *time.Time // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The // stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string // The name of the API. Name *string // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors // A version identifier for the API. Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type TagResourceInput ¶
type TagResourceInput struct { // The resource ARN for the tag. // // This member is required. ResourceArn *string // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string }
Creates a new Tag resource to represent a tag.
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Tag keys to delete // // This member is required. TagKeys []*string // The resource ARN for the tag. // // This member is required. ResourceArn *string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateApiInput ¶
type UpdateApiInput struct { // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors // This property is part of quick create. It specifies the credentials required for // the integration, if any. For a Lambda integration, three options are available. // To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource // Name (ARN). To require that the caller's identity be passed through from the // request, specify arn:aws:iam::*:user/*. To use resource-based permissions on // supported AWS services, specify null. Currently, this property is not used for // HTTP integrations. If provided, this value replaces the credentials associated // with the quick create integration. Supported only for HTTP APIs. CredentialsArn *string // A version identifier for the API. Version *string // The description of the API. Description *string // This property is part of quick create. If not specified, the route created using // quick create is kept. Otherwise, this value replaces the route key of the quick // create route. Additional routes may still be added after the API is updated. // Supported only for HTTP APIs. RouteKey *string // This property is part of quick create. For HTTP integrations, specify a fully // qualified URL. For Lambda integrations, specify a function ARN. The type of the // integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided // updates the integration URI and integration type. You can update a quick-created // target, but you can't remove it from an API. Supported only for HTTP APIs. Target *string // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not // provided, this will be the default for HTTP APIs. This property is required for // WebSocket APIs. RouteSelectionExpression *string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string // The name of the API. Name *string // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool // The API identifier. // // This member is required. ApiId *string }
Updates an Api.
type UpdateApiMappingInput ¶
type UpdateApiMappingInput struct { // The API identifier. // // This member is required. ApiId *string // The domain name. // // This member is required. DomainName *string // The API stage. Stage *string // The API mapping key. ApiMappingKey *string // The API mapping identifier. // // This member is required. ApiMappingId *string }
Updates an ApiMapping.
type UpdateApiMappingOutput ¶
type UpdateApiMappingOutput struct { // The API stage. Stage *string // The API identifier. ApiId *string // The API mapping key. ApiMappingKey *string // The API mapping identifier. ApiMappingId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateApiOutput ¶
type UpdateApiOutput struct { // The description of the API. Description *string // An API key selection expression. Supported only for WebSocket APIs. See API Key // Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). ApiKeySelectionExpression *string // The validation information during API import. This may include particular // properties of your OpenAPI definition which are ignored during import. Supported // only for HTTP APIs. ImportInfo []*string // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool // The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The // stage name is typically appended to this URI to form a complete path to a // deployed API stage. ApiEndpoint *string // The API protocol. ProtocolType types.ProtocolType // The route selection expression for the API. For HTTP APIs, the // routeSelectionExpression must be ${request.method} ${request.path}. If not // provided, this will be the default for HTTP APIs. This property is required for // WebSocket APIs. RouteSelectionExpression *string // A CORS configuration. Supported only for HTTP APIs. CorsConfiguration *types.Cors // The warning messages reported when failonwarnings is turned on during API // import. Warnings []*string // The name of the API. Name *string // The API ID. ApiId *string // A collection of tags associated with the API. Tags map[string]*string // The timestamp when the API was created. CreatedDate *time.Time // A version identifier for the API. Version *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAuthorizerInput ¶
type UpdateAuthorizerInput struct { // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source // can be headers, query string parameters, stage variables, and context // parameters. For example, if an Auth header and a Name query string parameter are // defined as identity sources, this value is route.request.header.Auth, // route.request.querystring.Name. These parameters will be used to perform runtime // validation for Lambda-based authorizers by verifying all of the identity-related // request parameters are present in the request, not null, and non-empty. Only // when this is true does the authorizer invoke the authorizer Lambda function. // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For JWT, a single entry that specifies where to extract the JSON Web // Token (JWT) from inbound requests. Currently only header-based and query // parameter-based selections are supported, for example // "$request.header.Authorization". IdentitySource []*string // The name of the authorizer. Name *string // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web // Tokens. AuthorizerType types.AuthorizerType // The API identifier. // // This member is required. ApiId *string // This parameter is not used. IdentityValidationExpression *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda // function, specify null. AuthorizerCredentialsArn *string // The authorizer identifier. // // This member is required. AuthorizerId *string // Authorizer caching is not currently supported. Don't specify this value for // authorizers. AuthorizerResultTtlInSeconds *int32 // The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, // this must be a well-formed Lambda function URI, for example, // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form: // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, // including the initial /. For Lambda functions, this is usually of the form // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST // authorizers. AuthorizerUri *string }
Updates an Authorizer.
type UpdateAuthorizerOutput ¶
type UpdateAuthorizerOutput struct { // The identity source for which authorization is requested. For a REQUEST // authorizer, this is optional. The value is a set of one or more mapping // expressions of the specified request parameters. Currently, the identity source // can be headers, query string parameters, stage variables, and context // parameters. For example, if an Auth header and a Name query string parameter are // defined as identity sources, this value is route.request.header.Auth, // route.request.querystring.Name. These parameters will be used to perform runtime // validation for Lambda-based authorizers by verifying all of the identity-related // request parameters are present in the request, not null, and non-empty. Only // when this is true does the authorizer invoke the authorizer Lambda function. // Otherwise, it returns a 401 Unauthorized response without calling the Lambda // function. For JWT, a single entry that specifies where to extract the JSON Web // Token (JWT) from inbound requests. Currently only header-based and query // parameter-based selections are supported, for example // "$request.header.Authorization". IdentitySource []*string // The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this // must be a well-formed Lambda function URI, for example, // arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. // In general, the URI has this form: // arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the // same as the region hosting the Lambda function, path indicates that the // remaining substring in the URI should be treated as the path to the resource, // including the initial /. For Lambda functions, this is usually of the form // /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST // authorizers. AuthorizerUri *string // The name of the authorizer. Name *string // The validation expression does not apply to the REQUEST authorizer. IdentityValidationExpression *string // Specifies the required credentials as an IAM role for API Gateway to invoke the // authorizer. To specify an IAM role for API Gateway to assume, use the role's // Amazon Resource Name (ARN). To use resource-based permissions on the Lambda // function, specify null. Supported only for REQUEST authorizers. AuthorizerCredentialsArn *string // Authorizer caching is not currently supported. Don't specify this value for // authorizers. AuthorizerResultTtlInSeconds *int32 // The authorizer identifier. AuthorizerId *string // Represents the configuration of a JWT authorizer. Required for the JWT // authorizer type. Supported only for HTTP APIs. JwtConfiguration *types.JWTConfiguration // The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function // using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web // Tokens. AuthorizerType types.AuthorizerType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDeploymentInput ¶
type UpdateDeploymentInput struct { // The deployment ID. // // This member is required. DeploymentId *string // The API identifier. // // This member is required. ApiId *string // The description for the deployment resource. Description *string }
Updates a Deployment.
type UpdateDeploymentOutput ¶
type UpdateDeploymentOutput struct { // The identifier for the deployment. DeploymentId *string // The description for the deployment. Description *string // The status of the deployment: PENDING, FAILED, or SUCCEEDED. DeploymentStatus types.DeploymentStatus // Specifies whether a deployment was automatically released. AutoDeployed *bool // The date and time when the Deployment resource was created. CreatedDate *time.Time // May contain additional feedback on the status of an API deployment. DeploymentStatusMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDomainNameInput ¶
type UpdateDomainNameInput struct { // The domain name configurations. DomainNameConfigurations []*types.DomainNameConfiguration // The domain name. // // This member is required. DomainName *string }
Updates a DomainName.
type UpdateDomainNameOutput ¶
type UpdateDomainNameOutput struct { // The domain name configurations. DomainNameConfigurations []*types.DomainNameConfiguration // The collection of tags associated with a domain name. Tags map[string]*string // The API mapping selection expression. ApiMappingSelectionExpression *string // The name of the DomainName resource. DomainName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateIntegrationInput ¶
type UpdateIntegrationInput struct { // Specifies the format of the payload sent to an integration. Required for HTTP // APIs. PayloadFormatVersion *string // The TLS configuration for a private integration. If you specify a TLS // configuration, private integration traffic uses the HTTPS protocol. Supported // only for HTTP APIs. TlsConfig *types.TlsConfigInput // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for // WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis *int32 // The description of the integration Description *string // The API identifier. // // This member is required. ApiId *string // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including // the Lambda function-invoking action. With the Lambda function-invoking action, // this is referred to as the Lambda custom integration. With any other AWS service // action, this is known as AWS integration. Supported only for WebSocket APIs. // AWS_PROXY: for integrating the route or method request with the Lambda // function-invoking action with the client request passed through as-is. This // integration is also referred to as Lambda proxy integration. HTTP: for // integrating the route or method request with an HTTP endpoint. This integration // is also referred to as the HTTP custom integration. Supported only for WebSocket // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP // endpoint, with the client request passed through as-is. This is also referred to // as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY // integration. MOCK: for integrating the route or method request with API Gateway // as a "loopback" endpoint without invoking any backend. Supported only for // WebSocket APIs. IntegrationType types.IntegrationType // Specifies the credentials required for the integration, if any. For AWS // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS // services, specify null. CredentialsArn *string // The integration ID. // // This member is required. IntegrationId *string // The type of the network connection to the integration endpoint. Specify INTERNET // for connections through the public routable internet or VPC_LINK for private // connections between API Gateway and resources in a VPC. The default value is // INTERNET. ConnectionType types.ConnectionType // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // The template selection expression for the integration. TemplateSelectionExpression *string // A key-value map specifying request parameters that are passed from the method // request to the backend. The key is an integration request parameter name and the // associated value is a method request parameter value or static value that must // be enclosed within single quotes and pre-encoded as required by the backend. The // method request parameter value must match the pattern of // method.request.{location}.{name} , where {location} is querystring, path, or // header; and {name} must be a valid and unique method request parameter name. // Supported only for WebSocket APIs. RequestParameters map[string]*string // For a Lambda integration, specify the URI of a Lambda function. For an HTTP // integration, specify a fully-qualified URL. For an HTTP API private integration, // specify the ARN of an Application Load Balancer listener, Network Load Balancer // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see // DiscoverInstances // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). // For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // Specifies the integration's HTTP method type. IntegrationMethod *string // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped // content types through to the integration backend without transformation. NEVER // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media // Type response. PassthroughBehavior types.PassthroughBehavior // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the value. // Supported only for WebSocket APIs. RequestTemplates map[string]*string // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string }
Updates an Integration.
type UpdateIntegrationOutput ¶
type UpdateIntegrationOutput struct { // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // Specifies whether an integration is managed by API Gateway. If you created an // API using using quick create, the resulting integration is managed by API // Gateway. You can update a managed integration, but you can't delete it. ApiGatewayManaged *bool // Specifies the credentials required for the integration, if any. For AWS // integrations, three options are available. To specify an IAM Role for API // Gateway to assume, use the role's Amazon Resource Name (ARN). To require that // the caller's identity be passed through from the request, specify the string // arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS // services, specify null. CredentialsArn *string // The integration response selection expression for the integration. Supported // only for WebSocket APIs. See Integration Response Selection Expressions // (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions). IntegrationResponseSelectionExpression *string // Represents the description of an integration. Description *string // Represents a map of Velocity templates that are applied on the request payload // based on the value of the Content-Type header sent by the client. The content // type value is the key in this map, and the template (as a String) is the value. // Supported only for WebSocket APIs. RequestTemplates map[string]*string // The integration type of an integration. One of the following: AWS: for // integrating the route or method request with an AWS service action, including // the Lambda function-invoking action. With the Lambda function-invoking action, // this is referred to as the Lambda custom integration. With any other AWS service // action, this is known as AWS integration. Supported only for WebSocket APIs. // AWS_PROXY: for integrating the route or method request with the Lambda // function-invoking action with the client request passed through as-is. This // integration is also referred to as Lambda proxy integration. HTTP: for // integrating the route or method request with an HTTP endpoint. This integration // is also referred to as the HTTP custom integration. Supported only for WebSocket // APIs. HTTP_PROXY: for integrating the route or method request with an HTTP // endpoint, with the client request passed through as-is. This is also referred to // as HTTP proxy integration. MOCK: for integrating the route or method request // with API Gateway as a "loopback" endpoint without invoking any backend. // Supported only for WebSocket APIs. IntegrationType types.IntegrationType // For a Lambda integration, specify the URI of a Lambda function. For an HTTP // integration, specify a fully-qualified URL. For an HTTP API private integration, // specify the ARN of an Application Load Balancer listener, Network Load Balancer // listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map // service, API Gateway uses DiscoverInstances to identify resources. You can use // query parameters to target specific resources. To learn more, see // DiscoverInstances // (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html). // For private integrations, all resources must be owned by the same AWS account. IntegrationUri *string // The ID of the VPC link for a private integration. Supported only for HTTP APIs. ConnectionId *string // The TLS configuration for a private integration. If you specify a TLS // configuration, private integration traffic uses the HTTPS protocol. Supported // only for HTTP APIs. TlsConfig *types.TlsConfig // Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between // 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for // WebSocket APIs and 30 seconds for HTTP APIs. TimeoutInMillis *int32 // Specifies the format of the payload sent to an integration. Required for HTTP // APIs. PayloadFormatVersion *string // Specifies the pass-through behavior for incoming requests based on the // Content-Type header in the request, and the available mapping templates // specified as the requestTemplates property on the Integration resource. There // are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported // only for WebSocket APIs. WHEN_NO_MATCH passes the request body for unmapped // content types through to the integration backend without transformation. NEVER // rejects unmapped content types with an HTTP 415 Unsupported Media Type response. // WHEN_NO_TEMPLATES allows pass-through when the integration has no content types // mapped to templates. However, if there is at least one content type defined, // unmapped content types will be rejected with the same HTTP 415 Unsupported Media // Type response. PassthroughBehavior types.PassthroughBehavior // Specifies the integration's HTTP method type. IntegrationMethod *string // The type of the network connection to the integration endpoint. Specify INTERNET // for connections through the public routable internet or VPC_LINK for private // connections between API Gateway and resources in a VPC. The default value is // INTERNET. ConnectionType types.ConnectionType // The template selection expression for the integration. Supported only for // WebSocket APIs. TemplateSelectionExpression *string // Represents the identifier of an integration. IntegrationId *string // A key-value map specifying request parameters that are passed from the method // request to the backend. The key is an integration request parameter name and the // associated value is a method request parameter value or static value that must // be enclosed within single quotes and pre-encoded as required by the backend. The // method request parameter value must match the pattern of // method.request.{location}.{name} , where {location} is querystring, path, or // header; and {name} must be a valid and unique method request parameter name. // Supported only for WebSocket APIs. RequestParameters map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateIntegrationResponseInput ¶
type UpdateIntegrationResponseInput struct { // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of // method.response.header.{name} , where name is a valid and unique header name. // The mapped non-static value must match the pattern of // integration.response.header.{name} or // integration.response.body.{JSON-expression} , where {name} is a valid and unique // response header name and {JSON-expression} is a valid JSON expression without // the $ prefix. ResponseParameters map[string]*string // The collection of response templates for the integration response as a // string-to-string map of key-value pairs. Response templates are represented as a // key/value map, with a content-type as the key and a template as the value. ResponseTemplates map[string]*string // The template selection expression for the integration response. Supported only // for WebSocket APIs. TemplateSelectionExpression *string // The API identifier. // // This member is required. ApiId *string // The integration response ID. // // This member is required. IntegrationResponseId *string // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // The integration ID. // // This member is required. IntegrationId *string // The integration response key. IntegrationResponseKey *string }
Updates an IntegrationResponses.
type UpdateIntegrationResponseOutput ¶
type UpdateIntegrationResponseOutput struct { // The template selection expressions for the integration response. TemplateSelectionExpression *string // A key-value map specifying response parameters that are passed to the method // response from the backend. The key is a method response header parameter name // and the mapped value is an integration response header value, a static value // enclosed within a pair of single quotes, or a JSON expression from the // integration response body. The mapping key must match the pattern of // method.response.header.{name}, where name is a valid and unique header name. The // mapped non-static value must match the pattern of // integration.response.header.{name} or // integration.response.body.{JSON-expression}, where name is a valid and unique // response header name and JSON-expression is a valid JSON expression without the // $ prefix. ResponseParameters map[string]*string // The integration response key. IntegrationResponseKey *string // The collection of response templates for the integration response as a // string-to-string map of key-value pairs. Response templates are represented as a // key/value map, with a content-type as the key and a template as the value. ResponseTemplates map[string]*string // The integration response ID. IntegrationResponseId *string // Supported only for WebSocket APIs. Specifies how to handle response payload // content type conversions. Supported values are CONVERT_TO_BINARY and // CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a // response payload from a Base64-encoded string to the corresponding binary blob. // CONVERT_TO_TEXT: Converts a response payload from a binary blob to a // Base64-encoded string. If this property is not defined, the response payload // will be passed through from the integration response to the route response or // method response without modification. ContentHandlingStrategy types.ContentHandlingStrategy // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateModelInput ¶
type UpdateModelInput struct { // The API identifier. // // This member is required. ApiId *string // The model ID. // // This member is required. ModelId *string // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. Schema *string // The name of the model. Name *string // The content-type for the model, for example, "application/json". ContentType *string // The description of the model. Description *string }
Updates a Model.
type UpdateModelOutput ¶
type UpdateModelOutput struct { // The schema for the model. For application/json models, this should be JSON // schema draft 4 model. Schema *string // The description of the model. Description *string // The content-type for the model, for example, "application/json". ContentType *string // The name of the model. Must be alphanumeric. Name *string // The model identifier. ModelId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateRouteInput ¶
type UpdateRouteInput struct { // The request models for the route. Supported only for WebSocket APIs. RequestModels map[string]*string // The request parameters for the route. Supported only for WebSocket APIs. RequestParameters map[string]*types.ParameterConstraints // The authorization type for the route. For WebSocket APIs, valid values are NONE // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT // for using JSON Web Tokens. AuthorizationType types.AuthorizationType // The route ID. // // This member is required. RouteId *string // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string // The API identifier. // // This member is required. ApiId *string // The route response selection expression for the route. Supported only for // WebSocket APIs. RouteResponseSelectionExpression *string // The target for the route. Target *string // The model selection expression for the route. Supported only for WebSocket APIs. ModelSelectionExpression *string // The authorization scopes supported by this route. AuthorizationScopes []*string // Specifies whether an API key is required for the route. Supported only for // WebSocket APIs. ApiKeyRequired *bool // The route key for the route. RouteKey *string // The operation name for the route. OperationName *string }
Updates a Route.
type UpdateRouteOutput ¶
type UpdateRouteOutput struct { // The authorization type for the route. For WebSocket APIs, valid values are NONE // for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a // Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT // for using JSON Web Tokens. AuthorizationType types.AuthorizationType // Specifies whether an API key is required for this route. Supported only for // WebSocket APIs. ApiKeyRequired *bool // The request parameters for the route. Supported only for WebSocket APIs. RequestParameters map[string]*types.ParameterConstraints // The request models for the route. Supported only for WebSocket APIs. RequestModels map[string]*string // The target for the route. Target *string // The identifier of the Authorizer resource to be associated with this route. The // authorizer identifier is generated by API Gateway when you created the // authorizer. AuthorizerId *string // The route ID. RouteId *string // The route response selection expression for the route. Supported only for // WebSocket APIs. RouteResponseSelectionExpression *string // The model selection expression for the route. Supported only for WebSocket APIs. ModelSelectionExpression *string // The operation name for the route. OperationName *string // The route key for the route. RouteKey *string // Specifies whether a route is managed by API Gateway. If you created an API using // quick create, the $default route is managed by API Gateway. You can't modify the // $default route key. ApiGatewayManaged *bool // A list of authorization scopes configured on a route. The scopes are used with a // JWT authorizer to authorize the method invocation. The authorization works by // matching the route scopes against the scopes parsed from the access token in the // incoming request. The method invocation is authorized if any route scope matches // a claimed scope in the access token. Otherwise, the invocation is not // authorized. When the route scope is configured, the client must provide an // access token instead of an identity token for authorization purposes. AuthorizationScopes []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateRouteResponseInput ¶
type UpdateRouteResponseInput struct { // The model selection expression for the route response. Supported only for // WebSocket APIs. ModelSelectionExpression *string // The route response key. RouteResponseKey *string // The route ID. // // This member is required. RouteId *string // The API identifier. // // This member is required. ApiId *string // The response models for the route response. ResponseModels map[string]*string // The route response parameters. ResponseParameters map[string]*types.ParameterConstraints // The route response ID. // // This member is required. RouteResponseId *string }
Updates a RouteResponse.
type UpdateRouteResponseOutput ¶
type UpdateRouteResponseOutput struct { // Represents the response models of a route response. ResponseModels map[string]*string // Represents the model selection expression of a route response. Supported only // for WebSocket APIs. ModelSelectionExpression *string // Represents the response parameters of a route response. ResponseParameters map[string]*types.ParameterConstraints // Represents the route response key of a route response. RouteResponseKey *string // Represents the identifier of a route response. RouteResponseId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateStageInput ¶
type UpdateStageInput struct { // The identifier of a client certificate for a Stage. ClientCertificateId *string // Route settings for the stage. RouteSettings map[string]*types.RouteSettings // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy *bool // The description for the API stage. Description *string // A map that defines the stage variables for a Stage. Variable names can have // alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string // The stage name. Stage names can only contain alphanumeric characters, hyphens, // and underscores. Maximum length is 128 characters. // // This member is required. StageName *string // The default route settings for the stage. DefaultRouteSettings *types.RouteSettings // The deployment identifier for the API stage. Can't be updated if autoDeploy is // enabled. DeploymentId *string // The API identifier. // // This member is required. ApiId *string }
Updates a Stage.
type UpdateStageOutput ¶
type UpdateStageOutput struct { // Specifies whether a stage is managed by API Gateway. If you created an API using // quick create, the $default stage is managed by API Gateway. You can't modify the // $default stage. ApiGatewayManaged *bool // Route settings for the stage, by routeKey. RouteSettings map[string]*types.RouteSettings // Specifies whether updates to an API automatically trigger a new deployment. The // default value is false. AutoDeploy *bool // The identifier of the Deployment that the Stage is associated with. Can't be // updated if autoDeploy is enabled. DeploymentId *string // The timestamp when the stage was created. CreatedDate *time.Time // The timestamp when the stage was last updated. LastUpdatedDate *time.Time // Settings for logging access in this stage. AccessLogSettings *types.AccessLogSettings // Describes the status of the last deployment of a stage. Supported only for // stages with autoDeploy enabled. LastDeploymentStatusMessage *string // The collection of tags. Each tag element is associated with a given resource. Tags map[string]*string // Default route settings for the stage. DefaultRouteSettings *types.RouteSettings // The identifier of a client certificate for a Stage. Supported only for WebSocket // APIs. ClientCertificateId *string // The description of the stage. Description *string // A map that defines the stage variables for a stage resource. Variable names can // have alphanumeric and underscore characters, and the values must match // [A-Za-z0-9-._~:/?#&=,]+. StageVariables map[string]*string // The name of the stage. StageName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateVpcLinkInput ¶
type UpdateVpcLinkInput struct { // The ID of the VPC link. // // This member is required. VpcLinkId *string // The name of the VPC link. Name *string }
Updates a VPC link.
type UpdateVpcLinkOutput ¶
type UpdateVpcLinkOutput struct { // The name of the VPC link. Name *string // The version of the VPC link. VpcLinkVersion types.VpcLinkVersion // A message summarizing the cause of the status of the VPC link. VpcLinkStatusMessage *string // The timestamp when the VPC link was created. CreatedDate *time.Time // A list of security group IDs for the VPC link. SecurityGroupIds []*string // The status of the VPC link. VpcLinkStatus types.VpcLinkStatus // Tags for the VPC link. Tags map[string]*string // The ID of the VPC link. VpcLinkId *string // A list of subnet IDs to include in the VPC link. SubnetIds []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CreateApi.go api_op_CreateApiMapping.go api_op_CreateAuthorizer.go api_op_CreateDeployment.go api_op_CreateDomainName.go api_op_CreateIntegration.go api_op_CreateIntegrationResponse.go api_op_CreateModel.go api_op_CreateRoute.go api_op_CreateRouteResponse.go api_op_CreateStage.go api_op_CreateVpcLink.go api_op_DeleteAccessLogSettings.go api_op_DeleteApi.go api_op_DeleteApiMapping.go api_op_DeleteAuthorizer.go api_op_DeleteCorsConfiguration.go api_op_DeleteDeployment.go api_op_DeleteDomainName.go api_op_DeleteIntegration.go api_op_DeleteIntegrationResponse.go api_op_DeleteModel.go api_op_DeleteRoute.go api_op_DeleteRouteRequestParameter.go api_op_DeleteRouteResponse.go api_op_DeleteRouteSettings.go api_op_DeleteStage.go api_op_DeleteVpcLink.go api_op_ExportApi.go api_op_GetApi.go api_op_GetApiMapping.go api_op_GetApiMappings.go api_op_GetApis.go api_op_GetAuthorizer.go api_op_GetAuthorizers.go api_op_GetDeployment.go api_op_GetDeployments.go api_op_GetDomainName.go api_op_GetDomainNames.go api_op_GetIntegration.go api_op_GetIntegrationResponse.go api_op_GetIntegrationResponses.go api_op_GetIntegrations.go api_op_GetModel.go api_op_GetModelTemplate.go api_op_GetModels.go api_op_GetRoute.go api_op_GetRouteResponse.go api_op_GetRouteResponses.go api_op_GetRoutes.go api_op_GetStage.go api_op_GetStages.go api_op_GetTags.go api_op_GetVpcLink.go api_op_GetVpcLinks.go api_op_ImportApi.go api_op_ReimportApi.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateApi.go api_op_UpdateApiMapping.go api_op_UpdateAuthorizer.go api_op_UpdateDeployment.go api_op_UpdateDomainName.go api_op_UpdateIntegration.go api_op_UpdateIntegrationResponse.go api_op_UpdateModel.go api_op_UpdateRoute.go api_op_UpdateRouteResponse.go api_op_UpdateStage.go api_op_UpdateVpcLink.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.26.0
- Published
- Oct 1, 2020
- Platform
- js/wasm
- Imports
- 27 packages
- Last checked
- now –
Tools for package owners.