AmplifyBackend / Client / import_backend_auth

import_backend_auth#

AmplifyBackend.Client.import_backend_auth(**kwargs)#

Imports an existing backend authentication resource.

See also: AWS API Documentation

Request Syntax

response = client.import_backend_auth(
    AppId='string',
    BackendEnvironmentName='string',
    IdentityPoolId='string',
    NativeClientId='string',
    UserPoolId='string',
    WebClientId='string'
)
Parameters:

  • AppId (string) –

    [REQUIRED]

    The app ID.

  • BackendEnvironmentName (string) –

    [REQUIRED]

    The name of the backend environment.

  • IdentityPoolId (string) – The ID of the Amazon Cognito identity pool.

  • NativeClientId (string) –

    [REQUIRED]

    The ID of the Amazon Cognito native client.

  • UserPoolId (string) –

    [REQUIRED]

    The ID of the Amazon Cognito user pool.

  • WebClientId (string) –

    [REQUIRED]

    The ID of the Amazon Cognito web client.

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