clone_backend `async` ¶

clone_backend(
    app_id: __string,
    backend_environment_name: __string,
    *,
    config_overrides: Optional[AsyncAmplifyBackendClientConfig] = None,
    target_environment_name: Optional[__string] = None,
) -> CloneBackendResponse

This operation clones an existing backend.

Parameters:

app_id (__string) –

The app ID.
backend_environment_name (__string) –

The name of the backend environment.
target_environment_name (Optional[__string], default: None ) –

The name of the destination backend environment to be created.

Raises:

BadRequestException –

An error returned if a request is not formed properly.
GatewayTimeoutException –

An error returned if there's a temporary issue with the service.
NotFoundException –

An error returned when a specific resource type is not found.
TooManyRequestsException –

An error that is returned when a limit of a specific type has been exceeded.
UnknownServiceError –

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

Source code in docs_src/capo_amplifybackend/_services/async_amplify_backend.py

async def clone_backend(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    backend_environment_name: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AsyncAmplifyBackendClientConfig] = None,
    target_environment_name: Optional[
        "capo_amplifybackend.types.__string.__string"
    ] = None,
) -> "capo_amplifybackend.types.clone_backend_response.CloneBackendResponse":
    """<p>This operation clones an existing backend.</p>

    Args:
        app_id: <p>The app ID.</p>
        backend_environment_name: <p>The name of the backend environment.</p>
        target_environment_name: <p>The name of the destination backend environment to be created.</p>

    Raises:
        capo_amplifybackend.errors.bad_request_exception.BadRequestException: <p>An error returned if a request is not formed properly.</p>
        capo_amplifybackend.errors.gateway_timeout_exception.GatewayTimeoutException: <p>An error returned if there's a temporary issue with the service.</p>
        capo_amplifybackend.errors.not_found_exception.NotFoundException: <p>An error returned when a specific resource type is not found.</p>
        capo_amplifybackend.errors.too_many_requests_exception.TooManyRequestsException: <p>An error that is returned when a limit of a specific type has been exceeded.</p>
        capo_amplifybackend.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amplifybackend.types.clone_backend_request.CloneBackendRequest]",
    ) -> AsyncOperationResponse[
        "capo_amplifybackend.types.clone_backend_response.CloneBackendResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.clone_backend

        (
            output,
            http_response,
        ) = await capo_amplifybackend._operations.amplify_backend.clone_backend.async_clone_backend(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CloneBackend")
    )
    input_: capo_amplifybackend.types.clone_backend_request.CloneBackendRequest = {
        "app_id": app_id,
        "backend_environment_name": backend_environment_name,
    }
    if target_environment_name is not None:
        input_["target_environment_name"] = target_environment_name

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

clone_backend async ¶

clone_backend `async` ¶