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.PutGatewayResponse

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data PutGatewayResponse = PutGatewayResponse' {
- responseParameters :: Maybe (HashMap Text Text)
- responseTemplates :: Maybe (HashMap Text Text)
- statusCode :: Maybe Text
- restApiId :: Text
- responseType :: GatewayResponseType
}
newPutGatewayResponse :: Text -> GatewayResponseType -> PutGatewayResponse
putGatewayResponse_responseParameters :: Lens' PutGatewayResponse (Maybe (HashMap Text Text))
putGatewayResponse_responseTemplates :: Lens' PutGatewayResponse (Maybe (HashMap Text Text))
putGatewayResponse_statusCode :: Lens' PutGatewayResponse (Maybe Text)
putGatewayResponse_restApiId :: Lens' PutGatewayResponse Text
putGatewayResponse_responseType :: Lens' PutGatewayResponse 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 PutGatewayResponse Source #

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

See: newPutGatewayResponse smart constructor.

Constructors

PutGatewayResponse'

Fields

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.
statusCode :: Maybe Text
The HTTP status code of the GatewayResponse.
restApiId :: Text
The string identifier of the associated RestApi.
responseType :: GatewayResponseType
The response type of the associated GatewayResponse

Instances

Instances details

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

newPutGatewayResponse Source #

Arguments

:: Text	`PutGatewayResponse`
-> GatewayResponseType	`PutGatewayResponse`
-> PutGatewayResponse

Create a value of PutGatewayResponse 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:

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

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

PutGatewayResponse, putGatewayResponse_statusCode - The HTTP status code of the GatewayResponse.

PutGatewayResponse, putGatewayResponse_restApiId - The string identifier of the associated RestApi.

PutGatewayResponse, putGatewayResponse_responseType - The response type of the associated GatewayResponse

Request Lenses

putGatewayResponse_responseParameters :: Lens' PutGatewayResponse (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.

putGatewayResponse_responseTemplates :: Lens' PutGatewayResponse (Maybe (HashMap Text Text)) Source #

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

putGatewayResponse_statusCode :: Lens' PutGatewayResponse (Maybe Text) Source #

The HTTP status code of the GatewayResponse.

putGatewayResponse_restApiId :: Lens' PutGatewayResponse Text Source #

The string identifier of the associated RestApi.

putGatewayResponse_responseType :: Lens' PutGatewayResponse 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.