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

TODO: Failed to render documentation: unhandled paragraph inner tag h4

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.

The identifier of an "ApiKey" used in a "UsagePlan".

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

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

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Represents a collection of "Authorizer" resources.

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

Represents a collection of "BasePathMapping" resources.

Configuration settings of a canary deployment.

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

Represents a collection of "ClientCertificate" resources.

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 key for adding an existing API key to a usage plan.

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.

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.

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.

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.

A documentation part for a targeted API entity.

A collection of the imported "DocumentationPart" identifiers.

Specifies the target API entity to which the documentation applies.

The collection of documentation parts of an API.

A snapshot of the documentation of an API.

The collection of documentation snapshots of an API.

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

Represents a collection of "DomainName" resources.

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

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

Request to flush authorizer cache entries on a specified stage.

Requests API Gateway to flush a stage's cache.

TODO: Failed to render documentation: unhandled paragraph inner tag div

TODO: Failed to render documentation: unhandled paragraph inner tag div

A request to generate a "ClientCertificate" resource.

A request to get information about the current "ApiKey" resource.

A request to get information about the current "ApiKeys" resource.

Request to describe an existing "Authorizer" resource.

Request to describe an existing "Authorizers" resource.

Request to describe a "BasePathMapping" resource.

A request to get information about 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.

Requests API Gateway to get information about a "Deployment" resource.

Requests API Gateway to get information about a "Deployments" collection.

Gets a specified documentation part of a given API.

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

Gets a documentation snapshot of an API.

Gets the documentation versions of an API.

Request to get the name of a "DomainName" resource.

Request to describe a collection of "DomainName" resources.

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

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

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.

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.

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

Gets a "RequestValidator" of a given "RestApi".

Gets the "RequestValidators" collection of a given "RestApi".

Request to list information about a resource.

Request to list information about a collection of resources.

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

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

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

Get an "SdkType" instance.

Get the "SdkTypes" collection.

Requests API Gateway to get information about a "Stage" resource.

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

Gets the "Tags" collection for a given resource.

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.

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

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

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

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 POST request to import API keys from an external source, such as a CSV-formatted file.

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

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 status code must map to an existing "MethodResponse", and parameters and templates can be used to transform the back-end response.

TODO: Failed to render documentation: unhandled paragraph inner tag h4

TODO: Failed to render documentation: unhandled paragraph inner tag h4

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.

Represents a collection of "Model" resources.

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your 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 custom domain name.

A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.

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.

A set of validation rules for incoming "Method" requests.

A collection of "RequestValidator" resources of a given "RestApi".

Represents an API resource.

Represents a collection of "Resource" resources.

Represents a REST API.

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.

A configuration property of an SDK type.

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

A type of SDK that API Gateway can generate.

The collection of "SdkType" instances.

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

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

Adds or updates a tag on a given resource.

The collection of tags. Each tag element is associated with a given resource.

Represents a mapping template used to transform a payload.

Make a request to simulate the execution of an "Authorizer".

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

Make a request to simulate the execution of a "Method".

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

The API request rate limits.

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

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

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 update a usage plan of a given plan Id.

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

Updates an existing "VpcLink" of a specified identifier.

Represents the usage data of a usage plan.

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 AWS Budgets to monitor costs and AWS WAF to manage API requests.

Represents a usage plan key to identify a plan customer.

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

Represents a collection of usage plans for an AWS account.

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

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

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.

Returns the size of the CacheCluster.

Returns the status of the CacheCluster.

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.

The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS 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.