Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.PutIntegrationResponse

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Represents a put integration.

Synopsis

data PutIntegrationResponse = PutIntegrationResponse' {
- contentHandling :: Maybe ContentHandlingStrategy
- responseTemplates :: Maybe (HashMap Text Text)
- selectionPattern :: Maybe Text
- responseParameters :: Maybe (HashMap Text Text)
- restApiId :: Text
- resourceId :: Text
- httpMethod :: Text
- statusCode :: Text
}
newPutIntegrationResponse :: Text -> Text -> Text -> Text -> PutIntegrationResponse
putIntegrationResponse_contentHandling :: Lens' PutIntegrationResponse (Maybe ContentHandlingStrategy)
putIntegrationResponse_responseTemplates :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text))
putIntegrationResponse_selectionPattern :: Lens' PutIntegrationResponse (Maybe Text)
putIntegrationResponse_responseParameters :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text))
putIntegrationResponse_restApiId :: Lens' PutIntegrationResponse Text
putIntegrationResponse_resourceId :: Lens' PutIntegrationResponse Text
putIntegrationResponse_httpMethod :: Lens' PutIntegrationResponse Text
putIntegrationResponse_statusCode :: Lens' PutIntegrationResponse Text
data IntegrationResponse = IntegrationResponse' {
- contentHandling :: Maybe ContentHandlingStrategy
- responseTemplates :: Maybe (HashMap Text Text)
- selectionPattern :: Maybe Text
- statusCode :: Maybe Text
- responseParameters :: Maybe (HashMap Text Text)
}
newIntegrationResponse :: IntegrationResponse
integrationResponse_contentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy)
integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
integrationResponse_selectionPattern :: Lens' IntegrationResponse (Maybe Text)
integrationResponse_statusCode :: Lens' IntegrationResponse (Maybe Text)
integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text))

Creating a Request

data PutIntegrationResponse Source #

Represents a put integration response request.

See: newPutIntegrationResponse smart constructor.

Constructors

PutIntegrationResponse'

Fields

contentHandling :: Maybe ContentHandlingStrategy
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.
responseTemplates :: Maybe (HashMap Text Text)
Specifies a put integration response's templates.
selectionPattern :: Maybe Text
Specifies the selection pattern of a put integration response.
responseParameters :: Maybe (HashMap Text Text)
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.
restApiId :: Text
Required
The string identifier of the associated RestApi.
resourceId :: Text
Required
Specifies a put integration response request's resource identifier.
httpMethod :: Text
Required
Specifies a put integration response request's HTTP method.
statusCode :: Text
Required
Specifies the status code that is used to map the integration response to an existing MethodResponse.

Instances

Instances details

Eq PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods (==) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool # (/=) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool #
Read PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods readsPrec :: Int -> ReadS PutIntegrationResponse # readList :: ReadS [PutIntegrationResponse] # readPrec :: ReadPrec PutIntegrationResponse # readListPrec :: ReadPrec [PutIntegrationResponse] #
Show PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods showsPrec :: Int -> PutIntegrationResponse -> ShowS # show :: PutIntegrationResponse -> String # showList :: [PutIntegrationResponse] -> ShowS #
Generic PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Associated Types type Rep PutIntegrationResponse :: Type -> Type # Methods from :: PutIntegrationResponse -> Rep PutIntegrationResponse x # to :: Rep PutIntegrationResponse x -> PutIntegrationResponse #
NFData PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods rnf :: PutIntegrationResponse -> () #
Hashable PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods hashWithSalt :: Int -> PutIntegrationResponse -> Int # hash :: PutIntegrationResponse -> Int #
ToJSON PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods toJSON :: PutIntegrationResponse -> Value # toEncoding :: PutIntegrationResponse -> Encoding # toJSONList :: [PutIntegrationResponse] -> Value # toEncodingList :: [PutIntegrationResponse] -> Encoding #
AWSRequest PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Associated Types type AWSResponse PutIntegrationResponse # Methods request :: PutIntegrationResponse -> Request PutIntegrationResponse # response :: MonadResource m => Logger -> Service -> Proxy PutIntegrationResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutIntegrationResponse))) #
ToHeaders PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods toHeaders :: PutIntegrationResponse -> [Header] #
ToPath PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods toPath :: PutIntegrationResponse -> ByteString #
ToQuery PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods toQuery :: PutIntegrationResponse -> QueryString #
type Rep PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse type Rep PutIntegrationResponse = D1 ('MetaData "PutIntegrationResponse" "Amazonka.APIGateway.PutIntegrationResponse" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "PutIntegrationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "selectionPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse type AWSResponse PutIntegrationResponse = IntegrationResponse

newPutIntegrationResponse Source #

Arguments

:: Text	`$sel:restApiId:PutIntegrationResponse'`
-> Text	`$sel:resourceId:PutIntegrationResponse'`
-> Text	`$sel:httpMethod:PutIntegrationResponse'`
-> Text	`$sel:statusCode:PutIntegrationResponse'`
-> PutIntegrationResponse

Create a value of PutIntegrationResponse 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:contentHandling:PutIntegrationResponse', putIntegrationResponse_contentHandling - 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.

$sel:responseTemplates:PutIntegrationResponse', putIntegrationResponse_responseTemplates - Specifies a put integration response's templates.

$sel:selectionPattern:PutIntegrationResponse', putIntegrationResponse_selectionPattern - Specifies the selection pattern of a put integration response.

$sel:responseParameters:PutIntegrationResponse', putIntegrationResponse_responseParameters - 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.

$sel:restApiId:PutIntegrationResponse', putIntegrationResponse_restApiId - [Required] The string identifier of the associated RestApi.

$sel:resourceId:PutIntegrationResponse', putIntegrationResponse_resourceId - [Required] Specifies a put integration response request's resource identifier.

$sel:httpMethod:PutIntegrationResponse', putIntegrationResponse_httpMethod - [Required] Specifies a put integration response request's HTTP method.

$sel:statusCode:PutIntegrationResponse', putIntegrationResponse_statusCode - [Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.

Request Lenses

putIntegrationResponse_contentHandling :: 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.

putIntegrationResponse_responseTemplates :: Lens' PutIntegrationResponse (Maybe (HashMap Text Text)) Source #

Specifies a put integration response's templates.

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

Specifies the selection pattern of a put integration response.

putIntegrationResponse_responseParameters :: Lens' PutIntegrationResponse (Maybe (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.

putIntegrationResponse_restApiId :: Lens' PutIntegrationResponse Text Source #

Required: The string identifier of the associated RestApi.

putIntegrationResponse_resourceId :: Lens' PutIntegrationResponse Text Source #

Required: Specifies a put integration response request's resource identifier.

putIntegrationResponse_httpMethod :: Lens' PutIntegrationResponse Text Source #

Required: Specifies a put integration response request's HTTP method.

putIntegrationResponse_statusCode :: Lens' PutIntegrationResponse Text Source #

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

Destructuring the Response

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: newIntegrationResponse smart constructor.

Constructors

IntegrationResponse'

Fields

contentHandling :: Maybe ContentHandlingStrategy
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.
responseTemplates :: Maybe (HashMap Text Text)
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.
selectionPattern :: Maybe Text
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.
statusCode :: Maybe Text
Specifies the status code that is used to map the integration response to an existing MethodResponse.
responseParameters :: Maybe (HashMap Text Text)
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.

Instances

Instances details

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

newIntegrationResponse :: IntegrationResponse Source #

Create a value of IntegrationResponse 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:contentHandling:IntegrationResponse', integrationResponse_contentHandling - 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.

$sel:responseTemplates:IntegrationResponse', integrationResponse_responseTemplates - 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.

$sel:selectionPattern:IntegrationResponse', integrationResponse_selectionPattern - 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.

$sel:statusCode:IntegrationResponse', integrationResponse_statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

$sel:responseParameters:IntegrationResponse', integrationResponse_responseParameters - 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.

Response Lenses

integrationResponse_contentHandling :: 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.

integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (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.

integrationResponse_selectionPattern :: 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.

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

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

integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (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.