AWS SDK for PHP 3.x

Service ID: connect

Version: 2017-08-08

This page describes the parameters and results for the operations of the Amazon Connect Service (2017-08-08), and shows how to use the Aws\Connect\ConnectClient object to call the described operations. This documentation is specific to the 2017-08-08 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateUser ( array $params = [] )
Creates a new user account in your Amazon Connect instance.
DeleteUser ( array $params = [] )
Deletes a user account from Amazon Connect.
DescribeUser ( array $params = [] )
Returns a User object that contains information about the user account specified by the UserId.
DescribeUserHierarchyGroup ( array $params = [] )
Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.
DescribeUserHierarchyStructure ( array $params = [] )
Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.
GetCurrentMetricData ( array $params = [] )
The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.
GetFederationToken ( array $params = [] )
Retrieves a token for federation.
GetMetricData ( array $params = [] )
The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.
ListRoutingProfiles ( array $params = [] )
Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.
ListSecurityProfiles ( array $params = [] )
Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.
ListUserHierarchyGroups ( array $params = [] )
Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.
ListUsers ( array $params = [] )
Returns a UserSummaryList, which is an array of UserSummary objects.
StartOutboundVoiceContact ( array $params = [] )
The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.
StopContact ( array $params = [] )
Ends the contact initiated by the StartOutboundVoiceContact operation.
UpdateContactAttributes ( array $params = [] )
The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact.
UpdateUserHierarchy ( array $params = [] )
Assigns the specified hierarchy group to the user.
UpdateUserIdentityInfo ( array $params = [] )
Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.
UpdateUserPhoneConfig ( array $params = [] )
Updates the phone configuration settings in the UserPhoneConfig object for the specified user.
UpdateUserRoutingProfile ( array $params = [] )
Assigns the specified routing profile to a user.
UpdateUserSecurityProfiles ( array $params = [] )
Updates the security profiles assigned to the user.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

GetCurrentMetricData
GetMetricData

Operations

CreateUser

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates a new user account in your Amazon Connect instance.

Parameter Syntax

$result = $client->createUser([
    'DirectoryUserId' => '<string>',
    'HierarchyGroupId' => '<string>',
    'IdentityInfo' => [
        'Email' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
    ],
    'InstanceId' => '<string>', // REQUIRED
    'Password' => '<string>',
    'PhoneConfig' => [ // REQUIRED
        'AfterContactWorkTimeLimit' => <integer>,
        'AutoAccept' => true || false,
        'DeskPhoneNumber' => '<string>',
        'PhoneType' => 'SOFT_PHONE|DESK_PHONE', // REQUIRED
    ],
    'RoutingProfileId' => '<string>', // REQUIRED
    'SecurityProfileIds' => ['<string>', ...], // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members

DirectoryUserId

Type: string

The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

HierarchyGroupId

Type: string

The unique identifier for the hierarchy group to assign to the user created.

IdentityInfo

Type: UserIdentityInfo structure

Information about the user, including email address, first name, and last name.

InstanceId

Required: Yes
Type: string

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Password

Type: string

The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

PhoneConfig

Required: Yes
Type: UserPhoneConfig structure

Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.

RoutingProfileId

Required: Yes
Type: string

The unique identifier for the routing profile to assign to the user created.

SecurityProfileIds

Required: Yes
Type: Array of strings

The unique identifier of the security profile to assign to the user created.

Username

Required: Yes
Type: string

The user name in Amazon Connect for the account to create.

Result Syntax

[
    'UserArn' => '<string>',
    'UserId' => '<string>',
]

Result Details

Members

UserArn

Type: string

The Amazon Resource Name (ARN) of the user account created.

UserId

Type: string

The unique identifier for the user account in Amazon Connect

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
LimitExceededException:
The allowed limit for the resource has been reached.
DuplicateResourceException:
A resource with that name already exists.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes a user account from Amazon Connect.

Parameter Syntax

$result = $client->deleteUser([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

UserId

Required: Yes
Type: string

The unique identifier of the user to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

DescribeUser

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

Returns a User object that contains information about the user account specified by the UserId.

Parameter Syntax

$result = $client->describeUser([
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

UserId

Required: Yes
Type: string

Unique identifier for the user account to return.

Result Syntax

[
    'User' => [
        'Arn' => '<string>',
        'DirectoryUserId' => '<string>',
        'HierarchyGroupId' => '<string>',
        'Id' => '<string>',
        'IdentityInfo' => [
            'Email' => '<string>',
            'FirstName' => '<string>',
            'LastName' => '<string>',
        ],
        'PhoneConfig' => [
            'AfterContactWorkTimeLimit' => <integer>,
            'AutoAccept' => true || false,
            'DeskPhoneNumber' => '<string>',
            'PhoneType' => 'SOFT_PHONE|DESK_PHONE',
        ],
        'RoutingProfileId' => '<string>',
        'SecurityProfileIds' => ['<string>', ...],
        'Username' => '<string>',
    ],
]

Result Details

Members

User

Type: User structure

A User object that contains information about the user account and configuration settings.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

DescribeUserHierarchyGroup

$result = $client->describeUserHierarchyGroup([/* ... */]);
$promise = $client->describeUserHierarchyGroupAsync([/* ... */]);

Returns a HierarchyGroup object that includes information about a hierarchy group in your instance.

Parameter Syntax

$result = $client->describeUserHierarchyGroup([
    'HierarchyGroupId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

HierarchyGroupId

Required: Yes
Type: string

The identifier for the hierarchy group to return.

InstanceId

Required: Yes
Type: string

Result Syntax

[
    'HierarchyGroup' => [
        'Arn' => '<string>',
        'HierarchyPath' => [
            'LevelFive' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelFour' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelOne' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelThree' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
            'LevelTwo' => [
                'Arn' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
            ],
        ],
        'Id' => '<string>',
        'LevelId' => '<string>',
        'Name' => '<string>',
    ],
]

Result Details

Members

HierarchyGroup

Type: HierarchyGroup structure

Returns a HierarchyGroup object.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

DescribeUserHierarchyStructure

$result = $client->describeUserHierarchyStructure([/* ... */]);
$promise = $client->describeUserHierarchyStructureAsync([/* ... */]);

Returns a HiearchyGroupStructure object, which contains data about the levels in the agent hierarchy.

Parameter Syntax

$result = $client->describeUserHierarchyStructure([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

Result Syntax

[
    'HierarchyStructure' => [
        'LevelFive' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelFour' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelOne' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelThree' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        'LevelTwo' => [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
    ],
]

Result Details

Members

HierarchyStructure

Type: HierarchyStructure structure

A HierarchyStructure object.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

GetCurrentMetricData

$result = $client->getCurrentMetricData([/* ... */]);
$promise = $client->getCurrentMetricDataAsync([/* ... */]);

The GetCurrentMetricData operation retrieves current metric data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetCurrentMetricData action.

Parameter Syntax

$result = $client->getCurrentMetricData([
    'CurrentMetrics' => [ // REQUIRED
        [
            'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED',
            'Unit' => 'SECONDS|COUNT|PERCENT',
        ],
        // ...
    ],
    'Filters' => [ // REQUIRED
        'Channels' => ['<string>', ...],
        'Queues' => ['<string>', ...],
    ],
    'Groupings' => ['<string>', ...],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

CurrentMetrics

Required: Yes
Type: Array of CurrentMetric structures

A list of CurrentMetric objects for the metrics to retrieve. Each CurrentMetric includes a name of a metric to retrieve and the unit to use for it.

The following metrics are available:

AGENTS_AVAILABLE: Unit: COUNT
AGENTS_ONLINE: Unit: COUNT
AGENTS_ON_CALL: Unit: COUNT
AGENTS_STAFFED: Unit: COUNT
AGENTS_AFTER_CONTACT_WORK: Unit: COUNT
AGENTS_NON_PRODUCTIVE: Unit: COUNT
AGENTS_ERROR: Unit: COUNT
CONTACTS_IN_QUEUE: Unit: COUNT
OLDEST_CONTACT_AGE: Unit: SECONDS
CONTACTS_SCHEDULED: Unit: COUNT

Filters

Required: Yes
Type: Filters structure

A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the queue IDs, ARNs, or Channels included in the filter. You can include both IDs and ARNs in the same request. To retrieve metrics for all queues, add the queue ID or ARN for each queue in your instance. Only VOICE is supported for Channels.

To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'.

Groupings

Type: Array of strings

The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of CurrentMetrics is returned.

InstanceId

Required: Yes
Type: string

MaxResults

Type: int

MaxResults indicates the maximum number of results to return per page in the response, between 1 and 100.

NextToken

Type: string

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.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.

Result Syntax

[
    'DataSnapshotTime' => <DateTime>,
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED',
                        'Unit' => 'SECONDS|COUNT|PERCENT',
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => [
                'Channel' => 'VOICE',
                'Queue' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DataSnapshotTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which CurrentMetricData was retrieved and cached for pagination.

MetricResults

Type: Array of CurrentMetricResult structures

A list of CurrentMetricResult objects organized by Dimensions combining with CurrentMetricDataCollections.

Dimensions is the resourceId specified in the Filters of the request.

Collections is a list of CurrentMetricData objects with corresponding values to the CurrentMetrics specified in the request.

If no Grouping is specified in the request, Collections is a summary for the CurrentMetric returned.

NextToken

Type: string

A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
InternalServiceException:
Request processing failed due to an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.

GetFederationToken

$result = $client->getFederationToken([/* ... */]);
$promise = $client->getFederationTokenAsync([/* ... */]);

Retrieves a token for federation.

Parameter Syntax

$result = $client->getFederationToken([
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

Result Syntax

[
    'Credentials' => [
        'AccessToken' => '<string>',
        'AccessTokenExpiration' => <DateTime>,
        'RefreshToken' => '<string>',
        'RefreshTokenExpiration' => <DateTime>,
    ],
]

Result Details

Members

Credentials

Type: Credentials structure

The credentials to use for federation.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
UserNotFoundException:
No user with the specified credentials was found in the Amazon Connect instance.
InternalServiceException:
Request processing failed due to an error or failure with the service.
DuplicateResourceException:
A resource with that name already exists.

GetMetricData

$result = $client->getMetricData([/* ... */]);
$promise = $client->getMetricDataAsync([/* ... */]);

The GetMetricData operation retrieves historical metrics data from your Amazon Connect instance.

If you are using an IAM account, it must have permission to the connect:GetMetricData action.

Parameter Syntax

$result = $client->getMetricData([
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'Filters' => [ // REQUIRED
        'Channels' => ['<string>', ...],
        'Queues' => ['<string>', ...],
    ],
    'Groupings' => ['<string>', ...],
    'HistoricalMetrics' => [ // REQUIRED
        [
            'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL',
            'Statistic' => 'SUM|MAX|AVG',
            'Threshold' => [
                'Comparison' => 'LT',
                'ThresholdValue' => <float>,
            ],
            'Unit' => 'SECONDS|COUNT|PERCENT',
        ],
        // ...
    ],
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members

EndTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the StartTime timestamp.

The time range between StartTime and EndTime must be less than 24 hours.

Filters

Required: Yes
Type: Filters structure

A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel.

Groupings

Type: Array of strings

The grouping applied to the metrics returned. For example, when results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

The current version supports grouping by Queue

If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.

HistoricalMetrics

Required: Yes
Type: Array of HistoricalMetric structures

A list of HistoricalMetric objects that contain the metrics to retrieve with the request.

A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.

For each historical metric you include in the request, you must include a Unit and a Statistic.

The following historical metrics are available:

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistics: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistics: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistics: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistics: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistics: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistics: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistics: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistics: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistics: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistics: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistics: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistics: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistics: SUM

API_CONTACTS_HANDLED

Unit: COUNT

Statistics: SUM

CONTACTS_MISSED

Unit: COUNT

Statistics: SUM

OCCUPANCY

Unit: PERCENT

Statistics: AVG

HANDLE_TIME

Unit: SECONDS

Statistics: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistics: AVG

QUEUED_TIME

Unit: SECONDS

Statistics: MAX

ABANDON_TIME

Unit: COUNT

Statistics: SUM

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistics: AVG

HOLD_TIME

Unit: SECONDS

Statistics: AVG

INTERACTION_TIME

Unit: SECONDS

Statistics: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistics: AVG

SERVICE_LEVEL

Unit: PERCENT

Statistics: AVG

Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

InstanceId

Required: Yes
Type: string

MaxResults

Type: int

Indicates the maximum number of results to return per page in the response, between 1-100.

NextToken

Type: string

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.

StartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.

Result Syntax

[
    'MetricResults' => [
        [
            'Collections' => [
                [
                    'Metric' => [
                        'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL',
                        'Statistic' => 'SUM|MAX|AVG',
                        'Threshold' => [
                            'Comparison' => 'LT',
                            'ThresholdValue' => <float>,
                        ],
                        'Unit' => 'SECONDS|COUNT|PERCENT',
                    ],
                    'Value' => <float>,
                ],
                // ...
            ],
            'Dimensions' => [
                'Channel' => 'VOICE',
                'Queue' => [
                    'Arn' => '<string>',
                    'Id' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

MetricResults

Type: Array of HistoricalMetricResult structures

A list of HistoricalMetricResult objects, organized by Dimensions, which is the ID of the resource specified in the Filters used for the request. The metrics are combined with the metrics included in Collections, which is a list of HisotricalMetricData objects.

If no Grouping is specified in the request, Collections includes summary data for the HistoricalMetrics.

NextToken

Type: string

A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the NextToken must use the same request parameters as the request that generated the token.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
InternalServiceException:
Request processing failed due to an error or failure with the service.
ThrottlingException:
The throttling limit has been exceeded.
ResourceNotFoundException:
The specified resource was not found.

ListRoutingProfiles

$result = $client->listRoutingProfiles([/* ... */]);
$promise = $client->listRoutingProfilesAsync([/* ... */]);

Returns an array of RoutingProfileSummary objects that includes information about the routing profiles in your instance.

Parameter Syntax

$result = $client->listRoutingProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

MaxResults

Type: int

The maximum number of routing profiles to return in the response.

NextToken

Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'RoutingProfileSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

RoutingProfileSummaryList

Type: Array of RoutingProfileSummary structures

An array of RoutingProfileSummary objects that include the ARN, Id, and Name of the routing profile.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

ListSecurityProfiles

$result = $client->listSecurityProfiles([/* ... */]);
$promise = $client->listSecurityProfilesAsync([/* ... */]);

Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.

Parameter Syntax

$result = $client->listSecurityProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

MaxResults

Type: int

The maximum number of security profiles to return.

NextToken

Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'SecurityProfileSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

SecurityProfileSummaryList

Type: Array of SecurityProfileSummary structures

An array of SecurityProfileSummary objects.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

ListUserHierarchyGroups

$result = $client->listUserHierarchyGroups([/* ... */]);
$promise = $client->listUserHierarchyGroupsAsync([/* ... */]);

Returns a UserHierarchyGroupSummaryList, which is an array of HierarchyGroupSummary objects that contain information about the hierarchy groups in your instance.

Parameter Syntax

$result = $client->listUserHierarchyGroups([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

MaxResults

Type: int

The maximum number of hierarchy groups to return.

NextToken

Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'UserHierarchyGroupSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

UserHierarchyGroupSummaryList

Type: Array of HierarchyGroupSummary structures

An array of HierarchyGroupSummary objects.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

ListUsers

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

Returns a UserSummaryList, which is an array of UserSummary objects.

Parameter Syntax

$result = $client->listUsers([
    'InstanceId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

MaxResults

Type: int

The maximum number of results to return in the response.

NextToken

Type: string

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.

Result Syntax

[
    'NextToken' => '<string>',
    'UserSummaryList' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

A string returned in the response. Use the value returned in the response as the value of the NextToken in a subsequent request to retrieve the next set of results.

UserSummaryList

Type: Array of UserSummary structures

An array of UserSummary objects that contain information about the users in your instance.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

StartOutboundVoiceContact

$result = $client->startOutboundVoiceContact([/* ... */]);
$promise = $client->startOutboundVoiceContactAsync([/* ... */]);

The StartOutboundVoiceContact operation initiates a contact flow to place an outbound call to a customer.

If you are using an IAM account, it must have permission to the connect:StartOutboundVoiceContact action.

Parameter Syntax

$result = $client->startOutboundVoiceContact([
    'Attributes' => ['<string>', ...],
    'ClientToken' => '<string>',
    'ContactFlowId' => '<string>', // REQUIRED
    'DestinationPhoneNumber' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'QueueId' => '<string>',
    'SourcePhoneNumber' => '<string>',
]);

Parameter Details

Members

Attributes

Type: Associative array of custom strings keys (AttributeName) to strings

Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.

For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:

ClientToken

Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.

ContactFlowId

Required: Yes
Type: string

The identifier for the contact flow to connect the outbound call to.

To find the ContactFlowId, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as 78ea8fd5-2659-4f2b-b528-699760ccfc1b.

DestinationPhoneNumber

Required: Yes
Type: string

The phone number of the customer in E.164 format.

InstanceId

Required: Yes
Type: string

QueueId

Type: string

The queue to add the call to. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue used will be the queue defined in the contact flow.

To find the QueueId, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as queue/aeg40574-2d01-51c3-73d6-bf8624d2168c.

SourcePhoneNumber

Type: string

The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.

Result Syntax

[
    'ContactId' => '<string>',
]

Result Details

Members

ContactId

Type: string

The unique identifier of this contact within your Amazon Connect instance.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed due to an error or failure with the service.
LimitExceededException:
The allowed limit for the resource has been reached.
DestinationNotAllowedException:
Outbound calls to the destination number are not allowed.
OutboundContactNotPermittedException:
The contact is not permitted.

StopContact

$result = $client->stopContact([/* ... */]);
$promise = $client->stopContactAsync([/* ... */]);

Ends the contact initiated by the StartOutboundVoiceContact operation.

If you are using an IAM account, it must have permission to the connect:StopContact action.

Parameter Syntax

$result = $client->stopContact([
    'ContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContactId

Required: Yes
Type: string

The unique identifier of the contact to end.

InstanceId

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
ContactNotFoundException:
The contact with the specified ID is not active or does not exist.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed due to an error or failure with the service.

UpdateContactAttributes

$result = $client->updateContactAttributes([/* ... */]);
$promise = $client->updateContactAttributesAsync([/* ... */]);

The UpdateContactAttributes operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the UpdateContactAttributes operation to update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important:

You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

Parameter Syntax

$result = $client->updateContactAttributes([
    'Attributes' => ['<string>', ...], // REQUIRED
    'InitialContactId' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Attributes

Required: Yes
Type: Associative array of custom strings keys (AttributeName) to strings

The key-value pairs for the attribute to update.

InitialContactId

Required: Yes
Type: string

The unique identifier of the contact for which to update attributes. This is the identifier for the contact associated with the first interaction with the contact center.

InstanceId

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
InternalServiceException:
Request processing failed due to an error or failure with the service.

UpdateUserHierarchy

$result = $client->updateUserHierarchy([/* ... */]);
$promise = $client->updateUserHierarchyAsync([/* ... */]);

Assigns the specified hierarchy group to the user.

Parameter Syntax

$result = $client->updateUserHierarchy([
    'HierarchyGroupId' => '<string>',
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

HierarchyGroupId

Type: string

The identifier for the hierarchy group to assign to the user.

InstanceId

Required: Yes
Type: string

UserId

Required: Yes
Type: string

The identifier of the user account to assign the hierarchy group to.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

UpdateUserIdentityInfo

$result = $client->updateUserIdentityInfo([/* ... */]);
$promise = $client->updateUserIdentityInfoAsync([/* ... */]);

Updates the identity information for the specified user in a UserIdentityInfo object, including email, first name, and last name.

Parameter Syntax

$result = $client->updateUserIdentityInfo([
    'IdentityInfo' => [ // REQUIRED
        'Email' => '<string>',
        'FirstName' => '<string>',
        'LastName' => '<string>',
    ],
    'InstanceId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IdentityInfo

Required: Yes
Type: UserIdentityInfo structure

A UserIdentityInfo object.

InstanceId

Required: Yes
Type: string

UserId

Required: Yes
Type: string

The identifier for the user account to update identity information for.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

UpdateUserPhoneConfig

$result = $client->updateUserPhoneConfig([/* ... */]);
$promise = $client->updateUserPhoneConfigAsync([/* ... */]);

Updates the phone configuration settings in the UserPhoneConfig object for the specified user.

Parameter Syntax

$result = $client->updateUserPhoneConfig([
    'InstanceId' => '<string>', // REQUIRED
    'PhoneConfig' => [ // REQUIRED
        'AfterContactWorkTimeLimit' => <integer>,
        'AutoAccept' => true || false,
        'DeskPhoneNumber' => '<string>',
        'PhoneType' => 'SOFT_PHONE|DESK_PHONE', // REQUIRED
    ],
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

PhoneConfig

Required: Yes
Type: UserPhoneConfig structure

A UserPhoneConfig object that contains settings for AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType to assign to the user.

UserId

Required: Yes
Type: string

The identifier for the user account to change phone settings for.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

UpdateUserRoutingProfile

$result = $client->updateUserRoutingProfile([/* ... */]);
$promise = $client->updateUserRoutingProfileAsync([/* ... */]);

Assigns the specified routing profile to a user.

Parameter Syntax

$result = $client->updateUserRoutingProfile([
    'InstanceId' => '<string>', // REQUIRED
    'RoutingProfileId' => '<string>', // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

RoutingProfileId

Required: Yes
Type: string

The identifier of the routing profile to assign to the user.

UserId

Required: Yes
Type: string

The identifier for the user account to assign the routing profile to.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

UpdateUserSecurityProfiles

$result = $client->updateUserSecurityProfiles([/* ... */]);
$promise = $client->updateUserSecurityProfilesAsync([/* ... */]);

Updates the security profiles assigned to the user.

Parameter Syntax

$result = $client->updateUserSecurityProfiles([
    'InstanceId' => '<string>', // REQUIRED
    'SecurityProfileIds' => ['<string>', ...], // REQUIRED
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InstanceId

Required: Yes
Type: string

SecurityProfileIds

Required: Yes
Type: Array of strings

The identifiers for the security profiles to assign to the user.

UserId

Required: Yes
Type: string

The identifier of the user account to assign the security profiles.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The request is not valid.
InvalidParameterException:
One or more of the parameters provided to the operation are not valid.
ResourceNotFoundException:
The specified resource was not found.
ThrottlingException:
The throttling limit has been exceeded.
InternalServiceException:
Request processing failed due to an error or failure with the service.

Shapes

ContactNotFoundException

Description

The contact with the specified ID is not active or does not exist.

Members

Message

Type: string

The message.

Credentials

Description

The credentials to use for federation.

Members

AccessToken

Type: string

An access token generated for a federated user to access Amazon Connect

AccessTokenExpiration

Type: timestamp (string|DateTime or anything parsable by strtotime)

A token generated with an expiration time for the session a user is logged in to Amazon Connect

RefreshToken

Type: string

Renews a token generated for a user to access the Amazon Connect instance.

RefreshTokenExpiration

Type: timestamp (string|DateTime or anything parsable by strtotime)

Renews the expiration timer for a generated token.

CurrentMetric

Description

A CurrentMetric object that contains the Name and Unit for the metric.

Members

Name

Type: string

The name of the metric.

Unit

Type: string

The unit for the metric.

CurrentMetricData

Description

A CurrentMetricData object.

Members

Metric

Type: CurrentMetric structure

The metric in a CurrentMetricData object.

Value

Type: double

The value of the metric in the CurrentMetricData object.

CurrentMetricResult

Description

A CurrentMetricResult object.

Members

Collections

Type: Array of CurrentMetricData structures

The Collections for the CurrentMetricResult object.

Dimensions

Type: Dimensions structure

The Dimensions for the CurrentMetricResult object.

DestinationNotAllowedException

Description

Outbound calls to the destination number are not allowed.

Members

Message

Type: string

The message.

Dimensions

Description

A Dimensions object that includes the Channel and Queue for the metric.

Members

Channel

Type: string

The channel used for grouping and filters. Only VOICE is supported.

Queue

Type: QueueReference structure

A QueueReference object used as one part of dimension for the metrics results.

DuplicateResourceException

Description

A resource with that name already exists.

Members

Message

Type: string

Filters

Description

The filter, either channel or queues, to apply to the metric results retrieved.

Members

Channels

Type: Array of strings

The Channel to use as a filter for the metrics returned. Only VOICE is supported.

Queues

Type: Array of strings

A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request.

HierarchyGroup

Description

A HierarchyGroup object that contains information about a hierarchy group in your Amazon Connect instance.

Members

Arn

Type: string

The Amazon Resource Name (ARN) for the hierarchy group.

HierarchyPath

Type: HierarchyPath structure

A HierarchyPath object that contains information about the levels in the hierarchy group.

Id

Type: string

The identifier for the hierarchy group.

LevelId

Type: string

The identifier for the level in the hierarchy group.

Name

Type: string

The name of the hierarchy group in your instance.

HierarchyGroupSummary

Description

A HierarchyGroupSummary object that contains information about the hierarchy group, including ARN, Id, and Name.

Members

Arn

Type: string

The ARN for the hierarchy group.

Id

Type: string

The identifier of the hierarchy group.

Name

Type: string

The name of the hierarchy group.

HierarchyLevel

Description

A HierarchyLevel object that contains information about the levels in a hierarchy group, including ARN, Id, and Name.

Members

Arn

Type: string

The ARN for the hierarchy group level.

Id

Type: string

The identifier for the hierarchy group level.

Name

Type: string

The name of the hierarchy group level.

HierarchyPath

Description

A HierarchyPath object that contains information about the levels of the hierarchy group.

Members

LevelFive

Type: HierarchyGroupSummary structure

A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

LevelFour

Type: HierarchyGroupSummary structure

A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

LevelOne

Type: HierarchyGroupSummary structure

A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

LevelThree

Type: HierarchyGroupSummary structure

A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

LevelTwo

Type: HierarchyGroupSummary structure

A HierarchyGroupSummary object that contains information about the level of the hierarchy group, including ARN, Id, and Name.

HierarchyStructure

Description

A HierarchyStructure object that contains information about the hierarchy group structure.

Members

LevelFive

Type: HierarchyLevel structure

A HierarchyLevel object that contains information about the hierarchy group level.

LevelFour

Type: HierarchyLevel structure

A HierarchyLevel object that contains information about the hierarchy group level.

LevelOne

Type: HierarchyLevel structure

A HierarchyLevel object that contains information about the hierarchy group level.

LevelThree

Type: HierarchyLevel structure

A HierarchyLevel object that contains information about the hierarchy group level.

LevelTwo

Type: HierarchyLevel structure

A HierarchyLevel object that contains information about the hierarchy group level.

HistoricalMetric

Description

A HistoricalMetric object that contains the Name, Unit, Statistic, and Threshold for the metric.

Members

Name

Type: string

The name of the historical metric.

Statistic

Type: string

The statistic for the metric: SUM, MAX, or SUM.

Threshold

Type: Threshold structure

The threshold for the metric, used with service level metrics.

Unit

Type: string

The unit for the metric: COUNT, PERCENT, or SECONDS.

HistoricalMetricData

Description

A HistoricalMetricData object than contains a Metric and a Value.

Members

Metric

Type: HistoricalMetric structure

A HistoricalMetric object.

Value

Type: double

The Value of the metric.

HistoricalMetricResult

Description

The metrics data returned from a GetMetricData operation.

Members

Collections

Type: Array of HistoricalMetricData structures

A list of HistoricalMetricData objects.

Dimensions

Type: Dimensions structure

The Dimensions for the metrics.

InternalServiceException

Description

Request processing failed due to an error or failure with the service.

Members

Message

Type: string

The message.

InvalidParameterException

Description

One or more of the parameters provided to the operation are not valid.

Members

Message

Type: string

The message.

InvalidRequestException

Description

The request is not valid.

Members

Message

Type: string

The message.

LimitExceededException

Description

The allowed limit for the resource has been reached.

Members

Message

Type: string

The message.

OutboundContactNotPermittedException

Description

The contact is not permitted.

Members

Message

Type: string

The message.

QueueReference

Description

A QueueReference object that contains the the QueueId and ARN for the queue resource for which metrics are returned.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of queue.

Id

Type: string

The ID of the queue associated with the metrics returned.

ResourceNotFoundException

Description

The specified resource was not found.

Members

Message

Type: string

The message.

RoutingProfileSummary

Description

A RoutingProfileSummary object that contains information about a routing profile, including ARN, Id, and Name.

Members

Arn

Type: string

The ARN of the routing profile.

Id

Type: string

The identifier of the routing profile.

Name

Type: string

The name of the routing profile.

SecurityProfileSummary

Description

A SecurityProfileSummary object that contains information about a security profile, including ARN, Id, Name.

Members

Arn

Type: string

The ARN of the security profile.

Id

Type: string

The identifier of the security profile.

Name

Type: string

The name of the security profile.

Threshold

Description

A Threshold object that includes a comparison and ThresholdValue to compare to. Used with service level metrics.

Members

Comparison

Type: string

The Threshold to use to compare service level metrics to. Only "Less than" (LT) comparisons are supported.

ThresholdValue

Type: double

The value of the threshold to compare the metric to. Only "Less than" (LT) comparisons are supported.

ThrottlingException

Description

The throttling limit has been exceeded.

Members

Message

Type: string

User

Description

A User object that contains information about a user account in your Amazon Connect instance, including configuration settings.

Members

Arn

Type: string

The ARN of the user account.

DirectoryUserId

Type: string

The directory Id for the user account in the existing directory used for identity management.

HierarchyGroupId

Type: string

The identifier for the hierarchy group assigned to the user.

Id

Type: string

The identifier of the user account.

IdentityInfo

Type: UserIdentityInfo structure

A UserIdentityInfo object.

PhoneConfig

Type: UserPhoneConfig structure

A UserPhoneConfig object.

RoutingProfileId

Type: string

The identifier of the routing profile assigned to the user.

SecurityProfileIds

Type: Array of strings

The identifier(s) for the security profile assigned to the user.

Username

Type: string

The user name assigned to the user account.

UserIdentityInfo

Description

A UserIdentityInfo object that contains information about the user's identity, including email address, first name, and last name.

Members

Email

Type: string

The email address added to the user account. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

FirstName

Type: string

The first name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.

LastName

Type: string

The last name used in the user account. This is required if you are using Amazon Connect or SAML for identity management.

UserNotFoundException

Description

No user with the specified credentials was found in the Amazon Connect instance.

Members

Message

Type: string

UserPhoneConfig

Description

A UserPhoneConfig object that contains information about the user phone configuration settings.

Members

AfterContactWorkTimeLimit

Type: int

The After Call Work (ACW) timeout setting, in seconds, for the user.

AutoAccept

Type: boolean

The Auto accept setting for the user, Yes or No.

DeskPhoneNumber

Type: string

The phone number for the user's desk phone.

PhoneType

Required: Yes
Type: string

The phone type selected for the user, either Soft phone or Desk phone.

UserSummary

Description

A UserSummary object that contains Information about a user, including ARN, Id, and user name.

Members

Arn

Type: string

The ARN for the user account.

Id

Type: string

The identifier for the user account.

Username

Type: string

The Amazon Connect user name for the user account.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Connect Service 2017-08-08

Operation Summary

Paginators

Operations

CreateUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeUser

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeUserHierarchyGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeUserHierarchyStructure

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetCurrentMetricData

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetFederationToken

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetMetricData

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListRoutingProfiles

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members