put_method_response¶
Operation¶
async
¶
put_method_response(input: PutMethodResponseInput, plugins: list[Plugin] | None = None) -> PutMethodResponseOutput
Adds a MethodResponse to an existing Method resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutMethodResponseInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutMethodResponseOutput
|
An instance of |
Input¶
dataclass
¶
Request to add a MethodResponse to an existing Method resource.
Attributes¶
class-attribute
instance-attribute
¶
http_method: str | None = None
The HTTP verb of the Method resource.
class-attribute
instance-attribute
¶
resource_id: str | None = None
The Resource identifier for the Method resource.
class-attribute
instance-attribute
¶
response_models: dict[str, str] | None = None
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.
class-attribute
instance-attribute
¶
response_parameters: dict[str, bool] | None = None
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.)
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
status_code: str | None = None
The method response's status code.
Output¶
dataclass
¶
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.
Attributes¶
class-attribute
instance-attribute
¶
response_models: dict[str, str] | None = None
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.
class-attribute
instance-attribute
¶
response_parameters: dict[str, bool] | None = None
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.)
class-attribute
instance-attribute
¶
status_code: str | None = None
The method response's status code.