AmplifyBackend / Client / update_backend_config

update_backend_config#

AmplifyBackend.Client.update_backend_config(**kwargs)#

Updates the AWS resources required to access the Amplify Admin UI.

See also: AWS API Documentation

Request Syntax

response = client.update_backend_config(
    AppId='string',
    LoginAuthConfig={
        'AwsCognitoIdentityPoolId': 'string',
        'AwsCognitoRegion': 'string',
        'AwsUserPoolsId': 'string',
        'AwsUserPoolsWebClientId': 'string'
    }
)
Parameters:

  • AppId (string) –

    [REQUIRED]

    The app ID.

  • LoginAuthConfig (dict) –

    Describes the Amazon Cognito configuration for Admin UI access.

    • AwsCognitoIdentityPoolId (string) –

      The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.

    • AwsCognitoRegion (string) –

      The AWS Region for the Amplify Admin UI login.

    • AwsUserPoolsId (string) –

      The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.

    • AwsUserPoolsWebClientId (string) –

      The web client ID for the Amazon Cognito user pools.

Return type:

dict

Returns:

Response Syntax

{
    'AppId': 'string',
    'BackendManagerAppId': 'string',
    'Error': 'string',
    'LoginAuthConfig': {
        'AwsCognitoIdentityPoolId': 'string',
        'AwsCognitoRegion': 'string',
        'AwsUserPoolsId': 'string',
        'AwsUserPoolsWebClientId': 'string'
    }
}

Response Structure

  • (dict) –

    200 response

    • AppId (string) –

      The app ID.

    • BackendManagerAppId (string) –

      The app ID for the backend manager.

    • Error (string) –

      If the request fails, this error is returned.

    • LoginAuthConfig (dict) –

      Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.

      • AwsCognitoIdentityPoolId (string) –

        The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.

      • AwsCognitoRegion (string) –

        The AWS Region for the Amplify Admin UI login.

      • AwsUserPoolsId (string) –

        The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.

      • AwsUserPoolsWebClientId (string) –

        The web client ID for the Amazon Cognito user pools.

Exceptions