Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

update_smb_local_groups

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

Request Syntax

response = client.update_smb_local_groups(
    GatewayARN='string',
    SMBLocalGroups={
        'GatewayAdmins': [
            'string',
        ]
    }
)
Parameters
  • GatewayARN (string) --

    [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.

  • SMBLocalGroups (dict) --

    [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) --
Return type

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

  • StorageGateway.Client.exceptions.InvalidGatewayRequestException
  • StorageGateway.Client.exceptions.InternalServerError