import_api ¶

import_api(
    *,
    config_overrides: Optional[ApiGatewayV2ClientConfig] = None,
    basepath: Optional[__string] = None,
    body: Optional[__string] = None,
    fail_on_warnings: Optional[__boolean] = None,
) -> ImportApiResponse

Imports an API.

Parameters:

basepath (Optional[__string], default: None ) –

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 Set the OpenAPI basePath Property. Supported only for HTTP APIs.
body (Optional[__string], default: None ) –

The OpenAPI definition. Supported only for HTTP APIs.
fail_on_warnings (Optional[__boolean], default: None ) –

Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.

Raises:

BadRequestException –

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ConflictException –

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.
NotFoundException –

The resource specified in the request was not found. See the message field for more information.
TooManyRequestsException –

A limit has been exceeded. See the accompanying error message for details.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_apigatewayv2/_services/api_gateway_v2.py

def import_api(
    self,
    *,
    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.import_api_response.ImportApiResponse":
    """<p>Imports an API.</p>

    Args:
        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.import_api_request.ImportApiRequest]",
    ) -> OperationResponse[
        "capo_apigatewayv2.types.import_api_response.ImportApiResponse"
    ]:
        import capo_apigatewayv2._operations.api_gateway_v2.import_api

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ImportApi")
    )
    input_: capo_apigatewayv2.types.import_api_request.ImportApiRequest = {}
    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