Skip to content

Delete User

connect_delete_user R Documentation

Deletes a user account from the specified Amazon Connect instance

Description

Deletes a user account from the specified Amazon Connect instance.

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

After calling DeleteUser, call delete_quick_connect 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 Amazon Connect processes, such as instance replication and syncing if you're using Amazon Connect Global Resiliency.

Usage

connect_delete_user(InstanceId, UserId)

Arguments

InstanceId

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

UserId

[required] The identifier of the user.

Value

An empty list.

Request syntax

svc$delete_user(
  InstanceId = "string",
  UserId = "string"
)