Connect / Client / delete_user

delete_user

Connect.Client.delete_user(**kwargs)

Deletes a user account from the specified Connect Customer instance.

For information about what happens to a user’s data when their account is deleted, see Delete Users from Your Connect Customer Instance in the Connect Customer Administrator Guide.

Warning

After calling DeleteUser, call DeleteQuickConnect to delete any records related to the deleted users. This will help you:

  • Avoid dangling resources that impact your service quotas.

  • Remove deleted users so they don’t appear to agents as transfer options.

  • Avoid the disruption of other Connect Customer processes, such as instance replication and syncing if you’re using Connect Customer Global Resiliency.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    InstanceId='string',
    UserId='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • UserId (string) –

    [REQUIRED]

    The identifier of the user.

Returns:

None

Exceptions