put_integration_response ¶

def put_integration_response(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    resource_id: "capo_api_gateway.types.string.String",
    http_method: "capo_api_gateway.types.string.String",
    status_code: "capo_api_gateway.types.status_code.StatusCode",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    selection_pattern: Optional["capo_api_gateway.types.string.String"] = None,
    response_parameters: Optional[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ] = None,
    response_templates: Optional[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ] = None,
    content_handling: Optional[
        "capo_api_gateway.types.content_handling_strategy.ContentHandlingStrategy"
    ] = None,
) -> "capo_api_gateway.types.integration_response.IntegrationResponse":
    """<p>Represents a put integration.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</p>
        resource_id: <p>Specifies a put integration response request's resource identifier.</p>
        http_method: <p>Specifies a put integration response request's HTTP method.</p>
        status_code: <p>Specifies the status code that is used to map the integration response to an existing MethodResponse.</p>
        selection_pattern: <p>Specifies the selection pattern of a put integration response.</p>
        response_parameters: <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: <p>Specifies a put integration response's templates.</p>
        content_handling: <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>

    Raises:
        capo_api_gateway.errors.bad_request_exception.BadRequestException: <p>The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_api_gateway.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_api_gateway.errors.limit_exceeded_exception.LimitExceededException: <p>The request exceeded the rate limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.not_found_exception.NotFoundException: <p>The requested resource is not found. Make sure that the request URI is correct.</p>
        capo_api_gateway.errors.too_many_requests_exception.TooManyRequestsException: <p>The request has reached its throttling limit. Retry after the specified time period.</p>
        capo_api_gateway.errors.unauthorized_exception.UnauthorizedException: <p>The request is denied because the caller has insufficient permissions.</p>
        capo_api_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_api_gateway.types.put_integration_response_request.PutIntegrationResponseRequest]",
    ) -> OperationResponse[
        "capo_api_gateway.types.integration_response.IntegrationResponse"
    ]:
        import capo_api_gateway._operations.backplane_control_service.put_integration_response

        output, http_response = (
            capo_api_gateway._operations.backplane_control_service.put_integration_response.put_integration_response(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutIntegrationResponse")
    )
    input_: capo_api_gateway.types.put_integration_response_request.PutIntegrationResponseRequest = {
        "rest_api_id": rest_api_id,
        "resource_id": resource_id,
        "http_method": http_method,
        "status_code": status_code,
    }
    if selection_pattern is not None:
        input_["selection_pattern"] = selection_pattern
    if response_parameters is not None:
        input_["response_parameters"] = response_parameters
    if response_templates is not None:
        input_["response_templates"] = response_templates
    if content_handling is not None:
        input_["content_handling"] = content_handling

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output