Amazonka.APIGateway.PutMethodResponse

Adds a MethodResponse to an existing Method resource.

Creating a Request

data PutMethodResponse

Request to add a MethodResponse to an existing Method resource.

See: newPutMethodResponse smart constructor.

Constructors

PutMethodResponse'

Fields

• responseModels :: Maybe (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.

• responseParameters :: Maybe (HashMap Text Bool)

  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 name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from 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.)

• restApiId :: Text

  The string identifier of the associated RestApi.

• resourceId :: Text

  The Resource identifier for the Method resource.

• httpMethod :: Text

  The HTTP verb of the Method resource.

• statusCode :: Text

  The method response's status code.

Instances

ToJSON PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

toJSON :: PutMethodResponse -> Value

toEncoding :: PutMethodResponse -> Encoding

toJSONList :: [PutMethodResponse] -> Value

toEncodingList :: [PutMethodResponse] -> Encoding

ToHeaders PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

toHeaders :: PutMethodResponse -> [Header]

ToPath PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

toPath :: PutMethodResponse -> ByteString

ToQuery PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

toQuery :: PutMethodResponse -> QueryString

AWSRequest PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Associated Types

type AWSResponse PutMethodResponse

Methods

request :: (Service -> Service) -> PutMethodResponse -> Request PutMethodResponse

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutMethodResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutMethodResponse)))

Generic PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Associated Types

type Rep PutMethodResponse :: Type -> Type

Methods

from :: PutMethodResponse -> Rep PutMethodResponse x

to :: Rep PutMethodResponse x -> PutMethodResponse

Read PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

readsPrec :: Int -> ReadS PutMethodResponse

readList :: ReadS [PutMethodResponse]

readPrec :: ReadPrec PutMethodResponse

readListPrec :: ReadPrec [PutMethodResponse]

Show PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

showsPrec :: Int -> PutMethodResponse -> ShowS

show :: PutMethodResponse -> String

showList :: [PutMethodResponse] -> ShowS

NFData PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

rnf :: PutMethodResponse -> ()

Eq PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

(==) :: PutMethodResponse -> PutMethodResponse -> Bool

(/=) :: PutMethodResponse -> PutMethodResponse -> Bool

Hashable PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

Methods

hashWithSalt :: Int -> PutMethodResponse -> Int

hash :: PutMethodResponse -> Int

type AWSResponse PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

type AWSResponse PutMethodResponse = MethodResponse

type Rep PutMethodResponse

Defined in Amazonka.APIGateway.PutMethodResponse

type Rep PutMethodResponse = D1 ('MetaData "PutMethodResponse" "Amazonka.APIGateway.PutMethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PutMethodResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "responseModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutMethodResponse

Arguments

:: Text

PutMethodResponse

-> Text

$sel:resourceId:PutMethodResponse'

-> Text

PutMethodResponse

-> Text

PutMethodResponse

-> PutMethodResponse

Create a value of PutMethodResponse 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:

PutMethodResponse, putMethodResponse_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.

PutMethodResponse, putMethodResponse_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 name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from 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.)

PutMethodResponse, putMethodResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:PutMethodResponse', putMethodResponse_resourceId - The Resource identifier for the Method resource.

PutMethodResponse, putMethodResponse_httpMethod - The HTTP verb of the Method resource.

PutMethodResponse, putMethodResponse_statusCode - The method response's status code.

Request Lenses

putMethodResponse_responseModels :: Lens' PutMethodResponse (Maybe (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.

putMethodResponse_responseParameters :: Lens' PutMethodResponse (Maybe (HashMap Text Bool))

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 name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from 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.)

putMethodResponse_restApiId :: Lens' PutMethodResponse Text

The string identifier of the associated RestApi.

putMethodResponse_resourceId :: Lens' PutMethodResponse Text

The Resource identifier for the Method resource.

putMethodResponse_httpMethod :: Lens' PutMethodResponse Text

The HTTP verb of the Method resource.

putMethodResponse_statusCode :: Lens' PutMethodResponse Text

The method response's status code.

Destructuring the Response

data MethodResponse

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

• responseModels :: Maybe (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.

• responseParameters :: Maybe (HashMap Text Bool)

  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.)

• statusCode :: Maybe Text

  The method response's status code.

Instances

FromJSON MethodResponse

Defined in Amazonka.APIGateway.Types.MethodResponse

Methods

parseJSON :: Value -> Parser MethodResponse

parseJSONList :: Value -> Parser [MethodResponse]

Generic MethodResponse

Defined in Amazonka.APIGateway.Types.MethodResponse

Associated Types

type Rep MethodResponse :: Type -> Type

Methods

from :: MethodResponse -> Rep MethodResponse x

to :: Rep MethodResponse x -> MethodResponse

Read MethodResponse

Defined in Amazonka.APIGateway.Types.MethodResponse

Methods

readsPrec :: Int -> ReadS MethodResponse

readList :: ReadS [MethodResponse]

readPrec :: ReadPrec MethodResponse

readListPrec :: ReadPrec [MethodResponse]

Show MethodResponse

Defined in Amazonka.APIGateway.Types.MethodResponse

Methods

showsPrec :: Int -> MethodResponse -> ShowS

show :: MethodResponse -> String

showList :: [MethodResponse] -> ShowS

NFData MethodResponse

Defined in Amazonka.APIGateway.Types.MethodResponse

Methods

rnf :: MethodResponse -> ()

Eq MethodResponse

Defined in Amazonka.APIGateway.Types.MethodResponse

Methods

(==) :: MethodResponse -> MethodResponse -> Bool

(/=) :: MethodResponse -> MethodResponse -> Bool

Hashable MethodResponse

Defined in Amazonka.APIGateway.Types.MethodResponse

Methods

hashWithSalt :: Int -> MethodResponse -> Int

hash :: MethodResponse -> Int

type Rep MethodResponse

Defined in Amazonka.APIGateway.Types.MethodResponse

type Rep MethodResponse = D1 ('MetaData "MethodResponse" "Amazonka.APIGateway.Types.MethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MethodResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "responseModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMethodResponse :: MethodResponse

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))

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))

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)

The method response's status code.