Network.AWS.APIGateway.UpdateGatewayResponse

Updates a GatewayResponse of a specified response type on the given RestApi .

Creating a Request

updateGatewayResponse

Arguments

:: Text

ugRestAPIId

-> GatewayResponseType

ugResponseType

-> UpdateGatewayResponse

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

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

• ugPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• ugRestAPIId - The string identifier of the associated RestApi .
• ugResponseType - 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 UpdateGatewayResponse

Updates a GatewayResponse of a specified response type on the given RestApi .

See: updateGatewayResponse smart constructor.

Instances

Eq UpdateGatewayResponse

Methods

(==) :: UpdateGatewayResponse -> UpdateGatewayResponse -> Bool

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

Data UpdateGatewayResponse

Methods

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

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

toConstr :: UpdateGatewayResponse -> Constr

dataTypeOf :: UpdateGatewayResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateGatewayResponse

Methods

readsPrec :: Int -> ReadS UpdateGatewayResponse

readList :: ReadS [UpdateGatewayResponse]

readPrec :: ReadPrec UpdateGatewayResponse

readListPrec :: ReadPrec [UpdateGatewayResponse]

Show UpdateGatewayResponse

Methods

showsPrec :: Int -> UpdateGatewayResponse -> ShowS

show :: UpdateGatewayResponse -> String

showList :: [UpdateGatewayResponse] -> ShowS

Generic UpdateGatewayResponse

Associated Types

type Rep UpdateGatewayResponse :: * -> *

Methods

from :: UpdateGatewayResponse -> Rep UpdateGatewayResponse x

to :: Rep UpdateGatewayResponse x -> UpdateGatewayResponse

Hashable UpdateGatewayResponse

Methods

hashWithSalt :: Int -> UpdateGatewayResponse -> Int

hash :: UpdateGatewayResponse -> Int

ToJSON UpdateGatewayResponse

Methods

toJSON :: UpdateGatewayResponse -> Value

toEncoding :: UpdateGatewayResponse -> Encoding

toJSONList :: [UpdateGatewayResponse] -> Value

toEncodingList :: [UpdateGatewayResponse] -> Encoding

NFData UpdateGatewayResponse

Methods

rnf :: UpdateGatewayResponse -> ()

AWSRequest UpdateGatewayResponse

Associated Types

type Rs UpdateGatewayResponse :: *

Methods

request :: UpdateGatewayResponse -> Request UpdateGatewayResponse

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

ToQuery UpdateGatewayResponse

Methods

toQuery :: UpdateGatewayResponse -> QueryString

ToPath UpdateGatewayResponse

Methods

toPath :: UpdateGatewayResponse -> ByteString

ToHeaders UpdateGatewayResponse

Methods

toHeaders :: UpdateGatewayResponse -> [Header]

type Rep UpdateGatewayResponse

type Rep UpdateGatewayResponse = D1 (MetaData "UpdateGatewayResponse" "Network.AWS.APIGateway.UpdateGatewayResponse" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "UpdateGatewayResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ugPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation]))) ((:*:) (S1 (MetaSel (Just Symbol "_ugRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ugResponseType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GatewayResponseType)))))

type Rs UpdateGatewayResponse

type Rs UpdateGatewayResponse = GatewayResponse

Request Lenses

ugPatchOperations :: Lens' UpdateGatewayResponse [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

ugRestAPIId :: Lens' UpdateGatewayResponse Text

The string identifier of the associated RestApi .

ugResponseType :: Lens' UpdateGatewayResponse 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.