AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessLogSettings

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

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

Class ApiStage

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

Class Authorizer

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

Class BadRequestException

APIGateway exception

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

Class CanarySettings

Configuration settings of a canary deployment.

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

Class ConflictException

APIGateway exception

Class CreateApiKeyRequest

Container for the parameters to the CreateApiKey operation. Create an ApiKey resource.

Class CreateApiKeyResponse

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.

Class CreateAuthorizerRequest

Container for the parameters to the CreateAuthorizer operation. Adds a new Authorizer resource to an existing RestApi resource.

Class CreateAuthorizerResponse

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

Class CreateBasePathMappingRequest

Container for the parameters to the CreateBasePathMapping operation. Creates a new BasePathMapping resource.

Class CreateBasePathMappingResponse

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.

Class CreateDeploymentRequest

Container for the parameters to the CreateDeployment operation. Creates a Deployment resource, which makes a specified RestApi callable over the internet.

Class CreateDeploymentResponse

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/{restapi_id}/deployments/{deployment_id}).

Class CreateDocumentationPartRequest

Container for the parameters to the CreateDocumentationPart operation.

Class CreateDocumentationPartResponse

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, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. 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 Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Class CreateDocumentationVersionRequest

Container for the parameters to the CreateDocumentationVersion operation.

Class CreateDocumentationVersionResponse

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., Swagger) file.

Class CreateDomainNameRequest

Container for the parameters to the CreateDomainName operation. Creates a new domain name.

Class CreateDomainNameResponse

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.

Class CreateModelRequest

Container for the parameters to the CreateModel operation. Adds a new Model resource to an existing RestApi resource.

Class CreateModelResponse

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.

Class CreateRequestValidatorRequest

Container for the parameters to the CreateRequestValidator operation. Creates a ReqeustValidator of a given RestApi.

Class CreateRequestValidatorResponse

A set of validation rules for incoming Method requests.

In Swagger, 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.

Class CreateResourceRequest

Container for the parameters to the CreateResource operation. Creates a Resource resource.

Class CreateResourceResponse

Represents an API resource.

Class CreateRestApiRequest

Container for the parameters to the CreateRestApi operation. Creates a new RestApi resource.

Class CreateRestApiResponse

Represents a REST API.

Class CreateStageRequest

Container for the parameters to the CreateStage operation. Creates a new Stage resource that references a pre-existing Deployment for the API.

Class CreateStageResponse

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

Class CreateUsagePlanKeyRequest

Container for the parameters to the CreateUsagePlanKey operation. Creates a usage plan key for adding an existing API key to a usage plan.

Class CreateUsagePlanKeyResponse

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.

"

Class CreateUsagePlanRequest

Container for the parameters to the CreateUsagePlan operation. Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Class CreateUsagePlanResponse

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.

Class CreateVpcLinkRequest

Container for the parameters to the CreateVpcLink operation. 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.

Class CreateVpcLinkResponse

A 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 HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

Class DeleteApiKeyRequest

Container for the parameters to the DeleteApiKey operation. Deletes the ApiKey resource.

Class DeleteApiKeyResponse

This is the response object from the DeleteApiKey operation.

Class DeleteAuthorizerRequest

Container for the parameters to the DeleteAuthorizer operation. Deletes an existing Authorizer resource.

Class DeleteAuthorizerResponse

This is the response object from the DeleteAuthorizer operation.

Class DeleteBasePathMappingRequest

Container for the parameters to the DeleteBasePathMapping operation. Deletes the BasePathMapping resource.

Class DeleteBasePathMappingResponse

This is the response object from the DeleteBasePathMapping operation.

Class DeleteClientCertificateRequest

Container for the parameters to the DeleteClientCertificate operation. Deletes the ClientCertificate resource.

Class DeleteClientCertificateResponse

This is the response object from the DeleteClientCertificate operation.

Class DeleteDeploymentRequest

Container for the parameters to the DeleteDeployment operation. Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

Class DeleteDeploymentResponse

This is the response object from the DeleteDeployment operation.

Class DeleteDocumentationPartRequest

Container for the parameters to the DeleteDocumentationPart operation.

Class DeleteDocumentationPartResponse

This is the response object from the DeleteDocumentationPart operation.

Class DeleteDocumentationVersionRequest

Container for the parameters to the DeleteDocumentationVersion operation.

Class DeleteDocumentationVersionResponse

This is the response object from the DeleteDocumentationVersion operation.

Class DeleteDomainNameRequest

Container for the parameters to the DeleteDomainName operation. Deletes the DomainName resource.

Class DeleteDomainNameResponse

This is the response object from the DeleteDomainName operation.

Class DeleteGatewayResponseRequest

Container for the parameters to the DeleteGatewayResponse operation. Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

Class DeleteGatewayResponseResponse

This is the response object from the DeleteGatewayResponse operation.

Class DeleteIntegrationRequest

Container for the parameters to the DeleteIntegration operation. Represents a delete integration.

Class DeleteIntegrationResponse

This is the response object from the DeleteIntegration operation.

Class DeleteIntegrationResponseRequest

Container for the parameters to the DeleteIntegrationResponse operation. Represents a delete integration response.

Class DeleteIntegrationResponseResponse

This is the response object from the DeleteIntegrationResponse operation.

Class DeleteMethodRequest

Container for the parameters to the DeleteMethod operation. Deletes an existing Method resource.

Class DeleteMethodResponse

This is the response object from the DeleteMethod operation.

Class DeleteMethodResponseRequest

Container for the parameters to the DeleteMethodResponse operation. Deletes an existing MethodResponse resource.

Class DeleteMethodResponseResponse

This is the response object from the DeleteMethodResponse operation.

Class DeleteModelRequest

Container for the parameters to the DeleteModel operation. Deletes a model.

Class DeleteModelResponse

This is the response object from the DeleteModel operation.

Class DeleteRequestValidatorRequest

Container for the parameters to the DeleteRequestValidator operation. Deletes a RequestValidator of a given RestApi.

Class DeleteRequestValidatorResponse

This is the response object from the DeleteRequestValidator operation.

Class DeleteResourceRequest

Container for the parameters to the DeleteResource operation. Deletes a Resource resource.

Class DeleteResourceResponse

This is the response object from the DeleteResource operation.

Class DeleteRestApiRequest

Container for the parameters to the DeleteRestApi operation. Deletes the specified API.

Class DeleteRestApiResponse

This is the response object from the DeleteRestApi operation.

Class DeleteStageRequest

Container for the parameters to the DeleteStage operation. Deletes a Stage resource.

Class DeleteStageResponse

This is the response object from the DeleteStage operation.

Class DeleteUsagePlanKeyRequest

Container for the parameters to the DeleteUsagePlanKey operation. Deletes a usage plan key and remove the underlying API key from the associated usage plan.

Class DeleteUsagePlanKeyResponse

This is the response object from the DeleteUsagePlanKey operation.

Class DeleteUsagePlanRequest

Container for the parameters to the DeleteUsagePlan operation. Deletes a usage plan of a given plan Id.

Class DeleteUsagePlanResponse

This is the response object from the DeleteUsagePlan operation.

Class DeleteVpcLinkRequest

Container for the parameters to the DeleteVpcLink operation. Deletes an existing VpcLink of a specified identifier.

Class DeleteVpcLinkResponse

This is the response object from the DeleteVpcLink operation.

Class 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/{restapi_id}/deployments/{deployment_id}).

Class DeploymentCanarySettings

The input configuration for a canary deployment.

Class 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, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. 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 Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Class DocumentationPartLocation

Specifies the target API entity to which the documentation applies.

Class 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., Swagger) file.

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

Class EndpointConfiguration

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

Class FlushStageAuthorizersCacheRequest

Container for the parameters to the FlushStageAuthorizersCache operation. Flushes all authorizer cache entries on a stage.

Class FlushStageAuthorizersCacheResponse

This is the response object from the FlushStageAuthorizersCache operation.

Class FlushStageCacheRequest

Container for the parameters to the FlushStageCache operation. Flushes a stage's cache.

Class FlushStageCacheResponse

This is the response object from the FlushStageCache operation.

Class 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 MISSING_AUTHENTICATION_TOKEN type.

GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN
            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/aws4_request,
            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/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            } }, "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": "MISSING_AUTHENTICATION_TOKEN", "statusCode":
            "404" }

Class GenerateClientCertificateRequest

Container for the parameters to the GenerateClientCertificate operation. Generates a ClientCertificate resource.

Class GenerateClientCertificateResponse

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.

Class GetAccountRequest

Container for the parameters to the GetAccount operation. Gets information about the current Account resource.

Class GetAccountResponse

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={access_key_ID}/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response

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

{ "_links": { "curies": { "href": "http://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.

Class GetApiKeyRequest

Container for the parameters to the GetApiKey operation. Gets information about the current ApiKey resource.

Class GetApiKeyResponse

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.

Class GetApiKeysRequest

Container for the parameters to the GetApiKeys operation. Gets information about the current ApiKeys resource.

Class GetApiKeysResponse

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

Class GetAuthorizerRequest

Container for the parameters to the GetAuthorizer operation. Describe an existing Authorizer resource.

Class GetAuthorizerResponse

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

Class GetAuthorizersRequest

Container for the parameters to the GetAuthorizers operation. Describe an existing Authorizers resource.

Class GetAuthorizersResponse

Represents a collection of Authorizer resources.

Class GetBasePathMappingRequest

Container for the parameters to the GetBasePathMapping operation. Describe a BasePathMapping resource.

Class GetBasePathMappingResponse

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.

Class GetBasePathMappingsRequest

Container for the parameters to the GetBasePathMappings operation. Represents a collection of BasePathMapping resources.

Class GetBasePathMappingsResponse

Represents a collection of BasePathMapping resources.

Class GetClientCertificateRequest

Container for the parameters to the GetClientCertificate operation. Gets information about the current ClientCertificate resource.

Class GetClientCertificateResponse

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.

Class GetClientCertificatesRequest

Container for the parameters to the GetClientCertificates operation. Gets a collection of ClientCertificate resources.

Class GetClientCertificatesResponse

Represents a collection of ClientCertificate resources.

Class GetDeploymentRequest

Container for the parameters to the GetDeployment operation. Gets information about a Deployment resource.

Class GetDeploymentResponse

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/{restapi_id}/deployments/{deployment_id}).

Class GetDeploymentsRequest

Container for the parameters to the GetDeployments operation. Gets information about a Deployments collection.

Class GetDeploymentsResponse

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.

Class GetDocumentationPartRequest

Container for the parameters to the GetDocumentationPart operation.

Class GetDocumentationPartResponse

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, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. 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 Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Class GetDocumentationPartsRequest

Container for the parameters to the GetDocumentationParts operation.

Class GetDocumentationPartsResponse

The collection of documentation parts of an API.

Class GetDocumentationVersionRequest

Container for the parameters to the GetDocumentationVersion operation.

Class GetDocumentationVersionResponse

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., Swagger) file.

Class GetDocumentationVersionsRequest

Container for the parameters to the GetDocumentationVersions operation.

Class GetDocumentationVersionsResponse

The collection of documentation snapshots of an API.

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

Class GetDomainNameRequest

Container for the parameters to the GetDomainName operation. Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Class GetDomainNameResponse

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.

Class GetDomainNamesRequest

Container for the parameters to the GetDomainNames operation. Represents a collection of DomainName resources.

Class GetDomainNamesResponse

Represents a collection of DomainName resources.

Class GetExportRequest

Container for the parameters to the GetExport operation. Exports a deployed version of a RestApi in a specified format.

Class GetExportResponse

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

Class GetGatewayResponseRequest

Container for the parameters to the GetGatewayResponse operation. Gets a GatewayResponse of a specified response type on the given RestApi.

Class GetGatewayResponseResponse

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 MISSING_AUTHENTICATION_TOKEN type.

GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN
            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/aws4_request,
            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/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            } }, "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": "MISSING_AUTHENTICATION_TOKEN", "statusCode":
            "404" }

Class GetGatewayResponsesRequest

Container for the parameters to the GetGatewayResponses operation. 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.

Class GetGatewayResponsesResponse

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/aws4_request, 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/{response_type}", "templated": true
            }, "item": [ { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE"
            }, { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND" }, { "href":
            "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE" }, { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED"
            }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE" }, { "href":
            "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR" }, { "href":
            "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX" }, { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX"
            }, { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS" }, { "href":
            "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY" }, { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN"
            }, { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY"
            }, { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR"
            }, { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED" }, { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT"
            }, { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            }, { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE" }, { "href":
            "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE" } ] }, "_embedded": { "item":
            [ { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "INTEGRATION_FAILURE",
            "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "RESOURCE_NOT_FOUND",
            "statusCode": "404" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "REQUEST_TOO_LARGE",
            "statusCode": "413" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/THROTTLED"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "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/UNSUPPORTED_MEDIA_TYPE"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "UNSUPPORTED_MEDIA_TYPE",
            "statusCode": "415" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "AUTHORIZER_CONFIGURATION_ERROR",
            "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "DEFAULT_5XX" }, {
            "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "DEFAULT_4XX" }, {
            "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "BAD_REQUEST_PARAMETERS",
            "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "BAD_REQUEST_BODY",
            "statusCode": "400" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "EXPIRED_TOKEN", "statusCode":
            "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "ACCESS_DENIED", "statusCode":
            "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "INVALID_API_KEY",
            "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "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/API_CONFIGURATION_ERROR"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "API_CONFIGURATION_ERROR",
            "statusCode": "500" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "QUOTA_EXCEEDED",
            "statusCode": "429" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "INTEGRATION_TIMEOUT",
            "statusCode": "504" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "MISSING_AUTHENTICATION_TOKEN",
            "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "INVALID_SIGNATURE",
            "statusCode": "403" }, { "_links": { "self": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE"
            } }, "defaultResponse": true, "responseParameters": {}, "responseTemplates": { "application/json":
            "{\"message\":$context.error.messageString}" }, "responseType": "AUTHORIZER_FAILURE",
            "statusCode": "500" } ] } }

Class GetIntegrationRequest

Container for the parameters to the GetIntegration operation. Get the integration settings.

Class GetIntegrationResponse

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

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

Class GetIntegrationResponseRequest

Container for the parameters to the GetIntegrationResponse operation. Represents a get integration response.

Class GetIntegrationResponseResponse

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.

Class GetMethodRequest

Container for the parameters to the GetMethod operation. Describe an existing Method resource.

Class GetMethodResponse

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={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

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

{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
            "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
            "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
            "name": "method", "templated": true }, { "href": "http://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/{status_code}",
            "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/{status_code}",
            "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials":
            "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior":
            "WHEN_NO_MATCH", "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.

Class GetMethodResponseRequest

Container for the parameters to the GetMethodResponse operation. Describes a MethodResponse resource.

Class GetMethodResponseResponse

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={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

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

{ "_links": { "curies": { "href": "http://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" }

Class GetModelRequest

Container for the parameters to the GetModel operation. Describes an existing model defined for a RestApi resource.

Class GetModelResponse

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.

Class GetModelsRequest

Container for the parameters to the GetModels operation. Describes existing Models defined for a RestApi resource.

Class GetModelsResponse

Represents a collection of Model resources.

Class GetModelTemplateRequest

Container for the parameters to the GetModelTemplate operation. Generates a sample mapping template that can be used to transform a payload into the structure of a model.

Class GetModelTemplateResponse

Represents a mapping template used to transform a payload.

Class GetRequestValidatorRequest

Container for the parameters to the GetRequestValidator operation. Gets a RequestValidator of a given RestApi.

Class GetRequestValidatorResponse

A set of validation rules for incoming Method requests.

In Swagger, 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.

Class GetRequestValidatorsRequest

Container for the parameters to the GetRequestValidators operation. Gets the RequestValidators collection of a given RestApi.

Class GetRequestValidatorsResponse

A collection of RequestValidator resources of a given RestApi.

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

Class GetResourceRequest

Container for the parameters to the GetResource operation. Lists information about a resource.

Class GetResourceResponse

Represents an API resource.

Class GetResourcesRequest

Container for the parameters to the GetResources operation. Lists information about a collection of Resource resources.

Class GetResourcesResponse

Represents a collection of Resource resources.

Class GetRestApiRequest

Container for the parameters to the GetRestApi operation. Lists the RestApi resource in the collection.

Class GetRestApiResponse

Represents a REST API.

Class GetRestApisRequest

Container for the parameters to the GetRestApis operation. Lists the RestApis resources for your collection.

Class GetRestApisResponse

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.

Class GetSdkRequest

Container for the parameters to the GetSdk operation. Generates a client SDK for a RestApi and Stage.

Class GetSdkResponse

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

Class GetSdkTypeRequest

Container for the parameters to the GetSdkType operation.

Class GetSdkTypeResponse

A type of SDK that API Gateway can generate.

Class GetSdkTypesRequest

Container for the parameters to the GetSdkTypes operation.

Class GetSdkTypesResponse

The collection of SdkType instances.

Class GetStageRequest

Container for the parameters to the GetStage operation. Gets information about a Stage resource.

Class GetStageResponse

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

Class GetStagesRequest

Container for the parameters to the GetStages operation. Gets information about one or more Stage resources.

Class GetStagesResponse

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

Class GetUsagePlanKeyRequest

Container for the parameters to the GetUsagePlanKey operation. Gets a usage plan key of a given key identifier.

Class GetUsagePlanKeyResponse

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.

"

Class GetUsagePlanKeysRequest

Container for the parameters to the GetUsagePlanKeys operation. Gets all the usage plan keys representing the API keys added to a specified usage plan.

Class GetUsagePlanKeysResponse

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

Class GetUsagePlanRequest

Container for the parameters to the GetUsagePlan operation. Gets a usage plan of a given plan identifier.

Class GetUsagePlanResponse

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.

Class GetUsagePlansRequest

Container for the parameters to the GetUsagePlans operation. Gets all the usage plans of the caller's account.

Class GetUsagePlansResponse

Represents a collection of usage plans for an AWS account.

Class GetUsageRequest

Container for the parameters to the GetUsage operation. Gets the usage data of a usage plan in a specified time interval.

Class GetUsageResponse

Represents the usage data of a usage plan.

Class GetVpcLinkRequest

Container for the parameters to the GetVpcLink operation. Gets a specified VPC link under the caller's account in a region.

Class GetVpcLinkResponse

A 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 HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

Class GetVpcLinksRequest

Container for the parameters to the GetVpcLinks operation. Gets the VpcLinks collection under the caller's account in a selected region.

Class GetVpcLinksResponse

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

Class ImportApiKeysRequest

Container for the parameters to the ImportApiKeys operation. Import API keys from an external source, such as a CSV-formatted file.

Class ImportApiKeysResponse

The identifier of an ApiKey used in a UsagePlan.

Class ImportDocumentationPartsRequest

Container for the parameters to the ImportDocumentationParts operation.

Class ImportDocumentationPartsResponse

A collection of the imported DocumentationPart identifiers.

This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into API Gateway

Class ImportRestApiRequest

Container for the parameters to the ImportRestApi operation. A feature of the API Gateway control service for creating a new API from an external API definition file.

Class ImportRestApiResponse

Represents a REST API.

Class Integration

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

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

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

Class LimitExceededException

APIGateway exception

Class 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={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

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

{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
            "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
            "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
            "name": "method", "templated": true }, { "href": "http://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/{status_code}",
            "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/{status_code}",
            "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials":
            "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior":
            "WHEN_NO_MATCH", "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.

Class 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={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

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

{ "_links": { "curies": { "href": "http://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" }

Class MethodSetting

Specifies the method setting properties.

Class MethodSnapshot

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

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

Class NotFoundException

APIGateway exception

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

Class PutGatewayResponseRequest

Container for the parameters to the PutGatewayResponse operation. Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

Class PutGatewayResponseResponse

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 MISSING_AUTHENTICATION_TOKEN type.

GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN
            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/aws4_request,
            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/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            } }, "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": "MISSING_AUTHENTICATION_TOKEN", "statusCode":
            "404" }

Class PutIntegrationRequest

Container for the parameters to the PutIntegration operation. Sets up a method's integration.

Class PutIntegrationResponse

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

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

Class PutIntegrationResponseRequest

Container for the parameters to the PutIntegrationResponse operation. Represents a put integration.

Class PutIntegrationResponseResponse

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.

Class PutMethodRequest

Container for the parameters to the PutMethod operation. Add a method to an existing Resource resource.

Class PutMethodResponse

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={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

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

{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
            "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
            "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
            "name": "method", "templated": true }, { "href": "http://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/{status_code}",
            "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/{status_code}",
            "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials":
            "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior":
            "WHEN_NO_MATCH", "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.

Class PutMethodResponseRequest

Container for the parameters to the PutMethodResponse operation. Adds a MethodResponse to an existing Method resource.

Class PutMethodResponseResponse

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={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

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

{ "_links": { "curies": { "href": "http://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" }

Class PutRestApiRequest

Container for the parameters to the PutRestApi operation. A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

Class PutRestApiResponse

Represents a REST API.

Class QuotaSettings

Quotas configured for a usage plan.

Class RequestValidator

A set of validation rules for incoming Method requests.

In Swagger, 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.

Class Resource

Represents an API resource.

Class RestApi

Represents a REST API.

Class SdkConfigurationProperty

A configuration property of an SDK type.

Class SdkType

A type of SDK that API Gateway can generate.

Class ServiceUnavailableException

APIGateway exception

Class Stage

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

Class StageKey

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

Class TestInvokeAuthorizerRequest

Container for the parameters to the TestInvokeAuthorizer operation. Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Class TestInvokeAuthorizerResponse

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

Class TestInvokeMethodRequest

Container for the parameters to the TestInvokeMethod operation. Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.

Class TestInvokeMethodResponse

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

Class ThrottleSettings

The API request rate limits.

Class TooManyRequestsException

APIGateway exception

Class UnauthorizedException

APIGateway exception

Class UpdateAccountRequest

Container for the parameters to the UpdateAccount operation. Changes information about the current Account resource.

Class UpdateAccountResponse

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={access_key_ID}/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} 
Response

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

{ "_links": { "curies": { "href": "http://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.

Class UpdateApiKeyRequest

Container for the parameters to the UpdateApiKey operation. Changes information about an ApiKey resource.

Class UpdateApiKeyResponse

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.

Class UpdateAuthorizerRequest

Container for the parameters to the UpdateAuthorizer operation. Updates an existing Authorizer resource.

Class UpdateAuthorizerResponse

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

Class UpdateBasePathMappingRequest

Container for the parameters to the UpdateBasePathMapping operation. Changes information about the BasePathMapping resource.

Class UpdateBasePathMappingResponse

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.

Class UpdateClientCertificateRequest

Container for the parameters to the UpdateClientCertificate operation. Changes information about an ClientCertificate resource.

Class UpdateClientCertificateResponse

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.

Class UpdateDeploymentRequest

Container for the parameters to the UpdateDeployment operation. Changes information about a Deployment resource.

Class UpdateDeploymentResponse

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/{restapi_id}/deployments/{deployment_id}).

Class UpdateDocumentationPartRequest

Container for the parameters to the UpdateDocumentationPart operation.

Class UpdateDocumentationPartResponse

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, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. 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 Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Class UpdateDocumentationVersionRequest

Container for the parameters to the UpdateDocumentationVersion operation.

Class UpdateDocumentationVersionResponse

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., Swagger) file.

Class UpdateDomainNameRequest

Container for the parameters to the UpdateDomainName operation. Changes information about the DomainName resource.

Class UpdateDomainNameResponse

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.

Class UpdateGatewayResponseRequest

Container for the parameters to the UpdateGatewayResponse operation. Updates a GatewayResponse of a specified response type on the given RestApi.

Class UpdateGatewayResponseResponse

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 MISSING_AUTHENTICATION_TOKEN type.

GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN
            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/aws4_request,
            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/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:delete": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            }, "gatewayresponse:put": { "href": "/restapis/o81lxisefl/gatewayresponses/{response_type}",
            "templated": true }, "gatewayresponse:update": { "href": "/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN"
            } }, "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": "MISSING_AUTHENTICATION_TOKEN", "statusCode":
            "404" }

Class UpdateIntegrationRequest

Container for the parameters to the UpdateIntegration operation. Represents an update integration.

Class UpdateIntegrationResponse

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

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

Class UpdateIntegrationResponseRequest

Container for the parameters to the UpdateIntegrationResponse operation. Represents an update integration response.

Class UpdateIntegrationResponseResponse

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.

Class UpdateMethodRequest

Container for the parameters to the UpdateMethod operation. Updates an existing Method resource.

Class UpdateMethodResponse

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={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

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

{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html",
            "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html",
            "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html",
            "name": "method", "templated": true }, { "href": "http://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/{status_code}",
            "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/{status_code}",
            "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials":
            "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior":
            "WHEN_NO_MATCH", "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.

Class UpdateMethodResponseRequest

Container for the parameters to the UpdateMethodResponse operation. Updates an existing MethodResponse resource.

Class UpdateMethodResponseResponse

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={access_key_ID}/20160603/us-east-1/apigateway/aws4_request,
            SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

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

{ "_links": { "curies": { "href": "http://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" }

Class UpdateModelRequest

Container for the parameters to the UpdateModel operation. Changes information about a model.

Class UpdateModelResponse

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.

Class UpdateRequestValidatorRequest

Container for the parameters to the UpdateRequestValidator operation. Updates a RequestValidator of a given RestApi.

Class UpdateRequestValidatorResponse

A set of validation rules for incoming Method requests.

In Swagger, 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.

Class UpdateResourceRequest

Container for the parameters to the UpdateResource operation. Changes information about a Resource resource.

Class UpdateResourceResponse

Represents an API resource.

Class UpdateRestApiRequest

Container for the parameters to the UpdateRestApi operation. Changes information about the specified API.

Class UpdateRestApiResponse

Represents a REST API.

Class UpdateStageRequest

Container for the parameters to the UpdateStage operation. Changes information about a Stage resource.

Class UpdateStageResponse

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

Class UpdateUsagePlanRequest

Container for the parameters to the UpdateUsagePlan operation. Updates a usage plan of a given plan Id.

Class UpdateUsagePlanResponse

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.

Class UpdateUsageRequest

Container for the parameters to the UpdateUsage operation. Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Class UpdateUsageResponse

Represents the usage data of a usage plan.

Class UpdateVpcLinkRequest

Container for the parameters to the UpdateVpcLink operation. Updates an existing VpcLink of a specified identifier.

Class UpdateVpcLinkResponse

A 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 HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

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

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

"

Class VpcLink

A 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 HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.