DirectoryServiceData / Client / update_group

update_group

DirectoryServiceData.Client.update_group(**kwargs)

Updates group information.

See also: AWS API Documentation

Request Syntax

response = client.update_group(
    ClientToken='string',
    DirectoryId='string',
    GroupScope='DomainLocal'|'Global'|'Universal'|'BuiltinLocal',
    GroupType='Distribution'|'Security',
    OtherAttributes={
        'string': {
            'BOOL': True|False,
            'N': 123,
            'S': 'string',
            'SS': [
                'string',
            ]
        }
    },
    SAMAccountName='string',
    UpdateType='ADD'|'REPLACE'|'REMOVE'
)

Parameters:

• ClientToken (string) –

  A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

  A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

  If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

  Note

  This parameter is optional when using the CLI or SDK.

  This field is autopopulated if not provided.

• DirectoryId (string) –

  [REQUIRED]

  The identifier (ID) of the directory that’s associated with the group.

• GroupScope (string) – The scope of the AD group. For details, see Active Directory security groups.

• GroupType (string) – The AD group type. For details, see Active Directory security group type.

• OtherAttributes (dict) –

  An expression that defines one or more attributes with the data type and the value of each attribute.

  • (string) –

    • (dict) –

      The data type for an attribute. Each attribute value is described as a name-value pair. The name is the AD schema name, and the value is the data itself. For a list of supported attributes, see Directory Service Data Attributes.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: BOOL, N, S, SS.

      • BOOL (boolean) –

        Indicates that the attribute type value is a boolean. For example:

        "BOOL": true

      • N (integer) –

        Indicates that the attribute type value is a number. For example:

        "N": "16"

      • S (string) –

        Indicates that the attribute type value is a string. For example:

        "S": "S Group"

      • SS (list) –

        Indicates that the attribute type value is a string set. For example:

        "SS": ["sample_service_class/host.sample.com:1234/sample_service_name_1", "sample_service_class/host.sample.com:1234/sample_service_name_2"]

        • (string) –

• SAMAccountName (string) –

  [REQUIRED]

  The name of the group.

• UpdateType (string) – The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• DirectoryServiceData.Client.exceptions.ResourceNotFoundException

• DirectoryServiceData.Client.exceptions.AccessDeniedException

• DirectoryServiceData.Client.exceptions.InternalServerException

• DirectoryServiceData.Client.exceptions.ValidationException

• DirectoryServiceData.Client.exceptions.DirectoryUnavailableException

• DirectoryServiceData.Client.exceptions.ConflictException

• DirectoryServiceData.Client.exceptions.ThrottlingException