| Copyright | (c) 2013-2015 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 |
Network.AWS.APIGateway.PutIntegrationResponse
Description
Represents a put integration.
See: AWS API Reference for PutIntegrationResponse.
- 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
Arguments
| :: 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.
Instances
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
Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern 'integration.response.header.{name}'.
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 backend 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 backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, 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
Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern 'integration.response.header.{name}'.