GatewayResponse (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigateway.model.GatewayResponse

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GatewayResponse
extends Object
implements Serializable, Cloneable, StructuredPojo

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 Amazon 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_AUTHNETICATION_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" }

Customize Gateway Responses

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

GatewayResponse()

Constructors
Constructor and Description
`GatewayResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GatewayResponse`	`addResponseParametersEntry(String key, String value)`
`GatewayResponse`	`addResponseTemplatesEntry(String key, String value)`
`GatewayResponse`	`clearResponseParametersEntries()` Removes all the entries added into ResponseParameters.
`GatewayResponse`	`clearResponseTemplatesEntries()` Removes all the entries added into ResponseTemplates.
`GatewayResponse`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getDefaultResponse()` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true` ) or not (`false`).
`Map<String,String>`	`getResponseParameters()` Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
`Map<String,String>`	`getResponseTemplates()` Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
`String`	`getResponseType()` The response type of the associated GatewayResponse.
`String`	`getStatusCode()` The HTTP status code for this GatewayResponse.
`int`	`hashCode()`
`Boolean`	`isDefaultResponse()` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true` ) or not (`false`).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefaultResponse(Boolean defaultResponse)` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true` ) or not (`false`).
`void`	`setResponseParameters(Map<String,String> responseParameters)` Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
`void`	`setResponseTemplates(Map<String,String> responseTemplates)` Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
`void`	`setResponseType(GatewayResponseType responseType)` The response type of the associated GatewayResponse.
`void`	`setResponseType(String responseType)` The response type of the associated GatewayResponse.
`void`	`setStatusCode(String statusCode)` The HTTP status code for this GatewayResponse.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`GatewayResponse`	`withDefaultResponse(Boolean defaultResponse)` A Boolean flag to indicate whether this GatewayResponse is the default gateway response (`true` ) or not (`false`).
`GatewayResponse`	`withResponseParameters(Map<String,String> responseParameters)` Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
`GatewayResponse`	`withResponseTemplates(Map<String,String> responseTemplates)` Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
`GatewayResponse`	`withResponseType(GatewayResponseType responseType)` The response type of the associated GatewayResponse.
`GatewayResponse`	`withResponseType(String responseType)` The response type of the associated GatewayResponse.
`GatewayResponse`	`withStatusCode(String statusCode)` The HTTP status code for this GatewayResponse.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GatewayResponse
```
public GatewayResponse()
```
- Method Detail
  - setResponseType
```
public void setResponseType(String responseType)
```
    The response type of the associated GatewayResponse. Valid values are
    - ACCESS_DENIED
    - API_CONFIGURATION_ERROR
    - AUTHORIZER_FAILURE
    - AUTHORIZER_CONFIGURATION_ERROR
    - BAD_REQUEST_PARAMETERS
    - BAD_REQUEST_BODY
    - DEFAULT_4XX
    - DEFAULT_5XX
    - EXPIRED_TOKEN
    - INVALID_SIGNATURE
    - INTEGRATION_FAILURE
    - INTEGRATION_TIMEOUT
    - INVALID_API_KEY
    - MISSING_AUTHENTICATION_TOKEN
    - QUOTA_EXCEEDED
    - REQUEST_TOO_LARGE
    - RESOURCE_NOT_FOUND
    - THROTTLED
    - UNAUTHORIZED
    - UNSUPPORTED_MEDIA_TYPES
    Parameters:
    responseType - The response type of the associated GatewayResponse. Valid values are
    
    ACCESS_DENIED
    
    API_CONFIGURATION_ERROR
    
    AUTHORIZER_FAILURE
    
    AUTHORIZER_CONFIGURATION_ERROR
    
    BAD_REQUEST_PARAMETERS
    
    BAD_REQUEST_BODY
    
    DEFAULT_4XX
    
    DEFAULT_5XX
    
    EXPIRED_TOKEN
    
    INVALID_SIGNATURE
    
    INTEGRATION_FAILURE
    
    INTEGRATION_TIMEOUT
    
    INVALID_API_KEY
    
    MISSING_AUTHENTICATION_TOKEN
    
    QUOTA_EXCEEDED
    
    REQUEST_TOO_LARGE
    
    RESOURCE_NOT_FOUND
    
    THROTTLED
    
    UNAUTHORIZED
    
    UNSUPPORTED_MEDIA_TYPES
    See Also:
    
    GatewayResponseType
  - getResponseType
```
public String getResponseType()
```
    The response type of the associated GatewayResponse. Valid values are
    - ACCESS_DENIED
    - API_CONFIGURATION_ERROR
    - AUTHORIZER_FAILURE
    - AUTHORIZER_CONFIGURATION_ERROR
    - BAD_REQUEST_PARAMETERS
    - BAD_REQUEST_BODY
    - DEFAULT_4XX
    - DEFAULT_5XX
    - EXPIRED_TOKEN
    - INVALID_SIGNATURE
    - INTEGRATION_FAILURE
    - INTEGRATION_TIMEOUT
    - INVALID_API_KEY
    - MISSING_AUTHENTICATION_TOKEN
    - QUOTA_EXCEEDED
    - REQUEST_TOO_LARGE
    - RESOURCE_NOT_FOUND
    - THROTTLED
    - UNAUTHORIZED
    - UNSUPPORTED_MEDIA_TYPES
    Returns:
    The response type of the associated GatewayResponse. Valid values are
    
    ACCESS_DENIED
    
    API_CONFIGURATION_ERROR
    
    AUTHORIZER_FAILURE
    
    AUTHORIZER_CONFIGURATION_ERROR
    
    BAD_REQUEST_PARAMETERS
    
    BAD_REQUEST_BODY
    
    DEFAULT_4XX
    
    DEFAULT_5XX
    
    EXPIRED_TOKEN
    
    INVALID_SIGNATURE
    
    INTEGRATION_FAILURE
    
    INTEGRATION_TIMEOUT
    
    INVALID_API_KEY
    
    MISSING_AUTHENTICATION_TOKEN
    
    QUOTA_EXCEEDED
    
    REQUEST_TOO_LARGE
    
    RESOURCE_NOT_FOUND
    
    THROTTLED
    
    UNAUTHORIZED
    
    UNSUPPORTED_MEDIA_TYPES
    See Also:
    
    GatewayResponseType
  - withResponseType
```
public GatewayResponse withResponseType(String responseType)
```
    The response type of the associated GatewayResponse. Valid values are
    - ACCESS_DENIED
    - API_CONFIGURATION_ERROR
    - AUTHORIZER_FAILURE
    - AUTHORIZER_CONFIGURATION_ERROR
    - BAD_REQUEST_PARAMETERS
    - BAD_REQUEST_BODY
    - DEFAULT_4XX
    - DEFAULT_5XX
    - EXPIRED_TOKEN
    - INVALID_SIGNATURE
    - INTEGRATION_FAILURE
    - INTEGRATION_TIMEOUT
    - INVALID_API_KEY
    - MISSING_AUTHENTICATION_TOKEN
    - QUOTA_EXCEEDED
    - REQUEST_TOO_LARGE
    - RESOURCE_NOT_FOUND
    - THROTTLED
    - UNAUTHORIZED
    - UNSUPPORTED_MEDIA_TYPES
    Parameters:
    responseType - The response type of the associated GatewayResponse. Valid values are
    
    ACCESS_DENIED
    
    API_CONFIGURATION_ERROR
    
    AUTHORIZER_FAILURE
    
    AUTHORIZER_CONFIGURATION_ERROR
    
    BAD_REQUEST_PARAMETERS
    
    BAD_REQUEST_BODY
    
    DEFAULT_4XX
    
    DEFAULT_5XX
    
    EXPIRED_TOKEN
    
    INVALID_SIGNATURE
    
    INTEGRATION_FAILURE
    
    INTEGRATION_TIMEOUT
    
    INVALID_API_KEY
    
    MISSING_AUTHENTICATION_TOKEN
    
    QUOTA_EXCEEDED
    
    REQUEST_TOO_LARGE
    
    RESOURCE_NOT_FOUND
    
    THROTTLED
    
    UNAUTHORIZED
    
    UNSUPPORTED_MEDIA_TYPES
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GatewayResponseType
  - setResponseType
```
public void setResponseType(GatewayResponseType responseType)
```
    The response type of the associated GatewayResponse. Valid values are
    - ACCESS_DENIED
    - API_CONFIGURATION_ERROR
    - AUTHORIZER_FAILURE
    - AUTHORIZER_CONFIGURATION_ERROR
    - BAD_REQUEST_PARAMETERS
    - BAD_REQUEST_BODY
    - DEFAULT_4XX
    - DEFAULT_5XX
    - EXPIRED_TOKEN
    - INVALID_SIGNATURE
    - INTEGRATION_FAILURE
    - INTEGRATION_TIMEOUT
    - INVALID_API_KEY
    - MISSING_AUTHENTICATION_TOKEN
    - QUOTA_EXCEEDED
    - REQUEST_TOO_LARGE
    - RESOURCE_NOT_FOUND
    - THROTTLED
    - UNAUTHORIZED
    - UNSUPPORTED_MEDIA_TYPES
    Parameters:
    responseType - The response type of the associated GatewayResponse. Valid values are
    
    ACCESS_DENIED
    
    API_CONFIGURATION_ERROR
    
    AUTHORIZER_FAILURE
    
    AUTHORIZER_CONFIGURATION_ERROR
    
    BAD_REQUEST_PARAMETERS
    
    BAD_REQUEST_BODY
    
    DEFAULT_4XX
    
    DEFAULT_5XX
    
    EXPIRED_TOKEN
    
    INVALID_SIGNATURE
    
    INTEGRATION_FAILURE
    
    INTEGRATION_TIMEOUT
    
    INVALID_API_KEY
    
    MISSING_AUTHENTICATION_TOKEN
    
    QUOTA_EXCEEDED
    
    REQUEST_TOO_LARGE
    
    RESOURCE_NOT_FOUND
    
    THROTTLED
    
    UNAUTHORIZED
    
    UNSUPPORTED_MEDIA_TYPES
    See Also:
    
    GatewayResponseType
  - withResponseType
```
public GatewayResponse withResponseType(GatewayResponseType responseType)
```
    The response type of the associated GatewayResponse. Valid values are
    - ACCESS_DENIED
    - API_CONFIGURATION_ERROR
    - AUTHORIZER_FAILURE
    - AUTHORIZER_CONFIGURATION_ERROR
    - BAD_REQUEST_PARAMETERS
    - BAD_REQUEST_BODY
    - DEFAULT_4XX
    - DEFAULT_5XX
    - EXPIRED_TOKEN
    - INVALID_SIGNATURE
    - INTEGRATION_FAILURE
    - INTEGRATION_TIMEOUT
    - INVALID_API_KEY
    - MISSING_AUTHENTICATION_TOKEN
    - QUOTA_EXCEEDED
    - REQUEST_TOO_LARGE
    - RESOURCE_NOT_FOUND
    - THROTTLED
    - UNAUTHORIZED
    - UNSUPPORTED_MEDIA_TYPES
    Parameters:
    responseType - The response type of the associated GatewayResponse. Valid values are
    
    ACCESS_DENIED
    
    API_CONFIGURATION_ERROR
    
    AUTHORIZER_FAILURE
    
    AUTHORIZER_CONFIGURATION_ERROR
    
    BAD_REQUEST_PARAMETERS
    
    BAD_REQUEST_BODY
    
    DEFAULT_4XX
    
    DEFAULT_5XX
    
    EXPIRED_TOKEN
    
    INVALID_SIGNATURE
    
    INTEGRATION_FAILURE
    
    INTEGRATION_TIMEOUT
    
    INVALID_API_KEY
    
    MISSING_AUTHENTICATION_TOKEN
    
    QUOTA_EXCEEDED
    
    REQUEST_TOO_LARGE
    
    RESOURCE_NOT_FOUND
    
    THROTTLED
    
    UNAUTHORIZED
    
    UNSUPPORTED_MEDIA_TYPES
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GatewayResponseType
  - setStatusCode
```
public void setStatusCode(String statusCode)
```
    The HTTP status code for this GatewayResponse.
    
    Parameters:
    
    statusCode - The HTTP status code for this GatewayResponse.
  - getStatusCode
```
public String getStatusCode()
```
    The HTTP status code for this GatewayResponse.
    
    Returns:
    
    The HTTP status code for this GatewayResponse.
  - withStatusCode
```
public GatewayResponse withStatusCode(String statusCode)
```
    The HTTP status code for this GatewayResponse.
    
    Parameters:
    
    statusCode - The HTTP status code for this GatewayResponse.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResponseParameters
```
public Map<String,String> getResponseParameters()
```
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Returns:
    
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
  - setResponseParameters
```
public void setResponseParameters(Map<String,String> responseParameters)
```
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Parameters:
    
    responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
  - withResponseParameters
```
public GatewayResponse withResponseParameters(Map<String,String> responseParameters)
```
    Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Parameters:
    
    responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addResponseParametersEntry
```
public GatewayResponse addResponseParametersEntry(String key,
                                                  String value)
```
  - clearResponseParametersEntries
```
public GatewayResponse clearResponseParametersEntries()
```
    Removes all the entries added into ResponseParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResponseTemplates
```
public Map<String,String> getResponseTemplates()
```
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Returns:
    
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
  - setResponseTemplates
```
public void setResponseTemplates(Map<String,String> responseTemplates)
```
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Parameters:
    
    responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
  - withResponseTemplates
```
public GatewayResponse withResponseTemplates(Map<String,String> responseTemplates)
```
    Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Parameters:
    
    responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addResponseTemplatesEntry
```
public GatewayResponse addResponseTemplatesEntry(String key,
                                                 String value)
```
  - clearResponseTemplatesEntries
```
public GatewayResponse clearResponseTemplatesEntries()
```
    Removes all the entries added into ResponseTemplates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultResponse
```
public void setDefaultResponse(Boolean 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 Amazon API Gateway without any customization by an API developer.
    
    Parameters:
    
    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 Amazon API Gateway without any customization by an API developer.
  - getDefaultResponse
```
public Boolean getDefaultResponse()
```
    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 Amazon API Gateway without any customization by an API developer.
    
    Returns:
    
    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 Amazon API Gateway without any customization by an API developer.
  - withDefaultResponse
```
public GatewayResponse withDefaultResponse(Boolean 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 Amazon API Gateway without any customization by an API developer.
    
    Parameters:
    
    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 Amazon API Gateway without any customization by an API developer.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefaultResponse
```
public Boolean isDefaultResponse()
```
    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 Amazon API Gateway without any customization by an API developer.
    
    Returns:
    
    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 Amazon API Gateway without any customization by an API developer.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GatewayResponse clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class GatewayResponse

Example: Get a Gateway Response of a given response type

Request

Response

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GatewayResponse

Method Detail

setResponseType

getResponseType

withResponseType

setResponseType

withResponseType

setStatusCode

getStatusCode

withStatusCode

getResponseParameters

setResponseParameters

withResponseParameters

addResponseParametersEntry

clearResponseParametersEntries

getResponseTemplates

setResponseTemplates

withResponseTemplates

addResponseTemplatesEntry

clearResponseTemplatesEntries

setDefaultResponse

getDefaultResponse

withDefaultResponse

isDefaultResponse

toString

equals

hashCode

clone

marshall