| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.APIGateway.GetMethodResponse
Description
Describes a MethodResponse resource.
Synopsis
- data GetMethodResponse = GetMethodResponse' {
- restApiId :: Text
- resourceId :: Text
- httpMethod :: Text
- statusCode :: Text
- newGetMethodResponse :: Text -> Text -> Text -> Text -> GetMethodResponse
- getMethodResponse_restApiId :: Lens' GetMethodResponse Text
- getMethodResponse_resourceId :: Lens' GetMethodResponse Text
- getMethodResponse_httpMethod :: Lens' GetMethodResponse Text
- getMethodResponse_statusCode :: Lens' GetMethodResponse Text
- data MethodResponse = MethodResponse' {
- responseModels :: Maybe (HashMap Text Text)
- responseParameters :: Maybe (HashMap Text Bool)
- statusCode :: Maybe Text
- newMethodResponse :: MethodResponse
- methodResponse_responseModels :: Lens' MethodResponse (Maybe (HashMap Text Text))
- methodResponse_responseParameters :: Lens' MethodResponse (Maybe (HashMap Text Bool))
- methodResponse_statusCode :: Lens' MethodResponse (Maybe Text)
Creating a Request
data GetMethodResponse Source #
Request to describe a MethodResponse resource.
See: newGetMethodResponse smart constructor.
Constructors
| GetMethodResponse' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> GetMethodResponse |
Create a value of GetMethodResponse 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:
GetMethodResponse, getMethodResponse_restApiId - The string identifier of the associated RestApi.
$sel:resourceId:GetMethodResponse', getMethodResponse_resourceId - The Resource identifier for the MethodResponse resource.
GetMethodResponse, getMethodResponse_httpMethod - The HTTP verb of the Method resource.
GetMethodResponse, getMethodResponse_statusCode - The status code for the MethodResponse resource.
Request Lenses
getMethodResponse_restApiId :: Lens' GetMethodResponse Text Source #
The string identifier of the associated RestApi.
getMethodResponse_resourceId :: Lens' GetMethodResponse Text Source #
The Resource identifier for the MethodResponse resource.
getMethodResponse_httpMethod :: Lens' GetMethodResponse Text Source #
The HTTP verb of the Method resource.
getMethodResponse_statusCode :: Lens' GetMethodResponse Text Source #
The status code for the MethodResponse resource.
Destructuring the Response
data MethodResponse Source #
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
See: newMethodResponse smart constructor.
Constructors
| MethodResponse' | |
Fields
| |
Instances
newMethodResponse :: MethodResponse Source #
Create a value of MethodResponse 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:responseModels:MethodResponse', methodResponse_responseModels - Specifies the Model resources used for the response's content-type.
Response models are represented as a key/value map, with a content-type
as the key and a Model name as the value.
$sel:responseParameters:MethodResponse', methodResponse_responseParameters - A key-value map specifying required or optional response parameters that
API Gateway can send back to the caller. A key defines a method response
header and the value specifies whether the associated method response
header is required or not. The expression of the key must match the
pattern method.response.header.{name}, where name is a valid and
unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping
you prescribe in the API's IntegrationResponse. The integration
response data that can be mapped include an integration response header
expressed in integration.response.header.{name}, a static value
enclosed within a pair of single quotes (e.g., 'application/json'),
or a JSON expression from the back-end response payload in the form of
integration.response.body.{JSON-expression}, where JSON-expression
is a valid JSON expression without the $ prefix.)
$sel:statusCode:MethodResponse', methodResponse_statusCode - The method response's status code.
Response Lenses
methodResponse_responseModels :: Lens' MethodResponse (Maybe (HashMap Text Text)) Source #
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
methodResponse_responseParameters :: Lens' MethodResponse (Maybe (HashMap Text Bool)) Source #
A key-value map specifying required or optional response parameters that
API Gateway can send back to the caller. A key defines a method response
header and the value specifies whether the associated method response
header is required or not. The expression of the key must match the
pattern method.response.header.{name}, where name is a valid and
unique header name. API Gateway passes certain integration response data
to the method response headers specified here according to the mapping
you prescribe in the API's IntegrationResponse. The integration
response data that can be mapped include an integration response header
expressed in integration.response.header.{name}, a static value
enclosed within a pair of single quotes (e.g., 'application/json'),
or a JSON expression from the back-end response payload in the form of
integration.response.body.{JSON-expression}, where JSON-expression
is a valid JSON expression without the $ prefix.)
methodResponse_statusCode :: Lens' MethodResponse (Maybe Text) Source #
The method response's status code.