Connect / Client / create_agent_status

create_agent_status#

Connect.Client.create_agent_status(**kwargs)#

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

Creates an agent status for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.create_agent_status(
    InstanceId='string',
    Name='string',
    Description='string',
    State='ENABLED'|'DISABLED',
    DisplayOrder=123,
    Tags={
        'string': 'string'
    }
)
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.

  • Name (string) –

    [REQUIRED]

    The name of the status.

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

  • State (string) –

    [REQUIRED]

    The state of the status.

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

  • Tags (dict) –

    The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'AgentStatusARN': 'string',
    'AgentStatusId': 'string'
}

Response Structure

  • (dict) –

    • AgentStatusARN (string) –

      The Amazon Resource Name (ARN) of the agent status.

    • AgentStatusId (string) –

      The identifier of the agent status.

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