Struct rusoto_apigateway::GatewayResponse

pub struct GatewayResponse {
    pub default_response: Option<bool>,
    pub response_parameters: Option<HashMap<String, String>>,
    pub response_templates: Option<HashMap<String, String>>,
    pub response_type: Option<String>,
    pub status_code: Option<String>,
}

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

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

Example: Get a Gateway Response of a given response type

Request

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

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

The response type is specified as a URL path.

Response

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

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

Customize Gateway Responses

Fields

default_response: Option<bool>

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.

response_parameters: Option<HashMap<String, String>>

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

response_templates: Option<HashMap<String, String>>

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

response_type: Option<String>

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_TYPE

status_code: Option<String>

The HTTP status code for this GatewayResponse.

Trait Implementations

impl Clone for GatewayResponse

fn clone(&self) -> GatewayResponse

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GatewayResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GatewayResponse

fn default() -> GatewayResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GatewayResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<GatewayResponse> for GatewayResponse

fn eq(&self, other: &GatewayResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GatewayResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for GatewayResponse