AmplifyBackend / Client / remove_all_backends

remove_all_backends#

AmplifyBackend.Client.remove_all_backends(**kwargs)#

Removes all backend environments from your Amplify project.

See also: AWS API Documentation

Request Syntax

response = client.remove_all_backends(
    AppId='string',
    CleanAmplifyApp=True|False
)
Parameters:

  • AppId (string) –

    [REQUIRED]

    The app ID.

  • CleanAmplifyApp (boolean) – Cleans up the Amplify Console app if this value is set to true.

Return type:

dict

Returns:

Response Syntax

{
    'AppId': 'string',
    'Error': 'string',
    'JobId': 'string',
    'Operation': 'string',
    'Status': 'string'
}

Response Structure

  • (dict) –

    200 response

    • AppId (string) –

      The app ID.

    • Error (string) –

      If the request fails, this error is returned.

    • JobId (string) –

      The ID for the job.

    • Operation (string) –

      The name of the operation.

    • Status (string) –

      The current status of the request.

Exceptions