:doc:`StorageGateway <../../storagegateway>` / Client / update_smb_local_groups

***********************
update_smb_local_groups
***********************



.. py:method:: StorageGateway.Client.update_smb_local_groups(**kwargs)

  

  Updates the list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/UpdateSMBLocalGroups>`_  


  **Request Syntax**
  ::

    response = client.update_smb_local_groups(
        GatewayARN='string',
        SMBLocalGroups={
            'GatewayAdmins': [
                'string',
            ]
        }
    )
    
  :type GatewayARN: string
  :param GatewayARN: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the gateway. Use the  ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

    

  
  :type SMBLocalGroups: dict
  :param SMBLocalGroups: **[REQUIRED]** 

    A list of Active Directory users and groups that you want to grant special permissions for SMB file shares on the gateway.

    

  
    - **GatewayAdmins** *(list) --* 

      A list of Active Directory users and groups that have local Gateway Admin permissions. Acceptable formats include: ``DOMAIN\User1``, ``user1``, ``DOMAIN\group1``, and ``group1``.

       

      Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to force-close files that are open and locked.

      

    
      - *(string) --* 

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

    
    ::

      {
          'GatewayARN': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **GatewayARN** *(string) --* 

        The Amazon Resource Name (ARN) of the gateway. Use the  ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

        
  
  **Exceptions**
  
  *   :py:class:`StorageGateway.Client.exceptions.InvalidGatewayRequestException`

  
  *   :py:class:`StorageGateway.Client.exceptions.InternalServerError`

  