Network.AWS.APIGateway.GetMethodResponse

Describes a MethodResponse resource.

See: AWS API Reference for GetMethodResponse.

Creating a Request

getMethodResponse

Arguments

:: Text

gmRestAPIId

-> Text

gmResourceId

-> Text

gmHttpMethod

-> Text

gmStatusCode

-> GetMethodResponse

Creates a value of GetMethodResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gmRestAPIId
• gmResourceId
• gmHttpMethod
• gmStatusCode

data GetMethodResponse

Request to describe a MethodResponse resource.

See: getMethodResponse smart constructor.

Instances

Eq GetMethodResponse

Data GetMethodResponse

Read GetMethodResponse

Show GetMethodResponse

Generic GetMethodResponse

AWSRequest GetMethodResponse

ToPath GetMethodResponse

ToHeaders GetMethodResponse

ToQuery GetMethodResponse

type Rep GetMethodResponse

type Rs GetMethodResponse = MethodResponse

Request Lenses

gmRestAPIId :: Lens' GetMethodResponse Text

The RestApi identifier for the MethodResponse resource.

gmResourceId :: Lens' GetMethodResponse Text

The Resource identifier for the MethodResponse resource.

gmHttpMethod :: Lens' GetMethodResponse Text

The HTTP verb identifier for the parent Method resource.

gmStatusCode :: Lens' GetMethodResponse Text

The status code identifier for the MethodResponse resource.

Destructuring the Response

methodResponse :: MethodResponse

Creates a value of MethodResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mResponseModels
• mStatusCode
• mResponseParameters

data MethodResponse

Represents a method response. Amazon API Gateway sends back the status code to the caller as the HTTP status code. Parameters and models can be used to transform the response from the method's integration.

See: methodResponse smart constructor.

Instances

Eq MethodResponse

Data MethodResponse

Read MethodResponse

Show MethodResponse

Generic MethodResponse

FromJSON MethodResponse

type Rep MethodResponse

Response Lenses

mResponseModels :: Lens' MethodResponse (HashMap Text Text)

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.

mStatusCode :: Lens' MethodResponse (Maybe Text)

The method response's status code.

mResponseParameters :: Lens' MethodResponse (HashMap Text Bool)

Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a boolean flag as the value, which is used to specify whether the parameter is required. A destination must match the pattern 'method.response.header.{name}', where name is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.