put_gateway_response ¶

def put_gateway_response(
    self,
    rest_api_id: "capo_api_gateway.types.string.String",
    response_type: "capo_api_gateway.types.gateway_response_type.GatewayResponseType",
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    status_code: Optional["capo_api_gateway.types.status_code.StatusCode"] = 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,
) -> "capo_api_gateway.types.gateway_response.GatewayResponse":
    """<p>Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.</p>

    Args:
        rest_api_id: <p>The string identifier of the associated RestApi.</p>
        response_type: <p>The response type of the associated GatewayResponse</p>
        status_code: <p>The HTTP status code of the GatewayResponse.</p>
        response_parameters: <p>Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.</p>
        response_templates: <p>Response templates of the GatewayResponse as a string-to-string map of key-value pairs.</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_gateway_response_request.PutGatewayResponseRequest]",
    ) -> OperationResponse[
        "capo_api_gateway.types.gateway_response.GatewayResponse"
    ]:
        import capo_api_gateway._operations.backplane_control_service.put_gateway_response

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutGatewayResponse")
    )
    input_: capo_api_gateway.types.put_gateway_response_request.PutGatewayResponseRequest = {
        "rest_api_id": rest_api_id,
        "response_type": response_type,
    }
    if status_code is not None:
        input_["status_code"] = status_code
    if response_parameters is not None:
        input_["response_parameters"] = response_parameters
    if response_templates is not None:
        input_["response_templates"] = response_templates

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