Network.AWS.APIGateway.PutGatewayResponse

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi .

Creating a Request

putGatewayResponse

Arguments

:: Text

pgRestAPIId

-> GatewayResponseType

pgResponseType

-> PutGatewayResponse

Creates a value of PutGatewayResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pgResponseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
• pgStatusCode - GatewayResponse
• pgResponseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
• pgRestAPIId - The string identifier of the associated RestApi .
• pgResponseType - 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

data PutGatewayResponse

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi .

See: putGatewayResponse smart constructor.

Instances

Eq PutGatewayResponse

Methods

(==) :: PutGatewayResponse -> PutGatewayResponse -> Bool

(/=) :: PutGatewayResponse -> PutGatewayResponse -> Bool

Data PutGatewayResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutGatewayResponse -> c PutGatewayResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutGatewayResponse

toConstr :: PutGatewayResponse -> Constr

dataTypeOf :: PutGatewayResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutGatewayResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutGatewayResponse)

gmapT :: (forall b. Data b => b -> b) -> PutGatewayResponse -> PutGatewayResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutGatewayResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutGatewayResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> PutGatewayResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutGatewayResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutGatewayResponse -> m PutGatewayResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutGatewayResponse -> m PutGatewayResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutGatewayResponse -> m PutGatewayResponse

Read PutGatewayResponse

Methods

readsPrec :: Int -> ReadS PutGatewayResponse

readList :: ReadS [PutGatewayResponse]

readPrec :: ReadPrec PutGatewayResponse

readListPrec :: ReadPrec [PutGatewayResponse]

Show PutGatewayResponse

Methods

showsPrec :: Int -> PutGatewayResponse -> ShowS

show :: PutGatewayResponse -> String

showList :: [PutGatewayResponse] -> ShowS

Generic PutGatewayResponse

Associated Types

type Rep PutGatewayResponse :: * -> *

Methods

from :: PutGatewayResponse -> Rep PutGatewayResponse x

to :: Rep PutGatewayResponse x -> PutGatewayResponse

Hashable PutGatewayResponse

Methods

hashWithSalt :: Int -> PutGatewayResponse -> Int

hash :: PutGatewayResponse -> Int

ToJSON PutGatewayResponse

Methods

toJSON :: PutGatewayResponse -> Value

toEncoding :: PutGatewayResponse -> Encoding

toJSONList :: [PutGatewayResponse] -> Value

toEncodingList :: [PutGatewayResponse] -> Encoding

NFData PutGatewayResponse

Methods

rnf :: PutGatewayResponse -> ()

AWSRequest PutGatewayResponse

Associated Types

type Rs PutGatewayResponse :: *

Methods

request :: PutGatewayResponse -> Request PutGatewayResponse

response :: MonadResource m => Logger -> Service -> Proxy * PutGatewayResponse -> ClientResponse -> m (Response PutGatewayResponse)

ToQuery PutGatewayResponse

Methods

toQuery :: PutGatewayResponse -> QueryString

ToPath PutGatewayResponse

Methods

toPath :: PutGatewayResponse -> ByteString

ToHeaders PutGatewayResponse

Methods

toHeaders :: PutGatewayResponse -> [Header]

type Rep PutGatewayResponse

type Rep PutGatewayResponse = D1 (MetaData "PutGatewayResponse" "Network.AWS.APIGateway.PutGatewayResponse" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "PutGatewayResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_pgResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_pgStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_pgResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_pgRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_pgResponseType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GatewayResponseType))))))

type Rs PutGatewayResponse

type Rs PutGatewayResponse = GatewayResponse

Request Lenses

pgResponseTemplates :: Lens' PutGatewayResponse (HashMap Text Text)

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

pgStatusCode :: Lens' PutGatewayResponse (Maybe Text)

GatewayResponse

pgResponseParameters :: Lens' PutGatewayResponse (HashMap Text Text)

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

pgRestAPIId :: Lens' PutGatewayResponse Text

The string identifier of the associated RestApi .

pgResponseType :: Lens' PutGatewayResponse GatewayResponseType

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

Destructuring the Response

gatewayResponse :: GatewayResponse

Creates a value of GatewayResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gDefaultResponse - 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.
• gResponseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
• gResponseType - 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
• gStatusCode - The HTTP status code for this GatewayResponse .
• gResponseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

data GatewayResponse

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 restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN HTTP1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: applicationjson X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}20170503us-east-1apigatewayaws4_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": "restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "restapiso81lxiseflgatewayresponses{response_type}", "templated": true }, "gatewayresponse:update": { "href": "restapiso81lxiseflgatewayresponsesMISSING_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: gatewayResponse smart constructor.

Instances

Eq GatewayResponse

Methods

(==) :: GatewayResponse -> GatewayResponse -> Bool

(/=) :: GatewayResponse -> GatewayResponse -> Bool

Data GatewayResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GatewayResponse -> c GatewayResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GatewayResponse

toConstr :: GatewayResponse -> Constr

dataTypeOf :: GatewayResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GatewayResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GatewayResponse)

gmapT :: (forall b. Data b => b -> b) -> GatewayResponse -> GatewayResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GatewayResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GatewayResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GatewayResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GatewayResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GatewayResponse -> m GatewayResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GatewayResponse -> m GatewayResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GatewayResponse -> m GatewayResponse

Read GatewayResponse

Methods

readsPrec :: Int -> ReadS GatewayResponse

readList :: ReadS [GatewayResponse]

readPrec :: ReadPrec GatewayResponse

readListPrec :: ReadPrec [GatewayResponse]

Show GatewayResponse

Methods

showsPrec :: Int -> GatewayResponse -> ShowS

show :: GatewayResponse -> String

showList :: [GatewayResponse] -> ShowS

Generic GatewayResponse

Associated Types

type Rep GatewayResponse :: * -> *

Methods

from :: GatewayResponse -> Rep GatewayResponse x

to :: Rep GatewayResponse x -> GatewayResponse

Hashable GatewayResponse

Methods

hashWithSalt :: Int -> GatewayResponse -> Int

hash :: GatewayResponse -> Int

FromJSON GatewayResponse

Methods

parseJSON :: Value -> Parser GatewayResponse

parseJSONList :: Value -> Parser [GatewayResponse]

NFData GatewayResponse

Methods

rnf :: GatewayResponse -> ()

type Rep GatewayResponse

type Rep GatewayResponse = D1 (MetaData "GatewayResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GatewayResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gDefaultResponse") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_gResponseType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GatewayResponseType))) ((:*:) (S1 (MetaSel (Just Symbol "_gStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))))))

Response Lenses

gDefaultResponse :: Lens' GatewayResponse (Maybe 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 Amazon API Gateway without any customization by an API developer.

gResponseTemplates :: Lens' GatewayResponse (HashMap Text Text)

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

gResponseType :: Lens' GatewayResponse (Maybe GatewayResponseType)

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

gStatusCode :: Lens' GatewayResponse (Maybe Text)

The HTTP status code for this GatewayResponse .

gResponseParameters :: Lens' GatewayResponse (HashMap Text Text)

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