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

ApiKeysFormat_Values returns all elements of the ApiKeysFormat enum.

ApiKeySourceType_Values returns all elements of the ApiKeySourceType enum.

AuthorizerType_Values returns all elements of the AuthorizerType enum.

CacheClusterSize_Values returns all elements of the CacheClusterSize enum.

CacheClusterStatus_Values returns all elements of the CacheClusterStatus enum.

ConnectionType_Values returns all elements of the ConnectionType enum.

ContentHandlingStrategy_Values returns all elements of the ContentHandlingStrategy enum.

DocumentationPartType_Values returns all elements of the DocumentationPartType enum.

DomainNameStatus_Values returns all elements of the DomainNameStatus enum.

EndpointType_Values returns all elements of the EndpointType enum.

GatewayResponseType_Values returns all elements of the GatewayResponseType enum.

IntegrationType_Values returns all elements of the IntegrationType enum.

LocationStatusType_Values returns all elements of the LocationStatusType enum.

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

Op_Values returns all elements of the Op enum.

PutMode_Values returns all elements of the PutMode enum.

QuotaPeriodType_Values returns all elements of the QuotaPeriodType enum.

SecurityPolicy_Values returns all elements of the SecurityPolicy enum.

UnauthorizedCacheControlHeaderStrategy_Values returns all elements of the UnauthorizedCacheControlHeaderStrategy enum.

VpcLinkStatus_Values returns all elements of the VpcLinkStatus enum.

ApiKeysFormatCsv is a ApiKeysFormat enum value.

ApiKeySourceTypeAuthorizer is a ApiKeySourceType enum value.

ApiKeySourceTypeHeader is a ApiKeySourceType enum value.

AuthorizerTypeCognitoUserPools is a AuthorizerType enum value.

AuthorizerTypeRequest is a AuthorizerType enum value.

AuthorizerTypeToken is a AuthorizerType enum value.

CacheClusterSize05 is a CacheClusterSize enum value.

CacheClusterSize118 is a CacheClusterSize enum value.

CacheClusterSize135 is a CacheClusterSize enum value.

CacheClusterSize16 is a CacheClusterSize enum value.

CacheClusterSize237 is a CacheClusterSize enum value.

CacheClusterSize284 is a CacheClusterSize enum value.

CacheClusterSize582 is a CacheClusterSize enum value.

CacheClusterSize61 is a CacheClusterSize enum value.

CacheClusterStatusAvailable is a CacheClusterStatus enum value.

CacheClusterStatusCreateInProgress is a CacheClusterStatus enum value.

CacheClusterStatusDeleteInProgress is a CacheClusterStatus enum value.

CacheClusterStatusFlushInProgress is a CacheClusterStatus enum value.

CacheClusterStatusNotAvailable is a CacheClusterStatus enum value.

ConnectionTypeInternet is a ConnectionType enum value.

ConnectionTypeVpcLink is a ConnectionType enum value.

ContentHandlingStrategyConvertToBinary is a ContentHandlingStrategy enum value.

ContentHandlingStrategyConvertToText is a ContentHandlingStrategy enum value.

DocumentationPartTypeApi is a DocumentationPartType enum value.

DocumentationPartTypeAuthorizer is a DocumentationPartType enum value.

DocumentationPartTypeMethod is a DocumentationPartType enum value.

DocumentationPartTypeModel is a DocumentationPartType enum value.

DocumentationPartTypePathParameter is a DocumentationPartType enum value.

DocumentationPartTypeQueryParameter is a DocumentationPartType enum value.

DocumentationPartTypeRequestBody is a DocumentationPartType enum value.

DocumentationPartTypeRequestHeader is a DocumentationPartType enum value.

DocumentationPartTypeResource is a DocumentationPartType enum value.

DocumentationPartTypeResponse is a DocumentationPartType enum value.

DocumentationPartTypeResponseBody is a DocumentationPartType enum value.

DocumentationPartTypeResponseHeader is a DocumentationPartType enum value.

DomainNameStatusAvailable is a DomainNameStatus enum value.

DomainNameStatusPending is a DomainNameStatus enum value.

DomainNameStatusPendingCertificateReimport is a DomainNameStatus enum value.

DomainNameStatusPendingOwnershipVerification is a DomainNameStatus enum value.

DomainNameStatusUpdating is a DomainNameStatus enum value.

ID to lookup a service endpoint with.

EndpointTypeEdge is a EndpointType enum value.

EndpointTypePrivate is a EndpointType enum value.

EndpointTypeRegional is a EndpointType enum value.

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".

GatewayResponseTypeAccessDenied is a GatewayResponseType enum value.

GatewayResponseTypeApiConfigurationError is a GatewayResponseType enum value.

GatewayResponseTypeAuthorizerConfigurationError is a GatewayResponseType enum value.

GatewayResponseTypeAuthorizerFailure is a GatewayResponseType enum value.

GatewayResponseTypeBadRequestBody is a GatewayResponseType enum value.

GatewayResponseTypeBadRequestParameters is a GatewayResponseType enum value.

GatewayResponseTypeDefault4xx is a GatewayResponseType enum value.

GatewayResponseTypeDefault5xx is a GatewayResponseType enum value.

GatewayResponseTypeExpiredToken is a GatewayResponseType enum value.

GatewayResponseTypeIntegrationFailure is a GatewayResponseType enum value.

GatewayResponseTypeIntegrationTimeout is a GatewayResponseType enum value.

GatewayResponseTypeInvalidApiKey is a GatewayResponseType enum value.

GatewayResponseTypeInvalidSignature is a GatewayResponseType enum value.

GatewayResponseTypeMissingAuthenticationToken is a GatewayResponseType enum value.

GatewayResponseTypeQuotaExceeded is a GatewayResponseType enum value.

GatewayResponseTypeRequestTooLarge is a GatewayResponseType enum value.

GatewayResponseTypeResourceNotFound is a GatewayResponseType enum value.

GatewayResponseTypeThrottled is a GatewayResponseType enum value.

GatewayResponseTypeUnauthorized is a GatewayResponseType enum value.

GatewayResponseTypeUnsupportedMediaType is a GatewayResponseType enum value.

GatewayResponseTypeWafFiltered is a GatewayResponseType enum value.

IntegrationTypeAws is a IntegrationType enum value.

IntegrationTypeAwsProxy is a IntegrationType enum value.

IntegrationTypeHttp is a IntegrationType enum value.

IntegrationTypeHttpProxy is a IntegrationType enum value.

IntegrationTypeMock is a IntegrationType enum value.

LocationStatusTypeDocumented is a LocationStatusType enum value.

LocationStatusTypeUndocumented is a LocationStatusType enum value.

OpAdd is a Op enum value.

OpCopy is a Op enum value.

OpMove is a Op enum value.

OpRemove is a Op enum value.

OpReplace is a Op enum value.

OpTest is a Op enum value.

PutModeMerge is a PutMode enum value.

PutModeOverwrite is a PutMode enum value.

QuotaPeriodTypeDay is a QuotaPeriodType enum value.

QuotaPeriodTypeMonth is a QuotaPeriodType enum value.

QuotaPeriodTypeWeek is a QuotaPeriodType enum value.

SecurityPolicyTls10 is a SecurityPolicy enum value.

SecurityPolicyTls12 is a SecurityPolicy enum value.

ServiceID is a unique identifier of a specific service.

Name of service.

UnauthorizedCacheControlHeaderStrategyFailWith403 is a UnauthorizedCacheControlHeaderStrategy enum value.

UnauthorizedCacheControlHeaderStrategySucceedWithoutResponseHeader is a UnauthorizedCacheControlHeaderStrategy enum value.

UnauthorizedCacheControlHeaderStrategySucceedWithResponseHeader is a UnauthorizedCacheControlHeaderStrategy enum value.

VpcLinkStatusAvailable is a VpcLinkStatus enum value.

VpcLinkStatusDeleting is a VpcLinkStatus enum value.

VpcLinkStatusFailed is a VpcLinkStatus enum value.

VpcLinkStatusPending is a VpcLinkStatus enum value.

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

Represents an AWS account that is associated with API Gateway.

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

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

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

Represents an authorization layer for methods.

The submitted request is not valid, for example, the input is incomplete or incorrect.

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

Configuration settings of a canary deployment.

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

The request configuration has conflicts.

Request to create an ApiKey resource.

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

Requests API Gateway to create a new BasePathMapping resource.

Requests API Gateway to create a Deployment resource.

Creates a new documentation part of a given API.

Creates a new documentation version of a given API.

A request to create a new domain name.

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

Creates a RequestValidator of a given RestApi.

Requests API Gateway to create a Resource resource.

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

Requests API Gateway to create a Stage resource.

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.

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.

A request to delete the ApiKey resource.

Request to delete an existing Authorizer resource.

A request to delete the BasePathMapping resource.

A request to delete the ClientCertificate resource.

Requests API Gateway to delete a Deployment resource.

Deletes an existing documentation part of an API.

Deletes an existing documentation version of an API.

A request to delete the DomainName resource.

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

Represents a delete integration request.

Represents a delete integration response request.

Request to delete an existing Method resource.

A request to delete an existing MethodResponse resource.

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

Deletes a specified RequestValidator of a given RestApi.

Request to delete a Resource.

Request to delete the specified API from your collection.

Requests API Gateway to delete a Stage resource.

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.

Deletes an existing VpcLink of a specified identifier.

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

The input configuration for a canary deployment.

A documentation part for a targeted API entity.

Specifies the target API entity to which the documentation applies.

A snapshot of the documentation of an API.

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

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.

Requests API Gateway to flush a stage's cache.

A request to generate a ClientCertificate resource.

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

A request to get information about the current ApiKey resource.

A request to get information about the current ApiKeys resource.

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

Request to describe an existing Authorizer resource.

Request to describe an existing Authorizers resource.

Represents a collection of Authorizer resources.

Request to describe a BasePathMapping resource.

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

Represents a collection of BasePathMapping resources.

A request to get information about the current ClientCertificate resource.

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

Represents a collection of ClientCertificate resources.

Requests API Gateway to get information about a Deployment resource.

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.

Gets a specified documentation part of a given API.

Gets the documentation parts of an API.

The collection of documentation parts of an API.

Gets a documentation snapshot of an API.

Gets the documentation versions of an API.

The collection of documentation snapshots of an API.

Request to get the name of a DomainName resource.

Request to describe a collection of DomainName resources.

Represents a collection of DomainName resources.

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

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

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

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.

Represents a request to get the integration configuration.

Represents a get integration response request.

Request to describe an existing Method resource.

Request to describe a MethodResponse resource.

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

Request to list existing Models defined for a RestApi resource.

Represents a collection of Model resources.

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

Represents a mapping template used to transform a payload.

Gets a RequestValidator of a given RestApi.

Gets the RequestValidators collection of a given RestApi.

A collection of RequestValidator resources of a given RestApi.

Request to list information about a resource.

Request to list information about a collection of resources.

Represents a collection of Resource resources.

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

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.

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

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

Get an SdkType instance.

Get the SdkTypes collection.

The collection of SdkType instances.

Requests API Gateway to get information about a Stage resource.

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

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

Gets the Tags collection for a given resource.

The collection of tags.

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

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.

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.

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

Represents a collection of usage plans for an AWS account.

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

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.

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.

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

A collection of the imported DocumentationPart identifiers.

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

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

Represents an integration response.

The request exceeded the rate limit.

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

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

Specifies the method setting properties.

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

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

The mutual TLS authentication configuration for a custom domain name.

The mutual TLS authentication configuration for a custom domain name.

The requested resource is not found.

For more information about supported patch operations, see Patch Operations (https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html).

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

Sets up a method's integration.

Represents a put integration response request.

Request to add a method to an existing Resource resource.

Request to add a MethodResponse to an existing Method resource.

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

Quotas configured for a usage plan.

Represents an API resource.

Represents a REST API.

A configuration property of an SDK type.

A type of SDK that API Gateway can generate.

The requested service is not available.

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

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

Adds or updates a tag on a given resource.

Make a request to simulate the invocation of an Authorizer.

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

Make a request to simulate the invocation of a Method.

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

The API request rate limits.

Specifies the TLS configuration for an integration.

The request has reached its throttling limit.

The request is denied because the caller has insufficient permissions.

Removes a tag from a given resource.

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

A request to change information about an ApiKey resource.

Request to update an existing Authorizer resource.

A request to change information about the BasePathMapping resource.

A request to change information about an ClientCertificate resource.

Requests API Gateway to change information about a Deployment resource.

Updates an existing documentation part of a given API.

Updates an existing documentation version of an API.

A request to change information about the DomainName resource.

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.

Represents an update integration request.

Represents an update integration response request.

Request to update an existing Method resource.

A request to update an existing MethodResponse resource.

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

Updates a RequestValidator of a given RestApi.

A set of validation rules for incoming Method requests.

Request to change information about a Resource resource.

Request to update an existing RestApi resource in your collection.

Requests API Gateway to change information about a Stage resource.

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

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

Updates an existing VpcLink of a specified identifier.

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

Represents the usage data of a usage plan.

Represents a usage plan used to specify who can assess associated API stages.

Represents a usage plan key to identify a plan customer.