Awso_apigateway.ValuesSourceval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
The request configuration has conflicts. For details, see the accompanying error message.
The request exceeded the rate limit. Retry after the specified time period.
The requested resource is not found. Make sure that the request URI is correct.
The status code.
The request has reached its throttling limit. Retry after the specified time period.
The request is denied because the caller has insufficient permissions.
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 API request rate limits.
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.
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
Represents a summary of a Method resource, given a particular date and time.
Specifies the method setting properties.
A configuration property of an SDK type.
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.
Quotas configured for a usage plan.
Access log settings, including the access log format and access log destination ARN.
Configuration settings of a canary deployment.
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 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.
Specifies the target API entity to which the documentation applies.
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
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.
For more information about supported patch operations, see Patch Operations.
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
A set of validation rules for incoming Method requests.
Represents the data structure of a method's request or response payload.
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
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.
A snapshot of the documentation of an API.
A documentation part for a targeted API entity.
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.
A reference to a unique stage identified in the format {restApiId}/{stage}.
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Represents the base path that callers of the API must provide as part of the URL after the domain name.
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
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 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 input configuration for a canary deployment.
The collection of VPC links under the caller's account in a region.
Represents a collection of usage plans for an AWS account.
Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.
Updates an existing VpcLink of a specified identifier.
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.
Requests API Gateway to change information about a Stage resource.
Request to update an existing RestApi resource in your collection.
Request to change information about a Resource resource.
Updates a RequestValidator of a given RestApi.
Request to update an existing model in an existing RestApi resource.
A request to update an existing MethodResponse resource.
Request to update an existing Method resource.
Represents an update integration response request.
Represents an update integration request.
Updates a GatewayResponse of a specified response type on the given RestApi.
A request to change information about the DomainName resource.
Updates an existing documentation version of an API.
Updates an existing documentation part of a given API.
Requests API Gateway to change information about a Deployment resource.
A request to change information about an ClientCertificate resource.
A request to change information about the BasePathMapping resource.
Request to update an existing Authorizer resource.
A request to change information about an ApiKey resource.
Requests API Gateway to change information about the current Account resource.
Removes a tag from a given resource.
Represents the response of the test invoke request in the HTTP method.
Make a request to simulate the invocation of a Method.
Represents the response of the test invoke request for a custom Authorizer
Make a request to simulate the invocation of an Authorizer.
The collection of tags. Each tag element is associated with a given resource.
Adds or updates a tag on a given resource.
A list of Stage resources that are associated with the ApiKey resource.
The binary blob response to GetSdk, which contains the generated SDK.
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 collection of RequestValidator resources of a given RestApi.
Rejects a domain name access association with a private custom domain name. To reject a domain name access association with an access association source in another AWS account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation.
A PUT request to update an existing API, with external API definitions specified as the request body.
Request to add a MethodResponse to an existing Method resource.
Request to add a method to an existing Resource resource.
Represents a put integration response request.
Sets up a method's integration.
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
A POST request to import an API to API Gateway using an input of an API definition file.
Import documentation parts from an external (e.g., OpenAPI) definition file.
The POST request to import API keys from an external source, such as a CSV-formatted file.
Gets the VpcLinks collection under the caller's account in a selected region.
Gets a specified VPC link under the caller's account in a region.
The GET request to get the usage data of a usage plan in a specified time interval.
The GET request to get all the usage plans of the caller's account.
The GET request to get a usage plan of a given plan 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 key of a given key identifier.
Gets the Tags collection for a given resource.
Requests API Gateway to get information about one or more Stage resources.
Requests API Gateway to get information about a Stage resource.
Get the SdkTypes collection.
Get an SdkType instance.
Request a new generated client SDK for a RestApi and Stage.
The GET request to list existing RestApis defined for your collection.
The GET request to list an existing RestApi defined for your collection.
Request to list information about a collection of resources.
Request to list information about a resource.
Gets the RequestValidators collection of a given RestApi.
Gets a RequestValidator of a given RestApi.
Request to list existing Models defined for a RestApi resource.
Request to generate a sample mapping template used to transform the payload.
Request to list information about a model in an existing RestApi resource.
Request to describe a MethodResponse resource.
Request to describe an existing Method resource.
Represents a get integration response request.
Represents a request to get the integration configuration.
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.
Gets a GatewayResponse of a specified response type on the given RestApi.
Request a new export of a RestApi for a particular Stage.
Request to describe a collection of DomainName resources.
Request to get the name of a DomainName resource.
Represents a collection on DomainNameAccessAssociations resources.
Gets the documentation versions of an API.
Gets a documentation snapshot of an 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 specified documentation part of a given API.
Requests API Gateway to get information about a Deployments collection.
Requests API Gateway to get information about a Deployment resource.
A request to get information about a collection of ClientCertificate resources.
A request to get information about the current ClientCertificate resource.
A request to get information about a collection of BasePathMapping resources.
Request to describe a BasePathMapping resource.
Request to describe an existing Authorizers resource.
Request to describe an existing Authorizer resource.
A request to get information about the current ApiKeys resource.
A request to get information about the current ApiKey resource.
Requests API Gateway to get information about the current Account resource.
A request to generate a ClientCertificate resource.
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.
Requests API Gateway to flush a stage's cache.
Request to flush authorizer cache entries on a specified stage.
The binary blob response to GetExport, which contains the generated SDK.
Represents a collection of DomainName resources.
Represents a collection on DomainNameAccessAssociations resources.
The collection of documentation snapshots of an API.
The collection of documentation parts of an API.
A collection of the imported DocumentationPart identifiers.
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.
Deletes an existing VpcLink of a specified identifier.
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.
Requests API Gateway to delete a Stage resource.
Request to delete the specified API from your collection.
Request to delete a Resource.
Deletes a specified RequestValidator of a given RestApi.
Request to delete an existing model in an existing RestApi resource.
A request to delete an existing MethodResponse resource.
Request to delete an existing Method resource.
Represents a delete integration response request.
Represents a delete integration request.
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
A request to delete the DomainName resource.
Deletes the DomainNameAccessAssociation resource. Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.
Deletes an existing documentation version of an API.
Deletes an existing documentation part of an API.
Requests API Gateway to delete a Deployment resource.
A request to delete the ClientCertificate resource.
A request to delete the BasePathMapping resource.
Request to delete an existing Authorizer resource.
A request to delete the ApiKey resource.
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.
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.
Requests API Gateway to create a Stage resource.
The POST Request to add a new RestApi resource to your collection.
Requests API Gateway to create a Resource resource.
Creates a RequestValidator of a given RestApi.
Request to add a new Model to an existing RestApi resource.
A request to create a new domain name.
Creates a domain name access association resource between an access association source and a private custom domain name.
Creates a new documentation version of a given API.
Creates a new documentation part of a given API.
Requests API Gateway to create a Deployment resource.
Requests API Gateway to create a new BasePathMapping resource.
Request to add a new Authorizer to an existing RestApi resource.
Request to create an ApiKey resource.
Represents a collection of ClientCertificate resources.
Represents a collection of BasePathMapping resources.
Represents a collection of Authorizer resources.
Represents a collection of API keys as represented by an ApiKeys resource.