IdentityStore / Client / delete_user
delete_user¶
- IdentityStore.Client.delete_user(**kwargs)¶
Deletes a user within an identity store given
UserId.See also: AWS API Documentation
Request Syntax
response = client.delete_user( IdentityStoreId='string', UserId='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.UserId (string) –
[REQUIRED]
The identifier for a user in the identity store.
You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111or user ARNarn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.Revision (string) – The expected current revision of the user. When you provide this value, the user is deleted only if it matches the current revision of the user in the identity store. If the value doesn’t match, the operation fails with a
ConflictException. If you don’t provide this value, the user 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