apigateway

package

Go to main page

Versions in this module

v1

v1.3.0

Aug 3, 2026

v1.2.0

Aug 3, 2026

Changes in this version

type APIKey

+ StageKeys []string

type CreateAPIKeyInput

+ StageKeys []StageKeyInput

type CreateRestAPIInput

+ DisableExecuteAPIEndpoint bool

+ EndpointAccessMode string

type CreateStageInput

+ DocumentationVersion string

type MethodSetting

+ CacheDataEncrypted bool

+ UnauthorizedCacheControlHeaderStrategy string

type RestAPI

+ APIStatus string

+ APIStatusMessage string

+ DisableExecuteAPIEndpoint bool

+ EndpointAccessMode string

type Stage

+ DocumentationVersion string

+ type StageKeyInput struct

+ RestAPIID string

+ StageName string

type UpdateAPIKeyInput

+ StageKeys []string

type UpdateRestAPIInput

+ DisableExecuteAPIEndpoint *bool

+ EndpointAccessMode string

type UpdateStageInput

+ DocumentationVersion string

v1.1.4

Jul 20, 2026

v1.1.3

Jul 20, 2026

v1.1.2

Jul 20, 2026

v1.1.1

Jul 20, 2026

v1.1.0

Jul 19, 2026

Changes in this version

+ const AuthTypeAWSIAM

+ const AuthTypeCognitoUserPool

+ const AuthTypeCustom

+ const AuthTypeNone

+ const IntegrationTypeAWS

+ const IntegrationTypeAWSProxy

+ const IntegrationTypeHTTP

+ const IntegrationTypeHTTPProxy

+ const IntegrationTypeMock

+ var ErrAPIKeyNotFound = errors.New("NotFoundException")

+ var ErrAlreadyExists = awserr.New("ConflictException", awserr.ErrAlreadyExists)

+ var ErrAuthorizerNotFound = errors.New("NotFoundException")

+ var ErrBasePathMappingNotFound = errors.New("NotFoundException")

+ var ErrDeploymentNotFound = errors.New("NotFoundException")

+ var ErrDocumentationPartNotFound = errors.New("NotFoundException")

+ var ErrDocumentationVersionNotFound = errors.New("NotFoundException")

+ var ErrDomainNameAccessAssociationNotFound = errors.New("NotFoundException")

+ var ErrDomainNameNotFound = errors.New("NotFoundException")

+ var ErrIntegrationResponseNotFound = errors.New("NotFoundException")

+ var ErrInvalidParameter = errors.New("BadRequestException")

+ var ErrMethodNotFound = errors.New("NotFoundException")

+ var ErrMethodResponseNotFound = errors.New("NotFoundException")

+ var ErrModelNotFound = errors.New("NotFoundException")

+ var ErrNotFound = errors.New("NotFoundException")

+ var ErrQuotaExceeded = errors.New("LimitExceededException")

+ var ErrResourceNotFound = errors.New("NotFoundException")

+ var ErrRestAPINotFound = errors.New("NotFoundException")

+ var ErrStageNotFound = errors.New("NotFoundException")

+ var ErrThrottled = errors.New("TooManyRequestsException")

+ var ErrUsagePlanKeyNotFound = errors.New("NotFoundException")

+ var ErrUsagePlanNotFound = errors.New("NotFoundException")

+ var ErrValidatorNotFound = errors.New("NotFoundException")

+ func ExtractLambdaFunctionName(uri string) string

+ func RenderTemplate(tmpl string, ctx VTLContext) string

+ type APIKey struct

+ CreatedDate unixEpochTime

+ CustomerID string

+ Description string

+ Enabled bool

+ ID string

+ LastUpdatedDate unixEpochTime

+ Name string

+ Tags *tags.Tags

+ Value string

+ type APIStageAssociation struct

+ RestAPIID string

+ Stage string

+ Throttle map[string]*ThrottleSettings

+ type AccessLogSettings struct

+ DestinationARN string

+ Format string

+ type Account struct

+ APIKeyVersion string

+ CloudwatchRoleARN string

+ Features []string

+ ThrottleSettings *ThrottleSettings

+ type Authorizer struct

+ AuthorizerCredentials string

+ AuthorizerResultTTLInSeconds int

+ AuthorizerURI string

+ ID string

+ IdentitySource string

+ IdentityValidationExpression string

+ Name string

+ ProviderARNs []string

+ RestAPIID string

+ Type string

+ type AuthorizerEvent struct

+ AuthorizationToken string

+ HTTPMethod string

+ Headers map[string]string

+ MethodArn string

+ Path string

+ QueryStringParameters map[string]string

+ RequestContext LambdaProxyContext

+ Resource string

+ StageVariables map[string]string

+ Type string

+ type AuthorizerResponse struct

+ Context map[string]any

+ PolicyDocument *PolicyDocument

+ PrincipalID string

+ type BasePathMapping struct

+ BasePath string

+ DomainName string

+ RestAPIID string

+ Stage string

+ type CanarySettings struct

+ DeploymentID string

+ PercentTraffic float64

+ StageVariableOverrides map[string]string

+ UseStageCache bool

+ type ClientCertificate struct

+ ClientCertificateID string

+ CreatedDate unixEpochTime

+ Description string

+ ExpirationDate unixEpochTime

+ PemEncodedCertificate string

+ type CorsConfiguration struct

+ AllowHeaders []string

+ AllowMethods []string

+ AllowOrigins []string

+ ExposeHeaders []string

+ MaxAge int

+ type CreateAPIKeyInput struct

+ CustomerID string

+ Description string

+ Enabled bool

+ Name string

+ Tags *tags.Tags

+ Value string

+ type CreateAuthorizerInput struct

+ AuthorizerCredentials string

+ AuthorizerResultTTLInSeconds int

+ AuthorizerURI string

+ IdentitySource string

+ IdentityValidationExpression string

+ Name string

+ ProviderARNs []string

+ Type string

+ type CreateBasePathMappingInput struct

+ BasePath string

+ DomainName string

+ RestAPIID string

+ Stage string

+ type CreateDocumentationPartInput struct

+ Location DocumentationLocation

+ Properties string

+ RestAPIID string

+ type CreateDocumentationVersionInput struct

+ Description string

+ RestAPIID string

+ Version string

+ type CreateDomainNameAccessAssociationInput struct

+ AccessAssociationSource string

+ AccessAssociationSourceType string

+ DomainNameARN string

+ type CreateDomainNameInput struct

+ CertificateARN string

+ DomainName string

+ EndpointConfiguration *EndpointConfiguration

+ RegionalCertificateARN string

+ SecurityPolicy string

+ Tags *tags.Tags

+ type CreateModelInput struct

+ ContentType string

+ Description string

+ Name string

+ RestAPIID string

+ Schema string

+ type CreateRequestValidatorInput struct

+ Name string

+ ValidateRequestBody bool

+ ValidateRequestParameters bool

+ type CreateRestAPIInput struct

+ APIKeySource string

+ BinaryMediaTypes []string

+ Description string

+ EndpointConfiguration *EndpointConfiguration

+ MinimumCompressionSize int

+ Name string

+ Policy string

+ Tags *tags.Tags

+ type CreateStageInput struct

+ AccessLogSettings *AccessLogSettings

+ CacheClusterEnabled bool

+ CacheClusterSize string

+ CanarySettings *CanarySettings

+ ClientCertificateID string

+ DeploymentID string

+ Description string

+ MethodSettings map[string]MethodSetting

+ RestAPIID string

+ StageName string

+ TracingEnabled bool

+ Variables map[string]string

+ type CreateUsagePlanInput struct

+ APIStages []APIStageAssociation

+ Description string

+ Name string

+ Quota *QuotaSettings

+ Tags *tags.Tags

+ Throttle *ThrottleSettings

+ type CreateUsagePlanKeyInput struct

+ KeyID string

+ KeyType string

+ UsagePlanID string

+ type CreateVpcLinkInput struct

+ Description string

+ Name string

+ Tags map[string]string

+ TargetARNs []string

+ type Deployment struct

+ CreatedDate unixEpochTime

+ Description string

+ ID string

+ RestAPIID string

+ type DocumentationLocation struct

+ Method string

+ Name string

+ Path string

+ StatusCode string

+ Type string

+ type DocumentationPart struct

+ ID string

+ Location DocumentationLocation

+ Properties string

+ RestAPIID string

+ type DocumentationVersion struct

+ CreatedDate unixEpochTime

+ Description string

+ RestAPIID string

+ Version string

+ type DomainName struct

+ CertificateARN string

+ CreatedDate *unixEpochTime

+ DistributionDomainName string

+ DistributionHostedZoneID string

+ DomainNameStatus string

+ DomainNameValue string

+ EndpointConfiguration *EndpointConfiguration

+ RegionalCertificateARN string

+ RegionalDomainName string

+ RegionalHostedZoneID string

+ SecurityPolicy string

+ Tags *tags.Tags

+ type DomainNameAccessAssociation struct

+ AccessAssociationSource string

+ AccessAssociationSourceType string

+ DomainNameARN string

+ DomainNameAccessAssociationARN string

+ type EndpointConfiguration struct

+ Types []string

+ VpcEndpointIDs []string

+ type ErrorResponse struct

+ Message string

+ Type string

+ type GatewayResponse struct

+ DefaultResponse bool

+ ResponseParameters map[string]string

+ ResponseTemplates map[string]string

+ ResponseType string

+ RestAPIID string

+ StatusCode string

+ type GenerateClientCertificateInput struct

+ Description string

+ Tags map[string]string

+ type GetUsageInput struct

+ EndDate string

+ Limit int

+ Position string

+ StartDate string

+ UsagePlanID string

+ type Handler struct

+ Backend StorageBackend

+ func NewHandler(backend StorageBackend) *Handler

+ func (h *Handler) ChaosOperations() []string

+ func (h *Handler) ChaosRegions() []string

+ func (h *Handler) ChaosServiceName() string

+ func (h *Handler) ExtractOperation(c *echo.Context) string

+ func (h *Handler) ExtractResource(c *echo.Context) string

+ func (h *Handler) GetSupportedOperations() []string

+ func (h *Handler) Handler() echo.HandlerFunc

+ func (h *Handler) MatchPriority() int

+ func (h *Handler) Name() string

+ func (h *Handler) Reset()

+ func (h *Handler) Restore(ctx context.Context, data []byte) error

+ func (h *Handler) RouteMatcher() service.Matcher

+ func (h *Handler) SetHTTPClient(c *http.Client)

+ func (h *Handler) SetJWKSProvider(p JWKSProvider)

+ func (h *Handler) SetLambdaInvoker(lambda LambdaInvoker)

+ func (h *Handler) Snapshot(ctx context.Context) []byte

+ type ImportRestAPIInput struct

+ Body []byte

+ FailOnWarnings bool

+ type InMemoryBackend struct

+ func NewInMemoryBackend() *InMemoryBackend

+ func (b *InMemoryBackend) CreateAPIKey(input CreateAPIKeyInput) (*APIKey, error)

+ func (b *InMemoryBackend) CreateAuthorizer(restAPIID string, input CreateAuthorizerInput) (*Authorizer, error)

+ func (b *InMemoryBackend) CreateBasePathMapping(input CreateBasePathMappingInput) (*BasePathMapping, error)

+ func (b *InMemoryBackend) CreateDeployment(restAPIID, stageName, description string) (*Deployment, error)

+ func (b *InMemoryBackend) CreateDocumentationPart(input CreateDocumentationPartInput) (*DocumentationPart, error)

+ func (b *InMemoryBackend) CreateDocumentationVersion(input CreateDocumentationVersionInput) (*DocumentationVersion, error)

+ func (b *InMemoryBackend) CreateDomainName(input CreateDomainNameInput) (*DomainName, error)

+ func (b *InMemoryBackend) CreateDomainNameAccessAssociation(input CreateDomainNameAccessAssociationInput) (*DomainNameAccessAssociation, error)

+ func (b *InMemoryBackend) CreateModel(input CreateModelInput) (*Model, error)

+ func (b *InMemoryBackend) CreateRequestValidator(restAPIID string, input CreateRequestValidatorInput) (*RequestValidator, error)

+ func (b *InMemoryBackend) CreateResource(restAPIID, parentID, pathPart string) (*Resource, error)

+ func (b *InMemoryBackend) CreateRestAPI(input CreateRestAPIInput) (*RestAPI, error)

+ func (b *InMemoryBackend) CreateStage(input CreateStageInput) (*Stage, error)

+ func (b *InMemoryBackend) CreateUsagePlan(input CreateUsagePlanInput) (*UsagePlan, error)

+ func (b *InMemoryBackend) CreateUsagePlanKey(input CreateUsagePlanKeyInput) (*UsagePlanKey, error)

+ func (b *InMemoryBackend) CreateVpcLink(input CreateVpcLinkInput) (*VpcLink, error)

+ func (b *InMemoryBackend) DeleteAPIKey(id string) error

+ func (b *InMemoryBackend) DeleteAuthorizer(restAPIID, authorizerID string) error

+ func (b *InMemoryBackend) DeleteBasePathMapping(domainName, basePath string) error

+ func (b *InMemoryBackend) DeleteClientCertificate(id string) error

+ func (b *InMemoryBackend) DeleteDeployment(restAPIID, deploymentID string) error

+ func (b *InMemoryBackend) DeleteDocumentationPart(restAPIID, docPartID string) error

+ func (b *InMemoryBackend) DeleteDocumentationVersion(restAPIID, version string) error

+ func (b *InMemoryBackend) DeleteDomainName(name string) error

+ func (b *InMemoryBackend) DeleteDomainNameAccessAssociation(arn string) error

+ func (b *InMemoryBackend) DeleteGatewayResponse(restAPIID, responseType string) error

+ func (b *InMemoryBackend) DeleteIntegration(restAPIID, resourceID, httpMethod string) error

+ func (b *InMemoryBackend) DeleteIntegrationResponse(restAPIID, resourceID, httpMethod, statusCode string) error

+ func (b *InMemoryBackend) DeleteMethod(restAPIID, resourceID, httpMethod string) error

+ func (b *InMemoryBackend) DeleteMethodResponse(restAPIID, resourceID, httpMethod, statusCode string) error

+ func (b *InMemoryBackend) DeleteModel(restAPIID, modelName string) error

+ func (b *InMemoryBackend) DeleteRequestValidator(restAPIID, validatorID string) error

+ func (b *InMemoryBackend) DeleteResource(restAPIID, resourceID string) error

+ func (b *InMemoryBackend) DeleteRestAPI(restAPIID string) error

+ func (b *InMemoryBackend) DeleteStage(restAPIID, stageName string) error

+ func (b *InMemoryBackend) DeleteUsagePlan(id string) error

+ func (b *InMemoryBackend) DeleteUsagePlanKey(usagePlanID, keyID string) error

+ func (b *InMemoryBackend) DeleteVpcLink(id string) error

+ func (b *InMemoryBackend) EnforceUsagePlan(apiID, stageName, keyID string) error

+ func (b *InMemoryBackend) GenerateClientCertificate(input GenerateClientCertificateInput) (*ClientCertificate, error)

+ func (b *InMemoryBackend) GetAPIKey(id string) (*APIKey, error)

+ func (b *InMemoryBackend) GetAPIKeyByValue(value string) (*APIKey, error)

+ func (b *InMemoryBackend) GetAPIKeys() ([]APIKey, error)

+ func (b *InMemoryBackend) GetAPIKeysPage(limit int, position string) ([]APIKey, string, error)

+ func (b *InMemoryBackend) GetAccount() (*Account, error)

+ func (b *InMemoryBackend) GetAuthorizer(restAPIID, authorizerID string) (*Authorizer, error)

+ func (b *InMemoryBackend) GetAuthorizers(restAPIID string) ([]Authorizer, error)

+ func (b *InMemoryBackend) GetBasePathMapping(domainName, basePath string) (*BasePathMapping, error)

+ func (b *InMemoryBackend) GetBasePathMappings(domainName string) ([]BasePathMapping, error)

+ func (b *InMemoryBackend) GetClientCertificate(id string) (*ClientCertificate, error)

+ func (b *InMemoryBackend) GetClientCertificates() ([]ClientCertificate, error)

+ func (b *InMemoryBackend) GetDeployment(restAPIID, deploymentID string) (*Deployment, error)

+ func (b *InMemoryBackend) GetDeployments(restAPIID string) ([]Deployment, error)

+ func (b *InMemoryBackend) GetDocumentationPart(restAPIID, docPartID string) (*DocumentationPart, error)

+ func (b *InMemoryBackend) GetDocumentationParts(restAPIID string) ([]DocumentationPart, error)

+ func (b *InMemoryBackend) GetDocumentationVersion(restAPIID, version string) (*DocumentationVersion, error)

+ func (b *InMemoryBackend) GetDocumentationVersions(restAPIID string) ([]DocumentationVersion, error)

+ func (b *InMemoryBackend) GetDomainName(name string) (*DomainName, error)

+ func (b *InMemoryBackend) GetDomainNameAccessAssociations(resourceOwner string) ([]DomainNameAccessAssociation, error)

+ func (b *InMemoryBackend) GetDomainNames() ([]DomainName, error)

+ func (b *InMemoryBackend) GetDomainNamesPage(limit int, position string) ([]DomainName, string, error)

+ func (b *InMemoryBackend) GetExport(restAPIID, stageName, exportType string) (map[string]any, error)

+ func (b *InMemoryBackend) GetGatewayResponse(restAPIID, responseType string) (*GatewayResponse, error)

+ func (b *InMemoryBackend) GetGatewayResponses(restAPIID string) ([]GatewayResponse, error)

+ func (b *InMemoryBackend) GetIntegration(restAPIID, resourceID, httpMethod string) (*Integration, error)

+ func (b *InMemoryBackend) GetIntegrationResponse(restAPIID, resourceID, httpMethod, statusCode string) (*IntegrationResponse, error)

+ func (b *InMemoryBackend) GetMethod(restAPIID, resourceID, httpMethod string) (*Method, error)

+ func (b *InMemoryBackend) GetMethodResponse(restAPIID, resourceID, httpMethod, statusCode string) (*MethodResponse, error)

+ func (b *InMemoryBackend) GetModel(restAPIID, modelName string) (*Model, error)

+ func (b *InMemoryBackend) GetModelTemplate(restAPIID, modelName string) (string, error)

+ func (b *InMemoryBackend) GetModels(restAPIID string) ([]Model, error)

+ func (b *InMemoryBackend) GetRequestValidator(restAPIID, validatorID string) (*RequestValidator, error)

+ func (b *InMemoryBackend) GetRequestValidators(restAPIID string) ([]RequestValidator, error)

+ func (b *InMemoryBackend) GetResource(restAPIID, resourceID string) (*Resource, error)

+ func (b *InMemoryBackend) GetResourceTags(resourceARN string) (map[string]string, error)

+ func (b *InMemoryBackend) GetResources(restAPIID, position string, limit int) ([]Resource, string, error)

+ func (b *InMemoryBackend) GetRestAPI(restAPIID string) (*RestAPI, error)

+ func (b *InMemoryBackend) GetRestAPIs(limit int, position string) ([]RestAPI, string, error)

+ func (b *InMemoryBackend) GetSdk(restAPIID, stageName, sdkType string) (*SdkExport, error)

+ func (b *InMemoryBackend) GetSdkType(id string) (*SdkType, error)

+ func (b *InMemoryBackend) GetSdkTypes() []SdkType

+ func (b *InMemoryBackend) GetStage(restAPIID, stageName string) (*Stage, error)

+ func (b *InMemoryBackend) GetStages(restAPIID string) ([]Stage, error)

+ func (b *InMemoryBackend) GetUsage(input GetUsageInput) (*UsageData, error)

+ func (b *InMemoryBackend) GetUsagePlan(id string) (*UsagePlan, error)

+ func (b *InMemoryBackend) GetUsagePlanKey(usagePlanID, keyID string) (*UsagePlanKey, error)

+ func (b *InMemoryBackend) GetUsagePlanKeys(usagePlanID string) ([]UsagePlanKey, error)

+ func (b *InMemoryBackend) GetUsagePlans() ([]UsagePlan, error)

+ func (b *InMemoryBackend) GetUsagePlansPage(limit int, position string) ([]UsagePlan, string, error)

+ func (b *InMemoryBackend) GetVpcLink(id string) (*VpcLink, error)

+ func (b *InMemoryBackend) GetVpcLinks() ([]VpcLink, error)

+ func (b *InMemoryBackend) ImportAPIKeys(body []byte, format string, failOnWarnings bool) ([]string, []string, error)

+ func (b *InMemoryBackend) ImportDocumentationParts(restAPIID string, body []byte, mode string, failOnWarnings bool) ([]string, []string, error)

+ func (b *InMemoryBackend) ImportRestAPI(input ImportRestAPIInput) (*RestAPI, error)

+ func (b *InMemoryBackend) PutGatewayResponse(input PutGatewayResponseInput) (*GatewayResponse, error)

+ func (b *InMemoryBackend) PutIntegration(restAPIID, resourceID, httpMethod string, input PutIntegrationInput) (*Integration, error)

+ func (b *InMemoryBackend) PutIntegrationResponse(restAPIID, resourceID, httpMethod, statusCode string, ...) (*IntegrationResponse, error)

+ func (b *InMemoryBackend) PutMethod(input PutMethodInput) (*Method, error)

+ func (b *InMemoryBackend) PutMethodResponse(restAPIID, resourceID, httpMethod, statusCode string, ...) (*MethodResponse, error)

+ func (b *InMemoryBackend) PutRestAPI(input PutRestAPIInput) (*RestAPI, error)

+ func (b *InMemoryBackend) RejectDomainNameAccessAssociation(arn, domainNameARN string) error

+ func (b *InMemoryBackend) Reset()

+ func (b *InMemoryBackend) ResourcesForRouting(restAPIID string) ([]Resource, uint64, error)

+ func (b *InMemoryBackend) Restore(ctx context.Context, data []byte) error

+ func (b *InMemoryBackend) Snapshot(ctx context.Context) []byte

+ func (b *InMemoryBackend) TagResource(resourceARN string, newTags map[string]string) error

+ func (b *InMemoryBackend) TestInvokeAuthorizer(input TestInvokeAuthorizerInput) (*TestInvokeAuthorizerOutput, error)

+ func (b *InMemoryBackend) TestInvokeMethod(input TestInvokeMethodInput) (*TestInvokeMethodOutput, error)

+ func (b *InMemoryBackend) UntagResource(resourceARN string, tagKeys []string) error

+ func (b *InMemoryBackend) UpdateAPIKey(id string, input UpdateAPIKeyInput) (*APIKey, error)

+ func (b *InMemoryBackend) UpdateAccount(input UpdateAccountInput) (*Account, error)

+ func (b *InMemoryBackend) UpdateAuthorizer(restAPIID, authorizerID string, input UpdateAuthorizerInput) (*Authorizer, error)

+ func (b *InMemoryBackend) UpdateBasePathMapping(input UpdateBasePathMappingInput) (*BasePathMapping, error)

+ func (b *InMemoryBackend) UpdateClientCertificate(input UpdateClientCertificateInput) (*ClientCertificate, error)

+ func (b *InMemoryBackend) UpdateDeployment(restAPIID, deploymentID string, input UpdateDeploymentInput) (*Deployment, error)

+ func (b *InMemoryBackend) UpdateDocumentationPart(input UpdateDocumentationPartInput) (*DocumentationPart, error)

+ func (b *InMemoryBackend) UpdateDocumentationVersion(input UpdateDocumentationVersionInput) (*DocumentationVersion, error)

+ func (b *InMemoryBackend) UpdateDomainName(input UpdateDomainNameInput) (*DomainName, error)

+ func (b *InMemoryBackend) UpdateGatewayResponse(input PutGatewayResponseInput) (*GatewayResponse, error)

+ func (b *InMemoryBackend) UpdateIntegration(input UpdateIntegrationInput) (*Integration, error)

+ func (b *InMemoryBackend) UpdateIntegrationResponse(input UpdateIntegrationResponseInput) (*IntegrationResponse, error)

+ func (b *InMemoryBackend) UpdateMethod(input UpdateMethodInput) (*Method, error)

+ func (b *InMemoryBackend) UpdateMethodResponse(input UpdateMethodResponseInput) (*MethodResponse, error)

+ func (b *InMemoryBackend) UpdateModel(restAPIID, modelName string, input UpdateModelInput) (*Model, error)

+ func (b *InMemoryBackend) UpdateRequestValidator(restAPIID, validatorID string, input UpdateRequestValidatorInput) (*RequestValidator, error)

+ func (b *InMemoryBackend) UpdateResource(restAPIID, resourceID string, input UpdateResourceInput) (*Resource, error)

+ func (b *InMemoryBackend) UpdateRestAPI(restAPIID string, input UpdateRestAPIInput) (*RestAPI, error)

+ func (b *InMemoryBackend) UpdateStage(restAPIID, stageName string, input UpdateStageInput) (*Stage, error)

+ func (b *InMemoryBackend) UpdateUsage(usagePlanID, keyID string, patchedFields map[string]string) (*UsageData, error)

+ func (b *InMemoryBackend) UpdateUsagePlan(input UpdateUsagePlanInput) (*UsagePlan, error)

+ func (b *InMemoryBackend) UpdateVpcLink(input UpdateVpcLinkInput) (*VpcLink, error)

+ type Integration struct

+ CacheKeyParameters []string

+ CacheNamespace string

+ ConnectionID string

+ ConnectionType string

+ ContentHandling string

+ Credentials string

+ HTTPMethod string

+ IntegrationResponses map[string]*IntegrationResponse

+ PassthroughBehavior string

+ RequestParameters map[string]string

+ RequestTemplates map[string]string

+ TimeoutInMillis int

+ Type string

+ URI string

+ type IntegrationResponse struct

+ ContentHandling string

+ ResponseParameters map[string]string

+ ResponseTemplates map[string]string

+ SelectionPattern string

+ StatusCode string

+ type JWKSProvider interface

+ GetJWTPublicKey func(issuerURL, kid string) (*rsa.PublicKey, error)

+ type LambdaInvoker interface

+ InvokeFunction func(ctx context.Context, name, invocationType string, payload []byte) ([]byte, int, error)

+ type LambdaProxyContext struct

+ APIId string

+ Authorizer map[string]any

+ HTTPMethod string

+ RequestID string

+ ResourcePath string

+ Stage string

+ type LambdaProxyEvent struct

+ Body string

+ HTTPMethod string

+ Headers map[string]string

+ IsBase64Encoded bool

+ MultiValueHeaders map[string][]string

+ MultiValueQueryString map[string][]string

+ Path string

+ PathParameters map[string]string

+ QueryStringParameters map[string]string

+ RequestContext LambdaProxyContext

+ Resource string

+ StageVariables map[string]string

+ func BuildProxyEvent(r *http.Request, apiID, stageName, resource, path string, ...) (*LambdaProxyEvent, error)

+ type LambdaProxyResponse struct

+ Body string

+ Headers map[string]string

+ IsBase64Encoded bool

+ StatusCode int

+ type Method struct

+ APIKeyRequired bool

+ AuthorizationType string

+ AuthorizerID string

+ HTTPMethod string

+ MethodIntegration *Integration

+ MethodResponses map[string]*MethodResponse

+ OperationName string

+ RequestModels map[string]string

+ RequestParameters map[string]bool

+ RequestValidatorID string

+ type MethodResponse struct

+ ResponseModels map[string]string

+ ResponseParameters map[string]bool

+ StatusCode string

+ type MethodSetting struct

+ CacheTTLInSeconds int

+ CachingEnabled bool

+ DataTraceEnabled bool

+ LoggingLevel string

+ MetricsEnabled bool

+ RequireAuthorizationForCacheControl bool

+ ThrottlingBurstLimit int

+ ThrottlingRateLimit float64

+ type Model struct

+ ContentType string

+ Description string

+ ID string

+ Name string

+ RestAPIID string

+ Schema string

+ type PolicyDocument struct

+ Statement []PolicyStatement

+ Version string

+ type PolicyStatement struct

+ Action any

+ Effect string

+ Resource any

+ type Provider struct

+ func (p *Provider) Init(_ *service.AppContext) (service.Registerable, error)

+ func (p *Provider) Name() string

+ type PutGatewayResponseInput struct

+ ResponseParameters map[string]string

+ ResponseTemplates map[string]string

+ ResponseType string

+ RestAPIID string

+ StatusCode string

+ type PutIntegrationInput struct

+ CacheKeyParameters []string

+ CacheNamespace string

+ ConnectionID string

+ ConnectionType string

+ ContentHandling string

+ Credentials string

+ HTTPMethod string

+ PassthroughBehavior string

+ RequestParameters map[string]string

+ RequestTemplates map[string]string

+ TimeoutInMillis int

+ Type string

+ URI string

+ type PutIntegrationResponseInput struct

+ ContentHandling string

+ ResponseParameters map[string]string

+ ResponseTemplates map[string]string

+ SelectionPattern string

+ type PutMethodInput struct

+ APIKeyRequired bool

+ AuthorizationType string

+ AuthorizerID string

+ HTTPMethod string

+ OperationName string

+ RequestModels map[string]string

+ RequestParameters map[string]bool

+ RequestValidatorID string

+ ResourceID string

+ RestAPIID string

+ type PutMethodResponseInput struct

+ ResponseModels map[string]string

+ ResponseParameters map[string]bool

+ type PutRestAPIInput struct

+ Body []byte

+ FailOnWarnings bool

+ Mode string

+ RestAPIID string

+ type QuotaSettings struct

+ Limit int

+ Offset int

+ Period string

+ type RequestValidator struct

+ ID string

+ Name string

+ RestAPIID string

+ ValidateRequestBody bool

+ ValidateRequestParameters bool

+ type Resource struct

+ CorsConfiguration *CorsConfiguration

+ ID string

+ ParentID string

+ Path string

+ PathPart string

+ ResourceMethods map[string]*Method

+ RestAPIID string

+ type RestAPI struct

+ APIKeySource string

+ BinaryMediaTypes []string

+ CreatedDate unixEpochTime

+ Description string

+ EndpointConfiguration *EndpointConfiguration

+ ID string

+ MinimumCompressionSize int

+ Name string

+ Policy string

+ RootResourceID string

+ Tags *tags.Tags

+ type SdkExport struct

+ Body []byte

+ ContentDisposition string

+ ContentType string

+ type SdkType struct

+ FriendlyName string

+ ID string

+ type Stage struct

+ AccessLogSettings *AccessLogSettings

+ CacheClusterEnabled bool

+ CacheClusterSize string

+ CacheClusterStatus string

+ CanarySettings *CanarySettings

+ ClientCertificateID string

+ CreatedDate unixEpochTime

+ DeploymentID string

+ Description string

+ InvokeURL string

+ LastUpdatedDate unixEpochTime

+ MethodSettings map[string]MethodSetting

+ RestAPIID string

+ StageName string

+ TracingEnabled bool

+ Variables map[string]string

+ type StorageBackend interface

+ CreateAPIKey func(input CreateAPIKeyInput) (*APIKey, error)

+ CreateAuthorizer func(restAPIID string, input CreateAuthorizerInput) (*Authorizer, error)

+ CreateBasePathMapping func(input CreateBasePathMappingInput) (*BasePathMapping, error)

+ CreateDeployment func(restAPIID, stageName, description string) (*Deployment, error)

+ CreateDocumentationPart func(input CreateDocumentationPartInput) (*DocumentationPart, error)

+ CreateDocumentationVersion func(input CreateDocumentationVersionInput) (*DocumentationVersion, error)

+ CreateDomainName func(input CreateDomainNameInput) (*DomainName, error)

+ CreateDomainNameAccessAssociation func(input CreateDomainNameAccessAssociationInput) (*DomainNameAccessAssociation, error)

+ CreateModel func(input CreateModelInput) (*Model, error)

+ CreateRequestValidator func(restAPIID string, input CreateRequestValidatorInput) (*RequestValidator, error)

+ CreateResource func(restAPIID, parentID, pathPart string) (*Resource, error)

+ CreateRestAPI func(input CreateRestAPIInput) (*RestAPI, error)

+ CreateStage func(input CreateStageInput) (*Stage, error)

+ CreateUsagePlan func(input CreateUsagePlanInput) (*UsagePlan, error)

+ CreateUsagePlanKey func(input CreateUsagePlanKeyInput) (*UsagePlanKey, error)

+ CreateVpcLink func(input CreateVpcLinkInput) (*VpcLink, error)

+ DeleteAPIKey func(id string) error

+ DeleteAuthorizer func(restAPIID, authorizerID string) error

+ DeleteBasePathMapping func(domainName, basePath string) error

+ DeleteClientCertificate func(id string) error

+ DeleteDeployment func(restAPIID, deploymentID string) error

+ DeleteDocumentationPart func(restAPIID, docPartID string) error

+ DeleteDocumentationVersion func(restAPIID, version string) error

+ DeleteDomainName func(name string) error

+ DeleteDomainNameAccessAssociation func(arn string) error

+ DeleteGatewayResponse func(restAPIID, responseType string) error

+ DeleteIntegration func(restAPIID, resourceID, httpMethod string) error

+ DeleteIntegrationResponse func(restAPIID, resourceID, httpMethod, statusCode string) error

+ DeleteMethod func(restAPIID, resourceID, httpMethod string) error

+ DeleteMethodResponse func(restAPIID, resourceID, httpMethod, statusCode string) error

+ DeleteModel func(restAPIID, modelName string) error

+ DeleteRequestValidator func(restAPIID, validatorID string) error

+ DeleteResource func(restAPIID, resourceID string) error

+ DeleteRestAPI func(restAPIID string) error

+ DeleteStage func(restAPIID, stageName string) error

+ DeleteUsagePlan func(id string) error

+ DeleteUsagePlanKey func(usagePlanID, keyID string) error

+ DeleteVpcLink func(id string) error

+ EnforceUsagePlan func(apiID, stageName, keyID string) error

+ GenerateClientCertificate func(input GenerateClientCertificateInput) (*ClientCertificate, error)

+ GetAPIKey func(id string) (*APIKey, error)

+ GetAPIKeyByValue func(value string) (*APIKey, error)

+ GetAPIKeys func() ([]APIKey, error)

+ GetAPIKeysPage func(limit int, position string) ([]APIKey, string, error)

+ GetAccount func() (*Account, error)

+ GetAuthorizer func(restAPIID, authorizerID string) (*Authorizer, error)

+ GetAuthorizers func(restAPIID string) ([]Authorizer, error)

+ GetBasePathMapping func(domainName, basePath string) (*BasePathMapping, error)

+ GetBasePathMappings func(domainName string) ([]BasePathMapping, error)

+ GetClientCertificate func(id string) (*ClientCertificate, error)

+ GetClientCertificates func() ([]ClientCertificate, error)

+ GetDeployment func(restAPIID, deploymentID string) (*Deployment, error)

+ GetDeployments func(restAPIID string) ([]Deployment, error)

+ GetDocumentationPart func(restAPIID, docPartID string) (*DocumentationPart, error)

+ GetDocumentationParts func(restAPIID string) ([]DocumentationPart, error)

+ GetDocumentationVersion func(restAPIID, version string) (*DocumentationVersion, error)

+ GetDocumentationVersions func(restAPIID string) ([]DocumentationVersion, error)

+ GetDomainName func(name string) (*DomainName, error)

+ GetDomainNameAccessAssociations func(resourceOwner string) ([]DomainNameAccessAssociation, error)

+ GetDomainNames func() ([]DomainName, error)

+ GetDomainNamesPage func(limit int, position string) ([]DomainName, string, error)

+ GetExport func(restAPIID, stageName, exportType string) (map[string]any, error)

+ GetGatewayResponse func(restAPIID, responseType string) (*GatewayResponse, error)

+ GetGatewayResponses func(restAPIID string) ([]GatewayResponse, error)

+ GetIntegration func(restAPIID, resourceID, httpMethod string) (*Integration, error)

+ GetIntegrationResponse func(restAPIID, resourceID, httpMethod, statusCode string) (*IntegrationResponse, error)

+ GetMethod func(restAPIID, resourceID, httpMethod string) (*Method, error)

+ GetMethodResponse func(restAPIID, resourceID, httpMethod, statusCode string) (*MethodResponse, error)

+ GetModel func(restAPIID, modelName string) (*Model, error)

+ GetModelTemplate func(restAPIID, modelName string) (string, error)

+ GetModels func(restAPIID string) ([]Model, error)

+ GetRequestValidator func(restAPIID, validatorID string) (*RequestValidator, error)

+ GetRequestValidators func(restAPIID string) ([]RequestValidator, error)

+ GetResource func(restAPIID, resourceID string) (*Resource, error)

+ GetResourceTags func(resourceARN string) (map[string]string, error)

+ GetResources func(restAPIID, position string, limit int) ([]Resource, string, error)

+ GetRestAPI func(restAPIID string) (*RestAPI, error)

+ GetRestAPIs func(limit int, position string) ([]RestAPI, string, error)

+ GetSdk func(restAPIID, stageName, sdkType string) (*SdkExport, error)

+ GetSdkType func(id string) (*SdkType, error)

+ GetSdkTypes func() []SdkType

+ GetStage func(restAPIID, stageName string) (*Stage, error)

+ GetStages func(restAPIID string) ([]Stage, error)

+ GetUsage func(input GetUsageInput) (*UsageData, error)

+ GetUsagePlan func(id string) (*UsagePlan, error)

+ GetUsagePlanKey func(usagePlanID, keyID string) (*UsagePlanKey, error)

+ GetUsagePlanKeys func(usagePlanID string) ([]UsagePlanKey, error)

+ GetUsagePlans func() ([]UsagePlan, error)

+ GetUsagePlansPage func(limit int, position string) ([]UsagePlan, string, error)

+ GetVpcLink func(id string) (*VpcLink, error)

+ GetVpcLinks func() ([]VpcLink, error)

+ ImportAPIKeys func(body []byte, format string, failOnWarnings bool) ([]string, []string, error)

+ ImportDocumentationParts func(restAPIID string, body []byte, mode string, failOnWarnings bool) ([]string, []string, error)

+ ImportRestAPI func(input ImportRestAPIInput) (*RestAPI, error)

+ PutGatewayResponse func(input PutGatewayResponseInput) (*GatewayResponse, error)

+ PutIntegration func(restAPIID, resourceID, httpMethod string, input PutIntegrationInput) (*Integration, error)

+ PutIntegrationResponse func(restAPIID, resourceID, httpMethod, statusCode string, ...) (*IntegrationResponse, error)

+ PutMethod func(input PutMethodInput) (*Method, error)

+ PutMethodResponse func(restAPIID, resourceID, httpMethod, statusCode string, ...) (*MethodResponse, error)

+ PutRestAPI func(input PutRestAPIInput) (*RestAPI, error)

+ RejectDomainNameAccessAssociation func(arn, domainNameARN string) error

+ ResourcesForRouting func(restAPIID string) ([]Resource, uint64, error)

+ TagResource func(resourceARN string, tags map[string]string) error

+ TestInvokeAuthorizer func(input TestInvokeAuthorizerInput) (*TestInvokeAuthorizerOutput, error)

+ TestInvokeMethod func(input TestInvokeMethodInput) (*TestInvokeMethodOutput, error)

+ UntagResource func(resourceARN string, tagKeys []string) error

+ UpdateAPIKey func(id string, input UpdateAPIKeyInput) (*APIKey, error)

+ UpdateAccount func(input UpdateAccountInput) (*Account, error)

+ UpdateAuthorizer func(restAPIID, authorizerID string, input UpdateAuthorizerInput) (*Authorizer, error)

+ UpdateBasePathMapping func(input UpdateBasePathMappingInput) (*BasePathMapping, error)

+ UpdateClientCertificate func(input UpdateClientCertificateInput) (*ClientCertificate, error)

+ UpdateDeployment func(restAPIID, deploymentID string, input UpdateDeploymentInput) (*Deployment, error)

+ UpdateDocumentationPart func(input UpdateDocumentationPartInput) (*DocumentationPart, error)

+ UpdateDocumentationVersion func(input UpdateDocumentationVersionInput) (*DocumentationVersion, error)

+ UpdateDomainName func(input UpdateDomainNameInput) (*DomainName, error)

+ UpdateGatewayResponse func(input PutGatewayResponseInput) (*GatewayResponse, error)

+ UpdateIntegration func(input UpdateIntegrationInput) (*Integration, error)

+ UpdateIntegrationResponse func(input UpdateIntegrationResponseInput) (*IntegrationResponse, error)

+ UpdateMethod func(input UpdateMethodInput) (*Method, error)

+ UpdateMethodResponse func(input UpdateMethodResponseInput) (*MethodResponse, error)

+ UpdateModel func(restAPIID, modelName string, input UpdateModelInput) (*Model, error)

+ UpdateRequestValidator func(restAPIID, validatorID string, input UpdateRequestValidatorInput) (*RequestValidator, error)

+ UpdateResource func(restAPIID, resourceID string, input UpdateResourceInput) (*Resource, error)

+ UpdateRestAPI func(restAPIID string, input UpdateRestAPIInput) (*RestAPI, error)

+ UpdateStage func(restAPIID, stageName string, input UpdateStageInput) (*Stage, error)

+ UpdateUsage func(usagePlanID, keyID string, dateValues map[string]string) (*UsageData, error)

+ UpdateUsagePlan func(input UpdateUsagePlanInput) (*UsagePlan, error)

+ UpdateVpcLink func(input UpdateVpcLinkInput) (*VpcLink, error)

+ type TestInvokeAuthorizerInput struct

+ AuthorizerID string

+ Body string

+ Headers map[string]string

+ Identity string

+ RestAPIID string

+ StageVariables map[string]string

+ type TestInvokeAuthorizerOutput struct

+ AuthorizationStatus int

+ Claims map[string]string

+ ClientStatus int

+ Context map[string]string

+ Latency int64

+ Log string

+ PolicyDocument string

+ PrincipalID string

+ type TestInvokeMethodInput struct

+ Body string

+ HTTPMethod string

+ Headers map[string]string

+ PathWithQueryString string

+ ResourceID string

+ RestAPIID string

+ StageVariables map[string]string

+ type TestInvokeMethodOutput struct

+ Body string

+ Headers map[string]string

+ Latency int64

+ Log string

+ Status int

+ type ThrottleSettings struct

+ BurstLimit int

+ RateLimit float64

+ type UpdateAPIKeyInput struct

+ CustomerID string

+ Description string

+ Enabled *bool

+ Name string

+ type UpdateAccountInput struct

+ CloudwatchRoleARN string

+ ThrottleSettings *ThrottleSettings

+ type UpdateAuthorizerInput struct

+ AuthorizerCredentials string

+ AuthorizerResultTTLInSeconds int

+ AuthorizerURI string

+ IdentitySource string

+ IdentityValidationExpression string

+ Name string

+ ProviderARNs []string

+ Type string

+ type UpdateBasePathMappingInput struct

+ BasePath string

+ DomainName string

+ RestAPIID string

+ Stage string

+ type UpdateClientCertificateInput struct

+ ClientCertificateID string

+ Description string

+ type UpdateDeploymentInput struct

+ Description string

+ type UpdateDocumentationPartInput struct

+ DocPartID string

+ Properties string

+ RestAPIID string

+ type UpdateDocumentationVersionInput struct

+ Description string

+ DocumentationVersion string

+ RestAPIID string

+ type UpdateDomainNameInput struct

+ CertificateARN string

+ DomainName string

+ EndpointConfiguration *EndpointConfiguration

+ RegionalCertificateARN string

+ SecurityPolicy string

+ type UpdateIntegrationInput struct

+ CacheKeyParameters []string

+ CacheNamespace string

+ ConnectionID string

+ ConnectionType string

+ ContentHandling string

+ Credentials string

+ HTTPMethod string

+ IntegrationHTTPMethod string

+ IntegrationType string

+ PassthroughBehavior string

+ RequestParameters map[string]string

+ RequestTemplates map[string]string

+ ResourceID string

+ RestAPIID string

+ TimeoutInMillis int

+ URI string

+ type UpdateIntegrationResponseInput struct

+ ContentHandling string

+ HTTPMethod string

+ ResourceID string

+ ResponseParameters map[string]string

+ ResponseTemplates map[string]string

+ RestAPIID string

+ SelectionPattern string

+ StatusCode string

+ type UpdateMethodInput struct

+ APIKeyRequired *bool

+ AuthorizationType string

+ AuthorizerID string

+ HTTPMethod string

+ OperationName string

+ RequestModels map[string]string

+ ResourceID string

+ RestAPIID string

+ type UpdateMethodResponseInput struct

+ HTTPMethod string

+ ResourceID string

+ ResponseModels map[string]string

+ ResponseParameters map[string]bool

+ RestAPIID string

+ StatusCode string

+ type UpdateModelInput struct

+ Description string

+ Schema string

+ type UpdateRequestValidatorInput struct

+ Name string

+ ValidateRequestBody *bool

+ ValidateRequestParameters *bool

+ type UpdateResourceInput struct

+ CorsConfiguration *CorsConfiguration

+ PathPart string

+ type UpdateRestAPIInput struct

+ APIKeySource string

+ BinaryMediaTypes []string

+ Description string

+ EndpointConfiguration *EndpointConfiguration

+ MinimumCompressionSize *int

+ Name string

+ Policy string

+ type UpdateStageInput struct

+ AccessLogSettings *AccessLogSettings

+ CacheClusterEnabled *bool

+ CacheClusterSize string

+ CanarySettings *CanarySettings

+ ClientCertificateID string

+ DeploymentID string

+ Description string

+ MethodSettings map[string]MethodSetting

+ TracingEnabled *bool

+ Variables map[string]string

+ type UpdateUsagePlanInput struct

+ APIStages []APIStageAssociation

+ Description string

+ Name string

+ Quota *QuotaSettings

+ Throttle *ThrottleSettings

+ UsagePlanID string

+ type UpdateVpcLinkInput struct

+ Description string

+ Name string

+ VpcLinkID string

+ type UsageData struct

+ EndDate string

+ Items map[string][]any

+ Position string

+ StartDate string

+ UsagePlanID string

+ type UsagePlan struct

+ APIStages []APIStageAssociation

+ Description string

+ ID string

+ Name string

+ Quota *QuotaSettings

+ Tags *tags.Tags

+ Throttle *ThrottleSettings

+ type UsagePlanKey struct

+ ID string

+ Name string

+ Type string

+ UsagePlanID string

+ Value string

+ type VTLContext struct

+ APIID string

+ Body string

+ HTTPMethod string

+ Path string

+ RequestID string

+ ResourcePath string

+ SourceIP string

+ Stage string

+ StageVariables map[string]string

+ UserAgent string

+ type VpcLink struct

+ Description string

+ ID string

+ Name string

+ Status string

+ Tags map[string]string

+ TargetARNs []string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL