WorkMail / Client / update_group
update_group#
- WorkMail.Client.update_group(**kwargs)#
Updates attibutes in a group.
See also: AWS API Documentation
Request Syntax
response = client.update_group( OrganizationId='string', GroupId='string', HiddenFromGlobalAddressList=True|False )
- Parameters:
OrganizationId (string) –
[REQUIRED]
The identifier for the organization under which the group exists.
GroupId (string) –
[REQUIRED]
The identifier for the group to be updated.
The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
Email address: group@domain.tld
Group name: group
HiddenFromGlobalAddressList (boolean) – If enabled, the group is hidden from the global address list.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
WorkMail.Client.exceptions.EntityNotFoundException
WorkMail.Client.exceptions.EntityStateException
WorkMail.Client.exceptions.OrganizationNotFoundException
WorkMail.Client.exceptions.OrganizationStateException
WorkMail.Client.exceptions.UnsupportedOperationException
WorkMail.Client.exceptions.InvalidParameterException