Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@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
- 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
- iResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text)
- iSelectionPattern :: Lens' IntegrationResponse (Maybe Text)
- iStatusCode :: Lens' IntegrationResponse (Maybe Text)
- iResponseParameters :: 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:
data PutIntegrationResponse Source #
Represents a put integration response request.
See: putIntegrationResponse
smart constructor.
Request Lenses
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 #
Specifies a put integration response request's API identifier.
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:
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
iResponseTemplates :: 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.
iSelectionPattern :: 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.
iStatusCode :: Lens' IntegrationResponse (Maybe Text) Source #
Specifies the status code that is used to map the integration response to an existing MethodResponse.
iResponseParameters :: 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.