AmplifyBackend / Client / import_backend_storage

import_backend_storage#

AmplifyBackend.Client.import_backend_storage(**kwargs)#

Imports an existing backend storage resource.

See also: AWS API Documentation

Request Syntax

response = client.import_backend_storage(
    AppId='string',
    BackendEnvironmentName='string',
    BucketName='string',
    ServiceName='S3'
)
Parameters:

  • AppId (string) –

    [REQUIRED]

    The app ID.

  • BackendEnvironmentName (string) –

    [REQUIRED]

    The name of the backend environment.

  • BucketName (string) – The name of the S3 bucket.

  • ServiceName (string) –

    [REQUIRED]

    The name of the storage service.

Return type:

dict

Returns:

Response Syntax

{
    'AppId': 'string',
    'BackendEnvironmentName': 'string',
    'JobId': 'string',
    'Status': 'string'
}

Response Structure

  • (dict) –

    200 response

    • AppId (string) –

      The app ID.

    • BackendEnvironmentName (string) –

      The name of the backend environment.

    • JobId (string) –

      The ID for the job.

    • Status (string) –

      The current status of the request.

Exceptions