amazonka-apigateway-1.5.0: Amazon API Gateway SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.PutIntegrationResponse

Contents

Description

Represents a put integration.

Synopsis

Creating a Request

putIntegrationResponse Source #

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

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

  • piContentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
  • piResponseTemplates - Specifies a put integration response's templates.
  • piSelectionPattern - Specifies the selection pattern of a put integration response.
  • piResponseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the > prefix.
  • piRestAPIId - The string identifier of the associated RestApi .
  • piResourceId - Specifies a put integration response request's resource identifier.
  • piHttpMethod - Specifies a put integration response request's HTTP method.
  • piStatusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse .

data PutIntegrationResponse Source #

Represents a put integration response request.

See: putIntegrationResponse smart constructor.

Instances

Eq PutIntegrationResponse Source # 
Data PutIntegrationResponse Source # 

Methods

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

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

toConstr :: PutIntegrationResponse -> Constr #

dataTypeOf :: PutIntegrationResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> PutIntegrationResponse -> PutIntegrationResponse #

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

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

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

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

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

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

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

Read PutIntegrationResponse Source # 
Show PutIntegrationResponse Source # 
Generic PutIntegrationResponse Source # 
Hashable PutIntegrationResponse Source # 
ToJSON PutIntegrationResponse Source # 
NFData PutIntegrationResponse Source # 

Methods

rnf :: PutIntegrationResponse -> () #

AWSRequest PutIntegrationResponse Source # 
ToQuery PutIntegrationResponse Source # 
ToPath PutIntegrationResponse Source # 
ToHeaders PutIntegrationResponse Source # 
type Rep PutIntegrationResponse Source # 
type Rep PutIntegrationResponse = D1 (MetaData "PutIntegrationResponse" "Network.AWS.APIGateway.PutIntegrationResponse" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "PutIntegrationResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_piContentHandling") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy))) (S1 (MetaSel (Just Symbol "_piResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_piSelectionPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_piResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_piRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_piResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_piHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_piStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs PutIntegrationResponse Source # 

Request Lenses

piContentHandling :: Lens' PutIntegrationResponse (Maybe ContentHandlingStrategy) Source #

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

piResponseTemplates :: Lens' PutIntegrationResponse (HashMap Text Text) Source #

Specifies a put integration response's templates.

piSelectionPattern :: Lens' PutIntegrationResponse (Maybe Text) Source #

Specifies the selection pattern of a put integration response.

piResponseParameters :: Lens' PutIntegrationResponse (HashMap Text Text) Source #

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the > prefix.

piRestAPIId :: Lens' PutIntegrationResponse Text Source #

The string identifier of the associated RestApi .

piResourceId :: Lens' PutIntegrationResponse Text Source #

Specifies a put integration response request's resource identifier.

piHttpMethod :: Lens' PutIntegrationResponse Text Source #

Specifies a put integration response request's HTTP method.

piStatusCode :: Lens' PutIntegrationResponse Text Source #

Specifies the status code that is used to map the integration response to an existing MethodResponse .

Destructuring the Response

integrationResponse :: IntegrationResponse Source #

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

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

  • intContentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
  • intResponseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
  • intSelectionPattern - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
  • intStatusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse .
  • intResponseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the > prefix.

data IntegrationResponse Source #

Represents an integration response. The status code must map to an existing MethodResponse , and parameters and templates can be used to transform the back-end response.

Creating an API

See: integrationResponse smart constructor.

Instances

Eq IntegrationResponse Source # 
Data IntegrationResponse Source # 

Methods

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

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

toConstr :: IntegrationResponse -> Constr #

dataTypeOf :: IntegrationResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> IntegrationResponse -> IntegrationResponse #

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

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

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

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

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

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

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

Read IntegrationResponse Source # 
Show IntegrationResponse Source # 
Generic IntegrationResponse Source # 
Hashable IntegrationResponse Source # 
FromJSON IntegrationResponse Source # 
NFData IntegrationResponse Source # 

Methods

rnf :: IntegrationResponse -> () #

type Rep IntegrationResponse Source # 
type Rep IntegrationResponse = D1 (MetaData "IntegrationResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "IntegrationResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_intContentHandling") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy))) (S1 (MetaSel (Just Symbol "_intResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_intSelectionPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_intStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_intResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))))))

Response Lenses

intContentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

intResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text) Source #

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

intSelectionPattern :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

intStatusCode :: Lens' IntegrationResponse (Maybe Text) Source #

Specifies the status code that is used to map the integration response to an existing MethodResponse .

intResponseParameters :: Lens' IntegrationResponse (HashMap Text Text) Source #

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the > prefix.