You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::GatewayResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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=<code>{access-key-id}</code>/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": "<a href="http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-">http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-</a><code>{rel}</code>.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/<code>{response_type}</code>", "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" }

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#default_responseBoolean

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:

  • (Boolean)

    A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false).

#response_parametersHash<String,String>

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

Returns:

  • (Hash<String,String>)

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

#response_templatesHash<String,String>

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

Returns:

  • (Hash<String,String>)

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

#response_typeString

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

Possible 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

Returns:

#status_codeString

The HTTP status code for this GatewayResponse.

Returns: