AppFabric / Client / batch_get_user_access_tasks

batch_get_user_access_tasks#

AppFabric.Client.batch_get_user_access_tasks(**kwargs)#

Gets user access details in a batch request.

This action polls data from the tasks that are kicked off by the StartUserAccessTasks action.

Request Syntax

response = client.batch_get_user_access_tasks(
    appBundleIdentifier='string',
    taskIdList=[
        'string',
    ]
)

Parameters:

appBundleIdentifier (string) –
[REQUIRED]

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

The tasks IDs to use for the request.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'userAccessResultsList': [
        {
            'app': 'string',
            'tenantId': 'string',
            'tenantDisplayName': 'string',
            'taskId': 'string',
            'resultStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'EXPIRED',
            'email': 'string',
            'userId': 'string',
            'userFullName': 'string',
            'userFirstName': 'string',
            'userLastName': 'string',
            'userStatus': 'string',
            'taskError': {
                'errorCode': 'string',
                'errorMessage': 'string'
            }
        },
    ]
}

Response Structure

(dict) –
- userAccessResultsList (list) –
  
  Contains a list of user access results.
  - (dict) –
    
    Contains information about a user’s access to an application.
    - app (string) –
      
      The name of the application.
    - tenantId (string) –
      
      The ID of the application tenant.
    - tenantDisplayName (string) –
      
      The display name of the tenant.
    - taskId (string) –
      
      The unique ID of the task.
    - resultStatus (string) –
      
      The status of the user access result item.
      
      The following states are possible:
      - IN_PROGRESS: The user access task is in progress.
      - COMPLETED: The user access task completed successfully.
      - FAILED: The user access task failed.
      - EXPIRED: The user access task expired.
    - email (string) –
      
      The email address of the target user.
    - userId (string) –
      
      The unique ID of user.
    - userFullName (string) –
      
      The full name of the user.
    - userFirstName (string) –
      
      The first name of the user.
    - userLastName (string) –
      
      The last name of the user.
    - userStatus (string) –
      
      The status of the user returned by the application.
    - taskError (dict) –
      
      Contains information about an error returned from a user access task.
      - 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