Skip to content

RemoveGroupMemberRequest

Source code in docs_src/capo_directory_service_data/types/remove_group_member_request.py
class RemoveGroupMemberRequest(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 member. </p>"""
    group_name: "capo_directory_service_data.types.group_name.GroupName"
    """<p> The name of the group. </p>"""
    member_name: "capo_directory_service_data.types.member_name.MemberName"
    """<p> The <code>SAMAccountName</code> of the user, group, or computer to remove from the group. </p>"""
    member_realm: NotRequired["capo_directory_service_data.types.realm.Realm"]
    """<p> The domain name that's associated with the group member. This parameter defaults to the Managed Microsoft AD domain. </p> <note> <p> This parameter is optional and case insensitive. </p> </note>"""
    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 member.

group_name instance-attribute

group_name: GroupName

The name of the group.

member_name instance-attribute

member_name: MemberName

The SAMAccountName of the user, group, or computer to remove from the group.

member_realm instance-attribute

member_realm: NotRequired[Realm]

The domain name that's associated with the group member. This parameter defaults to the Managed Microsoft AD domain.

This parameter is optional and case insensitive.