Connect / Client / update_agent_status

update_agent_status#

Connect.Client.update_agent_status(**kwargs)#

This API is in preview release for Amazon Connect and is subject to change.

Updates agent status.

See also: AWS API Documentation

Request Syntax

response = client.update_agent_status(
    InstanceId='string',
    AgentStatusId='string',
    Name='string',
    Description='string',
    State='ENABLED'|'DISABLED',
    DisplayOrder=123,
    ResetOrderNumber=True|False
)
Parameters:

  • 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.

  • Name (string) – The name of the agent status.

  • Description (string) – The description of the agent status.

  • State (string) – The state of the agent status.

  • DisplayOrder (integer) – The display order of the agent status.

  • ResetOrderNumber (boolean) – A number indicating the reset order of the agent status.

Returns:

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.DuplicateResourceException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.LimitExceededException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException