Connect / Client / put_user_status
put_user_status#
- Connect.Client.put_user_status(**kwargs)#
Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent’s next status.
For more information, see Agent status and Set your next status in the Amazon Connect Administrator Guide.
See also: AWS API Documentation
Request Syntax
response = client.put_user_status( UserId='string', InstanceId='string', AgentStatusId='string' )
- Parameters:
UserId (string) –
[REQUIRED]
The identifier of the user.
InstanceId (string) –
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
AgentStatusId (string) –
[REQUIRED]
The identifier of the agent status.
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ThrottlingException
Connect.Client.exceptions.AccessDeniedException
Connect.Client.exceptions.InternalServiceException