Skip to content

clone_backend 

clone_backend(
    app_id: __string,
    backend_environment_name: __string,
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = 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:

Source code in docs_src/capo_amplifybackend/_services/amplify_backend.py 
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
def clone_backend(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    backend_environment_name: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = 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.
    """

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

        output, http_response = (
            capo_amplifybackend._operations.amplify_backend.clone_backend.clone_backend(
                req.options, req.input
            )
        )
        return OperationResponse(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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output