PutIntegrationResponseRequest ¶

class PutIntegrationResponseRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    resource_id: "capo_api_gateway.types.string.String"
    """<p>Specifies a put integration response request's resource identifier.</p>"""
    http_method: "capo_api_gateway.types.string.String"
    """<p>Specifies a put integration response request's HTTP method.</p>"""
    status_code: "capo_api_gateway.types.status_code.StatusCode"
    """<p>Specifies the status code that is used to map the integration response to an existing MethodResponse.</p>"""
    selection_pattern: NotRequired["capo_api_gateway.types.string.String"]
    """<p>Specifies the selection pattern of a put integration response.</p>"""
    response_parameters: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>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 <code>method.response.header.{name}</code>, where <code>name</code> is a valid and unique header name. The mapped non-static value must match the pattern of <code>integration.response.header.{name}</code> or <code>integration.response.body.{JSON-expression}</code>, where <code>name</code> must be a valid and unique response header name and <code>JSON-expression</code> a valid JSON expression without the <code>$</code> prefix.</p>"""
    response_templates: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>Specifies a put integration response's templates.</p>"""
    content_handling: NotRequired[
        "capo_api_gateway.types.content_handling_strategy.ContentHandlingStrategy"
    ]
    """<p>Specifies how to handle response payload content type conversions. Supported values are <code>CONVERT_TO_BINARY</code> and <code>CONVERT_TO_TEXT</code>, with the following behaviors:</p> <p>If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.</p>"""