2023/11/01 - Amazon Connect Service - 1 new 29 updated api methods
Changes Adds the BatchGetFlowAssociation API which returns flow associations (flow-resource) corresponding to the list of resourceArns supplied in the request. This release also adds IsDefault, LastModifiedRegion and LastModifiedTime fields to the responses of several Describe and List APIs.
Retrieve the flow associations for the given resources.
See also: AWS API Documentation
Request Syntax
client.batch_get_flow_association(
InstanceId='string',
ResourceIds=[
'string',
],
ResourceType='SMS_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
list
[REQUIRED]
A list of resource identifiers to retrieve flow associations.
(string) --
string
The type of resource association.
dict
Response Syntax
{
'FlowAssociationSummaryList': [
{
'ResourceId': 'string',
'FlowId': 'string',
'ResourceType': 'SMS_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'
},
]
}
Response Structure
(dict) --
FlowAssociationSummaryList (list) --
Information about flow associations.
(dict) --
Information about flow associations.
ResourceId (string) --
The identifier of the resource.
FlowId (string) --
The identifier of the flow.
ResourceType (string) --
The type of resource association.
{'AgentStatus': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
See also: AWS API Documentation
Request Syntax
client.describe_agent_status(
InstanceId='string',
AgentStatusId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier for the agent status.
dict
Response Syntax
{
'AgentStatus': {
'AgentStatusARN': 'string',
'AgentStatusId': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE',
'DisplayOrder': 123,
'State': 'ENABLED'|'DISABLED',
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
}
Response Structure
(dict) --
AgentStatus (dict) --
The agent status.
AgentStatusARN (string) --
The Amazon Resource Name (ARN) of the agent status.
AgentStatusId (string) --
The identifier of the agent status.
Name (string) --
The name of the agent status.
Description (string) --
The description of the agent status.
Type (string) --
The type of agent status.
DisplayOrder (integer) --
The display order of the agent status.
State (string) --
The state of the agent status.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'HoursOfOperation': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
See also: AWS API Documentation
Request Syntax
client.describe_hours_of_operation(
InstanceId='string',
HoursOfOperationId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier for the hours of operation.
dict
Response Syntax
{
'HoursOfOperation': {
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string',
'Name': 'string',
'Description': 'string',
'TimeZone': 'string',
'Config': [
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
}
Response Structure
(dict) --
HoursOfOperation (dict) --
The hours of operation.
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Name (string) --
The name for the hours of operation.
Description (string) --
The description for the hours of operation.
TimeZone (string) --
The time zone for the hours of operation.
Config (list) --
Configuration information for the hours of operation.
(dict) --
Contains information about the hours of operation.
Day (string) --
The day that the hours of operation applies to.
StartTime (dict) --
The start time that your contact center opens.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EndTime (dict) --
The end time that your contact center closes.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'Prompt': {'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}}
Describes the prompt.
See also: AWS API Documentation
Request Syntax
client.describe_prompt(
InstanceId='string',
PromptId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
A unique identifier for the prompt.
dict
Response Syntax
{
'Prompt': {
'PromptARN': 'string',
'PromptId': 'string',
'Name': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
}
Response Structure
(dict) --
Prompt (dict) --
Information about the prompt.
PromptARN (string) --
The Amazon Resource Name (ARN) of the prompt.
PromptId (string) --
A unique identifier for the prompt.
Name (string) --
The name of the prompt.
Description (string) --
The description of the prompt.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'Queue': {'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}}
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
See also: AWS API Documentation
Request Syntax
client.describe_queue(
InstanceId='string',
QueueId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier for the queue.
dict
Response Syntax
{
'Queue': {
'Name': 'string',
'QueueArn': 'string',
'QueueId': 'string',
'Description': 'string',
'OutboundCallerConfig': {
'OutboundCallerIdName': 'string',
'OutboundCallerIdNumberId': 'string',
'OutboundFlowId': 'string'
},
'HoursOfOperationId': 'string',
'MaxContacts': 123,
'Status': 'ENABLED'|'DISABLED',
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
}
Response Structure
(dict) --
Queue (dict) --
The name of the queue.
Name (string) --
The name of the queue.
QueueArn (string) --
The Amazon Resource Name (ARN) for the queue.
QueueId (string) --
The identifier for the queue.
Description (string) --
The description of the queue.
OutboundCallerConfig (dict) --
The outbound caller ID name, number, and outbound whisper flow.
OutboundCallerIdName (string) --
The caller ID name.
OutboundCallerIdNumberId (string) --
The caller ID number.
OutboundFlowId (string) --
The outbound whisper flow to be used during an outbound call.
HoursOfOperationId (string) --
The identifier for the hours of operation.
MaxContacts (integer) --
The maximum number of contacts that can be in the queue before it is considered full.
Status (string) --
The status of the queue.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'QuickConnect': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Describes the quick connect.
See also: AWS API Documentation
Request Syntax
client.describe_quick_connect(
InstanceId='string',
QuickConnectId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier for the quick connect.
dict
Response Syntax
{
'QuickConnect': {
'QuickConnectARN': 'string',
'QuickConnectId': 'string',
'Name': 'string',
'Description': 'string',
'QuickConnectConfig': {
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
}
},
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
}
Response Structure
(dict) --
QuickConnect (dict) --
Information about the quick connect.
QuickConnectARN (string) --
The Amazon Resource Name (ARN) of the quick connect.
QuickConnectId (string) --
The identifier for the quick connect.
Name (string) --
The name of the quick connect.
Description (string) --
The description.
QuickConnectConfig (dict) --
Contains information about the quick connect.
QuickConnectType (string) --
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
UserConfig (dict) --
The user configuration. This is required only if QuickConnectType is USER.
UserId (string) --
The identifier of the user.
ContactFlowId (string) --
The identifier of the flow.
QueueConfig (dict) --
The queue configuration. This is required only if QuickConnectType is QUEUE.
QueueId (string) --
The identifier for the queue.
ContactFlowId (string) --
The identifier of the flow.
PhoneConfig (dict) --
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
PhoneNumber (string) --
The phone number in E.164 format.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'RoutingProfile': {'IsDefault': 'boolean',
'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Describes the specified routing profile.
See also: AWS API Documentation
Request Syntax
client.describe_routing_profile(
InstanceId='string',
RoutingProfileId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the routing profile.
dict
Response Syntax
{
'RoutingProfile': {
'InstanceId': 'string',
'Name': 'string',
'RoutingProfileArn': 'string',
'RoutingProfileId': 'string',
'Description': 'string',
'MediaConcurrencies': [
{
'Channel': 'VOICE'|'CHAT'|'TASK',
'Concurrency': 123,
'CrossChannelBehavior': {
'BehaviorType': 'ROUTE_CURRENT_CHANNEL_ONLY'|'ROUTE_ANY_CHANNEL'
}
},
],
'DefaultOutboundQueueId': 'string',
'Tags': {
'string': 'string'
},
'NumberOfAssociatedQueues': 123,
'NumberOfAssociatedUsers': 123,
'AgentAvailabilityTimer': 'TIME_SINCE_LAST_ACTIVITY'|'TIME_SINCE_LAST_INBOUND',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'IsDefault': True|False
}
}
Response Structure
(dict) --
RoutingProfile (dict) --
The routing profile.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Name (string) --
The name of the routing profile.
RoutingProfileArn (string) --
The Amazon Resource Name (ARN) of the routing profile.
RoutingProfileId (string) --
The identifier of the routing profile.
Description (string) --
The description of the routing profile.
MediaConcurrencies (list) --
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
(dict) --
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
Channel (string) --
The channels that agents can handle in the Contact Control Panel (CCP).
Concurrency (integer) --
The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE : Minimum value of 1. Maximum value of 1.
Valid Range for CHAT : Minimum value of 1. Maximum value of 10.
Valid Range for TASK : Minimum value of 1. Maximum value of 10.
CrossChannelBehavior (dict) --
Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.
BehaviorType (string) --
Specifies the other channels that can be routed to an agent handling their current channel.
DefaultOutboundQueueId (string) --
The identifier of the default outbound queue for this routing profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
NumberOfAssociatedQueues (integer) --
The number of associated queues in routing profile.
NumberOfAssociatedUsers (integer) --
The number of associated users in routing profile.
AgentAvailabilityTimer (string) --
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time .
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
IsDefault (boolean) --
Whether this a default routing profile.
{'SecurityProfile': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Gets basic information about the security profle.
See also: AWS API Documentation
Request Syntax
client.describe_security_profile(
SecurityProfileId='string',
InstanceId='string'
)
string
[REQUIRED]
The identifier for the security profle.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Response Syntax
{
'SecurityProfile': {
'Id': 'string',
'OrganizationResourceId': 'string',
'Arn': 'string',
'SecurityProfileName': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
},
'AllowedAccessControlTags': {
'string': 'string'
},
'TagRestrictedResources': [
'string',
],
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
}
Response Structure
(dict) --
SecurityProfile (dict) --
The security profile.
Id (string) --
The identifier for the security profile.
OrganizationResourceId (string) --
The organization resource identifier for the security profile.
Arn (string) --
The Amazon Resource Name (ARN) for the secruity profile.
SecurityProfileName (string) --
The name for the security profile.
Description (string) --
The description of the security profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
AllowedAccessControlTags (dict) --
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
(string) --
(string) --
TagRestrictedResources (list) --
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'User': {'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}}
Describes the specified user account. You can find the instance ID in the Amazon Connect 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
client.describe_user(
UserId='string',
InstanceId='string'
)
string
[REQUIRED]
The identifier of the user account.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Response Syntax
{
'User': {
'Id': 'string',
'Arn': 'string',
'Username': 'string',
'IdentityInfo': {
'FirstName': 'string',
'LastName': 'string',
'Email': 'string',
'SecondaryEmail': 'string',
'Mobile': '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'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': '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.
SecondaryEmail (string) --
The user's secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.
Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}
Mobile (string) --
The user's mobile number.
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.
Note
When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
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.
(string) --
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.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'HierarchyGroup': {'HierarchyPath': {'LevelFive': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'},
'LevelFour': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'},
'LevelOne': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'},
'LevelThree': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'},
'LevelTwo': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}},
'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Describes the specified hierarchy group.
See also: AWS API Documentation
Request Syntax
client.describe_user_hierarchy_group(
HierarchyGroupId='string',
InstanceId='string'
)
string
[REQUIRED]
The identifier of the hierarchy group.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Response Syntax
{
'HierarchyGroup': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LevelId': 'string',
'HierarchyPath': {
'LevelOne': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
'LevelTwo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
'LevelThree': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
'LevelFour': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
'LevelFive': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
},
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': '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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'HierarchyStructure': {'LevelFive': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'},
'LevelFour': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'},
'LevelOne': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'},
'LevelThree': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'},
'LevelTwo': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}}
Describes the hierarchy structure of the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.describe_user_hierarchy_structure(
InstanceId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
dict
Response Syntax
{
'HierarchyStructure': {
'LevelOne': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
'LevelTwo': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
'LevelThree': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
'LevelFour': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
'LevelFive': {
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
}
}
Response Structure
(dict) --
HierarchyStructure (dict) --
Information about the hierarchy structure.
LevelOne (dict) --
Information about level one.
Id (string) --
The identifier of the hierarchy level.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy level.
Name (string) --
The name of the hierarchy level.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
LevelTwo (dict) --
Information about level two.
Id (string) --
The identifier of the hierarchy level.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy level.
Name (string) --
The name of the hierarchy level.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
LevelThree (dict) --
Information about level three.
Id (string) --
The identifier of the hierarchy level.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy level.
Name (string) --
The name of the hierarchy level.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
LevelFour (dict) --
Information about level four.
Id (string) --
The identifier of the hierarchy level.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy level.
Name (string) --
The name of the hierarchy level.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
LevelFive (dict) --
Information about level five.
Id (string) --
The identifier of the hierarchy level.
Arn (string) --
The Amazon Resource Name (ARN) of the hierarchy level.
Name (string) --
The name of the hierarchy level.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}
Gets the prompt file.
See also: AWS API Documentation
Request Syntax
client.get_prompt_file(
InstanceId='string',
PromptId='string'
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
A unique identifier for the prompt.
dict
Response Syntax
{
'PromptPresignedUrl': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
Response Structure
(dict) --
PromptPresignedUrl (string) --
A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'AgentStatusSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
See also: AWS API Documentation
Request Syntax
client.list_agent_statuses(
InstanceId='string',
NextToken='string',
MaxResults=123,
AgentStatusTypes=[
'ROUTABLE'|'CUSTOM'|'OFFLINE',
]
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
list
Available agent status types.
(string) --
dict
Response Syntax
{
'NextToken': 'string',
'AgentStatusSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
AgentStatusSummaryList (list) --
A summary of agent statuses.
(dict) --
Summary information for an agent status.
Id (string) --
The identifier for an agent status.
Arn (string) --
The Amazon Resource Name (ARN) for the agent status.
Name (string) --
The name of the agent status.
Type (string) --
The type of the agent status.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'HoursOfOperationSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Provides information about the hours of operation for the specified Amazon Connect instance.
For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.list_hours_of_operations(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'HoursOfOperationSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': '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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'PromptSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Provides information about the prompts for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_prompts(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'PromptSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PromptSummaryList (list) --
Information about the prompts.
(dict) --
Contains information about the prompt.
Id (string) --
The identifier of the prompt.
Arn (string) --
The Amazon Resource Name (ARN) of the prompt.
Name (string) --
The name of the prompt.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp',
'QuickConnectSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
This API is in preview release for Amazon Connect and is subject to change.
Lists the quick connects associated with a queue.
See also: AWS API Documentation
Request Syntax
client.list_queue_quick_connects(
InstanceId='string',
QueueId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier for the queue.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'NextToken': 'string',
'QuickConnectSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
QuickConnectSummaryList (list) --
Information about the quick connects.
(dict) --
Contains summary information about a quick connect.
Id (string) --
The identifier for the quick connect.
Arn (string) --
The Amazon Resource Name (ARN) of the quick connect.
Name (string) --
The name of the quick connect.
QuickConnectType (string) --
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'QueueSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Provides information about the queues for the specified Amazon Connect instance.
If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.
For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.list_queues(
InstanceId='string',
QueueTypes=[
'STANDARD'|'AGENT',
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
list
The type of queue.
(string) --
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'QueueSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QueueType': 'STANDARD'|'AGENT',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'QuickConnectSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Provides information about the quick connects for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_quick_connects(
InstanceId='string',
NextToken='string',
MaxResults=123,
QuickConnectTypes=[
'USER'|'QUEUE'|'PHONE_NUMBER',
]
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
list
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
(string) --
dict
Response Syntax
{
'QuickConnectSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
QuickConnectSummaryList (list) --
Information about the quick connects.
(dict) --
Contains summary information about a quick connect.
Id (string) --
The identifier for the quick connect.
Arn (string) --
The Amazon Resource Name (ARN) of the quick connect.
Name (string) --
The name of the quick connect.
QuickConnectType (string) --
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}
Lists the queues associated with a routing profile.
See also: AWS API Documentation
Request Syntax
client.list_routing_profile_queues(
InstanceId='string',
RoutingProfileId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
[REQUIRED]
The identifier of the routing profile.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'NextToken': 'string',
'RoutingProfileQueueConfigSummaryList': [
{
'QueueId': 'string',
'QueueArn': 'string',
'QueueName': 'string',
'Priority': 123,
'Delay': 123,
'Channel': 'VOICE'|'CHAT'|'TASK'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
RoutingProfileQueueConfigSummaryList (list) --
Information about the routing profiles.
(dict) --
Contains summary information about a routing profile queue.
QueueId (string) --
The identifier for the queue.
QueueArn (string) --
The Amazon Resource Name (ARN) of the queue.
QueueName (string) --
The name of the queue.
Priority (integer) --
The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.
Delay (integer) --
The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide .
Channel (string) --
The channels this queue supports.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'RoutingProfileSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Provides summary information about the routing profiles for the specified Amazon Connect instance.
For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.list_routing_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'RoutingProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': '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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}
Returns a list of third-party applications in a specific security profile.
See also: AWS API Documentation
Request Syntax
client.list_security_profile_applications(
SecurityProfileId='string',
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier for the security profle.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
dict
Response Syntax
{
'Applications': [
{
'Namespace': 'string',
'ApplicationPermissions': [
'string',
]
},
],
'NextToken': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
Response Structure
(dict) --
Applications (list) --
This API is in preview release for Amazon Connect and is subject to change.
A list of the third-party application's metadata.
(dict) --
This API is in preview release for Amazon Connect and is subject to change.
A third-party application's metadata.
Namespace (string) --
Namespace of the application that you want to give access to.
ApplicationPermissions (list) --
The permissions that the agent is granted on the application. Only the ACCESS permission is supported.
(string) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}
Lists the permissions granted to a security profile.
See also: AWS API Documentation
Request Syntax
client.list_security_profile_permissions(
SecurityProfileId='string',
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier for the security profle.
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
dict
Response Syntax
{
'Permissions': [
'string',
],
'NextToken': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
Response Structure
(dict) --
Permissions (list) --
The permissions granted to the security profile. For a complete list of valid permissions, see List of security profile permissions.
(string) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
{'SecurityProfileSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.list_security_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'SecurityProfileSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': '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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'UserHierarchyGroupSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide .
See also: AWS API Documentation
Request Syntax
client.list_user_hierarchy_groups(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'UserHierarchyGroupSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': '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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'UserSummaryList': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Provides summary information about the users for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_users(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page. The default MaxResult size is 100.
dict
Response Syntax
{
'UserSummaryList': [
{
'Id': 'string',
'Arn': 'string',
'Username': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': '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.
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'HoursOfOperations': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_hours_of_operations(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria to be used to return hours of operations.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return hours of operations.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return hours of operations.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
Note
The currently supported values for FieldName are name , description , timezone , and resourceID .
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Response Syntax
{
'HoursOfOperations': [
{
'HoursOfOperationId': 'string',
'HoursOfOperationArn': 'string',
'Name': 'string',
'Description': 'string',
'TimeZone': 'string',
'Config': [
{
'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'StartTime': {
'Hours': 123,
'Minutes': 123
},
'EndTime': {
'Hours': 123,
'Minutes': 123
}
},
],
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
HoursOfOperations (list) --
Information about the hours of operations.
(dict) --
Information about of the hours of operation.
HoursOfOperationId (string) --
The identifier for the hours of operation.
HoursOfOperationArn (string) --
The Amazon Resource Name (ARN) for the hours of operation.
Name (string) --
The name for the hours of operation.
Description (string) --
The description for the hours of operation.
TimeZone (string) --
The time zone for the hours of operation.
Config (list) --
Configuration information for the hours of operation.
(dict) --
Contains information about the hours of operation.
Day (string) --
The day that the hours of operation applies to.
StartTime (dict) --
The start time that your contact center opens.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
EndTime (dict) --
The end time that your contact center closes.
Hours (integer) --
The hours.
Minutes (integer) --
The minutes.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of hours of operations which matched your search query.
{'Prompts': {'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}}
Searches prompts in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_prompts(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria to be used to return prompts.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return prompts.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return prompts.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
Note
The currently supported values for FieldName are name , description , and resourceID .
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Response Syntax
{
'Prompts': [
{
'PromptARN': 'string',
'PromptId': 'string',
'Name': 'string',
'Description': 'string',
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
Prompts (list) --
Information about the prompts.
(dict) --
Information about a prompt.
PromptARN (string) --
The Amazon Resource Name (ARN) of the prompt.
PromptId (string) --
A unique identifier for the prompt.
Name (string) --
The name of the prompt.
Description (string) --
The description of the prompt.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of quick connects which matched your search query.
{'Queues': {'LastModifiedRegion': 'string', 'LastModifiedTime': 'timestamp'}}
Searches queues in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_queues(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'QueueTypeCondition': 'STANDARD'
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria to be used to return queues.
Note
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return queues.
Note
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return queues.
Note
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
Note
The currently supported values for FieldName are name , description , and resourceID .
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
QueueTypeCondition (string) --
The type of queue.
dict
Response Syntax
{
'Queues': [
{
'Name': 'string',
'QueueArn': 'string',
'QueueId': 'string',
'Description': 'string',
'OutboundCallerConfig': {
'OutboundCallerIdName': 'string',
'OutboundCallerIdNumberId': 'string',
'OutboundFlowId': 'string'
},
'HoursOfOperationId': 'string',
'MaxContacts': 123,
'Status': 'ENABLED'|'DISABLED',
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
Queues (list) --
Information about the queues.
(dict) --
Contains information about a queue.
Name (string) --
The name of the queue.
QueueArn (string) --
The Amazon Resource Name (ARN) for the queue.
QueueId (string) --
The identifier for the queue.
Description (string) --
The description of the queue.
OutboundCallerConfig (dict) --
The outbound caller ID name, number, and outbound whisper flow.
OutboundCallerIdName (string) --
The caller ID name.
OutboundCallerIdNumberId (string) --
The caller ID number.
OutboundFlowId (string) --
The outbound whisper flow to be used during an outbound call.
HoursOfOperationId (string) --
The identifier for the hours of operation.
MaxContacts (integer) --
The maximum number of contacts that can be in the queue before it is considered full.
Status (string) --
The status of the queue.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of queues which matched your search query.
{'QuickConnects': {'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Searches quick connects in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_quick_connects(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria to be used to return quick connects.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return quick connects.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return quick connects.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
Note
The currently supported values for FieldName are name , description , and resourceID .
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Response Syntax
{
'QuickConnects': [
{
'QuickConnectARN': 'string',
'QuickConnectId': 'string',
'Name': 'string',
'Description': 'string',
'QuickConnectConfig': {
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
}
},
'Tags': {
'string': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
QuickConnects (list) --
Information about the quick connects.
(dict) --
Contains information about a quick connect.
QuickConnectARN (string) --
The Amazon Resource Name (ARN) of the quick connect.
QuickConnectId (string) --
The identifier for the quick connect.
Name (string) --
The name of the quick connect.
Description (string) --
The description.
QuickConnectConfig (dict) --
Contains information about the quick connect.
QuickConnectType (string) --
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
UserConfig (dict) --
The user configuration. This is required only if QuickConnectType is USER.
UserId (string) --
The identifier of the user.
ContactFlowId (string) --
The identifier of the flow.
QueueConfig (dict) --
The queue configuration. This is required only if QuickConnectType is QUEUE.
QueueId (string) --
The identifier for the queue.
ContactFlowId (string) --
The identifier of the flow.
PhoneConfig (dict) --
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
PhoneNumber (string) --
The phone number in E.164 format.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of quick connects which matched your search query.
{'RoutingProfiles': {'IsDefault': 'boolean',
'LastModifiedRegion': 'string',
'LastModifiedTime': 'timestamp'}}
Searches routing profiles in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_routing_profiles(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
}
}
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
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.
integer
The maximum number of results to return per page.
dict
Filters to be applied to search results.
TagFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR of AND (List of List) input where:
Top level list specifies conditions that need to be applied with OR operator
Inner list specifies conditions that need to be applied with AND operator.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(list) --
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
TagCondition (dict) --
A leaf node condition which can be used to specify a tag condition.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria to be used to return routing profiles.
Note
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return routing profiles.
Note
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return routing profiles.
Note
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
Note
The currently supported values for FieldName are name , description , and resourceID .
FieldName (string) --
The name of the field in the string condition.
Value (string) --
The value of the string.
ComparisonType (string) --
The type of comparison to be made when evaluating the string condition.
dict
Response Syntax
{
'RoutingProfiles': [
{
'InstanceId': 'string',
'Name': 'string',
'RoutingProfileArn': 'string',
'RoutingProfileId': 'string',
'Description': 'string',
'MediaConcurrencies': [
{
'Channel': 'VOICE'|'CHAT'|'TASK',
'Concurrency': 123,
'CrossChannelBehavior': {
'BehaviorType': 'ROUTE_CURRENT_CHANNEL_ONLY'|'ROUTE_ANY_CHANNEL'
}
},
],
'DefaultOutboundQueueId': 'string',
'Tags': {
'string': 'string'
},
'NumberOfAssociatedQueues': 123,
'NumberOfAssociatedUsers': 123,
'AgentAvailabilityTimer': 'TIME_SINCE_LAST_ACTIVITY'|'TIME_SINCE_LAST_INBOUND',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'IsDefault': True|False
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
RoutingProfiles (list) --
Information about the routing profiles.
(dict) --
Contains information about a routing profile.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Name (string) --
The name of the routing profile.
RoutingProfileArn (string) --
The Amazon Resource Name (ARN) of the routing profile.
RoutingProfileId (string) --
The identifier of the routing profile.
Description (string) --
The description of the routing profile.
MediaConcurrencies (list) --
The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
(dict) --
Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
Channel (string) --
The channels that agents can handle in the Contact Control Panel (CCP).
Concurrency (integer) --
The number of contacts an agent can have on a channel simultaneously.
Valid Range for VOICE : Minimum value of 1. Maximum value of 1.
Valid Range for CHAT : Minimum value of 1. Maximum value of 10.
Valid Range for TASK : Minimum value of 1. Maximum value of 10.
CrossChannelBehavior (dict) --
Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.
BehaviorType (string) --
Specifies the other channels that can be routed to an agent handling their current channel.
DefaultOutboundQueueId (string) --
The identifier of the default outbound queue for this routing profile.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
NumberOfAssociatedQueues (integer) --
The number of associated queues in routing profile.
NumberOfAssociatedUsers (integer) --
The number of associated users in routing profile.
AgentAvailabilityTimer (string) --
Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time .
LastModifiedTime (datetime) --
The timestamp when this resource was last modified.
LastModifiedRegion (string) --
The Amazon Web Services Region where this resource was last modified.
IsDefault (boolean) --
Whether this a default routing profile.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of routing profiles which matched your search query.