Package-level declarations
Types
Access log settings, including the access log format and access log destination ARN.
Base class for all service related exceptions thrown by the ApiGateway client
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
Represents the base path that callers of the API must provide as part of the URL after the domain name.
Returns the size of the CacheCluster.
Returns the status of the CacheCluster.
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. For details, see the accompanying error message.
Request to create an ApiKey resource.
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
Request to add a new Authorizer to an existing RestApi resource.
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Requests API Gateway to create a new BasePathMapping resource.
Represents the base path that callers of the API must provide as part of the URL after the domain name.
Requests API Gateway to create a Deployment resource.
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
Creates a new documentation part of a given API.
A documentation part for a targeted API entity.
Creates a new documentation version of a given API.
A snapshot of the documentation of an API.
Represents a domain name access association between an access association source and a private custom domain name. With a domain name access association, an access association source can invoke a private custom domain name while isolated from the public internet.
A request to create a new domain name.
Represents a custom domain name as a user-friendly host name of an API (RestApi).
Request to add a new Model to an existing RestApi resource.
Represents the data structure of a method's request or response payload.
Creates a RequestValidator of a given RestApi.
A set of validation rules for incoming Method requests.
Requests API Gateway to create a Resource resource.
Represents an API resource.
The POST Request to add a new RestApi resource to your collection.
Represents a REST API.
Requests API Gateway to create a Stage resource.
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
The POST request to create a usage plan key for adding an existing API key to a usage plan.
Represents a usage plan key to identify a plan customer.
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.
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.
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. The caller must have permissions to create and update VPC Endpoint services.
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
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 key and remove the underlying API key from the associated usage plan.
The DELETE request to delete a usage plan of a given plan Id.
Deletes an existing VpcLink of a specified identifier.
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
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).
Represents a domain name access association between an access association source and a private custom domain name. With a domain name access association, an access association source can invoke a private custom domain name while isolated from the public internet.
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has and the IP address types that can invoke it.
The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.
Request to flush authorizer cache entries on a specified stage.
Requests API Gateway to flush a stage's cache.
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
A request to generate a ClientCertificate resource.
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Requests API Gateway to get information about the current Account resource.
Represents an AWS account that is associated with API Gateway.
A request to get information about the current ApiKey resource.
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
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.
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
Request to describe an existing Authorizers resource.
Represents a collection of Authorizer resources.
Request to describe a BasePathMapping resource.
Represents the base path that callers of the API must provide as part of the URL after the domain name.
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.
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
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.
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
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. The collection offers a paginated view of the contained deployments.
Gets a specified documentation part of a given API.
A documentation part for a targeted API entity.
Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).
The collection of documentation parts of an API.
Gets a documentation snapshot of an API.
A snapshot of the documentation 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.
Represents a custom domain name as a user-friendly host name of an API (RestApi).
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.
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.
Represents a request to get the integration configuration.
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Represents a get integration response request.
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Request to describe an existing Method resource.
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Request to describe a MethodResponse resource.
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
Request to list information about a model in an existing RestApi resource.
Represents the data structure of a method's request or response payload.
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.
A set of validation rules for incoming Method requests.
Gets the RequestValidators collection of a given RestApi.
A collection of RequestValidator resources of a given RestApi.
Request to list information about a resource.
Represents an API 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.
Represents a REST API.
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. A collection offers a paginated view of your APIs.
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.
A type of SDK that API Gateway can generate.
Get the SdkTypes collection.
The collection of SdkType instances.
Requests API Gateway to get information about a Stage resource.
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
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. Each tag element is associated with a given resource.
The GET request to get a usage plan key of a given key identifier.
Represents a usage plan key to identify a plan customer.
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 a usage plan of a given plan identifier.
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.
The GET request to get all the usage plans of the caller's account.
Represents a collection of usage plans for an AWS account.
The GET request to get the usage data of a usage plan in a specified time interval.
Represents the usage data of a usage plan.
Gets a specified VPC link under the caller's account in a region.
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
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 a REST API.
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any Amazon Web Services service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration.
The request exceeded the rate limit. Retry after the specified time period.
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
Specifies the method setting properties.
Represents a summary of a Method resource, given a particular date and time.
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
The requested resource is not found. Make sure that the request URI is correct.
For more information about supported patch operations, see Patch Operations.
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
Sets up a method's integration.
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Represents a put integration response request.
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Request to add a method to an existing Resource resource.
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Request to add a MethodResponse to an existing Method resource.
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
A PUT request to update an existing API, with external API definitions specified as the request body.
Represents a REST API.
Quotas configured for a usage plan.
A set of validation rules for incoming Method requests.
A configuration property of an SDK type.
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
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.
The request has reached its throttling limit. Retry after the specified time period.
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.
Represents an AWS account that is associated with API Gateway.
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. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
Request to update an existing Authorizer resource.
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
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.
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.
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. A deployment must be associated with a Stage for it to be callable over the Internet.
Updates an existing documentation part of a given API.
A documentation part for a targeted API entity.
Updates an existing documentation version of an API.
A snapshot of the documentation of an API.
A request to change information about the DomainName resource.
Represents a custom domain name as a user-friendly host name of an API (RestApi).
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 HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Represents an update integration response request.
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
Request to update an existing Method resource.
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
A request to update an existing MethodResponse resource.
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
Request to update an existing model in an existing RestApi resource.
Represents the data structure of a method's request or response payload.
Updates a RequestValidator of a given RestApi.
A set of validation rules for incoming Method requests.
Request to change information about a Resource resource.
Represents an API resource.
Request to update an existing RestApi resource in your collection.
Represents a REST API.
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.
The PATCH request to update a usage plan of a given plan Id.
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.
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.
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 a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.
Represents a usage plan key to identify a plan customer.