Skip to content

import_backend_storage 

import_backend_storage(
    app_id: __string,
    backend_environment_name: __string,
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    bucket_name: Optional[__string] = None,
    service_name: Optional[ServiceName] = None,
) -> ImportBackendStorageResponse

Imports an existing backend storage resource.

Parameters:

  • app_id (__string) –

    The app ID.

  • backend_environment_name (__string) –

    The name of the backend environment.

  • bucket_name (Optional[__string], default: None ) –

    The name of the S3 bucket.

  • service_name (Optional[ServiceName], default: None ) –

    The name of the storage service.

Raises:

Source code in docs_src/capo_amplifybackend/_services/amplify_backend.py 
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
def import_backend_storage(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    backend_environment_name: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    bucket_name: Optional["capo_amplifybackend.types.__string.__string"] = None,
    service_name: Optional[
        "capo_amplifybackend.types.service_name.ServiceName"
    ] = None,
) -> "capo_amplifybackend.types.import_backend_storage_response.ImportBackendStorageResponse":
    """<p>Imports an existing backend storage resource.</p>

    Args:
        app_id: <p>The app ID.</p>
        backend_environment_name: <p>The name of the backend environment.</p>
        bucket_name: <p>The name of the S3 bucket.</p>
        service_name: <p>The name of the storage service.</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.import_backend_storage_request.ImportBackendStorageRequest]",
    ) -> OperationResponse[
        "capo_amplifybackend.types.import_backend_storage_response.ImportBackendStorageResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.import_backend_storage

        output, http_response = (
            capo_amplifybackend._operations.amplify_backend.import_backend_storage.import_backend_storage(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ImportBackendStorage")
    )
    input_: capo_amplifybackend.types.import_backend_storage_request.ImportBackendStorageRequest = {
        "app_id": app_id,
        "backend_environment_name": backend_environment_name,
    }
    if bucket_name is not None:
        input_["bucket_name"] = bucket_name
    if service_name is not None:
        input_["service_name"] = service_name

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