Amazonka.APIGateway.UpdateMethodResponse

Updates an existing MethodResponse resource.

Creating a Request

data UpdateMethodResponse

A request to update an existing MethodResponse resource.

See: newUpdateMethodResponse smart constructor.

Constructors

UpdateMethodResponse'

Fields

• patchOperations :: Maybe [PatchOperation]

  For more information about supported patch operations, see Patch Operations.

• restApiId :: Text

  The string identifier of the associated RestApi.

• resourceId :: Text

  The Resource identifier for the MethodResponse resource.

• httpMethod :: Text

  The HTTP verb of the Method resource.

• statusCode :: Text

  The status code for the MethodResponse resource.

Instances

ToJSON UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

toJSON :: UpdateMethodResponse -> Value

toEncoding :: UpdateMethodResponse -> Encoding

toJSONList :: [UpdateMethodResponse] -> Value

toEncodingList :: [UpdateMethodResponse] -> Encoding

ToHeaders UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

toHeaders :: UpdateMethodResponse -> [Header]

ToPath UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

toPath :: UpdateMethodResponse -> ByteString

ToQuery UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

toQuery :: UpdateMethodResponse -> QueryString

AWSRequest UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Associated Types

type AWSResponse UpdateMethodResponse

Methods

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

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

Generic UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Associated Types

type Rep UpdateMethodResponse :: Type -> Type

Methods

from :: UpdateMethodResponse -> Rep UpdateMethodResponse x

to :: Rep UpdateMethodResponse x -> UpdateMethodResponse

Read UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

readsPrec :: Int -> ReadS UpdateMethodResponse

readList :: ReadS [UpdateMethodResponse]

readPrec :: ReadPrec UpdateMethodResponse

readListPrec :: ReadPrec [UpdateMethodResponse]

Show UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

showsPrec :: Int -> UpdateMethodResponse -> ShowS

show :: UpdateMethodResponse -> String

showList :: [UpdateMethodResponse] -> ShowS

NFData UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

rnf :: UpdateMethodResponse -> ()

Eq UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

(==) :: UpdateMethodResponse -> UpdateMethodResponse -> Bool

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

Hashable UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

Methods

hashWithSalt :: Int -> UpdateMethodResponse -> Int

hash :: UpdateMethodResponse -> Int

type AWSResponse UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

type AWSResponse UpdateMethodResponse = MethodResponse

type Rep UpdateMethodResponse

Defined in Amazonka.APIGateway.UpdateMethodResponse

type Rep UpdateMethodResponse = D1 ('MetaData "UpdateMethodResponse" "Amazonka.APIGateway.UpdateMethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateMethodResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: 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)))))

newUpdateMethodResponse

Arguments

:: Text

UpdateMethodResponse

-> Text

$sel:resourceId:UpdateMethodResponse'

-> Text

UpdateMethodResponse

-> Text

UpdateMethodResponse

-> UpdateMethodResponse

Create a value of UpdateMethodResponse 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:patchOperations:UpdateMethodResponse', updateMethodResponse_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateMethodResponse, updateMethodResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:UpdateMethodResponse', updateMethodResponse_resourceId - The Resource identifier for the MethodResponse resource.

UpdateMethodResponse, updateMethodResponse_httpMethod - The HTTP verb of the Method resource.

UpdateMethodResponse, updateMethodResponse_statusCode - The status code for the MethodResponse resource.

Request Lenses

updateMethodResponse_patchOperations :: Lens' UpdateMethodResponse (Maybe [PatchOperation])

For more information about supported patch operations, see Patch Operations.

updateMethodResponse_restApiId :: Lens' UpdateMethodResponse Text

The string identifier of the associated RestApi.

updateMethodResponse_resourceId :: Lens' UpdateMethodResponse Text

The Resource identifier for the MethodResponse resource.

updateMethodResponse_httpMethod :: Lens' UpdateMethodResponse Text

The HTTP verb of the Method resource.

updateMethodResponse_statusCode :: Lens' UpdateMethodResponse Text

The status code for the MethodResponse resource.

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.