Skip to content

update_method_response

Operation

update_method_response

update_method_response(request: UpdateMethodResponseInput | UpdateMethodResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateMethodResponseInputDict]) -> UpdateMethodResponseOutput

Updates an existing MethodResponse resource.

Parameters:

Name Type Description Default
request UpdateMethodResponseInput | UpdateMethodResponseInputDict | 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[UpdateMethodResponseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateMethodResponseOutput

An instance of UpdateMethodResponseOutput.

update_method_response async

update_method_response(request: UpdateMethodResponseInput | UpdateMethodResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateMethodResponseInputDict]) -> UpdateMethodResponseOutput

Updates an existing MethodResponse resource.

Parameters:

Name Type Description Default
request UpdateMethodResponseInput | UpdateMethodResponseInputDict | 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[UpdateMethodResponseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateMethodResponseOutput

An instance of UpdateMethodResponseOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateMethodResponseInputDict

Bases: TypedDict

Dictionary form of UpdateMethodResponseInput.

Attributes

http_method instance-attribute
http_method: Required[str]

The HTTP verb of the Method resource.

patch_operations instance-attribute
patch_operations: Sequence[PatchOperation | PatchOperationDict] | None

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

resource_id instance-attribute
resource_id: Required[str]

The Resource identifier for the MethodResponse resource.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

status_code instance-attribute
status_code: Required[str]

The status code for the MethodResponse resource.

UpdateMethodResponseInput dataclass

Bases: _SerdeShape

A request to update an existing MethodResponse resource.

Attributes

http_method class-attribute instance-attribute
http_method: str | None = ...

The HTTP verb of the Method resource.

patch_operations class-attribute instance-attribute
patch_operations: list[PatchOperation] | None = ...

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

resource_id class-attribute instance-attribute
resource_id: str | None = ...

The Resource identifier for the MethodResponse resource.

rest_api_id class-attribute instance-attribute
rest_api_id: str | None = ...

The string identifier of the associated RestApi.

status_code class-attribute instance-attribute
status_code: str | None = ...

The status code for the MethodResponse resource.

Output

UpdateMethodResponseOutput 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
response_metadata: ResponseMetadata = ...

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
response_models: dict[str, str] | 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.

response_parameters class-attribute instance-attribute
response_parameters: dict[str, bool] | 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.)

status_code class-attribute instance-attribute
status_code: str | None = ...

The method response's status code.