GatewayResponse
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
Contents
- defaultResponse
-
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (
true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.Type: Boolean
Required: No
- responseParameters
-
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
Type: String to string map
Required: No
- responseTemplates
-
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
Type: String to string map
Required: No
- responseType
-
The response type of the associated GatewayResponse.
Type: String
Valid Values:
DEFAULT_4XX | DEFAULT_5XX | RESOURCE_NOT_FOUND | UNAUTHORIZED | INVALID_API_KEY | ACCESS_DENIED | AUTHORIZER_FAILURE | AUTHORIZER_CONFIGURATION_ERROR | INVALID_SIGNATURE | EXPIRED_TOKEN | MISSING_AUTHENTICATION_TOKEN | INTEGRATION_FAILURE | INTEGRATION_TIMEOUT | API_CONFIGURATION_ERROR | UNSUPPORTED_MEDIA_TYPE | BAD_REQUEST_PARAMETERS | BAD_REQUEST_BODY | REQUEST_TOO_LARGE | THROTTLED | QUOTA_EXCEEDED | WAF_FILTEREDRequired: No
- statusCode
-
The HTTP status code for this GatewayResponse.
Type: String
Pattern:
[1-5]\d\dRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
