Crate rusoto_apigateway

Crate rusoto_apigateway 

Source
Expand description

Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

If you’re using the service, you’re probably looking for ApiGatewayClient and ApiGateway.

Structs§

AccessLogSettings

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

Account

Represents an AWS account that is associated with API Gateway.

To view the account info, call GET on this resource.

Error Codes

The following exception may be thrown when the request fails.

  • UnauthorizedException
  • NotFoundException
  • TooManyRequestsException

For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes

Example: Get the information about an account.

Request
GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={accesskeyID}/us-east-1/apigateway/aws4request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } }

In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

API Gateway Limits Developer Guide, AWS CLI

ApiGatewayClient
A client for the Amazon API Gateway API.
ApiKey

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.

Use API Keys

ApiKeyIds

The identifier of an ApiKey used in a UsagePlan.

ApiKeys

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

Use API Keys

ApiStage

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

Authorizer

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

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer

Authorizers

Represents a collection of Authorizer resources.

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer

BasePathMapping

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

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.
Use Custom Domain Names

BasePathMappings

Represents a collection of BasePathMapping resources.

Use Custom Domain Names

CanarySettings

Configuration settings of a canary deployment.

ClientCertificate

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

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.
Use Client-Side Certificate

ClientCertificates

Represents a collection of ClientCertificate resources.

Use Client-Side Certificate

CreateApiKeyRequest

Request to create an ApiKey resource.

CreateAuthorizerRequest

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

CreateBasePathMappingRequest

Requests API Gateway to create a new BasePathMapping resource.

CreateDeploymentRequest

Requests API Gateway to create a Deployment resource.

CreateDocumentationPartRequest

Creates a new documentation part of a given API.

CreateDocumentationVersionRequest

Creates a new documentation version of a given API.

CreateDomainNameRequest

A request to create a new domain name.

CreateModelRequest

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

CreateRequestValidatorRequest

Creates a RequestValidator of a given RestApi.

CreateResourceRequest

Requests API Gateway to create a Resource resource.

CreateRestApiRequest

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

CreateStageRequest

Requests API Gateway to create a Stage resource.

CreateUsagePlanKeyRequest

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

CreateUsagePlanRequest

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.

CreateVpcLinkRequest

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.

DeleteApiKeyRequest

A request to delete the ApiKey resource.

DeleteAuthorizerRequest

Request to delete an existing Authorizer resource.

DeleteBasePathMappingRequest

A request to delete the BasePathMapping resource.

DeleteClientCertificateRequest

A request to delete the ClientCertificate resource.

DeleteDeploymentRequest

Requests API Gateway to delete a Deployment resource.

DeleteDocumentationPartRequest

Deletes an existing documentation part of an API.

DeleteDocumentationVersionRequest

Deletes an existing documentation version of an API.

DeleteDomainNameRequest

A request to delete the DomainName resource.

DeleteGatewayResponseRequest

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

DeleteIntegrationRequest

Represents a delete integration request.

DeleteIntegrationResponseRequest

Represents a delete integration response request.

DeleteMethodRequest

Request to delete an existing Method resource.

DeleteMethodResponseRequest

A request to delete an existing MethodResponse resource.

DeleteModelRequest

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

DeleteRequestValidatorRequest

Deletes a specified RequestValidator of a given RestApi.

DeleteResourceRequest

Request to delete a Resource.

DeleteRestApiRequest

Request to delete the specified API from your collection.

DeleteStageRequest

Requests API Gateway to delete a Stage resource.

DeleteUsagePlanKeyRequest

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

DeleteUsagePlanRequest

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

DeleteVpcLinkRequest

Deletes an existing VpcLink of a specified identifier.

Deployment

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.

To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapiid}/deployments/{deploymentid}).
RestApi, Deployments, Stage, AWS CLI, AWS SDKs

DeploymentCanarySettings

The input configuration for a canary deployment.

Deployments

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.

To create a new deployment of a RestApi, make a POST request against this resource. To view, update, or delete an existing deployment, make a GET, PATCH, or DELETE request, respectively, on a specified Deployment resource.
Deploying an API, AWS CLI, AWS SDKs

DocumentationPart

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATHPARAMETER, QUERYPARAMETER, REQUESTHEADER, REQUESTBODY, RESPONSE, RESPONSEHEADER, and RESPONSEBODY. Valid location fields depend on the API entity type. All valid fields are not required.

The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.

Documenting an API, DocumentationParts

DocumentationPartIds

A collection of the imported DocumentationPart identifiers.

This is used to return the result when documentation parts in an external (e.g., OpenAPI) file are imported into API Gateway
Documenting an API, documentationpart:import, DocumentationPart

DocumentationPartLocation

Specifies the target API entity to which the documentation applies.

DocumentationParts

The collection of documentation parts of an API.

Documenting an API, DocumentationPart

DocumentationVersion

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.

Documenting an API, DocumentationPart, DocumentationVersions

DocumentationVersions

The collection of documentation snapshots of an API.

Use the DocumentationVersions to manage documentation snapshots associated with various API stages.

Documenting an API, DocumentationPart, DocumentationVersion

DomainName

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

When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.

Set a Custom Host Name for an API

DomainNames

Represents a collection of DomainName resources.

Use Client-Side Certificate

EndpointConfiguration

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

ExportResponse

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

FlushStageAuthorizersCacheRequest

Request to flush authorizer cache entries on a specified stage.

FlushStageCacheRequest

Requests API Gateway to flush a stage's cache.

GatewayResponse

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

For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway

Example: Get a Gateway Response of a given response type

Request

This example shows how to get a gateway response of the MISSINGAUTHENTICATIONTOKEN type.

GET /restapis/o81lxisefl/gatewayresponses/MISSINGAUTHENTICATIONTOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45

The response type is specified as a URL path.

Response

The successful operation returns the 200 OK status code and a payload similar to the following:

{ "links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSINGAUTHENTICATIONTOKEN" }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSINGAUTHENTICATIONTOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSINGAUTHENTICATIONTOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{\n "message": $context.error.messageString,\n "type": "$context.error.responseType",\n "stage": "$context.stage",\n "resourcePath": "$context.resourcePath",\n "stageVariables.a": "$stageVariables.a",\n "statusCode": "'404'"\n}" }, "responseType": "MISSINGAUTHENTICATION_TOKEN", "statusCode": "404" }

Customize Gateway Responses

GatewayResponses

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.

For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway

Example: Get the collection of gateway responses of an API

Request

This example request shows how to retrieve the GatewayResponses collection from an API.

GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515

Response

The successful operation returns the 200 OK status code and a payload similar to the following:

{ "links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "first": { "href": "/restapis/o81lxisefl/gatewayresponses" }, "gatewayresponse:by-type": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATIONFAILURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCENOTFOUND" }, { "href": "/restapis/o81lxisefl/gatewayresponses/REQUESTTOOLARGE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTEDMEDIATYPE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZERCONFIGURATIONERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT5XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT4XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BADREQUESTPARAMETERS" }, { "href": "/restapis/o81lxisefl/gatewayresponses/BADREQUESTBODY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIREDTOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESSDENIED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALIDAPIKEY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/APICONFIGURATIONERROR" }, { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTAEXCEEDED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATIONTIMEOUT" }, { "href": "/restapis/o81lxisefl/gatewayresponses/MISSINGAUTHENTICATIONTOKEN" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALIDSIGNATURE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZERFAILURE" } ] }, "embedded": { "item": [ { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATIONFAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATIONFAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "INTEGRATIONFAILURE", "statusCode": "504" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCENOTFOUND" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCENOTFOUND" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "RESOURCENOTFOUND", "statusCode": "404" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUESTTOOLARGE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUESTTOOLARGE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "REQUESTTOOLARGE", "statusCode": "413" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "THROTTLED", "statusCode": "429" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTEDMEDIATYPE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTEDMEDIATYPE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "UNSUPPORTEDMEDIATYPE", "statusCode": "415" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZERCONFIGURATIONERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZERCONFIGURATIONERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "AUTHORIZERCONFIGURATIONERROR", "statusCode": "500" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT5XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT5XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "DEFAULT5XX" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT4XX" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT4XX" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "DEFAULT4XX" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BADREQUESTPARAMETERS" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BADREQUESTPARAMETERS" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "BADREQUESTPARAMETERS", "statusCode": "400" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BADREQUESTBODY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BADREQUESTBODY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "BADREQUESTBODY", "statusCode": "400" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIREDTOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIREDTOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "EXPIREDTOKEN", "statusCode": "403" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESSDENIED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESSDENIED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "ACCESSDENIED", "statusCode": "403" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALIDAPIKEY" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALIDAPIKEY" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "INVALIDAPIKEY", "statusCode": "403" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "UNAUTHORIZED", "statusCode": "401" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/APICONFIGURATIONERROR" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/APICONFIGURATIONERROR" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "APICONFIGURATIONERROR", "statusCode": "500" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTAEXCEEDED" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTAEXCEEDED" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "QUOTAEXCEEDED", "statusCode": "429" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATIONTIMEOUT" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATIONTIMEOUT" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "INTEGRATIONTIMEOUT", "statusCode": "504" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSINGAUTHENTICATIONTOKEN" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSINGAUTHENTICATIONTOKEN" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "MISSINGAUTHENTICATIONTOKEN", "statusCode": "403" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALIDSIGNATURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALIDSIGNATURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "INVALIDSIGNATURE", "statusCode": "403" }, { "links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZERFAILURE" }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{responsetype}", "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZERFAILURE" } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json": "{"message":$context.error.messageString}" }, "responseType": "AUTHORIZERFAILURE", "statusCode": "500" } ] } }

Customize Gateway Responses

GenerateClientCertificateRequest

A request to generate a ClientCertificate resource.

GetAccountRequest

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

GetApiKeyRequest

A request to get information about the current ApiKey resource.

GetApiKeysRequest

A request to get information about the current ApiKeys resource.

GetAuthorizerRequest

Request to describe an existing Authorizer resource.

GetAuthorizersRequest

Request to describe an existing Authorizers resource.

GetBasePathMappingRequest

Request to describe a BasePathMapping resource.

GetBasePathMappingsRequest

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

GetClientCertificateRequest

A request to get information about the current ClientCertificate resource.

GetClientCertificatesRequest

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

GetDeploymentRequest

Requests API Gateway to get information about a Deployment resource.

GetDeploymentsRequest

Requests API Gateway to get information about a Deployments collection.

GetDocumentationPartRequest

Gets a specified documentation part of a given API.

GetDocumentationPartsRequest

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

GetDocumentationVersionRequest

Gets a documentation snapshot of an API.

GetDocumentationVersionsRequest

Gets the documentation versions of an API.

GetDomainNameRequest

Request to get the name of a DomainName resource.

GetDomainNamesRequest

Request to describe a collection of DomainName resources.

GetExportRequest

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

GetGatewayResponseRequest

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

GetGatewayResponsesRequest

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.

GetIntegrationRequest

Represents a request to get the integration configuration.

GetIntegrationResponseRequest

Represents a get integration response request.

GetMethodRequest

Request to describe an existing Method resource.

GetMethodResponseRequest

Request to describe a MethodResponse resource.

GetModelRequest

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

GetModelTemplateRequest

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

GetModelsRequest

Request to list existing Models defined for a RestApi resource.

GetRequestValidatorRequest

Gets a RequestValidator of a given RestApi.

GetRequestValidatorsRequest

Gets the RequestValidators collection of a given RestApi.

GetResourceRequest

Request to list information about a resource.

GetResourcesRequest

Request to list information about a collection of resources.

GetRestApiRequest

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

GetRestApisRequest

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

GetSdkRequest

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

GetSdkTypeRequest

Get an SdkType instance.

GetSdkTypesRequest

Get the SdkTypes collection.

GetStageRequest

Requests API Gateway to get information about a Stage resource.

GetStagesRequest

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

GetTagsRequest

Gets the Tags collection for a given resource.

GetUsagePlanKeyRequest

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

GetUsagePlanKeysRequest

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

GetUsagePlanRequest

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

GetUsagePlansRequest

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

GetUsageRequest

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

GetVpcLinkRequest

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

GetVpcLinksRequest

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

ImportApiKeysRequest

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

ImportDocumentationPartsRequest

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

ImportRestApiRequest

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

Integration

Represents an HTTP, HTTPPROXY, AWS, AWSPROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.
Creating an API

IntegrationResponse

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.

Creating an API

Method

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.

Example: Retrive the GET method on a specified resource

Request

The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri). 

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={accesskeyID}/20160603/us-east-1/apigateway/aws4request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ "links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{statuscode}", "templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "embedded": { "method:integration": { "links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{statuscode}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHENNOMATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "embedded": { "integration:responses": { "links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" }, "statusCode": "200" } } }, "method:responses": { "links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }

In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() helper function.

MethodResponse, Integration, IntegrationResponse, Resource, Set up an API's method

MethodResponse

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.

Example: A MethodResponse instance of an API

Request

The example request retrieves a MethodResponse of the 200 status code.

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={accesskeyID}/20160603/us-east-1/apigateway/aws4request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4hash}
Response

The successful response returns 200 OK status and a payload as follows:

{ "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }

Method, IntegrationResponse, Integration Creating an API

MethodSetting

Specifies the method setting properties.

MethodSnapshot

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

Model

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

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings

Models

Represents a collection of Model resources.

Method, MethodResponse, Models and Mappings

MutualTlsAuthentication

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.

MutualTlsAuthenticationInput

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.

PatchOperation

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.

PutGatewayResponseRequest

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

PutIntegrationRequest

Sets up a method's integration.

PutIntegrationResponseRequest

Represents a put integration response request.

PutMethodRequest

Request to add a method to an existing Resource resource.

PutMethodResponseRequest

Request to add a MethodResponse to an existing Method resource.

PutRestApiRequest

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

QuotaSettings

Quotas configured for a usage plan.

RequestValidator

A set of validation rules for incoming Method requests.

In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.

Enable Basic Request Validation in API Gateway

RequestValidators

A collection of RequestValidator resources of a given RestApi.

In OpenAPI, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators extension.

Enable Basic Request Validation in API Gateway

Resource

Represents an API resource.

Create an API

Resources

Represents a collection of Resource resources.

Create an API

RestApi

Represents a REST API.

Create an API

RestApis

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.

Create an API

SdkConfigurationProperty

A configuration property of an SDK type.

SdkResponse

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

SdkType

A type of SDK that API Gateway can generate.

SdkTypes

The collection of SdkType instances.

Stage

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

Deploy an API

StageKey

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

Stages

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

Deploying API in Stages

TagResourceRequest

Adds or updates a tag on a given resource.

Tags

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

Template

Represents a mapping template used to transform a payload.

Mapping Templates

TestInvokeAuthorizerRequest

Make a request to simulate the execution of an Authorizer.

TestInvokeAuthorizerResponse

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

TestInvokeMethodRequest

Make a request to simulate the execution of a Method.

TestInvokeMethodResponse

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

Test API using the API Gateway console

ThrottleSettings

The API request rate limits.

TlsConfig
UntagResourceRequest

Removes a tag from a given resource.

UpdateAccountRequest

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

UpdateApiKeyRequest

A request to change information about an ApiKey resource.

UpdateAuthorizerRequest

Request to update an existing Authorizer resource.

UpdateBasePathMappingRequest

A request to change information about the BasePathMapping resource.

UpdateClientCertificateRequest

A request to change information about an ClientCertificate resource.

UpdateDeploymentRequest

Requests API Gateway to change information about a Deployment resource.

UpdateDocumentationPartRequest

Updates an existing documentation part of a given API.

UpdateDocumentationVersionRequest

Updates an existing documentation version of an API.

UpdateDomainNameRequest

A request to change information about the DomainName resource.

UpdateGatewayResponseRequest

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

UpdateIntegrationRequest

Represents an update integration request.

UpdateIntegrationResponseRequest

Represents an update integration response request.

UpdateMethodRequest

Request to update an existing Method resource.

UpdateMethodResponseRequest

A request to update an existing MethodResponse resource.

UpdateModelRequest

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

UpdateRequestValidatorRequest

Updates a RequestValidator of a given RestApi.

UpdateResourceRequest

Request to change information about a Resource resource.

UpdateRestApiRequest

Request to update an existing RestApi resource in your collection.

UpdateStageRequest

Requests API Gateway to change information about a Stage resource.

UpdateUsagePlanRequest

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

UpdateUsageRequest

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

UpdateVpcLinkRequest

Updates an existing VpcLink of a specified identifier.

Usage

Represents the usage data of a usage plan.

Create and Use Usage Plans, Manage Usage in a Usage Plan

UsagePlan

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

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

Create and Use Usage Plans

UsagePlanKey

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

"
Create and Use Usage Plans

UsagePlanKeys

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

Create and Use Usage Plans

UsagePlans

Represents a collection of usage plans for an AWS account.

Create and Use Usage Plans

VpcLink

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

To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTPPROXY and has a connection type of VPCLINK. The integration uses the connectionId property to identify the VpcLink used.

VpcLinks

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

Getting Started with Private Integrations, Set up Private Integrations

Enums§

CreateApiKeyError
Errors returned by CreateApiKey
CreateAuthorizerError
Errors returned by CreateAuthorizer
CreateBasePathMappingError
Errors returned by CreateBasePathMapping
CreateDeploymentError
Errors returned by CreateDeployment
CreateDocumentationPartError
Errors returned by CreateDocumentationPart
CreateDocumentationVersionError
Errors returned by CreateDocumentationVersion
CreateDomainNameError
Errors returned by CreateDomainName
CreateModelError
Errors returned by CreateModel
CreateRequestValidatorError
Errors returned by CreateRequestValidator
CreateResourceError
Errors returned by CreateResource
CreateRestApiError
Errors returned by CreateRestApi
CreateStageError
Errors returned by CreateStage
CreateUsagePlanError
Errors returned by CreateUsagePlan
CreateUsagePlanKeyError
Errors returned by CreateUsagePlanKey
CreateVpcLinkError
Errors returned by CreateVpcLink
DeleteApiKeyError
Errors returned by DeleteApiKey
DeleteAuthorizerError
Errors returned by DeleteAuthorizer
DeleteBasePathMappingError
Errors returned by DeleteBasePathMapping
DeleteClientCertificateError
Errors returned by DeleteClientCertificate
DeleteDeploymentError
Errors returned by DeleteDeployment
DeleteDocumentationPartError
Errors returned by DeleteDocumentationPart
DeleteDocumentationVersionError
Errors returned by DeleteDocumentationVersion
DeleteDomainNameError
Errors returned by DeleteDomainName
DeleteGatewayResponseError
Errors returned by DeleteGatewayResponse
DeleteIntegrationError
Errors returned by DeleteIntegration
DeleteIntegrationResponseError
Errors returned by DeleteIntegrationResponse
DeleteMethodError
Errors returned by DeleteMethod
DeleteMethodResponseError
Errors returned by DeleteMethodResponse
DeleteModelError
Errors returned by DeleteModel
DeleteRequestValidatorError
Errors returned by DeleteRequestValidator
DeleteResourceError
Errors returned by DeleteResource
DeleteRestApiError
Errors returned by DeleteRestApi
DeleteStageError
Errors returned by DeleteStage
DeleteUsagePlanError
Errors returned by DeleteUsagePlan
DeleteUsagePlanKeyError
Errors returned by DeleteUsagePlanKey
DeleteVpcLinkError
Errors returned by DeleteVpcLink
FlushStageAuthorizersCacheError
Errors returned by FlushStageAuthorizersCache
FlushStageCacheError
Errors returned by FlushStageCache
GenerateClientCertificateError
Errors returned by GenerateClientCertificate
GetAccountError
Errors returned by GetAccount
GetApiKeyError
Errors returned by GetApiKey
GetApiKeysError
Errors returned by GetApiKeys
GetAuthorizerError
Errors returned by GetAuthorizer
GetAuthorizersError
Errors returned by GetAuthorizers
GetBasePathMappingError
Errors returned by GetBasePathMapping
GetBasePathMappingsError
Errors returned by GetBasePathMappings
GetClientCertificateError
Errors returned by GetClientCertificate
GetClientCertificatesError
Errors returned by GetClientCertificates
GetDeploymentError
Errors returned by GetDeployment
GetDeploymentsError
Errors returned by GetDeployments
GetDocumentationPartError
Errors returned by GetDocumentationPart
GetDocumentationPartsError
Errors returned by GetDocumentationParts
GetDocumentationVersionError
Errors returned by GetDocumentationVersion
GetDocumentationVersionsError
Errors returned by GetDocumentationVersions
GetDomainNameError
Errors returned by GetDomainName
GetDomainNamesError
Errors returned by GetDomainNames
GetExportError
Errors returned by GetExport
GetGatewayResponseError
Errors returned by GetGatewayResponse
GetGatewayResponsesError
Errors returned by GetGatewayResponses
GetIntegrationError
Errors returned by GetIntegration
GetIntegrationResponseError
Errors returned by GetIntegrationResponse
GetMethodError
Errors returned by GetMethod
GetMethodResponseError
Errors returned by GetMethodResponse
GetModelError
Errors returned by GetModel
GetModelTemplateError
Errors returned by GetModelTemplate
GetModelsError
Errors returned by GetModels
GetRequestValidatorError
Errors returned by GetRequestValidator
GetRequestValidatorsError
Errors returned by GetRequestValidators
GetResourceError
Errors returned by GetResource
GetResourcesError
Errors returned by GetResources
GetRestApiError
Errors returned by GetRestApi
GetRestApisError
Errors returned by GetRestApis
GetSdkError
Errors returned by GetSdk
GetSdkTypeError
Errors returned by GetSdkType
GetSdkTypesError
Errors returned by GetSdkTypes
GetStageError
Errors returned by GetStage
GetStagesError
Errors returned by GetStages
GetTagsError
Errors returned by GetTags
GetUsageError
Errors returned by GetUsage
GetUsagePlanError
Errors returned by GetUsagePlan
GetUsagePlanKeyError
Errors returned by GetUsagePlanKey
GetUsagePlanKeysError
Errors returned by GetUsagePlanKeys
GetUsagePlansError
Errors returned by GetUsagePlans
GetVpcLinkError
Errors returned by GetVpcLink
GetVpcLinksError
Errors returned by GetVpcLinks
ImportApiKeysError
Errors returned by ImportApiKeys
ImportDocumentationPartsError
Errors returned by ImportDocumentationParts
ImportRestApiError
Errors returned by ImportRestApi
PutGatewayResponseError
Errors returned by PutGatewayResponse
PutIntegrationError
Errors returned by PutIntegration
PutIntegrationResponseError
Errors returned by PutIntegrationResponse
PutMethodError
Errors returned by PutMethod
PutMethodResponseError
Errors returned by PutMethodResponse
PutRestApiError
Errors returned by PutRestApi
TagResourceError
Errors returned by TagResource
TestInvokeAuthorizerError
Errors returned by TestInvokeAuthorizer
TestInvokeMethodError
Errors returned by TestInvokeMethod
UntagResourceError
Errors returned by UntagResource
UpdateAccountError
Errors returned by UpdateAccount
UpdateApiKeyError
Errors returned by UpdateApiKey
UpdateAuthorizerError
Errors returned by UpdateAuthorizer
UpdateBasePathMappingError
Errors returned by UpdateBasePathMapping
UpdateClientCertificateError
Errors returned by UpdateClientCertificate
UpdateDeploymentError
Errors returned by UpdateDeployment
UpdateDocumentationPartError
Errors returned by UpdateDocumentationPart
UpdateDocumentationVersionError
Errors returned by UpdateDocumentationVersion
UpdateDomainNameError
Errors returned by UpdateDomainName
UpdateGatewayResponseError
Errors returned by UpdateGatewayResponse
UpdateIntegrationError
Errors returned by UpdateIntegration
UpdateIntegrationResponseError
Errors returned by UpdateIntegrationResponse
UpdateMethodError
Errors returned by UpdateMethod
UpdateMethodResponseError
Errors returned by UpdateMethodResponse
UpdateModelError
Errors returned by UpdateModel
UpdateRequestValidatorError
Errors returned by UpdateRequestValidator
UpdateResourceError
Errors returned by UpdateResource
UpdateRestApiError
Errors returned by UpdateRestApi
UpdateStageError
Errors returned by UpdateStage
UpdateUsageError
Errors returned by UpdateUsage
UpdateUsagePlanError
Errors returned by UpdateUsagePlan
UpdateVpcLinkError
Errors returned by UpdateVpcLink

Traits§

ApiGateway
Trait representing the capabilities of the Amazon API Gateway API. Amazon API Gateway clients implement this trait.