AppFabric / Client / start_user_access_tasks

start_user_access_tasks#

AppFabric.Client.start_user_access_tasks(**kwargs)#

Starts the tasks to search user access status for a specific email address.

The tasks are stopped when the user access status data is found. The tasks are terminated when the API calls to the application time out.

Request Syntax

response = client.start_user_access_tasks(
    appBundleIdentifier='string',
    email='string'
)

Parameters:

appBundleIdentifier (string) –
[REQUIRED]

The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app bundle to use for the request.
email (string) –
[REQUIRED]

The email address of the target user.

Return type:

dict

Returns:

Response Syntax

{
    'userAccessTasksList': [
        {
            'app': 'string',
            'tenantId': 'string',
            'taskId': 'string',
            'error': {
                'errorCode': 'string',
                'errorMessage': 'string'
            }
        },
    ]
}

Response Structure

(dict) –
- userAccessTasksList (list) –
  
  Contains a list of user access task information.
  - (dict) –
    
    Contains information about a user access task.
    - app (string) –
      
      The name of the application.
    - tenantId (string) –
      
      The ID of the application tenant.
    - taskId (string) –
      
      The unique ID of the task.
    - error (dict) –
      
      Error from the task, if any.
      - errorCode (string) –
        
        The code of the error.
      - errorMessage (string) –
        
        The message of the error.

Exceptions

AppFabric.Client.exceptions.InternalServerException
AppFabric.Client.exceptions.ThrottlingException
AppFabric.Client.exceptions.ValidationException
AppFabric.Client.exceptions.ResourceNotFoundException
AppFabric.Client.exceptions.AccessDeniedException