put_method_response¶
Operation¶
put_method_response
¶
put_method_response(request: PutMethodResponseInput | PutMethodResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutMethodResponseInputDict]) -> PutMethodResponseOutput
Adds a MethodResponse to an existing Method resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutMethodResponseInput | PutMethodResponseInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[PutMethodResponseInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutMethodResponseOutput
|
An instance of |
put_method_response
async
¶
put_method_response(request: PutMethodResponseInput | PutMethodResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutMethodResponseInputDict]) -> PutMethodResponseOutput
Adds a MethodResponse to an existing Method resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PutMethodResponseInput | PutMethodResponseInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[PutMethodResponseInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PutMethodResponseOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
PutMethodResponseInputDict
¶
Bases: TypedDict
Dictionary form of PutMethodResponseInput.
Attributes¶
resource_id
instance-attribute
¶
The Resource identifier for the Method resource.
response_models
instance-attribute
¶
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.
response_parameters
instance-attribute
¶
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.)
rest_api_id
instance-attribute
¶
The string identifier of the associated RestApi.
PutMethodResponseInput
dataclass
¶
Bases: _SerdeShape
Request to add a MethodResponse to an existing Method resource.
Attributes¶
http_method
class-attribute
instance-attribute
¶
http_method: str | None = ...
The HTTP verb of the Method resource.
resource_id
class-attribute
instance-attribute
¶
resource_id: str | None = ...
The Resource identifier for the Method resource.
response_models
class-attribute
instance-attribute
¶
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.
response_parameters
class-attribute
instance-attribute
¶
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.)
Output¶
PutMethodResponseOutput
dataclass
¶
Bases: _SerdeShape
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¶
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
response_models
class-attribute
instance-attribute
¶
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.
response_parameters
class-attribute
instance-attribute
¶
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.)