:doc:`AmplifyBackend <../../amplifybackend>` / Client / import_backend_auth

*******************
import_backend_auth
*******************



.. py:method:: AmplifyBackend.Client.import_backend_auth(**kwargs)

  

  Imports an existing backend authentication resource.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11/ImportBackendAuth>`_  


  **Request Syntax**
  ::

    response = client.import_backend_auth(
        AppId='string',
        BackendEnvironmentName='string',
        IdentityPoolId='string',
        NativeClientId='string',
        UserPoolId='string',
        WebClientId='string'
    )
    
  :type AppId: string
  :param AppId: **[REQUIRED]** 

    The app ID.

    

  
  :type BackendEnvironmentName: string
  :param BackendEnvironmentName: **[REQUIRED]** 

    The name of the backend environment.

    

  
  :type IdentityPoolId: string
  :param IdentityPoolId: 

    The ID of the Amazon Cognito identity pool.

    

  
  :type NativeClientId: string
  :param NativeClientId: **[REQUIRED]** 

    The ID of the Amazon Cognito native client.

    

  
  :type UserPoolId: string
  :param UserPoolId: **[REQUIRED]** 

    The ID of the Amazon Cognito user pool.

    

  
  :type WebClientId: string
  :param WebClientId: **[REQUIRED]** 

    The ID of the Amazon Cognito web client.

    

  
  
  :rtype: 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**
  
  *   :py:class:`AmplifyBackend.Client.exceptions.NotFoundException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.GatewayTimeoutException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`AmplifyBackend.Client.exceptions.BadRequestException`

  