Skip to content

put_integration_response

Operation

put_integration_response

put_integration_response(request: PutIntegrationResponseInput | PutIntegrationResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutIntegrationResponseInputDict]) -> PutIntegrationResponseOutput

Represents a put integration.

Parameters:

Name Type Description Default
request PutIntegrationResponseInput | PutIntegrationResponseInputDict | 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[PutIntegrationResponseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutIntegrationResponseOutput

An instance of PutIntegrationResponseOutput.

put_integration_response async

put_integration_response(request: PutIntegrationResponseInput | PutIntegrationResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutIntegrationResponseInputDict]) -> PutIntegrationResponseOutput

Represents a put integration.

Parameters:

Name Type Description Default
request PutIntegrationResponseInput | PutIntegrationResponseInputDict | 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[PutIntegrationResponseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
PutIntegrationResponseOutput

An instance of PutIntegrationResponseOutput.

Input

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

PutIntegrationResponseInputDict

Bases: TypedDict

Dictionary form of PutIntegrationResponseInput.

Attributes

content_handling instance-attribute
content_handling: str | None

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

http_method instance-attribute
http_method: Required[str]

Specifies a put integration response request's HTTP method.

resource_id instance-attribute
resource_id: Required[str]

Specifies a put integration response request's resource identifier.

response_parameters instance-attribute
response_parameters: Mapping[str, str] | None

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

response_templates instance-attribute
response_templates: Mapping[str, str] | None

Specifies a put integration response's templates.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

selection_pattern instance-attribute
selection_pattern: str | None

Specifies the selection pattern of a put integration response.

status_code instance-attribute
status_code: Required[str]

Specifies the status code that is used to map the integration response to an existing MethodResponse.

PutIntegrationResponseInput dataclass

Bases: _SerdeShape

Represents a put integration response request.

Attributes

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

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

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

Specifies a put integration response request's HTTP method.

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

Specifies a put integration response request's resource identifier.

response_parameters class-attribute instance-attribute
response_parameters: dict[str, str] | None = ...

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

response_templates class-attribute instance-attribute
response_templates: dict[str, str] | None = ...

Specifies a put integration response's templates.

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

The string identifier of the associated RestApi.

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

Specifies the selection pattern of a put integration response.

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

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Output

PutIntegrationResponseOutput dataclass

Bases: _SerdeShape

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

Attributes

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

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

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_parameters class-attribute instance-attribute
response_parameters: dict[str, str] | None = ...

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

response_templates class-attribute instance-attribute
response_templates: dict[str, str] | None = ...

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

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

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an Lambda function, the Lambda function error header is matched. For all other HTTP and Amazon Web Services back ends, the HTTP status code is matched.

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

Specifies the status code that is used to map the integration response to an existing MethodResponse.