:doc:`WorkMail <../../workmail>` / Client / list_mobile_device_access_overrides

***********************************
list_mobile_device_access_overrides
***********************************



.. py:method:: WorkMail.Client.list_mobile_device_access_overrides(**kwargs)

  

  Lists all the mobile device access overrides for any given combination of WorkMail organization, user, or device.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessOverrides>`_  


  **Request Syntax**
  ::

    response = client.list_mobile_device_access_overrides(
        OrganizationId='string',
        UserId='string',
        DeviceId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

    The WorkMail organization under which to list mobile device access overrides.

    

  
  :type UserId: string
  :param UserId: 

    The WorkMail user under which you list the mobile device access overrides. Accepts the following types of user identities:

     

    
    * User ID: ``12345678-1234-1234-1234-123456789012`` or ``S-1-1-12-1234567890-123456789-123456789-1234``
     
    * Email address: ``user@domain.tld``
     
    * User name: ``user``
    

    

  
  :type DeviceId: string
  :param DeviceId: 

    The mobile device to which the access override applies.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next page of results. The first call does not require a token.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'Overrides': [
              {
                  'UserId': 'string',
                  'DeviceId': 'string',
                  'Effect': 'ALLOW'|'DENY',
                  'Description': 'string',
                  'DateCreated': datetime(2015, 1, 1),
                  'DateModified': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Overrides** *(list) --* 

        The list of mobile device access overrides that exist for the specified WorkMail organization and user.

        
        

        - *(dict) --* 

          The override object.

          
          

          - **UserId** *(string) --* 

            The WorkMail user to which the access override applies.

            
          

          - **DeviceId** *(string) --* 

            The device to which the override applies.

            
          

          - **Effect** *(string) --* 

            The effect of the override, ``ALLOW`` or ``DENY``.

            
          

          - **Description** *(string) --* 

            A description of the override.

            
          

          - **DateCreated** *(datetime) --* 

            The date the override was first created.

            
          

          - **DateModified** *(datetime) --* 

            The date the override was last modified.

            
      
    
      

      - **NextToken** *(string) --* 

        The token to use to retrieve the next page of results. The value is “null” when there are no more results to return.

        
  
  **Exceptions**
  
  *   :py:class:`WorkMail.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.EntityNotFoundException`

  