Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Represents a put integration.
- putIntegrationResponse :: Text -> Text -> Text -> Text -> PutIntegrationResponse
- data PutIntegrationResponse
- piContentHandling :: Lens' PutIntegrationResponse (Maybe ContentHandlingStrategy)
- piResponseTemplates :: Lens' PutIntegrationResponse (HashMap Text Text)
- piSelectionPattern :: Lens' PutIntegrationResponse (Maybe Text)
- piResponseParameters :: Lens' PutIntegrationResponse (HashMap Text Text)
- piRestAPIId :: Lens' PutIntegrationResponse Text
- piResourceId :: Lens' PutIntegrationResponse Text
- piHttpMethod :: Lens' PutIntegrationResponse Text
- piStatusCode :: Lens' PutIntegrationResponse Text
- integrationResponse :: IntegrationResponse
- data IntegrationResponse
- intContentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy)
- intResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text)
- intSelectionPattern :: Lens' IntegrationResponse (Maybe Text)
- intStatusCode :: Lens' IntegrationResponse (Maybe Text)
- intResponseParameters :: Lens' IntegrationResponse (HashMap Text Text)
Creating a Request
putIntegrationResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> PutIntegrationResponse |
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 areCONVERT_TO_BINARY
andCONVERT_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 ofmethod.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
must be a valid and unique response header name andJSON-expression
a valid JSON expression without the>
prefix.piRestAPIId
- [Required] The string identifier of the associatedRestApi
.piResourceId
- [Required] Specifies a put integration response request's resource identifier.piHttpMethod
- [Required] Specifies a put integration response request's HTTP method.piStatusCode
- [Required] Specifies the status code that is used to map the integration response to an existingMethodResponse
.
data PutIntegrationResponse Source #
Represents a put integration response request.
See: putIntegrationResponse
smart constructor.
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 #
- Required
- The string identifier of the associated
RestApi
.
piResourceId :: Lens' PutIntegrationResponse Text Source #
- Required
- Specifies a put integration response request's resource identifier.
piHttpMethod :: Lens' PutIntegrationResponse Text Source #
- Required
- Specifies a put integration response request's HTTP method.
piStatusCode :: Lens' PutIntegrationResponse Text Source #
- Required
- 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 areCONVERT_TO_BINARY
andCONVERT_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 existingMethodResponse
.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 ofmethod.response.header.{name}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-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.
See: integrationResponse
smart constructor.
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.