Table of Contents
A low-level client representing Amazon Connect Service:
import boto3
client = boto3.client('connect')
These are the available methods:
Check if an operation can be paginated.
Creates a user account for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.create_user(
Username='string',
Password='string',
IdentityInfo={
'FirstName': 'string',
'LastName': 'string',
'Email': 'string'
},
PhoneConfig={
'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
'AutoAccept': True|False,
'AfterContactWorkTimeLimit': 123,
'DeskPhoneNumber': 'string'
},
DirectoryUserId='string',
SecurityProfileIds=[
'string',
],
RoutingProfileId='string',
HierarchyGroupId='string',
InstanceId='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.@]+.
The information about the identity of the user.
The first name. This is required if you are using Amazon Connect or SAML for identity management.
The last name. This is required if you are using Amazon Connect or SAML for identity management.
The email address. If you are using SAML for identity management and include this parameter, an error is returned.
[REQUIRED]
The phone settings for the user.
The phone type.
The Auto accept setting.
The After Call Work (ACW) timeout setting, in seconds.
The phone number for the user's desk phone.
The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your 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 error is returned.
[REQUIRED]
The identifier of the security profile for the user.
[REQUIRED]
The identifier of the routing profile for the user.
[REQUIRED]
The identifier of the Amazon Connect instance.
One or more tags.
dict
Response Syntax
{
'UserId': 'string',
'UserArn': 'string'
}
Response Structure
(dict) --
UserId (string) --
The identifier of the user account.
UserArn (string) --
The Amazon Resource Name (ARN) of the user account.
Deletes a user account from the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.delete_user(
InstanceId='string',
UserId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The identifier of the user.
None
Describes the specified user account. You can find the instance ID in the console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.
See also: AWS API Documentation
Request Syntax
response = client.describe_user(
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{
'User': {
'Id': 'string',
'Arn': 'string',
'Username': 'string',
'IdentityInfo': {
'FirstName': 'string',
'LastName': 'string',
'Email': 'string'
},
'PhoneConfig': {
'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
'AutoAccept': True|False,
'AfterContactWorkTimeLimit': 123,
'DeskPhoneNumber': 'string'
},
'DirectoryUserId': 'string',
'SecurityProfileIds': [
'string',
],
'RoutingProfileId': 'string',
'HierarchyGroupId': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
User (dict) --
Information about the user account and configuration settings.
Id (string) --
The identifier of the user account.
Arn (string) --
The Amazon Resource Name (ARN) of the user account.
Username (string) --
The user name assigned to the user account.
IdentityInfo (dict) --
Information about the user identity.
FirstName (string) --
The first name. This is required if you are using Amazon Connect or SAML for identity management.
LastName (string) --
The last name. This is required if you are using Amazon Connect or SAML for identity management.
Email (string) --
The email address. If you are using SAML for identity management and include this parameter, an error is returned.
PhoneConfig (dict) --
Information about the phone configuration for the user.
PhoneType (string) --
The phone type.
AutoAccept (boolean) --
The Auto accept setting.
AfterContactWorkTimeLimit (integer) --
The After Call Work (ACW) timeout setting, in seconds.
DeskPhoneNumber (string) --
The phone number for the user's desk phone.
DirectoryUserId (string) --
The identifier of the user account in the directory used for identity management.
SecurityProfileIds (list) --
The identifiers of the security profiles for the user.
RoutingProfileId (string) --
The identifier of the routing profile for the user.
HierarchyGroupId (string) --
The identifier of the hierarchy group for the user.
Tags (dict) --
The tags.
Describes the specified hierarchy group.
See also: AWS API Documentation
Request Syntax
response = client.describe_user_hierarchy_group(
HierarchyGroupId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the hierarchy group.
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{
'HierarchyGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LevelId': 'string',
'HierarchyPath': {
'LevelOne': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelTwo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelThree': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelFour': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelFive': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
}
}
}
Response Structure
(dict) --
HierarchyGroup (dict) --
Information about the hierarchy group.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelId (string) --
The identifier of the level in the hierarchy group.
HierarchyPath (dict) --
Information about the levels in the hierarchy group.
LevelOne (dict) --
Information about level one.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelTwo (dict) --
Information about level two.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelThree (dict) --
Information about level three.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelFour (dict) --
Information about level four.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
LevelFive (dict) --
Information about level five.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
Describes the hierarchy structure of the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.describe_user_hierarchy_structure(
InstanceId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
{
'HierarchyStructure': {
'LevelOne': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelTwo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelThree': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelFour': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
'LevelFive': {
'Id': 'string',
'Arn': 'string',
'Name': 'string'
}
}
}
Response Structure
Information about the hierarchy structure.
Information about level one.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Information about level two.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Information about level three.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Information about level four.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Information about level five.
The identifier of the hierarchy level.
The Amazon Resource Name (ARN) of the hierarchy level.
The name of the hierarchy level.
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves the contact attributes for the specified contact.
See also: AWS API Documentation
Request Syntax
response = client.get_contact_attributes(
InstanceId='string',
InitialContactId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The identifier of the initial contact.
dict
Response Syntax
{
'Attributes': {
'string': 'string'
}
}
Response Structure
(dict) --
Attributes (dict) --
Information about the attributes.
Gets the real-time metric data from the specified Amazon Connect instance.
For more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_current_metric_data(
InstanceId='string',
Filters={
'Queues': [
'string',
],
'Channels': [
'VOICE'|'CHAT',
]
},
Groupings=[
'QUEUE'|'CHANNEL',
],
CurrentMetrics=[
{
'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'|'AGENTS_ON_CONTACT'|'SLOTS_ACTIVE'|'SLOTS_AVAILABLE',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. The only supported channel is VOICE .
The queues to use to filter the metrics. You can specify up to 100 queues per request.
The channel to use to filter the metrics.
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 metrics is returned.
[REQUIRED]
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:
AGENTS_AFTER_CONTACT_WORK
Unit: COUNT
AGENTS_AVAILABLE
Unit: COUNT
AGENTS_ERROR
Unit: COUNT
AGENTS_NON_PRODUCTIVE
Unit: COUNT
AGENTS_ON_CALL
Unit: COUNT
AGENTS_ON_CONTACT
Unit: COUNT
AGENTS_ONLINE
Unit: COUNT
AGENTS_STAFFED
Unit: COUNT
CONTACTS_IN_QUEUE
Unit: COUNT
CONTACTS_SCHEDULED
Unit: COUNT
OLDEST_CONTACT_AGE
Unit: SECONDS
SLOTS_ACTIVE
Unit: COUNT
SLOTS_AVAILABLE
Unit: COUNT
Contains information about a real-time metric.
The name of the metric.
The unit for the metric.
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 token must use the same request parameters as the request that generated the token.
dict
Response Syntax
{
'NextToken': 'string',
'MetricResults': [
{
'Dimensions': {
'Queue': {
'Id': 'string',
'Arn': 'string'
},
'Channel': 'VOICE'|'CHAT'
},
'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'|'AGENTS_ON_CONTACT'|'SLOTS_ACTIVE'|'SLOTS_AVAILABLE',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
'Value': 123.0
},
]
},
],
'DataSnapshotTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
MetricResults (list) --
Information about the real-time metrics.
(dict) --
Contains information about a set of real-time metrics.
Dimensions (dict) --
The dimensions for the metrics.
Queue (dict) --
Information about the queue for which metrics are returned.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Channel (string) --
The channel used for grouping and filters.
Collections (list) --
The set of metrics.
(dict) --
Contains the data for a real-time metric.
Metric (dict) --
Information about the metric.
Name (string) --
The name of the metric.
Unit (string) --
The unit for the metric.
Value (float) --
The value of the metric.
DataSnapshotTime (datetime) --
The time at which the metrics were retrieved and cached for pagination.
Retrieves a token for federation.
See also: AWS API Documentation
Request Syntax
response = client.get_federation_token(
InstanceId='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
{
'Credentials': {
'AccessToken': 'string',
'AccessTokenExpiration': datetime(2015, 1, 1),
'RefreshToken': 'string',
'RefreshTokenExpiration': datetime(2015, 1, 1)
}
}
Response Structure
The credentials to use for federation.
An access token generated for a federated user to access Amazon Connect.
A token generated with an expiration time for the session a user is logged in to Amazon Connect.
Renews a token generated for a user to access the Amazon Connect instance.
Renews the expiration timer for a generated token.
Gets historical metric data from the specified Amazon Connect instance.
For more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_metric_data(
InstanceId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Filters={
'Queues': [
'string',
],
'Channels': [
'VOICE'|'CHAT',
]
},
Groupings=[
'QUEUE'|'CHANNEL',
],
HistoricalMetrics=[
{
'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',
'Threshold': {
'Comparison': 'LT',
'ThresholdValue': 123.0
},
'Statistic': 'SUM'|'MAX'|'AVG',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
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.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
[REQUIRED]
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 start time timestamp.
The time range between the start and end time must be less than 24 hours.
[REQUIRED]
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. The only supported channel is VOICE .
The queues to use to filter the metrics. You can specify up to 100 queues per request.
The channel to use to filter the metrics.
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE .
If no grouping is specified, a summary of metrics for all queues is returned.
[REQUIRED]
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:
ABANDON_TIME
Unit: SECONDS
Statistic: AVG
AFTER_CONTACT_WORK_TIME
Unit: SECONDS
Statistic: AVG
API_CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CALLBACK_CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CONTACTS_ABANDONED
Unit: COUNT
Statistic: SUM
CONTACTS_AGENT_HUNG_UP_FIRST
Unit: COUNT
Statistic: SUM
CONTACTS_CONSULTED
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED_INCOMING
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED_OUTBOUND
Unit: COUNT
Statistic: SUM
CONTACTS_HOLD_ABANDONS
Unit: COUNT
Statistic: SUM
CONTACTS_MISSED
Unit: COUNT
Statistic: SUM
CONTACTS_QUEUED
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_IN
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_OUT
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: COUNT
Statistic: SUM
HANDLE_TIME
Unit: SECONDS
Statistic: AVG
HOLD_TIME
Unit: SECONDS
Statistic: AVG
INTERACTION_AND_HOLD_TIME
Unit: SECONDS
Statistic: AVG
INTERACTION_TIME
Unit: SECONDS
Statistic: AVG
OCCUPANCY
Unit: PERCENT
Statistic: AVG
QUEUE_ANSWER_TIME
Unit: SECONDS
Statistic: AVG
QUEUED_TIME
Unit: SECONDS
Statistic: MAX
SERVICE_LEVEL
Unit: PERCENT
Statistic: 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
Contains information about a historical metric.
The name of the metric.
The threshold for the metric, used with service level metrics.
The type of comparison. Only "less than" (LT) comparisons are supported.
The threshold value to compare.
The statistic for the metric.
The unit for the metric.
dict
Response Syntax
{
'NextToken': 'string',
'MetricResults': [
{
'Dimensions': {
'Queue': {
'Id': 'string',
'Arn': 'string'
},
'Channel': 'VOICE'|'CHAT'
},
'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',
'Threshold': {
'Comparison': 'LT',
'ThresholdValue': 123.0
},
'Statistic': 'SUM'|'MAX'|'AVG',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
'Value': 123.0
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
MetricResults (list) --
Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
(dict) --
Contains information about the historical metrics retrieved.
Dimensions (dict) --
The dimension for the metrics.
Queue (dict) --
Information about the queue for which metrics are returned.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Channel (string) --
The channel used for grouping and filters.
Collections (list) --
The set of metrics.
(dict) --
Contains the data for a historical metric.
Metric (dict) --
Information about the metric.
Name (string) --
The name of the metric.
Threshold (dict) --
The threshold for the metric, used with service level metrics.
Comparison (string) --
The type of comparison. Only "less than" (LT) comparisons are supported.
ThresholdValue (float) --
The threshold value to compare.
Statistic (string) --
The statistic for the metric.
Unit (string) --
The unit for the metric.
Value (float) --
The value of the metric.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Provides information about the contact flows for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_contact_flows(
InstanceId='string',
ContactFlowTypes=[
'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
The type of contact flow.
dict
Response Syntax
{
'ContactFlowSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ContactFlowSummaryList (list) --
Information about the contact flows.
(dict) --
Contains summary information about a contact flow.
Id (string) --
The identifier of the contact flow.
Arn (string) --
The Amazon Resource Name (ARN) of the contact flow.
Name (string) --
The name of the contact flow.
ContactFlowType (string) --
The type of contact flow.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Provides information about the hours of operation for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_hours_of_operations(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{
'HoursOfOperationSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
HoursOfOperationSummaryList (list) --
Information about the hours of operation.
(dict) --
Contains summary information about hours of operation for a contact center.
Id (string) --
The identifier of the hours of operation.
Arn (string) --
The Amazon Resource Name (ARN) of the hours of operation.
Name (string) --
The name of the hours of operation.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Provides information about the phone numbers for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_phone_numbers(
InstanceId='string',
PhoneNumberTypes=[
'TOLL_FREE'|'DID',
],
PhoneNumberCountryCodes=[
'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
The type of phone number.
The ISO country code.
dict
Response Syntax
{
'PhoneNumberSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'PhoneNumber': 'string',
'PhoneNumberType': 'TOLL_FREE'|'DID',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PhoneNumberSummaryList (list) --
Information about the phone numbers.
(dict) --
Contains summary information about a phone number for a contact center.
Id (string) --
The identifier of the phone number.
Arn (string) --
The Amazon Resource Name (ARN) of the phone number.
PhoneNumber (string) --
The phone number.
PhoneNumberType (string) --
The type of phone number.
PhoneNumberCountryCode (string) --
The ISO country code.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Provides information about the queues for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_queues(
InstanceId='string',
QueueTypes=[
'STANDARD'|'AGENT',
],
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
The type of queue.
dict
Response Syntax
{
'QueueSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QueueType': 'STANDARD'|'AGENT'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
QueueSummaryList (list) --
Information about the queues.
(dict) --
Contains summary information about a queue.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Name (string) --
The name of the queue.
QueueType (string) --
The type of queue.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Provides summary information about the routing profiles for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_routing_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{
'RoutingProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RoutingProfileSummaryList (list) --
Information about the routing profiles.
(dict) --
Contains summary information about a routing profile.
Id (string) --
The identifier of the routing profile.
Arn (string) --
The Amazon Resource Name (ARN) of the routing profile.
Name (string) --
The name of the routing profile.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Provides summary information about the security profiles for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_security_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{
'SecurityProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityProfileSummaryList (list) --
Information about the security profiles.
(dict) --
Contains information about a security profile.
Id (string) --
The identifier of the security profile.
Arn (string) --
The Amazon Resource Name (ARN) of the security profile.
Name (string) --
The name of the security profile.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Lists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
Information about the tags.
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_user_hierarchy_groups(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{
'UserHierarchyGroupSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UserHierarchyGroupSummaryList (list) --
Information about the hierarchy groups.
(dict) --
Contains summary information about a hierarchy group.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Provides summary information about the users for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
response = client.list_users(
InstanceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{
'UserSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Username': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
UserSummaryList (list) --
Information about the users.
(dict) --
Contains summary information about a user.
Id (string) --
The identifier of the user account.
Arn (string) --
The Amazon Resource Name (ARN) of the user account.
Username (string) --
The Amazon Connect user name of the user account.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
See also: AWS API Documentation
Request Syntax
response = client.start_chat_contact(
InstanceId='string',
ContactFlowId='string',
Attributes={
'string': 'string'
},
ParticipantDetails={
'DisplayName': 'string'
},
InitialMessage={
'ContentType': 'string',
'Content': 'string'
},
ClientToken='string'
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The identifier of the contact flow for the chat.
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 per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
[REQUIRED]
Information identifying the participant.
Display name of the participant.
The initial message to be sent to the newly created chat.
The type of the content. Supported types are text/plain.
The content of the chat message.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactId': 'string',
'ParticipantId': 'string',
'ParticipantToken': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
ParticipantId (string) --
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
ParticipantToken (string) --
The token used by the chat participant to call CreateParticipantConnection . The participant token is valid for the lifetime of a chat participant.
Initiates a contact flow to place an outbound call to a customer.
There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
See also: AWS API Documentation
Request Syntax
response = client.start_outbound_voice_contact(
DestinationPhoneNumber='string',
ContactFlowId='string',
InstanceId='string',
ClientToken='string',
SourcePhoneNumber='string',
QueueId='string',
Attributes={
'string': 'string'
}
)
[REQUIRED]
The phone number of the customer, in E.164 format.
[REQUIRED]
The identifier of the contact flow for the outbound call.
[REQUIRED]
The identifier of the Amazon Connect instance.
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.
This field is autopopulated if not provided.
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 per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
Ends the specified contact.
See also: AWS API Documentation
Request Syntax
response = client.stop_contact(
ContactId='string',
InstanceId='string'
)
[REQUIRED]
The ID of the contact.
[REQUIRED]
The identifier of the Amazon Connect instance.
dict
Response Syntax
{}
Response Structure
Adds the specified tags to the specified resource.
The supported resource type is users.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
None
Removes the specified tags from the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
The tag keys.
None
Creates or updates the contact attributes associated with the specified contact.
You can 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 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.
See also: AWS API Documentation
Request Syntax
response = client.update_contact_attributes(
InitialContactId='string',
InstanceId='string',
Attributes={
'string': 'string'
}
)
[REQUIRED]
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
dict
Response Syntax
{}
Response Structure
Assigns the specified hierarchy group to the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_hierarchy(
HierarchyGroupId='string',
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance.
None
Updates the identity information for the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_identity_info(
IdentityInfo={
'FirstName': 'string',
'LastName': 'string',
'Email': 'string'
},
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identity information for the user.
The first name. This is required if you are using Amazon Connect or SAML for identity management.
The last name. This is required if you are using Amazon Connect or SAML for identity management.
The email address. If you are using SAML for identity management and include this parameter, an error is returned.
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance.
None
Updates the phone configuration settings for the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_phone_config(
PhoneConfig={
'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
'AutoAccept': True|False,
'AfterContactWorkTimeLimit': 123,
'DeskPhoneNumber': 'string'
},
UserId='string',
InstanceId='string'
)
[REQUIRED]
Information about phone configuration settings for the user.
The phone type.
The Auto accept setting.
The After Call Work (ACW) timeout setting, in seconds.
The phone number for the user's desk phone.
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance.
None
Assigns the specified routing profile to the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_routing_profile(
RoutingProfileId='string',
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identifier of the routing profile for the user.
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance.
None
Assigns the specified security profiles to the specified user.
See also: AWS API Documentation
Request Syntax
response = client.update_user_security_profiles(
SecurityProfileIds=[
'string',
],
UserId='string',
InstanceId='string'
)
[REQUIRED]
The identifiers of the security profiles for the user.
[REQUIRED]
The identifier of the user account.
[REQUIRED]
The identifier of the Amazon Connect instance.
None
The available paginators are:
paginator = client.get_paginator('get_metric_data')
Creates an iterator that will paginate through responses from Connect.Client.get_metric_data().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Filters={
'Queues': [
'string',
],
'Channels': [
'VOICE'|'CHAT',
]
},
Groupings=[
'QUEUE'|'CHANNEL',
],
HistoricalMetrics=[
{
'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',
'Threshold': {
'Comparison': 'LT',
'ThresholdValue': 123.0
},
'Statistic': 'SUM'|'MAX'|'AVG',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
[REQUIRED]
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.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
[REQUIRED]
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 start time timestamp.
The time range between the start and end time must be less than 24 hours.
[REQUIRED]
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. The only supported channel is VOICE .
The queues to use to filter the metrics. You can specify up to 100 queues per request.
The channel to use to filter the metrics.
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
The only supported grouping is QUEUE .
If no grouping is specified, a summary of metrics for all queues is returned.
[REQUIRED]
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:
ABANDON_TIME
Unit: SECONDS
Statistic: AVG
AFTER_CONTACT_WORK_TIME
Unit: SECONDS
Statistic: AVG
API_CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CALLBACK_CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CONTACTS_ABANDONED
Unit: COUNT
Statistic: SUM
CONTACTS_AGENT_HUNG_UP_FIRST
Unit: COUNT
Statistic: SUM
CONTACTS_CONSULTED
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED_INCOMING
Unit: COUNT
Statistic: SUM
CONTACTS_HANDLED_OUTBOUND
Unit: COUNT
Statistic: SUM
CONTACTS_HOLD_ABANDONS
Unit: COUNT
Statistic: SUM
CONTACTS_MISSED
Unit: COUNT
Statistic: SUM
CONTACTS_QUEUED
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_IN
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_IN_FROM_QUEUE
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_OUT
Unit: COUNT
Statistic: SUM
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: COUNT
Statistic: SUM
HANDLE_TIME
Unit: SECONDS
Statistic: AVG
HOLD_TIME
Unit: SECONDS
Statistic: AVG
INTERACTION_AND_HOLD_TIME
Unit: SECONDS
Statistic: AVG
INTERACTION_TIME
Unit: SECONDS
Statistic: AVG
OCCUPANCY
Unit: PERCENT
Statistic: AVG
QUEUE_ANSWER_TIME
Unit: SECONDS
Statistic: AVG
QUEUED_TIME
Unit: SECONDS
Statistic: MAX
SERVICE_LEVEL
Unit: PERCENT
Statistic: 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
Contains information about a historical metric.
The name of the metric.
The threshold for the metric, used with service level metrics.
The type of comparison. Only "less than" (LT) comparisons are supported.
The threshold value to compare.
The statistic for the metric.
The unit for the metric.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'MetricResults': [
{
'Dimensions': {
'Queue': {
'Id': 'string',
'Arn': 'string'
},
'Channel': 'VOICE'|'CHAT'
},
'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',
'Threshold': {
'Comparison': 'LT',
'ThresholdValue': 123.0
},
'Statistic': 'SUM'|'MAX'|'AVG',
'Unit': 'SECONDS'|'COUNT'|'PERCENT'
},
'Value': 123.0
},
]
},
]
}
Response Structure
(dict) --
MetricResults (list) --
Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
(dict) --
Contains information about the historical metrics retrieved.
Dimensions (dict) --
The dimension for the metrics.
Queue (dict) --
Information about the queue for which metrics are returned.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Channel (string) --
The channel used for grouping and filters.
Collections (list) --
The set of metrics.
(dict) --
Contains the data for a historical metric.
Metric (dict) --
Information about the metric.
Name (string) --
The name of the metric.
Threshold (dict) --
The threshold for the metric, used with service level metrics.
Comparison (string) --
The type of comparison. Only "less than" (LT) comparisons are supported.
ThresholdValue (float) --
The threshold value to compare.
Statistic (string) --
The statistic for the metric.
Unit (string) --
The unit for the metric.
Value (float) --
The value of the metric.
paginator = client.get_paginator('list_contact_flows')
Creates an iterator that will paginate through responses from Connect.Client.list_contact_flows().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
ContactFlowTypes=[
'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
The type of contact flow.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ContactFlowSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'
},
],
}
Response Structure
(dict) --
ContactFlowSummaryList (list) --
Information about the contact flows.
(dict) --
Contains summary information about a contact flow.
Id (string) --
The identifier of the contact flow.
Arn (string) --
The Amazon Resource Name (ARN) of the contact flow.
Name (string) --
The name of the contact flow.
ContactFlowType (string) --
The type of contact flow.
paginator = client.get_paginator('list_hours_of_operations')
Creates an iterator that will paginate through responses from Connect.Client.list_hours_of_operations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'HoursOfOperationSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
HoursOfOperationSummaryList (list) --
Information about the hours of operation.
(dict) --
Contains summary information about hours of operation for a contact center.
Id (string) --
The identifier of the hours of operation.
Arn (string) --
The Amazon Resource Name (ARN) of the hours of operation.
Name (string) --
The name of the hours of operation.
paginator = client.get_paginator('list_phone_numbers')
Creates an iterator that will paginate through responses from Connect.Client.list_phone_numbers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PhoneNumberTypes=[
'TOLL_FREE'|'DID',
],
PhoneNumberCountryCodes=[
'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
The type of phone number.
The ISO country code.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PhoneNumberSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'PhoneNumber': 'string',
'PhoneNumberType': 'TOLL_FREE'|'DID',
'PhoneNumberCountryCode': 'AF'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BA'|'BW'|'BR'|'IO'|'VG'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CK'|'CR'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'TL'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'PF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'CI'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'KP'|'MP'|'NO'|'OM'|'PK'|'PW'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'CG'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'KR'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'VI'|'UG'|'UA'|'AE'|'GB'|'US'|'UY'|'UZ'|'VU'|'VA'|'VE'|'VN'|'WF'|'EH'|'YE'|'ZM'|'ZW'
},
],
}
Response Structure
(dict) --
PhoneNumberSummaryList (list) --
Information about the phone numbers.
(dict) --
Contains summary information about a phone number for a contact center.
Id (string) --
The identifier of the phone number.
Arn (string) --
The Amazon Resource Name (ARN) of the phone number.
PhoneNumber (string) --
The phone number.
PhoneNumberType (string) --
The type of phone number.
PhoneNumberCountryCode (string) --
The ISO country code.
paginator = client.get_paginator('list_queues')
Creates an iterator that will paginate through responses from Connect.Client.list_queues().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
QueueTypes=[
'STANDARD'|'AGENT',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
The type of queue.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'QueueSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QueueType': 'STANDARD'|'AGENT'
},
],
}
Response Structure
(dict) --
QueueSummaryList (list) --
Information about the queues.
(dict) --
Contains summary information about a queue.
Id (string) --
The identifier of the queue.
Arn (string) --
The Amazon Resource Name (ARN) of the queue.
Name (string) --
The name of the queue.
QueueType (string) --
The type of queue.
paginator = client.get_paginator('list_routing_profiles')
Creates an iterator that will paginate through responses from Connect.Client.list_routing_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RoutingProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
RoutingProfileSummaryList (list) --
Information about the routing profiles.
(dict) --
Contains summary information about a routing profile.
Id (string) --
The identifier of the routing profile.
Arn (string) --
The Amazon Resource Name (ARN) of the routing profile.
Name (string) --
The name of the routing profile.
paginator = client.get_paginator('list_security_profiles')
Creates an iterator that will paginate through responses from Connect.Client.list_security_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SecurityProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
SecurityProfileSummaryList (list) --
Information about the security profiles.
(dict) --
Contains information about a security profile.
Id (string) --
The identifier of the security profile.
Arn (string) --
The Amazon Resource Name (ARN) of the security profile.
Name (string) --
The name of the security profile.
paginator = client.get_paginator('list_user_hierarchy_groups')
Creates an iterator that will paginate through responses from Connect.Client.list_user_hierarchy_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'UserHierarchyGroupSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string'
},
],
}
Response Structure
(dict) --
UserHierarchyGroupSummaryList (list) --
Information about the hierarchy groups.
(dict) --
Contains summary information about a hierarchy group.
Id (string) --
The identifier of the hierarchy group.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy group.
Name (string) --
The name of the hierarchy group.
paginator = client.get_paginator('list_users')
Creates an iterator that will paginate through responses from Connect.Client.list_users().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstanceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the Amazon Connect instance.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'UserSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Username': 'string'
},
],
}
Response Structure
(dict) --
UserSummaryList (list) --
Information about the users.
(dict) --
Contains summary information about a user.
Id (string) --
The identifier of the user account.
Arn (string) --
The Amazon Resource Name (ARN) of the user account.
Username (string) --
The Amazon Connect user name of the user account.