Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.UpdateGatewayResponse

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data UpdateGatewayResponse = UpdateGatewayResponse' {
- patchOperations :: Maybe [PatchOperation]
- restApiId :: Text
- responseType :: GatewayResponseType
}
newUpdateGatewayResponse :: Text -> GatewayResponseType -> UpdateGatewayResponse
updateGatewayResponse_patchOperations :: Lens' UpdateGatewayResponse (Maybe [PatchOperation])
updateGatewayResponse_restApiId :: Lens' UpdateGatewayResponse Text
updateGatewayResponse_responseType :: Lens' UpdateGatewayResponse GatewayResponseType
data GatewayResponse = GatewayResponse' {
- defaultResponse :: Maybe Bool
- responseParameters :: Maybe (HashMap Text Text)
- responseTemplates :: Maybe (HashMap Text Text)
- responseType :: Maybe GatewayResponseType
- statusCode :: Maybe Text
}
newGatewayResponse :: GatewayResponse
gatewayResponse_defaultResponse :: Lens' GatewayResponse (Maybe Bool)
gatewayResponse_responseParameters :: Lens' GatewayResponse (Maybe (HashMap Text Text))
gatewayResponse_responseTemplates :: Lens' GatewayResponse (Maybe (HashMap Text Text))
gatewayResponse_responseType :: Lens' GatewayResponse (Maybe GatewayResponseType)
gatewayResponse_statusCode :: Lens' GatewayResponse (Maybe Text)

Creating a Request

data UpdateGatewayResponse Source #

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

See: newUpdateGatewayResponse smart constructor.

Constructors

UpdateGatewayResponse'
Fields patchOperations :: Maybe [PatchOperation] For more information about supported patch operations, see Patch Operations. restApiId :: Text The string identifier of the associated RestApi. responseType :: GatewayResponseType The response type of the associated GatewayResponse.

Instances

Instances details

ToJSON UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods toJSON :: UpdateGatewayResponse -> Value # toEncoding :: UpdateGatewayResponse -> Encoding # toJSONList :: [UpdateGatewayResponse] -> Value # toEncodingList :: [UpdateGatewayResponse] -> Encoding #
ToHeaders UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods toHeaders :: UpdateGatewayResponse -> [Header] #
ToPath UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods toPath :: UpdateGatewayResponse -> ByteString #
ToQuery UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods toQuery :: UpdateGatewayResponse -> QueryString #
AWSRequest UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Associated Types type AWSResponse UpdateGatewayResponse # Methods request :: (Service -> Service) -> UpdateGatewayResponse -> Request UpdateGatewayResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateGatewayResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGatewayResponse))) #
Generic UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Associated Types type Rep UpdateGatewayResponse :: Type -> Type # Methods from :: UpdateGatewayResponse -> Rep UpdateGatewayResponse x # to :: Rep UpdateGatewayResponse x -> UpdateGatewayResponse #
Read UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods readsPrec :: Int -> ReadS UpdateGatewayResponse # readList :: ReadS [UpdateGatewayResponse] # readPrec :: ReadPrec UpdateGatewayResponse # readListPrec :: ReadPrec [UpdateGatewayResponse] #
Show UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods showsPrec :: Int -> UpdateGatewayResponse -> ShowS # show :: UpdateGatewayResponse -> String # showList :: [UpdateGatewayResponse] -> ShowS #
NFData UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods rnf :: UpdateGatewayResponse -> () #
Eq UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods (==) :: UpdateGatewayResponse -> UpdateGatewayResponse -> Bool # (/=) :: UpdateGatewayResponse -> UpdateGatewayResponse -> Bool #
Hashable UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods hashWithSalt :: Int -> UpdateGatewayResponse -> Int # hash :: UpdateGatewayResponse -> Int #
type AWSResponse UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse type AWSResponse UpdateGatewayResponse = GatewayResponse
type Rep UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse type Rep UpdateGatewayResponse = D1 ('MetaData "UpdateGatewayResponse" "Amazonka.APIGateway.UpdateGatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateGatewayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayResponseType))))

newUpdateGatewayResponse Source #

Arguments

:: Text	`UpdateGatewayResponse`
-> GatewayResponseType	`UpdateGatewayResponse`
-> UpdateGatewayResponse

Create a value of UpdateGatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateGatewayResponse', updateGatewayResponse_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateGatewayResponse, updateGatewayResponse_restApiId - The string identifier of the associated RestApi.

UpdateGatewayResponse, updateGatewayResponse_responseType - The response type of the associated GatewayResponse.

Request Lenses

updateGatewayResponse_patchOperations :: Lens' UpdateGatewayResponse (Maybe [PatchOperation]) Source #

For more information about supported patch operations, see Patch Operations.

updateGatewayResponse_restApiId :: Lens' UpdateGatewayResponse Text Source #

The string identifier of the associated RestApi.

updateGatewayResponse_responseType :: Lens' UpdateGatewayResponse GatewayResponseType Source #

The response type of the associated GatewayResponse.

Destructuring the Response

data GatewayResponse Source #

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

See: newGatewayResponse smart constructor.

Constructors

GatewayResponse'

Fields

defaultResponse :: 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 API Gateway without any customization by an API developer.
responseParameters :: Maybe (HashMap Text Text)
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
responseTemplates :: Maybe (HashMap Text Text)
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
responseType :: Maybe GatewayResponseType
The response type of the associated GatewayResponse.
statusCode :: Maybe Text
The HTTP status code for this GatewayResponse.

Instances

Instances details

FromJSON GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods parseJSON :: Value -> Parser GatewayResponse # parseJSONList :: Value -> Parser [GatewayResponse] #
Generic GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Associated Types type Rep GatewayResponse :: Type -> Type # Methods from :: GatewayResponse -> Rep GatewayResponse x # to :: Rep GatewayResponse x -> GatewayResponse #
Read GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods readsPrec :: Int -> ReadS GatewayResponse # readList :: ReadS [GatewayResponse] # readPrec :: ReadPrec GatewayResponse # readListPrec :: ReadPrec [GatewayResponse] #
Show GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods showsPrec :: Int -> GatewayResponse -> ShowS # show :: GatewayResponse -> String # showList :: [GatewayResponse] -> ShowS #
NFData GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods rnf :: GatewayResponse -> () #
Eq GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods (==) :: GatewayResponse -> GatewayResponse -> Bool # (/=) :: GatewayResponse -> GatewayResponse -> Bool #
Hashable GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods hashWithSalt :: Int -> GatewayResponse -> Int # hash :: GatewayResponse -> Int #
type Rep GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse type Rep GatewayResponse = D1 ('MetaData "GatewayResponse" "Amazonka.APIGateway.Types.GatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GatewayResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayResponseType)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGatewayResponse :: GatewayResponse Source #

Create a value of GatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultResponse:GatewayResponse', gatewayResponse_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 API Gateway without any customization by an API developer.

$sel:responseParameters:GatewayResponse', gatewayResponse_responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseTemplates:GatewayResponse', gatewayResponse_responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseType:GatewayResponse', gatewayResponse_responseType - The response type of the associated GatewayResponse.

$sel:statusCode:GatewayResponse', gatewayResponse_statusCode - The HTTP status code for this GatewayResponse.

Response Lenses

gatewayResponse_defaultResponse :: Lens' GatewayResponse (Maybe Bool) Source #

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.

gatewayResponse_responseParameters :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

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

gatewayResponse_responseTemplates :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #

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

gatewayResponse_responseType :: Lens' GatewayResponse (Maybe GatewayResponseType) Source #

The response type of the associated GatewayResponse.

gatewayResponse_statusCode :: Lens' GatewayResponse (Maybe Text) Source #

The HTTP status code for this GatewayResponse.