| Package | Description |
|---|---|
| software.amazon.awscdk.services.apigateway |
Amazon API Gateway Construct Library
|
| Modifier and Type | Field and Description |
|---|---|
static ResponseType |
ResponseType.ACCESS_DENIED
The gateway response for authorization failure.
|
static ResponseType |
ResponseType.API_CONFIGURATION_ERROR
The gateway response for an invalid API configuration.
|
static ResponseType |
ResponseType.AUTHORIZER_CONFIGURATION_ERROR
The gateway response for failing to connect to a custom or Amazon Cognito authorizer.
|
static ResponseType |
ResponseType.AUTHORIZER_FAILURE
The gateway response when a custom or Amazon Cognito authorizer failed to authenticate the caller.
|
static ResponseType |
ResponseType.BAD_REQUEST_BODY
The gateway response when the request body cannot be validated according to an enabled request validator.
|
static ResponseType |
ResponseType.BAD_REQUEST_PARAMETERS
The gateway response when the request parameter cannot be validated according to an enabled request validator.
|
static ResponseType |
ResponseType.DEFAULT_4_XX
The default gateway response for an unspecified response type with the status code of 4XX.
|
static ResponseType |
ResponseType.DEFAULT_5_XX
The default gateway response for an unspecified response type with a status code of 5XX.
|
static ResponseType |
ResponseType.EXPIRED_TOKEN
The gateway response for an AWS authentication token expired error.
|
static ResponseType |
ResponseType.INTEGRATION_FAILURE
The gateway response for an integration failed error.
|
static ResponseType |
ResponseType.INTEGRATION_TIMEOUT
The gateway response for an integration timed out error.
|
static ResponseType |
ResponseType.INVALID_API_KEY
The gateway response for an invalid API key submitted for a method requiring an API key.
|
static ResponseType |
ResponseType.INVALID_SIGNATURE
The gateway response for an invalid AWS signature error.
|
static ResponseType |
ResponseType.MISSING_AUTHENTICATION_TOKEN
The gateway response for a missing authentication token error, including the cases when the client attempts to invoke an unsupported API method or resource.
|
static ResponseType |
ResponseType.QUOTA_EXCEEDED
The gateway response for the usage plan quota exceeded error.
|
static ResponseType |
ResponseType.REQUEST_TOO_LARGE
The gateway response for the request too large error.
|
static ResponseType |
ResponseType.RESOURCE_NOT_FOUND
The gateway response when API Gateway cannot find the specified resource after an API request passes authentication and authorization.
|
static ResponseType |
ResponseType.THROTTLED
The gateway response when usage plan, method, stage, or account level throttling limits exceeded.
|
static ResponseType |
ResponseType.UNAUTHORIZED
The gateway response when the custom or Amazon Cognito authorizer failed to authenticate the caller.
|
static ResponseType |
ResponseType.UNSUPPORTED_MEDIA_TYPE
The gateway response when a payload is of an unsupported media type, if strict passthrough behavior is enabled.
|
static ResponseType |
ResponseType.WAF_FILTERED
The gateway response when a request is blocked by AWS WAF.
|
| Modifier and Type | Method and Description |
|---|---|
ResponseType |
GatewayResponseProps.Jsii$Proxy.getType() |
ResponseType |
GatewayResponseOptions.getType()
Response type to associate with gateway response.
|
ResponseType |
GatewayResponseOptions.Jsii$Proxy.getType() |
static ResponseType |
ResponseType.of(String type)
A custom response type to support future cases.
|
| Modifier and Type | Method and Description |
|---|---|
GatewayResponse.Builder |
GatewayResponse.Builder.type(ResponseType type)
Response type to associate with gateway response.
|
GatewayResponseProps.Builder |
GatewayResponseProps.Builder.type(ResponseType type)
Sets the value of
GatewayResponseOptions.getType() |
GatewayResponseOptions.Builder |
GatewayResponseOptions.Builder.type(ResponseType type)
Sets the value of
GatewayResponseOptions.getType() |
Copyright © 2022. All rights reserved.