AmplifyBackend / Client / delete_backend_auth

delete_backend_auth#

AmplifyBackend.Client.delete_backend_auth(**kwargs)#

Deletes an existing backend authentication resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_backend_auth(
    AppId='string',
    BackendEnvironmentName='string',
    ResourceName='string'
)
Parameters:

  • AppId (string) –

    [REQUIRED]

    The app ID.

  • BackendEnvironmentName (string) –

    [REQUIRED]

    The name of the backend environment.

  • ResourceName (string) –

    [REQUIRED]

    The name of this resource.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    200 response

    • AppId (string) –

      The app ID.

    • BackendEnvironmentName (string) –

      The name of the backend environment.

    • 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