reimport_api ¶

def reimport_api(
    self,
    api_id: "capo_apigatewayv2.types.__string.__string",
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    basepath: Optional["capo_apigatewayv2.types.__string.__string"] = None,
    body: Optional["capo_apigatewayv2.types.__string.__string"] = None,
    fail_on_warnings: Optional[
        "capo_apigatewayv2.types.__boolean.__boolean"
    ] = None,
) -> "capo_apigatewayv2.types.reimport_api_response.ReimportApiResponse":
    """<p>Puts an Api resource.</p>

    Args:
        api_id: <p>The API identifier.</p>
        basepath: <p>Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html">Set the OpenAPI basePath Property</a>. Supported only for HTTP APIs.</p>
        body: <p>The OpenAPI definition. Supported only for HTTP APIs.</p>
        fail_on_warnings: <p>Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.</p>

    Raises:
        capo_apigatewayv2.errors.bad_request_exception.BadRequestException: <p>The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.conflict_exception.ConflictException: <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.not_found_exception.NotFoundException: <p>The resource specified in the request was not found. See the message field for more information.</p>
        capo_apigatewayv2.errors.too_many_requests_exception.TooManyRequestsException: <p>A limit has been exceeded. See the accompanying error message for details.</p>
        capo_apigatewayv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_apigatewayv2.types.reimport_api_request.ReimportApiRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.reimport_api_response.ReimportApiResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.reimport_api

        output, http_response = (
            capo_apigatewayv2._operations.api_gateway_v2.reimport_api.reimport_api(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReimportApi")
    )
    input_: capo_apigatewayv2.types.reimport_api_request.ReimportApiRequest = {
        "api_id": api_id
    }
    if basepath is not None:
        input_["basepath"] = basepath
    if body is not None:
        input_["body"] = body
    if fail_on_warnings is not None:
        input_["fail_on_warnings"] = fail_on_warnings

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