Skip to content

UpdateGroupRequest

Source code in docs_src/capo_directory_service_data/types/update_group_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class UpdateGroupRequest(TypedDict, closed=True):
    directory_id: "capo_directory_service_data.types.directory_id.DirectoryId"
    """<p> The identifier (ID) of the directory that's associated with the group. </p>"""
    sam_account_name: "capo_directory_service_data.types.group_name.GroupName"
    """<p> The name of the group. </p>"""
    group_type: NotRequired["capo_directory_service_data.types.group_type.GroupType"]
    """<p> The AD group type. For details, see <a href="https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#how-active-directory-security-groups-work">Active Directory security group type</a>. </p>"""
    group_scope: NotRequired["capo_directory_service_data.types.group_scope.GroupScope"]
    """<p> The scope of the AD group. For details, see <a href="https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#group-scope">Active Directory security groups</a>. </p>"""
    other_attributes: NotRequired[
        "capo_directory_service_data.types.attributes.Attributes"
    ]
    """<p> An expression that defines one or more attributes with the data type and the value of each attribute. </p>"""
    update_type: NotRequired["capo_directory_service_data.types.update_type.UpdateType"]
    """<p> The type of update to be performed. If no value exists for the attribute, use <code>ADD</code>. Otherwise, use <code>REPLACE</code> to change an attribute value or <code>REMOVE</code> to clear the attribute value. </p>"""
    client_token: NotRequired[
        "capo_directory_service_data.types.client_token.ClientToken"
    ]
    """<p> 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. </p> <p> 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. </p> <p> 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 <code>ConflictException</code>. </p> <note> <p> This parameter is optional when using the CLI or SDK. </p> </note>"""

client_token instance-attribute 

client_token: NotRequired[ClientToken]

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.

This parameter is optional when using the CLI or SDK.

directory_id instance-attribute 

directory_id: DirectoryId

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

group_scope instance-attribute 

group_scope: NotRequired[GroupScope]

The scope of the AD group. For details, see Active Directory security groups.

group_type instance-attribute 

group_type: NotRequired[GroupType]

The AD group type. For details, see Active Directory security group type.

other_attributes instance-attribute 

other_attributes: NotRequired[Attributes]

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

sam_account_name instance-attribute 

sam_account_name: GroupName

The name of the group.

update_type instance-attribute 

update_type: NotRequired[UpdateType]

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.