Package apigatewayiface provides an interface to enable mocking the Amazon API Gateway service client for testing your code.

New creates a new instance of the APIGateway client with a config.

Enum values for ApiKeysFormat.

Enum values for ApiKeySourceType.

Enum values for ApiKeySourceType.

Enum values for AuthorizerType.

Enum values for AuthorizerType.

Enum values for AuthorizerType.

Enum values for CacheClusterSize.

Enum values for CacheClusterSize.

Enum values for CacheClusterSize.

Enum values for CacheClusterSize.

Enum values for CacheClusterSize.

Enum values for CacheClusterSize.

Enum values for CacheClusterSize.

Enum values for CacheClusterSize.

Enum values for CacheClusterStatus.

Enum values for CacheClusterStatus.

Enum values for CacheClusterStatus.

Enum values for CacheClusterStatus.

Enum values for CacheClusterStatus.

Enum values for ConnectionType.

Enum values for ConnectionType.

Enum values for ContentHandlingStrategy.

Enum values for ContentHandlingStrategy.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Enum values for DocumentationPartType.

Service ID for Regions and Endpoints metadata.

Enum values for EndpointType.

Enum values for EndpointType.

Enum values for EndpointType.

ErrCodeBadRequestException for service response error code "BadRequestException".

ErrCodeConflictException for service response error code "ConflictException".

ErrCodeLimitExceededException for service response error code "LimitExceededException".

ErrCodeNotFoundException for service response error code "NotFoundException".

ErrCodeServiceUnavailableException for service response error code "ServiceUnavailableException".

ErrCodeTooManyRequestsException for service response error code "TooManyRequestsException".

ErrCodeUnauthorizedException for service response error code "UnauthorizedException".

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for GatewayResponseType.

Enum values for IntegrationType.

Enum values for IntegrationType.

Enum values for IntegrationType.

Enum values for IntegrationType.

Enum values for IntegrationType.

Enum values for LocationStatusType.

Enum values for LocationStatusType.

Enum values for Op.

Enum values for Op.

Enum values for Op.

Enum values for Op.

Enum values for Op.

Enum values for Op.

Enum values for PutMode.

Enum values for PutMode.

Enum values for QuotaPeriodType.

Enum values for QuotaPeriodType.

Enum values for QuotaPeriodType.

Service endpoint prefix API calls made to.

Enum values for UnauthorizedCacheControlHeaderStrategy.

Enum values for UnauthorizedCacheControlHeaderStrategy.

Enum values for UnauthorizedCacheControlHeaderStrategy.

Enum values for VpcLinkStatus.

Enum values for VpcLinkStatus.

Enum values for VpcLinkStatus.

Enum values for VpcLinkStatus.

Access log settings, including the access log format and access log destination ARN.

APIGateway provides the API operation methods for making requests to Amazon API Gateway.

API stage name of the associated API stage in a usage plan.

Configuration settings of a canary deployment.

Request to create an ApiKey resource.

CreateApiKeyRequest is a API request type for the CreateApiKey API operation.

Request to add a new Authorizer to an existing RestApi resource.

CreateAuthorizerRequest is a API request type for the CreateAuthorizer API operation.

Requests API Gateway to create a new BasePathMapping resource.

CreateBasePathMappingRequest is a API request type for the CreateBasePathMapping API operation.

Requests API Gateway to create a Deployment resource.

CreateDeploymentRequest is a API request type for the CreateDeployment API operation.

Creates a new documentation part of a given API.

CreateDocumentationPartRequest is a API request type for the CreateDocumentationPart API operation.

Creates a new documentation version of a given API.

CreateDocumentationVersionRequest is a API request type for the CreateDocumentationVersion API operation.

A request to create a new domain name.

CreateDomainNameRequest is a API request type for the CreateDomainName API operation.

Request to add a new Model to an existing RestApi resource.

CreateModelRequest is a API request type for the CreateModel API operation.

Creates a RequestValidator of a given RestApi.

CreateRequestValidatorRequest is a API request type for the CreateRequestValidator API operation.

Requests API Gateway to create a Resource resource.

CreateResourceRequest is a API request type for the CreateResource API operation.

The POST Request to add a new RestApi resource to your collection.

CreateRestApiRequest is a API request type for the CreateRestApi API operation.

Requests API Gateway to create a Stage resource.

CreateStageRequest is a API request type for the CreateStage API operation.

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

The POST request to create a usage plan key for adding an existing API key to a usage plan.

CreateUsagePlanKeyRequest is a API request type for the CreateUsagePlanKey API operation.

CreateUsagePlanRequest is a API request type for the CreateUsagePlan API operation.

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational.

CreateVpcLinkRequest is a API request type for the CreateVpcLink API operation.

A request to delete the ApiKey resource.

DeleteApiKeyRequest is a API request type for the DeleteApiKey API operation.

Request to delete an existing Authorizer resource.

DeleteAuthorizerRequest is a API request type for the DeleteAuthorizer API operation.

A request to delete the BasePathMapping resource.

DeleteBasePathMappingRequest is a API request type for the DeleteBasePathMapping API operation.

A request to delete the ClientCertificate resource.

DeleteClientCertificateRequest is a API request type for the DeleteClientCertificate API operation.

Requests API Gateway to delete a Deployment resource.

DeleteDeploymentRequest is a API request type for the DeleteDeployment API operation.

Deletes an existing documentation part of an API.

DeleteDocumentationPartRequest is a API request type for the DeleteDocumentationPart API operation.

Deletes an existing documentation version of an API.

DeleteDocumentationVersionRequest is a API request type for the DeleteDocumentationVersion API operation.

A request to delete the DomainName resource.

DeleteDomainNameRequest is a API request type for the DeleteDomainName API operation.

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

DeleteGatewayResponseRequest is a API request type for the DeleteGatewayResponse API operation.

Represents a delete integration request.

DeleteIntegrationRequest is a API request type for the DeleteIntegration API operation.

Represents a delete integration response request.

DeleteIntegrationResponseRequest is a API request type for the DeleteIntegrationResponse API operation.

Request to delete an existing Method resource.

DeleteMethodRequest is a API request type for the DeleteMethod API operation.

A request to delete an existing MethodResponse resource.

DeleteMethodResponseRequest is a API request type for the DeleteMethodResponse API operation.

Request to delete an existing model in an existing RestApi resource.

DeleteModelRequest is a API request type for the DeleteModel API operation.

Deletes a specified RequestValidator of a given RestApi.

DeleteRequestValidatorRequest is a API request type for the DeleteRequestValidator API operation.

Request to delete a Resource.

DeleteResourceRequest is a API request type for the DeleteResource API operation.

Request to delete the specified API from your collection.

DeleteRestApiRequest is a API request type for the DeleteRestApi API operation.

Requests API Gateway to delete a Stage resource.

DeleteStageRequest is a API request type for the DeleteStage API operation.

The DELETE request to delete a usage plan of a given plan Id.

The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

DeleteUsagePlanKeyRequest is a API request type for the DeleteUsagePlanKey API operation.

DeleteUsagePlanRequest is a API request type for the DeleteUsagePlan API operation.

Deletes an existing VpcLink of a specified identifier.

DeleteVpcLinkRequest is a API request type for the DeleteVpcLink API operation.

The input configuration for a canary deployment.

Specifies the target API entity to which the documentation applies.

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

Request to flush authorizer cache entries on a specified stage.

FlushStageAuthorizersCacheRequest is a API request type for the FlushStageAuthorizersCache API operation.

Requests API Gateway to flush a stage's cache.

FlushStageCacheRequest is a API request type for the FlushStageCache API operation.

A request to generate a ClientCertificate resource.

GenerateClientCertificateRequest is a API request type for the GenerateClientCertificate API operation.

Requests API Gateway to get information about the current Account resource.

GetAccountRequest is a API request type for the GetAccount API operation.

A request to get information about the current ApiKey resource.

GetApiKeyRequest is a API request type for the GetApiKey API operation.

A request to get information about the current ApiKeys resource.

Represents a collection of API keys as represented by an ApiKeys resource.

GetApiKeysPager is used to paginate the request.

GetApiKeysRequest is a API request type for the GetApiKeys API operation.

Request to describe an existing Authorizer resource.

GetAuthorizerRequest is a API request type for the GetAuthorizer API operation.

Request to describe an existing Authorizers resource.

Represents a collection of Authorizer resources.

GetAuthorizersRequest is a API request type for the GetAuthorizers API operation.

Request to describe a BasePathMapping resource.

GetBasePathMappingRequest is a API request type for the GetBasePathMapping API operation.

A request to get information about a collection of BasePathMapping resources.

Represents a collection of BasePathMapping resources.

GetBasePathMappingsPager is used to paginate the request.

GetBasePathMappingsRequest is a API request type for the GetBasePathMappings API operation.

A request to get information about the current ClientCertificate resource.

GetClientCertificateRequest is a API request type for the GetClientCertificate API operation.

A request to get information about a collection of ClientCertificate resources.

Represents a collection of ClientCertificate resources.

GetClientCertificatesPager is used to paginate the request.

GetClientCertificatesRequest is a API request type for the GetClientCertificates API operation.

Requests API Gateway to get information about a Deployment resource.

GetDeploymentRequest is a API request type for the GetDeployment API operation.

Requests API Gateway to get information about a Deployments collection.

Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection.

GetDeploymentsPager is used to paginate the request.

GetDeploymentsRequest is a API request type for the GetDeployments API operation.

Gets a specified documentation part of a given API.

GetDocumentationPartRequest is a API request type for the GetDocumentationPart API operation.

Gets the documentation parts of an API.

The collection of documentation parts of an API.

GetDocumentationPartsRequest is a API request type for the GetDocumentationParts API operation.

Gets a documentation snapshot of an API.

GetDocumentationVersionRequest is a API request type for the GetDocumentationVersion API operation.

Gets the documentation versions of an API.

The collection of documentation snapshots of an API.

GetDocumentationVersionsRequest is a API request type for the GetDocumentationVersions API operation.

Request to get the name of a DomainName resource.

GetDomainNameRequest is a API request type for the GetDomainName API operation.

Request to describe a collection of DomainName resources.

Represents a collection of DomainName resources.

GetDomainNamesPager is used to paginate the request.

GetDomainNamesRequest is a API request type for the GetDomainNames API operation.

Request a new export of a RestApi for a particular Stage.

The binary blob response to GetExport, which contains the generated SDK.

GetExportRequest is a API request type for the GetExport API operation.

Gets a GatewayResponse of a specified response type on the given RestApi.

GetGatewayResponseRequest is a API request type for the GetGatewayResponse API operation.

Gets the GatewayResponses collection on the given RestApi.

The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs.

GetGatewayResponsesRequest is a API request type for the GetGatewayResponses API operation.

Represents a request to get the integration configuration.

GetIntegrationRequest is a API request type for the GetIntegration API operation.

Represents a get integration response request.

GetIntegrationResponseRequest is a API request type for the GetIntegrationResponse API operation.

Request to describe an existing Method resource.

GetMethodRequest is a API request type for the GetMethod API operation.

Request to describe a MethodResponse resource.

GetMethodResponseRequest is a API request type for the GetMethodResponse API operation.

Request to list information about a model in an existing RestApi resource.

GetModelRequest is a API request type for the GetModel API operation.

Request to list existing Models defined for a RestApi resource.

Represents a collection of Model resources.

GetModelsPager is used to paginate the request.

GetModelsRequest is a API request type for the GetModels API operation.

Request to generate a sample mapping template used to transform the payload.

Represents a mapping template used to transform a payload.

GetModelTemplateRequest is a API request type for the GetModelTemplate API operation.

Gets a RequestValidator of a given RestApi.

GetRequestValidatorRequest is a API request type for the GetRequestValidator API operation.

Gets the RequestValidators collection of a given RestApi.

A collection of RequestValidator resources of a given RestApi.

GetRequestValidatorsRequest is a API request type for the GetRequestValidators API operation.

Request to list information about a resource.

GetResourceRequest is a API request type for the GetResource API operation.

Request to list information about a collection of resources.

Represents a collection of Resource resources.

GetResourcesPager is used to paginate the request.

GetResourcesRequest is a API request type for the GetResources API operation.

The GET request to list an existing RestApi defined for your collection.

GetRestApiRequest is a API request type for the GetRestApi API operation.

The GET request to list existing RestApis defined for your collection.

Contains references to your APIs and links that guide you in how to interact with your collection.

GetRestApisPager is used to paginate the request.

GetRestApisRequest is a API request type for the GetRestApis API operation.

Request a new generated client SDK for a RestApi and Stage.

The binary blob response to GetSdk, which contains the generated SDK.

GetSdkRequest is a API request type for the GetSdk API operation.

Get an SdkType instance.

A type of SDK that API Gateway can generate.

GetSdkTypeRequest is a API request type for the GetSdkType API operation.

Get the SdkTypes collection.

The collection of SdkType instances.

GetSdkTypesRequest is a API request type for the GetSdkTypes API operation.

Requests API Gateway to get information about a Stage resource.

GetStageRequest is a API request type for the GetStage API operation.

Requests API Gateway to get information about one or more Stage resources.

A list of Stage resources that are associated with the ApiKey resource.

GetStagesRequest is a API request type for the GetStages API operation.

Gets the Tags collection for a given resource.

The collection of tags.

GetTagsRequest is a API request type for the GetTags API operation.

The GET request to get the usage data of a usage plan in a specified time interval.

GetUsagePager is used to paginate the request.

The GET request to get a usage plan of a given plan identifier.

The GET request to get a usage plan key of a given key identifier.

Represents a usage plan key to identify a plan customer.

GetUsagePlanKeyRequest is a API request type for the GetUsagePlanKey API operation.

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

GetUsagePlanKeysPager is used to paginate the request.

GetUsagePlanKeysRequest is a API request type for the GetUsagePlanKeys API operation.

GetUsagePlanRequest is a API request type for the GetUsagePlan API operation.

The GET request to get all the usage plans of the caller's account.

Represents a collection of usage plans for an AWS account.

GetUsagePlansPager is used to paginate the request.

GetUsagePlansRequest is a API request type for the GetUsagePlans API operation.

GetUsageRequest is a API request type for the GetUsage API operation.

Gets a specified VPC link under the caller's account in a region.

GetVpcLinkRequest is a API request type for the GetVpcLink API operation.

Gets the VpcLinks collection under the caller's account in a selected region.

The collection of VPC links under the caller's account in a region.

GetVpcLinksPager is used to paginate the request.

GetVpcLinksRequest is a API request type for the GetVpcLinks API operation.

The POST request to import API keys from an external source, such as a CSV-formatted file.

The identifier of an ApiKey used in a UsagePlan.

ImportApiKeysRequest is a API request type for the ImportApiKeys API operation.

Import documentation parts from an external (e.g., OpenAPI) definition file.

A collection of the imported DocumentationPart identifiers.

ImportDocumentationPartsRequest is a API request type for the ImportDocumentationParts API operation.

A POST request to import an API to API Gateway using an input of an API definition file.

ImportRestApiRequest is a API request type for the ImportRestApi API operation.

Specifies the method setting properties.

Represents a summary of a Method resource, given a particular date and time.

A single patch operation to apply to the specified resource.

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

PutGatewayResponseRequest is a API request type for the PutGatewayResponse API operation.

Sets up a method's integration.

PutIntegrationRequest is a API request type for the PutIntegration API operation.

Represents a put integration response request.

PutIntegrationResponseRequest is a API request type for the PutIntegrationResponse API operation.

Request to add a method to an existing Resource resource.

PutMethodRequest is a API request type for the PutMethod API operation.

Request to add a MethodResponse to an existing Method resource.

PutMethodResponseRequest is a API request type for the PutMethodResponse API operation.

A PUT request to update an existing API, with external API definitions specified as the request body.

PutRestApiRequest is a API request type for the PutRestApi API operation.

Quotas configured for a usage plan.

A configuration property of an SDK type.

A reference to a unique stage identified in the format {restApiId}/{stage}.

Adds or updates a tag on a given resource.

TagResourceRequest is a API request type for the TagResource API operation.

Make a request to simulate the execution of an Authorizer.

Represents the response of the test invoke request for a custom Authorizer.

TestInvokeAuthorizerRequest is a API request type for the TestInvokeAuthorizer API operation.

Make a request to simulate the execution of a Method.

Represents the response of the test invoke request in the HTTP method.

TestInvokeMethodRequest is a API request type for the TestInvokeMethod API operation.

The API request rate limits.

Removes a tag from a given resource.

UntagResourceRequest is a API request type for the UntagResource API operation.

Requests API Gateway to change information about the current Account resource.

Represents an AWS account that is associated with API Gateway.

UpdateAccountRequest is a API request type for the UpdateAccount API operation.

A request to change information about an ApiKey resource.

A resource that can be distributed to callers for executing Method resources that require an API key.

UpdateApiKeyRequest is a API request type for the UpdateApiKey API operation.

Request to update an existing Authorizer resource.

Represents an authorization layer for methods.

UpdateAuthorizerRequest is a API request type for the UpdateAuthorizer API operation.

A request to change information about the BasePathMapping resource.

Represents the base path that callers of the API must provide as part of the URL after the domain name.

UpdateBasePathMappingRequest is a API request type for the UpdateBasePathMapping API operation.

A request to change information about an ClientCertificate resource.

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

UpdateClientCertificateRequest is a API request type for the UpdateClientCertificate API operation.

Requests API Gateway to change information about a Deployment resource.

An immutable representation of a RestApi resource that can be called by users using Stages.

UpdateDeploymentRequest is a API request type for the UpdateDeployment API operation.

Updates an existing documentation part of a given API.

A documentation part for a targeted API entity.

UpdateDocumentationPartRequest is a API request type for the UpdateDocumentationPart API operation.

Updates an existing documentation version of an API.

A snapshot of the documentation of an API.

UpdateDocumentationVersionRequest is a API request type for the UpdateDocumentationVersion API operation.

A request to change information about the DomainName resource.

Represents a custom domain name as a user-friendly host name of an API (RestApi).

UpdateDomainNameRequest is a API request type for the UpdateDomainName API operation.

Updates a GatewayResponse of a specified response type on the given RestApi.

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

UpdateGatewayResponseRequest is a API request type for the UpdateGatewayResponse API operation.

Represents an update integration request.

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

UpdateIntegrationRequest is a API request type for the UpdateIntegration API operation.

Represents an update integration response request.

Represents an integration response.

UpdateIntegrationResponseRequest is a API request type for the UpdateIntegrationResponse API operation.

Request to update an existing Method resource.

Represents a client-facing interface by which the client calls the API to access back-end resources.

UpdateMethodRequest is a API request type for the UpdateMethod API operation.

A request to update an existing MethodResponse resource.

Represents a method response of a given HTTP status code returned to the client.

UpdateMethodResponseRequest is a API request type for the UpdateMethodResponse API operation.

Request to update an existing model in an existing RestApi resource.

Represents the data structure of a method's request or response payload.

UpdateModelRequest is a API request type for the UpdateModel API operation.

Updates a RequestValidator of a given RestApi.

A set of validation rules for incoming Method requests.

UpdateRequestValidatorRequest is a API request type for the UpdateRequestValidator API operation.

Request to change information about a Resource resource.

Represents an API resource.

UpdateResourceRequest is a API request type for the UpdateResource API operation.

Request to update an existing RestApi resource in your collection.

Represents a REST API.

UpdateRestApiRequest is a API request type for the UpdateRestApi API operation.

Requests API Gateway to change information about a Stage resource.

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

UpdateStageRequest is a API request type for the UpdateStage API operation.

The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Represents the usage data of a usage plan.

The PATCH request to update a usage plan of a given plan Id.

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

UpdateUsagePlanRequest is a API request type for the UpdateUsagePlan API operation.

UpdateUsageRequest is a API request type for the UpdateUsage API operation.

Updates an existing VpcLink of a specified identifier.

A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

UpdateVpcLinkRequest is a API request type for the UpdateVpcLink API operation.

The authorizer type.

Returns the size of the CacheCluster.

Returns the status of the CacheCluster.

The endpoint type.

The integration type.