Amazon Connect Service

2021/08/06 - Amazon Connect Service - 7 new api methods

Changes  This release adds support for agent status and hours of operation. For details, see the Release Notes in the Amazon Connect Administrator Guide.

ListAgentStatuses (new) Link ¶

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

Lists agent statuses.

See also: AWS API Documentation

Request Syntax

client.list_agent_statuses(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    AgentStatusTypes=[
        'ROUTABLE'|'CUSTOM'|'OFFLINE',
    ]
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type NextToken:

string

param NextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

type AgentStatusTypes:

list

param AgentStatusTypes:

Available agent status types.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'AgentStatusSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If there are additional results, this is the token for the next set of results.

    • AgentStatusSummaryList (list) --

      A summary of agent statuses.

      • (dict) --

        Summary information for an agent status.

        • Id (string) --

          The identifier for an agent status.

        • Arn (string) --

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

        • Name (string) --

          The name of the agent status.

        • Type (string) --

          The type of the agent status.

CreateAgentStatus (new) Link ¶

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

client.create_agent_status(
    InstanceId='string',
    Name='string',
    Description='string',
    State='ENABLED'|'DISABLED',
    DisplayOrder=123,
    Tags={
        'string': 'string'
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type Name:

string

param Name:

[REQUIRED]

The name of the status.

type Description:

string

param Description:

The description of the status.

type State:

string

param State:

[REQUIRED]

The state of the status.

type DisplayOrder:

integer

param DisplayOrder:

The display order of the status.

type Tags:

dict

param Tags:

One or more tags.

  • (string) --

    • (string) --

rtype:

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.

DeleteHoursOfOperation (new) Link ¶

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

Deletes an hours of operation.

See also: AWS API Documentation

Request Syntax

client.delete_hours_of_operation(
    InstanceId='string',
    HoursOfOperationId='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier for the hours of operation.

returns:

None

DescribeAgentStatus (new) Link ¶

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

Describes an agent status.

See also: AWS API Documentation

Request Syntax

client.describe_agent_status(
    InstanceId='string',
    AgentStatusId='string'
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type AgentStatusId:

string

param AgentStatusId:

[REQUIRED]

The identifier for the agent status.

rtype:

dict

returns:

Response Syntax

{
    'AgentStatus': {
        'AgentStatusARN': 'string',
        'AgentStatusId': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE',
        'DisplayOrder': 123,
        'State': 'ENABLED'|'DISABLED',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • AgentStatus (dict) --

      The agent status.

      • AgentStatusARN (string) --

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

      • AgentStatusId (string) --

        The identifier of the agent status.

      • Name (string) --

        The name of the agent status.

      • Description (string) --

        The description of the agent status.

      • Type (string) --

        The type of agent status.

      • DisplayOrder (integer) --

        The display order of the agent status.

      • State (string) --

        The state of the agent status.

      • Tags (dict) --

        One or more tags.

        • (string) --

          • (string) --

UpdateHoursOfOperation (new) Link ¶

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

Updates the hours of operation.

See also: AWS API Documentation

Request Syntax

client.update_hours_of_operation(
    InstanceId='string',
    HoursOfOperationId='string',
    Name='string',
    Description='string',
    TimeZone='string',
    Config=[
        {
            'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
            'StartTime': {
                'Hours': 123,
                'Minutes': 123
            },
            'EndTime': {
                'Hours': 123,
                'Minutes': 123
            }
        },
    ]
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type HoursOfOperationId:

string

param HoursOfOperationId:

[REQUIRED]

The identifier of the hours of operation.

type Name:

string

param Name:

The name of the hours of operation.

type Description:

string

param Description:

The description of the hours of operation.

type TimeZone:

string

param TimeZone:

The time zone of the hours of operation.

type Config:

list

param Config:

Configuration information of the hours of operation.

  • (dict) --

    Contains information about the hours of operation.

    • Day (string) -- [REQUIRED]

      The day that the hours of operation applies to.

    • StartTime (dict) -- [REQUIRED]

      The start time that your contact center is open.

      • Hours (integer) -- [REQUIRED]

        The hours.

      • Minutes (integer) -- [REQUIRED]

        The minutes.

    • EndTime (dict) -- [REQUIRED]

      The end time that your contact center is closes.

      • Hours (integer) -- [REQUIRED]

        The hours.

      • Minutes (integer) -- [REQUIRED]

        The minutes.

returns:

None

UpdateAgentStatus (new) Link ¶

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

Updates agent status.

See also: AWS API Documentation

Request Syntax

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

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type AgentStatusId:

string

param AgentStatusId:

[REQUIRED]

The identifier of the agent status.

type Name:

string

param Name:

The name of the agent status.

type Description:

string

param Description:

The description of the agent status.

type State:

string

param State:

The state of the agent status.

type DisplayOrder:

integer

param DisplayOrder:

The display order of the agent status.

type ResetOrderNumber:

boolean

param ResetOrderNumber:

A number indicating the reset order of the agent status.

returns:

None

CreateHoursOfOperation (new) Link ¶

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

Creates hours of operation.

See also: AWS API Documentation

Request Syntax

client.create_hours_of_operation(
    InstanceId='string',
    Name='string',
    Description='string',
    TimeZone='string',
    Config=[
        {
            'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
            'StartTime': {
                'Hours': 123,
                'Minutes': 123
            },
            'EndTime': {
                'Hours': 123,
                'Minutes': 123
            }
        },
    ],
    Tags={
        'string': 'string'
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type Name:

string

param Name:

[REQUIRED]

The name of the hours of operation.

type Description:

string

param Description:

The description of the hours of operation.

type TimeZone:

string

param TimeZone:

[REQUIRED]

The time zone of the hours of operation.

type Config:

list

param Config:

[REQUIRED]

Configuration information for the hours of operation: day, start time, and end time.

  • (dict) --

    Contains information about the hours of operation.

    • Day (string) -- [REQUIRED]

      The day that the hours of operation applies to.

    • StartTime (dict) -- [REQUIRED]

      The start time that your contact center is open.

      • Hours (integer) -- [REQUIRED]

        The hours.

      • Minutes (integer) -- [REQUIRED]

        The minutes.

    • EndTime (dict) -- [REQUIRED]

      The end time that your contact center is closes.

      • Hours (integer) -- [REQUIRED]

        The hours.

      • Minutes (integer) -- [REQUIRED]

        The minutes.

type Tags:

dict

param Tags:

One or more tags.

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'HoursOfOperationId': 'string',
    'HoursOfOperationArn': 'string'
}

Response Structure

  • (dict) --

    • HoursOfOperationId (string) --

      The identifier for the hours of operation.

    • HoursOfOperationArn (string) --

      The Amazon Resource Name (ARN) for the hours of operation.