IdentityStore / Client / delete_group
delete_group¶
- IdentityStore.Client.delete_group(**kwargs)¶
Delete a group within an identity store given
GroupId.See also: AWS API Documentation
Request Syntax
response = client.delete_group( IdentityStoreId='string', GroupId='string', Revision='string' )
- Parameters:
IdentityStoreId (string) –
[REQUIRED]
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID
d-1234567890or identity store ARNarn:aws:identitystore::111122223333:identitystore/d-1234567890.GroupId (string) –
[REQUIRED]
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID
a1b2c3d4-5678-90ab-cdef-EXAMPLE22222or group ARNarn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.Revision (string) – The expected current revision of the group. When you provide this value, the group is deleted only if it matches the current revision of the group in the identity store. If the value doesn’t match, the operation fails with a
ConflictException. If you don’t provide this value, the group is deleted regardless of its current revision.
- Return type:
dict
- Returns:
Response Syntax
{}Response Structure
(dict) –
Exceptions
IdentityStore.Client.exceptions.ResourceNotFoundExceptionIdentityStore.Client.exceptions.ThrottlingExceptionIdentityStore.Client.exceptions.AccessDeniedExceptionIdentityStore.Client.exceptions.ConflictExceptionIdentityStore.Client.exceptions.InternalServerExceptionIdentityStore.Client.exceptions.ValidationException