2025/12/01 - Amazon Connect Service - 44 new38 updated api methods
Changes This is a combined re:Invent release for Amazon Connect.
Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using AWS Service Quotas.
See also: AWS API Documentation
Request Syntax
client.create_data_table(
InstanceId='string',
Name='string',
Description='string',
TimeZone='string',
ValueLockLevel='NONE'|'DATA_TABLE'|'PRIMARY_VALUE'|'ATTRIBUTE'|'VALUE',
Status='PUBLISHED',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance where the data table will be created.
string
[REQUIRED]
The name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Whitespace must be trimmed first. Must not start with the reserved case insensitive values 'connect:' and 'aws:'. Must be unique for the instance using case-insensitive comparison.
string
An optional description for the data table. Must conform to Connect human readable string specification and have 0-250 characters. Whitespace must be trimmed first.
string
[REQUIRED]
The IANA timezone identifier to use when resolving time based dynamic values. Required even if no time slices are specified.
string
[REQUIRED]
The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. NONE is the default if unspecified. This determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.
string
[REQUIRED]
The status of the data table. One of PUBLISHED or SAVED. Required parameter that determines the initial state of the table.
dict
Key value pairs for attribute based access control (TBAC or ABAC). Optional tags to apply to the data table for organization and access control purposes.
(string) --
(string) --
dict
Response Syntax
{
'Id': 'string',
'Arn': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
}
Response Structure
(dict) --
Id (string) --
The unique identifier for the created data table. Does not include the version alias.
Arn (string) --
The Amazon Resource Name (ARN) for the created data table. Does not include the version alias.
LockVersion (dict) --
The lock version information for the created data table, used for optimistic locking and table versioning.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.
See also: AWS API Documentation
Request Syntax
client.create_data_table_attribute(
InstanceId='string',
DataTableId='string',
Name='string',
ValueType='TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
Description='string',
Primary=True|False,
Validation={
'MinLength': 123,
'MaxLength': 123,
'MinValues': 123,
'MaxValues': 123,
'IgnoreCase': True|False,
'Minimum': 123.0,
'Maximum': 123.0,
'ExclusiveMinimum': 123.0,
'ExclusiveMaximum': 123.0,
'MultipleOf': 123.0,
'Enum': {
'Strict': True|False,
'Values': [
'string',
]
}
}
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be one of the two available system managed aliases, $SAVED or $LATEST.
string
[REQUIRED]
The name for the attribute. Must conform to Connect human readable string specification and have 1-127 characters. Must not start with the reserved case insensitive values 'connect:' and 'aws:'. Whitespace trimmed before persisting. Must be unique for the data table using case-insensitive comparison.
string
[REQUIRED]
The type of value allowed or the resultant type after the value's expression is evaluated. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, and BOOLEAN.
string
An optional description for the attribute. Must conform to Connect human readable string specification and have 0-250 characters. Whitespace trimmed before persisting.
boolean
Optional boolean that defaults to false. Determines if the value is used to identify a record in the table. Values for primary attributes must not be expressions.
dict
Optional validation rules for the attribute. Borrows heavily from JSON Schema - Draft 2020-12. The maximum length of arrays within validations and depth of validations is 5. There are default limits that apply to all types. Customer specified limits in excess of the default limits are not permitted.
MinLength (integer) --
The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.
MaxLength (integer) --
The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.
MinValues (integer) --
The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.
MaxValues (integer) --
The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.
IgnoreCase (boolean) --
Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.
Minimum (float) --
The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.
Maximum (float) --
The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMinimum (float) --
The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMaximum (float) --
The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.
MultipleOf (float) --
Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.
Enum (dict) --
Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.
Strict (boolean) --
Boolean that defaults to false. When true, only values specified in the enum list are allowed. When false, custom values beyond the enumerated list are permitted.
Values (list) --
A list of predefined values that are allowed for this attribute. These values are always permitted regardless of the Strict setting.
(string) --
dict
Response Syntax
{
'Name': 'string',
'AttributeId': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
}
Response Structure
(dict) --
Name (string) --
The name of the created attribute since it also serves as the identifier. This could be different than the parameter passed in since it will be trimmed for whitespace.
AttributeId (string) --
The unique identifier assigned to the created attribute.
LockVersion (dict) --
The lock version information for the data table and attribute, used for optimistic locking and versioning.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.
See also: AWS API Documentation
Request Syntax
client.associate_workspace(
InstanceId='string',
WorkspaceId='string',
ResourceArns=[
'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 workspace.
list
[REQUIRED]
The Amazon Resource Names (ARNs) of the resources to associate with the workspace. Valid resource types are users and routing profiles.
(string) --
dict
Response Syntax
{
'SuccessfulList': [
{
'ResourceArn': 'string'
},
],
'FailedList': [
{
'ResourceArn': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulList (list) --
A list of resources that were successfully associated with the workspace.
(dict) --
Contains information about a resource that was successfully associated with a workspace in a batch operation.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource that was successfully associated.
FailedList (list) --
A list of resources that failed to be associated with the workspace, including error details.
(dict) --
Contains information about a resource that failed to be associated with a workspace in a batch operation.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource that failed to be associated.
ErrorCode (string) --
The error code indicating why the association failed.
ErrorMessage (string) --
An error message describing why the association failed.
Removes the association between a workspace and one or more users or routing profiles.
See also: AWS API Documentation
Request Syntax
client.disassociate_workspace(
InstanceId='string',
WorkspaceId='string',
ResourceArns=[
'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 workspace.
list
[REQUIRED]
The Amazon Resource Names (ARNs) of the resources to disassociate from the workspace.
(string) --
dict
Response Syntax
{
'SuccessfulList': [
{
'ResourceArn': 'string'
},
],
'FailedList': [
{
'ResourceArn': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulList (list) --
A list of resources that were successfully disassociated from the workspace.
(dict) --
Contains information about a resource that was successfully associated with a workspace in a batch operation.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource that was successfully associated.
FailedList (list) --
A list of resources that failed to be disassociated from the workspace, including error details.
(dict) --
Contains information about a resource that failed to be associated with a workspace in a batch operation.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the resource that failed to be associated.
ErrorCode (string) --
The error code indicating why the association failed.
ErrorMessage (string) --
An error message describing why the association failed.
Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
See also: AWS API Documentation
Request Syntax
client.describe_data_table(
InstanceId='string',
DataTableId='string'
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the $LATEST alias.
dict
Response Syntax
{
'DataTable': {
'Name': 'string',
'Id': 'string',
'Arn': 'string',
'TimeZone': 'string',
'Description': 'string',
'ValueLockLevel': 'NONE'|'DATA_TABLE'|'PRIMARY_VALUE'|'ATTRIBUTE'|'VALUE',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
},
'Version': 'string',
'VersionDescription': 'string',
'Status': 'PUBLISHED',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
DataTable (dict) --
The complete data table information including metadata, configuration, and versioning details.
Name (string) --
The human-readable name of the data table. Must be unique within the instance and conform to Connect naming standards.
Id (string) --
The unique identifier for the data table. Does not include version aliases.
Arn (string) --
The Amazon Resource Name (ARN) for the data table. Does not include version aliases.
TimeZone (string) --
The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are specified.
Description (string) --
An optional description of the data table's purpose and contents.
ValueLockLevel (string) --
The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.
LockVersion (dict) --
The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Version (string) --
A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).
VersionDescription (string) --
A description of the customer managed version.
Status (string) --
The current status of the data table. One of PUBLISHED or SAVED.
CreatedTime (datetime) --
The timestamp when the data table was created.
LastModifiedTime (datetime) --
The timestamp when the data table or any of its properties were last modified.
LastModifiedRegion (string) --
The AWS region where the data table was last modified, used for region replication.
Tags (dict) --
Key-value pairs for attribute based access control (TBAC or ABAC) and organization.
(string) --
(string) --
Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.
See also: AWS API Documentation
Request Syntax
client.search_data_tables(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'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 unique identifier for the Amazon Connect instance to search within.
string
Specify the pagination token from a previous request to retrieve the next page of results.
integer
The maximum number of data tables to return in one page of results.
dict
Optional filters to apply to the search results, such as tag-based filtering for attribute-based access control.
AttributeFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The 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.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports STARTS_WITH, CONTAINS, and EXACT comparison types.
OrConditions (list) --
The criteria's or conditions.
(dict) --
A data table search criteria.
AndConditions (list) --
The criteria's and conditions.
(dict) --
A data table search criteria.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
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
{
'DataTables': [
{
'Name': 'string',
'Id': 'string',
'Arn': 'string',
'TimeZone': 'string',
'Description': 'string',
'ValueLockLevel': 'NONE'|'DATA_TABLE'|'PRIMARY_VALUE'|'ATTRIBUTE'|'VALUE',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
},
'Version': 'string',
'VersionDescription': 'string',
'Status': 'PUBLISHED',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
DataTables (list) --
An array of data tables matching the search criteria with the same structure as DescribeTable except Version, VersionDescription, and LockVersion are omitted.
(dict) --
Represents a data table in Amazon Connect. A data table is a JSON-like data structure where attributes and values are dynamically set by customers. Customers can reference table values within call flows, applications, views, and workspaces to pinpoint dynamic configuration that changes their contact center's behavior in a predetermined and safe way.
Name (string) --
The human-readable name of the data table. Must be unique within the instance and conform to Connect naming standards.
Id (string) --
The unique identifier for the data table. Does not include version aliases.
Arn (string) --
The Amazon Resource Name (ARN) for the data table. Does not include version aliases.
TimeZone (string) --
The IANA timezone identifier used when resolving time based dynamic values. Required even if no time slices are specified.
Description (string) --
An optional description of the data table's purpose and contents.
ValueLockLevel (string) --
The data level that concurrent value edits are locked on. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.
LockVersion (dict) --
The lock version information used for optimistic locking and table versioning. Changes with each update to prevent concurrent modification conflicts.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Version (string) --
A unique identifier and alias for customer managed versions (not $LATEST or $SAVED).
VersionDescription (string) --
A description of the customer managed version.
Status (string) --
The current status of the data table. One of PUBLISHED or SAVED.
CreatedTime (datetime) --
The timestamp when the data table was created.
LastModifiedTime (datetime) --
The timestamp when the data table or any of its properties were last modified.
LastModifiedRegion (string) --
The AWS region where the data table was last modified, used for region replication.
Tags (dict) --
Key-value pairs for attribute based access control (TBAC or ABAC) and organization.
(string) --
(string) --
NextToken (string) --
Specify the pagination token from a previous request to retrieve the next page of results.
ApproximateTotalCount (integer) --
The approximate number of data tables that matched the search criteria.
Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.
See also: AWS API Documentation
Request Syntax
client.list_data_table_primary_values(
InstanceId='string',
DataTableId='string',
RecordIds=[
'string',
],
PrimaryAttributeValues=[
{
'AttributeName': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table whose primary values should be listed.
list
Optional list of specific record IDs to retrieve. Used for CloudFormation to effectively describe records by ID. If NextToken is provided, this parameter is ignored.
(string) --
list
Optional filter to retrieve primary values matching specific criteria.
(dict) --
A primary attribute value filter.
AttributeName (string) -- [REQUIRED]
The filter's attribute name.
Values (list) -- [REQUIRED]
The filter's values.
(string) --
string
Specify the pagination token from a previous request to retrieve the next page of results.
integer
The maximum number of data table primary values to return in one page of results.
dict
Response Syntax
{
'NextToken': 'string',
'PrimaryValuesList': [
{
'RecordId': 'string',
'PrimaryValues': [
{
'AttributeName': 'string',
'AttributeId': 'string',
'Value': 'string'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
Specify the pagination token from a previous request to retrieve the next page of results.
PrimaryValuesList (list) --
A list of primary value combinations with their record IDs and modification metadata.
(dict) --
A record primary value.
RecordId (string) --
The value's record ID.
PrimaryValues (list) --
The value's primary values.
(dict) --
A primary value response.
AttributeName (string) --
The value's attribute name.
AttributeId (string) --
The value's attribute ID.
Value (string) --
The value's value.
LastModifiedTime (datetime) --
The value's last modified time.
LastModifiedRegion (string) --
The value's last modified region.
Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: AWS API Standards.
See also: AWS API Documentation
Request Syntax
client.evaluate_data_table_values(
InstanceId='string',
DataTableId='string',
Values=[
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeNames': [
'string',
]
},
],
TimeZone='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
list
[REQUIRED]
A list of value evaluation sets specifying which primary values and attributes to evaluate.
(dict) --
A data table value evaluation set.
PrimaryValues (list) --
The set's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) -- [REQUIRED]
The name of the primary attribute that this value belongs to.
Value (string) -- [REQUIRED]
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeNames (list) -- [REQUIRED]
The set's attribute names.
(string) --
string
Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table time zone if not provided.
string
Specify the pagination token from a previous request to retrieve the next page of results.
integer
The maximum number of data table values to return in one page of results.
dict
Response Syntax
{
'Values': [
{
'RecordId': 'string',
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'ValueType': 'TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
'Found': True|False,
'Error': True|False,
'EvaluatedValue': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Values (list) --
A list of evaluated values with their computed results, error information, and metadata.
(dict) --
A data table evaluated value.
RecordId (string) --
The value's record ID.
PrimaryValues (list) --
The value's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) --
The name of the primary attribute that this value belongs to.
Value (string) --
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) --
The value's attribute name.
ValueType (string) --
The value's value type.
Found (boolean) --
The value's found.
Error (boolean) --
The value's error.
EvaluatedValue (string) --
The value's evaluated value.
NextToken (string) --
Specify the pagination token from a previous request to retrieve the next page of results.
Updates the theme configuration for a workspace, including colors and styling.
See also: AWS API Documentation
Request Syntax
client.update_workspace_theme(
InstanceId='string',
WorkspaceId='string',
Theme={
'Light': {
'Palette': {
'Header': {
'Background': 'string',
'Text': 'string',
'TextHover': 'string',
'InvertActionsColors': True|False
},
'Navigation': {
'Background': 'string',
'TextBackgroundHover': 'string',
'TextBackgroundActive': 'string',
'Text': 'string',
'TextHover': 'string',
'TextActive': 'string',
'InvertActionsColors': True|False
},
'Canvas': {
'ContainerBackground': 'string',
'PageBackground': 'string',
'ActiveBackground': 'string'
},
'Primary': {
'Default': 'string',
'Active': 'string',
'ContrastText': 'string'
}
},
'Images': {
'Logo': {
'Default': 'string',
'Favicon': 'string'
}
},
'Typography': {
'FontFamily': {
'Default': 'Arial'|'Courier New'|'Georgia'|'Times New Roman'|'Trebuchet'|'Verdana'
}
}
},
'Dark': {
'Palette': {
'Header': {
'Background': 'string',
'Text': 'string',
'TextHover': 'string',
'InvertActionsColors': True|False
},
'Navigation': {
'Background': 'string',
'TextBackgroundHover': 'string',
'TextBackgroundActive': 'string',
'Text': 'string',
'TextHover': 'string',
'TextActive': 'string',
'InvertActionsColors': True|False
},
'Canvas': {
'ContainerBackground': 'string',
'PageBackground': 'string',
'ActiveBackground': 'string'
},
'Primary': {
'Default': 'string',
'Active': 'string',
'ContrastText': 'string'
}
},
'Images': {
'Logo': {
'Default': 'string',
'Favicon': 'string'
}
},
'Typography': {
'FontFamily': {
'Default': 'Arial'|'Courier New'|'Georgia'|'Times New Roman'|'Trebuchet'|'Verdana'
}
}
}
}
)
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 workspace.
dict
The theme configuration, including color schemes and visual styles.
Light (dict) --
The theme configuration for light mode.
Palette (dict) --
The color palette configuration for the workspace theme.
Header (dict) --
The color configuration for the header area.
Background (string) --
The background color of the header.
Text (string) --
The text color in the header.
TextHover (string) --
The text color when hovering over header elements.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the header.
Navigation (dict) --
The color configuration for the navigation area.
Background (string) --
The background color of the navigation area.
TextBackgroundHover (string) --
The background color when hovering over navigation text.
TextBackgroundActive (string) --
The background color for active navigation items.
Text (string) --
The text color in the navigation area.
TextHover (string) --
The text color when hovering over navigation items.
TextActive (string) --
The text color for active navigation items.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the navigation area.
Canvas (dict) --
The color configuration for the canvas area.
ContainerBackground (string) --
The background color for container elements.
PageBackground (string) --
The background color for page elements.
ActiveBackground (string) --
The background color for active elements.
Primary (dict) --
The primary color configuration used throughout the workspace.
Default (string) --
The default primary color used throughout the workspace.
Active (string) --
The primary color used for active states.
ContrastText (string) --
The text color that contrasts with the primary color for readability.
Images (dict) --
The image assets used in the workspace theme.
Logo (dict) --
The logo images used in the workspace.
Default (string) --
The default logo image displayed in the workspace.
Favicon (string) --
The favicon image displayed in the browser tab.
Typography (dict) --
The typography configuration for the workspace theme.
FontFamily (dict) --
The font family configuration for text in the workspace.
Default (string) --
The default font family to use in the workspace theme.
Dark (dict) --
The theme configuration for dark mode.
Palette (dict) --
The color palette configuration for the workspace theme.
Header (dict) --
The color configuration for the header area.
Background (string) --
The background color of the header.
Text (string) --
The text color in the header.
TextHover (string) --
The text color when hovering over header elements.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the header.
Navigation (dict) --
The color configuration for the navigation area.
Background (string) --
The background color of the navigation area.
TextBackgroundHover (string) --
The background color when hovering over navigation text.
TextBackgroundActive (string) --
The background color for active navigation items.
Text (string) --
The text color in the navigation area.
TextHover (string) --
The text color when hovering over navigation items.
TextActive (string) --
The text color for active navigation items.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the navigation area.
Canvas (dict) --
The color configuration for the canvas area.
ContainerBackground (string) --
The background color for container elements.
PageBackground (string) --
The background color for page elements.
ActiveBackground (string) --
The background color for active elements.
Primary (dict) --
The primary color configuration used throughout the workspace.
Default (string) --
The default primary color used throughout the workspace.
Active (string) --
The primary color used for active states.
ContrastText (string) --
The text color that contrasts with the primary color for readability.
Images (dict) --
The image assets used in the workspace theme.
Logo (dict) --
The logo images used in the workspace.
Default (string) --
The default logo image displayed in the workspace.
Favicon (string) --
The favicon image displayed in the browser tab.
Typography (dict) --
The typography configuration for the workspace theme.
FontFamily (dict) --
The font family configuration for text in the workspace.
Default (string) --
The default font family to use in the workspace theme.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.
See also: AWS API Documentation
Request Syntax
client.batch_delete_data_table_value(
InstanceId='string',
DataTableId='string',
Values=[
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
},
]
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
list
[REQUIRED]
A list of value identifiers to delete, each specifying primary values, attribute name, and lock version information.
(dict) --
A data table delete value identifier.
PrimaryValues (list) --
The identifier's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) -- [REQUIRED]
The name of the primary attribute that this value belongs to.
Value (string) -- [REQUIRED]
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) -- [REQUIRED]
The identifier's attribute name.
LockVersion (dict) -- [REQUIRED]
The identifier's lock version.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
dict
Response Syntax
{
'Successful': [
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
},
],
'Failed': [
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Successful (list) --
A list of successfully deleted values with their identifiers and updated lock versions.
(dict) --
A batch delete data table value success result.
PrimaryValues (list) --
The result's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) --
The name of the primary attribute that this value belongs to.
Value (string) --
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) --
The result's attribute name.
LockVersion (dict) --
The result's lock version.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Failed (list) --
A list of values that failed to be deleted with error messages explaining the failure reason.
(dict) --
A batch delete data table value failure result.
PrimaryValues (list) --
The result's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) --
The name of the primary attribute that this value belongs to.
Value (string) --
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) --
The result's attribute name.
Message (string) --
The result's message.
Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.
See also: AWS API Documentation
Request Syntax
client.batch_create_data_table_value(
InstanceId='string',
DataTableId='string',
Values=[
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'Value': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
]
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the $LATEST alias.
list
[REQUIRED]
A list of values to create. Each value must specify the attribute name and optionally primary values if the table has primary attributes.
(dict) --
A data table value.
PrimaryValues (list) --
The value's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) -- [REQUIRED]
The name of the primary attribute that this value belongs to.
Value (string) -- [REQUIRED]
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) -- [REQUIRED]
The value's attribute name.
Value (string) -- [REQUIRED]
The value's value.
LockVersion (dict) --
The value's lock version.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
LastModifiedTime (datetime) --
The value's last modified time.
LastModifiedRegion (string) --
The value's last modified region.
dict
Response Syntax
{
'Successful': [
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'RecordId': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
},
],
'Failed': [
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Successful (list) --
A list of successfully created values with their identifiers and lock versions.
(dict) --
A batch create data table value success result.
PrimaryValues (list) --
The result's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) --
The name of the primary attribute that this value belongs to.
Value (string) --
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) --
The result's attribute name.
RecordId (string) --
The result's record ID.
LockVersion (dict) --
The result's lock version.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Failed (list) --
A list of values that failed to be created with error messages explaining the failure reason.
(dict) --
A batch create data table value failure result.
PrimaryValues (list) --
The result's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) --
The name of the primary attribute that this value belongs to.
Value (string) --
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) --
The result's attribute name.
Message (string) --
The result's message.
A list of Flow Modules an AI Agent can invoke as a tool
See also: AWS API Documentation
Request Syntax
client.list_security_profile_flow_modules(
SecurityProfileId='string',
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The identifier for the security profile.
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
{
'AllowedFlowModules': [
{
'Type': 'MCP',
'FlowModuleId': 'string'
},
],
'NextToken': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
Response Structure
(dict) --
AllowedFlowModules (list) --
A list of Flow Modules an AI Agent can invoke as a tool.
(dict) --
A list of Flow Modules an AI Agent can invoke as a tool
Type (string) --
Only Type we support is MCP.
FlowModuleId (string) --
If of Flow Modules invocable as tool
NextToken (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.
LastModifiedTime (datetime) --
The time the flow module was last modified.
LastModifiedRegion (string) --
The Region that flow module was last modified in.
Deletes a media asset (such as a logo) from a workspace.
See also: AWS API Documentation
Request Syntax
client.delete_workspace_media(
InstanceId='string',
WorkspaceId='string',
MediaType='IMAGE_LOGO_LIGHT_FAVICON'|'IMAGE_LOGO_DARK_FAVICON'|'IMAGE_LOGO_LIGHT_HORIZONTAL'|'IMAGE_LOGO_DARK_HORIZONTAL'
)
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 workspace.
string
[REQUIRED]
The type of media to delete. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the metadata of a workspace, such as its name and description.
See also: AWS API Documentation
Request Syntax
client.update_workspace_metadata(
InstanceId='string',
WorkspaceId='string',
Name='string',
Description='string',
Title='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 workspace.
string
The name of the workspace.
string
The description of the workspace.
string
The title displayed for the workspace.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.
See also: AWS API Documentation
Request Syntax
client.update_data_table_metadata(
InstanceId='string',
DataTableId='string',
Name='string',
Description='string',
ValueLockLevel='NONE'|'DATA_TABLE'|'PRIMARY_VALUE'|'ATTRIBUTE'|'VALUE',
TimeZone='string'
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be $LATEST. Providing any other alias fails with an error.
string
[REQUIRED]
The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Must be unique for the instance using case-insensitive comparison.
string
The updated description for the data table. Must conform to Connect human readable string specification and have 0-250 characters.
string
[REQUIRED]
The updated value lock level for the data table. One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE.
string
[REQUIRED]
The updated IANA timezone identifier to use when resolving time based dynamic values.
dict
Response Syntax
{
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
}
Response Structure
(dict) --
LockVersion (dict) --
The new lock version for the data table after the update.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.disassociate_security_profiles(
InstanceId='string',
SecurityProfiles=[
{
'Id': 'string'
},
],
EntityType='USER'|'AI_AGENT',
EntityArn='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.
list
[REQUIRED]
List of Security Profile Object.
(dict) --
Security profile items.
Id (string) --
Id of a security profile item.
string
[REQUIRED]
Only supported type is AI_AGENT.
string
[REQUIRED]
ARN of a Q in Connect AI Agent.
None
Enables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends.
See also: AWS API Documentation
Request Syntax
client.start_contact_media_processing(
InstanceId='string',
ContactId='string',
ProcessorArn='string',
FailureMode='DELIVER_UNPROCESSED_MESSAGE'|'DO_NOT_DELIVER_UNPROCESSED_MESSAGE'
)
string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The identifier of the contact.
string
The Amazon Resource Name (ARN) of the Lambda processor. You can find the Amazon Resource Name of the lambda in the lambda console.
string
The desired behavior for failed message processing.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
See also: AWS API Documentation
Request Syntax
client.batch_describe_data_table_value(
InstanceId='string',
DataTableId='string',
Values=[
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string'
},
]
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
list
[REQUIRED]
A list of value identifiers to retrieve, each specifying primary values and attribute names.
(dict) --
A data table value identifier.
PrimaryValues (list) --
The identifier's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) -- [REQUIRED]
The name of the primary attribute that this value belongs to.
Value (string) -- [REQUIRED]
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) -- [REQUIRED]
The identifier's attribute name.
dict
Response Syntax
{
'Successful': [
{
'RecordId': 'string',
'AttributeId': 'string',
'PrimaryValues': [
{
'AttributeName': 'string',
'AttributeId': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'Value': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'Failed': [
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Successful (list) --
A list of successfully retrieved values with their data, metadata, and lock version information.
(dict) --
A batch describe data table value success result.
RecordId (string) --
The result's record ID.
AttributeId (string) --
The result's attribute ID.
PrimaryValues (list) --
The result's primary values.
(dict) --
A primary value response.
AttributeName (string) --
The value's attribute name.
AttributeId (string) --
The value's attribute ID.
Value (string) --
The value's value.
AttributeName (string) --
The result's attribute name.
Value (string) --
The result's value.
LockVersion (dict) --
The result's lock version.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
LastModifiedTime (datetime) --
The result's last modified time.
LastModifiedRegion (string) --
The result's last modified region.
Failed (list) --
A list of values that failed to be retrieved with error messages explaining the failure reason.
(dict) --
A batch describe data table value failure result.
PrimaryValues (list) --
The result's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) --
The name of the primary attribute that this value belongs to.
Value (string) --
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) --
The result's attribute name.
Message (string) --
The result's message.
Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.
See also: AWS API Documentation
Request Syntax
client.update_workspace_visibility(
InstanceId='string',
WorkspaceId='string',
Visibility='ALL'|'ASSIGNED'|'NONE'
)
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 workspace.
string
[REQUIRED]
The visibility setting for the workspace. Valid values are: ALL (available to all users), ASSIGNED (available only to assigned users and routing profiles), and NONE (not visible to any users).
dict
Response Syntax
{}
Response Structure
(dict) --
Searches for workspace associations with users or routing profiles based on various criteria.
See also: AWS API Documentation
Request Syntax
client.search_workspace_associations(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'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 apply to the search, such as tag-based filters.
AttributeFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The 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.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria, including workspace ID, resource ID, or resource type.
OrConditions (list) --
A list of conditions to be met, where at least one condition must be satisfied.
(dict) --
Defines the search criteria for filtering workspace associations.
AndConditions (list) --
A list of conditions that must all be satisfied.
(dict) --
Defines the search criteria for filtering workspace associations.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
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
{
'NextToken': 'string',
'WorkspaceAssociations': [
{
'WorkspaceId': 'string',
'WorkspaceArn': 'string',
'ResourceId': 'string',
'ResourceArn': 'string',
'ResourceType': 'string',
'ResourceName': 'string'
},
],
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
WorkspaceAssociations (list) --
A list of workspace associations that match the search criteria.
(dict) --
Contains summary information about a workspace association with a user or routing profile.
WorkspaceId (string) --
The identifier of the workspace.
WorkspaceArn (string) --
The Amazon Resource Name (ARN) of the workspace.
ResourceId (string) --
The identifier of the associated resource (user or routing profile).
ResourceArn (string) --
The Amazon Resource Name (ARN) of the associated resource.
ResourceType (string) --
The type of resource associated with the workspace. Valid values are: USER and ROUTING_PROFILE.
ResourceName (string) --
The name of the associated resource.
ApproximateTotalCount (integer) --
The approximate total number of workspace associations that match the search criteria.
Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.
See also: AWS API Documentation
Request Syntax
client.update_data_table_primary_values(
InstanceId='string',
DataTableId='string',
PrimaryValues=[
{
'AttributeName': 'string',
'Value': 'string'
},
],
NewPrimaryValues=[
{
'AttributeName': 'string',
'Value': 'string'
},
],
LockVersion={
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be one of the two available system managed aliases, $SAVED or $LATEST.
list
[REQUIRED]
The current primary values for the record. Required and must include values for all primary attributes. Fails if the table has primary attributes and some primary values are omitted.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) -- [REQUIRED]
The name of the primary attribute that this value belongs to.
Value (string) -- [REQUIRED]
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
list
[REQUIRED]
The new primary values for the record. Required and must include values for all primary attributes. The combination must be unique within the table.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) -- [REQUIRED]
The name of the primary attribute that this value belongs to.
Value (string) -- [REQUIRED]
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
dict
[REQUIRED]
The lock version information required for optimistic locking to prevent concurrent modifications.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
dict
Response Syntax
{
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
}
Response Structure
(dict) --
LockVersion (dict) --
The updated lock version information for the data table and affected components after the primary values change.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Deletes a workspace and removes all associated view and resource assignments.
See also: AWS API Documentation
Request Syntax
client.delete_workspace(
InstanceId='string',
WorkspaceId='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 workspace.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.
See also: AWS API Documentation
Request Syntax
client.list_data_table_values(
InstanceId='string',
DataTableId='string',
RecordIds=[
'string',
],
PrimaryAttributeValues=[
{
'AttributeName': 'string',
'Values': [
'string',
]
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table whose values should be listed.
list
Optional list of specific record IDs to retrieve values for.
(string) --
list
Optional filter to retrieve values for records matching specific primary attribute criteria.
(dict) --
A primary attribute value filter.
AttributeName (string) -- [REQUIRED]
The filter's attribute name.
Values (list) -- [REQUIRED]
The filter's values.
(string) --
string
Specify the pagination token from a previous request to retrieve the next page of results.
integer
The maximum number of data table values to return in one page of results.
dict
Response Syntax
{
'NextToken': 'string',
'Values': [
{
'RecordId': 'string',
'AttributeId': 'string',
'PrimaryValues': [
{
'AttributeName': 'string',
'AttributeId': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'ValueType': 'TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
'Value': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
Specify the pagination token from a previous request to retrieve the next page of results.
Values (list) --
A list of data table values with their associated metadata, lock versions, and modification details.
(dict) --
A data table value summary.
RecordId (string) --
The summary's record ID.
AttributeId (string) --
The summary's attribute ID.
PrimaryValues (list) --
The summary's primary values.
(dict) --
A primary value response.
AttributeName (string) --
The value's attribute name.
AttributeId (string) --
The value's attribute ID.
Value (string) --
The value's value.
AttributeName (string) --
The summary's attribute name.
ValueType (string) --
The summary's value type.
Value (string) --
The summary's value.
LockVersion (dict) --
The summary's lock version.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
LastModifiedTime (datetime) --
The summary's last modified time.
LastModifiedRegion (string) --
The summary's last modified region.
Retrieves details about a workspace, including its configuration and metadata.
See also: AWS API Documentation
Request Syntax
client.describe_workspace(
InstanceId='string',
WorkspaceId='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 workspace.
dict
Response Syntax
{
'Workspace': {
'Visibility': 'ALL'|'ASSIGNED'|'NONE',
'Id': 'string',
'Name': 'string',
'Arn': 'string',
'Description': 'string',
'Theme': {
'Light': {
'Palette': {
'Header': {
'Background': 'string',
'Text': 'string',
'TextHover': 'string',
'InvertActionsColors': True|False
},
'Navigation': {
'Background': 'string',
'TextBackgroundHover': 'string',
'TextBackgroundActive': 'string',
'Text': 'string',
'TextHover': 'string',
'TextActive': 'string',
'InvertActionsColors': True|False
},
'Canvas': {
'ContainerBackground': 'string',
'PageBackground': 'string',
'ActiveBackground': 'string'
},
'Primary': {
'Default': 'string',
'Active': 'string',
'ContrastText': 'string'
}
},
'Images': {
'Logo': {
'Default': 'string',
'Favicon': 'string'
}
},
'Typography': {
'FontFamily': {
'Default': 'Arial'|'Courier New'|'Georgia'|'Times New Roman'|'Trebuchet'|'Verdana'
}
}
},
'Dark': {
'Palette': {
'Header': {
'Background': 'string',
'Text': 'string',
'TextHover': 'string',
'InvertActionsColors': True|False
},
'Navigation': {
'Background': 'string',
'TextBackgroundHover': 'string',
'TextBackgroundActive': 'string',
'Text': 'string',
'TextHover': 'string',
'TextActive': 'string',
'InvertActionsColors': True|False
},
'Canvas': {
'ContainerBackground': 'string',
'PageBackground': 'string',
'ActiveBackground': 'string'
},
'Primary': {
'Default': 'string',
'Active': 'string',
'ContrastText': 'string'
}
},
'Images': {
'Logo': {
'Default': 'string',
'Favicon': 'string'
}
},
'Typography': {
'FontFamily': {
'Default': 'Arial'|'Courier New'|'Georgia'|'Times New Roman'|'Trebuchet'|'Verdana'
}
}
}
},
'Title': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Workspace (dict) --
Information about the workspace.
Visibility (string) --
Controls who can access the workspace. Valid values are: ALL (all users), ASSIGNED (only assigned users and routing profiles), and NONE (not visible).
Id (string) --
The unique identifier of the workspace.
Name (string) --
The name of the workspace.
Arn (string) --
The Amazon Resource Name (ARN) of the workspace.
Description (string) --
The description of the workspace.
Theme (dict) --
The theme configuration for the workspace, including colors and styling.
Light (dict) --
The theme configuration for light mode.
Palette (dict) --
The color palette configuration for the workspace theme.
Header (dict) --
The color configuration for the header area.
Background (string) --
The background color of the header.
Text (string) --
The text color in the header.
TextHover (string) --
The text color when hovering over header elements.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the header.
Navigation (dict) --
The color configuration for the navigation area.
Background (string) --
The background color of the navigation area.
TextBackgroundHover (string) --
The background color when hovering over navigation text.
TextBackgroundActive (string) --
The background color for active navigation items.
Text (string) --
The text color in the navigation area.
TextHover (string) --
The text color when hovering over navigation items.
TextActive (string) --
The text color for active navigation items.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the navigation area.
Canvas (dict) --
The color configuration for the canvas area.
ContainerBackground (string) --
The background color for container elements.
PageBackground (string) --
The background color for page elements.
ActiveBackground (string) --
The background color for active elements.
Primary (dict) --
The primary color configuration used throughout the workspace.
Default (string) --
The default primary color used throughout the workspace.
Active (string) --
The primary color used for active states.
ContrastText (string) --
The text color that contrasts with the primary color for readability.
Images (dict) --
The image assets used in the workspace theme.
Logo (dict) --
The logo images used in the workspace.
Default (string) --
The default logo image displayed in the workspace.
Favicon (string) --
The favicon image displayed in the browser tab.
Typography (dict) --
The typography configuration for the workspace theme.
FontFamily (dict) --
The font family configuration for text in the workspace.
Default (string) --
The default font family to use in the workspace theme.
Dark (dict) --
The theme configuration for dark mode.
Palette (dict) --
The color palette configuration for the workspace theme.
Header (dict) --
The color configuration for the header area.
Background (string) --
The background color of the header.
Text (string) --
The text color in the header.
TextHover (string) --
The text color when hovering over header elements.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the header.
Navigation (dict) --
The color configuration for the navigation area.
Background (string) --
The background color of the navigation area.
TextBackgroundHover (string) --
The background color when hovering over navigation text.
TextBackgroundActive (string) --
The background color for active navigation items.
Text (string) --
The text color in the navigation area.
TextHover (string) --
The text color when hovering over navigation items.
TextActive (string) --
The text color for active navigation items.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the navigation area.
Canvas (dict) --
The color configuration for the canvas area.
ContainerBackground (string) --
The background color for container elements.
PageBackground (string) --
The background color for page elements.
ActiveBackground (string) --
The background color for active elements.
Primary (dict) --
The primary color configuration used throughout the workspace.
Default (string) --
The default primary color used throughout the workspace.
Active (string) --
The primary color used for active states.
ContrastText (string) --
The text color that contrasts with the primary color for readability.
Images (dict) --
The image assets used in the workspace theme.
Logo (dict) --
The logo images used in the workspace.
Default (string) --
The default logo image displayed in the workspace.
Favicon (string) --
The favicon image displayed in the browser tab.
Typography (dict) --
The typography configuration for the workspace theme.
FontFamily (dict) --
The font family configuration for text in the workspace.
Default (string) --
The default font family to use in the workspace theme.
Title (string) --
The title displayed for the workspace.
LastModifiedTime (datetime) --
The timestamp when the workspace was last modified.
LastModifiedRegion (string) --
The AWS Region where the workspace was last modified.
Tags (dict) --
The tags used to organize, track, or control access for the workspace.
(string) --
(string) --
Removes the association between a view and a page in a workspace. The page will display the default view after deletion.
See also: AWS API Documentation
Request Syntax
client.delete_workspace_page(
InstanceId='string',
WorkspaceId='string',
Page='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 workspace.
string
[REQUIRED]
The page identifier.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.
See also: AWS API Documentation
Request Syntax
client.describe_data_table_attribute(
InstanceId='string',
DataTableId='string',
AttributeName='string'
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
string
[REQUIRED]
The name of the attribute to retrieve detailed information for.
dict
Response Syntax
{
'Attribute': {
'AttributeId': 'string',
'Name': 'string',
'ValueType': 'TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
'Description': 'string',
'DataTableId': 'string',
'DataTableArn': 'string',
'Primary': True|False,
'Version': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'Validation': {
'MinLength': 123,
'MaxLength': 123,
'MinValues': 123,
'MaxValues': 123,
'IgnoreCase': True|False,
'Minimum': 123.0,
'Maximum': 123.0,
'ExclusiveMinimum': 123.0,
'ExclusiveMaximum': 123.0,
'MultipleOf': 123.0,
'Enum': {
'Strict': True|False,
'Values': [
'string',
]
}
}
}
}
Response Structure
(dict) --
Attribute (dict) --
The complete attribute information including configuration, validation rules, lock version, and metadata.
AttributeId (string) --
The unique identifier for the attribute within the data table.
Name (string) --
The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.
ValueType (string) --
The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.
Description (string) --
An optional description explaining the purpose and usage of this attribute.
DataTableId (string) --
The unique identifier of the data table that contains this attribute.
DataTableArn (string) --
The Amazon Resource Name (ARN) of the data table that contains this attribute.
Primary (boolean) --
Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes must have unique value combinations and cannot contain expressions.
Version (string) --
The version identifier for this attribute, used for versioning and change tracking.
LockVersion (dict) --
The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
LastModifiedTime (datetime) --
The timestamp when this attribute was last modified.
LastModifiedRegion (string) --
The AWS region where this attribute was last modified, used for region replication.
Validation (dict) --
The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.
MinLength (integer) --
The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.
MaxLength (integer) --
The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.
MinValues (integer) --
The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.
MaxValues (integer) --
The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.
IgnoreCase (boolean) --
Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.
Minimum (float) --
The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.
Maximum (float) --
The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMinimum (float) --
The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMaximum (float) --
The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.
MultipleOf (float) --
Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.
Enum (dict) --
Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.
Strict (boolean) --
Boolean that defaults to false. When true, only values specified in the enum list are allowed. When false, custom values beyond the enumerated list are permitted.
Values (list) --
A list of predefined values that are allowed for this attribute. These values are always permitted regardless of the Strict setting.
(string) --
Searches workspaces based on name, description, visibility, or tags.
See also: AWS API Documentation
Request Syntax
client.search_workspaces(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'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 apply to the search, such as tag-based filters.
AttributeFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The 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.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria, including field names and comparison types.
OrConditions (list) --
A list of conditions to be met, where at least one condition must be satisfied.
(dict) --
Defines the search criteria for filtering workspaces.
AndConditions (list) --
A list of conditions that must all be satisfied.
(dict) --
Defines the search criteria for filtering workspaces.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
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
{
'NextToken': 'string',
'Workspaces': [
{
'Id': 'string',
'Name': 'string',
'Visibility': 'ALL'|'ASSIGNED'|'NONE',
'Description': 'string',
'Title': 'string',
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
Workspaces (list) --
A list of workspaces that match the search criteria.
(dict) --
Contains summary information about a workspace returned from a search operation.
Id (string) --
The unique identifier of the workspace.
Name (string) --
The name of the workspace.
Visibility (string) --
The visibility setting of the workspace.
Description (string) --
The description of the workspace.
Title (string) --
The title displayed for the workspace.
Arn (string) --
The Amazon Resource Name (ARN) of the workspace.
CreatedAt (datetime) --
The timestamp when the workspace was created.
Tags (dict) --
The tags associated with the workspace.
(string) --
(string) --
ApproximateTotalCount (integer) --
The approximate total number of workspaces that match the search criteria.
Searches views based on name, description, or tags.
See also: AWS API Documentation
Request Syntax
client.search_views(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'ViewTypeCondition': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
'ViewStatusCondition': 'PUBLISHED'|'SAVED'
}
)
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 apply to the search, such as tag-based filters.
AttributeFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The 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.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
The search criteria, including field names and comparison types.
OrConditions (list) --
A list of conditions to be met, where at least one condition must be satisfied.
(dict) --
Defines the search criteria for filtering views.
AndConditions (list) --
A list of conditions that must all be satisfied.
(dict) --
Defines the search criteria for filtering views.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
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.
ViewTypeCondition (string) --
A condition that filters views by their type.
ViewStatusCondition (string) --
A condition that filters views by their status.
dict
Response Syntax
{
'Views': [
{
'Id': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'PUBLISHED'|'SAVED',
'Type': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
'Description': 'string',
'Version': 123,
'VersionDescription': 'string',
'Content': {
'InputSchema': 'string',
'Template': 'string',
'Actions': [
'string',
]
},
'Tags': {
'string': 'string'
},
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'ViewContentSha256': 'string'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
Views (list) --
A list of views that match the search criteria.
(dict) --
A view resource object. Contains metadata and content necessary to render the view.
Id (string) --
The identifier of the view.
Arn (string) --
The Amazon Resource Name (ARN) of the view.
Name (string) --
The name of the view.
Status (string) --
Indicates the view status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content.
Type (string) --
The type of the view - CUSTOMER_MANAGED.
Description (string) --
The description of the view.
Version (integer) --
Current version of the view.
VersionDescription (string) --
The description of the version.
Content (dict) --
View content containing all content necessary to render a view except for runtime input data.
InputSchema (string) --
The data schema matching data that the view template must be provided to render.
Template (string) --
The view template representing the structure of the view.
Actions (list) --
A list of possible actions from the view.
(string) --
Tags (dict) --
The tags associated with the view resource (not specific to view version).
(string) --
(string) --
CreatedTime (datetime) --
The timestamp of when the view was created.
LastModifiedTime (datetime) --
Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
ViewContentSha256 (string) --
Indicates the checksum value of the latest published view content.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The approximate total number of views that match the search criteria.
Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_entity_security_profiles(
InstanceId='string',
EntityType='USER'|'AI_AGENT',
EntityArn='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]
Only supported type is AI_AGENT.
string
[REQUIRED]
ARN of a Q in Connect AI Agent.
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
{
'SecurityProfiles': [
{
'Id': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecurityProfiles (list) --
List of Security Profile Object.
(dict) --
Security profile items.
Id (string) --
Id of a security profile item.
NextToken (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.
Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.
See also: AWS API Documentation
Request Syntax
client.list_data_tables(
InstanceId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance whose data tables should be listed.
string
Specify the pagination token from a previous request to retrieve the next page of results.
integer
The maximum number of data tables to return in one page of results.
dict
Response Syntax
{
'NextToken': 'string',
'DataTableSummaryList': [
{
'Name': 'string',
'Id': 'string',
'Arn': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
Specify the pagination token from a previous request to retrieve the next page of results.
DataTableSummaryList (list) --
A list of data table summaries containing basic information about each table including ID, ARN, name, and modification details.
(dict) --
A data table summary.
Name (string) --
The summary's name.
Id (string) --
The summary's ID.
Arn (string) --
The summary's ARN.
LastModifiedTime (datetime) --
The summary's last modified time.
LastModifiedRegion (string) --
The summary's last modified region.
Lists the workspaces in an Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_workspaces(
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.
dict
Response Syntax
{
'NextToken': 'string',
'WorkspaceSummaryList': [
{
'Id': 'string',
'Name': 'string',
'Arn': '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.
WorkspaceSummaryList (list) --
A summary list of workspaces.
(dict) --
Contains summary information about a workspace.
Id (string) --
The unique identifier of the workspace.
Name (string) --
The name of the workspace.
Arn (string) --
The Amazon Resource Name (ARN) of the workspace.
LastModifiedTime (datetime) --
The timestamp when the workspace was last modified.
LastModifiedRegion (string) --
The AWS Region where the workspace was last modified.
Imports a media asset (such as a logo) for use in a workspace.
See also: AWS API Documentation
Request Syntax
client.import_workspace_media(
InstanceId='string',
WorkspaceId='string',
MediaType='IMAGE_LOGO_LIGHT_FAVICON'|'IMAGE_LOGO_DARK_FAVICON'|'IMAGE_LOGO_LIGHT_HORIZONTAL'|'IMAGE_LOGO_DARK_HORIZONTAL',
MediaSource='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 workspace.
string
[REQUIRED]
The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL.
string
[REQUIRED]
The media source. Can be an S3 presigned URL or a base64-encoded string.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.
See also: AWS API Documentation
Request Syntax
client.batch_update_data_table_value(
InstanceId='string',
DataTableId='string',
Values=[
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'Value': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
]
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
list
[REQUIRED]
A list of values to update, each including the current lock version to ensure optimistic locking.
(dict) --
A data table value.
PrimaryValues (list) --
The value's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) -- [REQUIRED]
The name of the primary attribute that this value belongs to.
Value (string) -- [REQUIRED]
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) -- [REQUIRED]
The value's attribute name.
Value (string) -- [REQUIRED]
The value's value.
LockVersion (dict) --
The value's lock version.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
LastModifiedTime (datetime) --
The value's last modified time.
LastModifiedRegion (string) --
The value's last modified region.
dict
Response Syntax
{
'Successful': [
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
},
],
'Failed': [
{
'PrimaryValues': [
{
'AttributeName': 'string',
'Value': 'string'
},
],
'AttributeName': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
Successful (list) --
A list of successfully updated values with their new lock versions and identifiers.
(dict) --
A batch update data table value success result.
PrimaryValues (list) --
The result's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) --
The name of the primary attribute that this value belongs to.
Value (string) --
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) --
The result's attribute name.
LockVersion (dict) --
The result's lock version.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Failed (list) --
A list of values that failed to be updated with error messages explaining the failure reason.
(dict) --
A batch update data table value failure result.
PrimaryValues (list) --
The result's primary values.
(dict) --
Represents a primary key value used to identify a specific record in a data table. Primary values are used in combination to create unique record identifiers when a table has multiple primary attributes.
AttributeName (string) --
The name of the primary attribute that this value belongs to.
Value (string) --
The actual value for the primary attribute. Must be provided as a string regardless of the attribute's value type. Primary values cannot be expressions and must be explicitly specified.
AttributeName (string) --
The result's attribute name.
Message (string) --
The result's message.
Stops in-flight message processing for an ongoing chat session.
See also: AWS API Documentation
Request Syntax
client.stop_contact_media_processing(
InstanceId='string',
ContactId='string'
)
string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
string
The identifier of the contact.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes an attribute and all its values from a data table.
See also: AWS API Documentation
Request Syntax
client.delete_data_table_attribute(
InstanceId='string',
DataTableId='string',
AttributeName='string'
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table.
string
[REQUIRED]
The name of the attribute to delete.
dict
Response Syntax
{
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
}
Response Structure
(dict) --
LockVersion (dict) --
The updated lock version of the data table.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Associates a view with a page in a workspace, defining what users see when they navigate to that page.
See also: AWS API Documentation
Request Syntax
client.create_workspace_page(
InstanceId='string',
WorkspaceId='string',
ResourceArn='string',
Page='string',
Slug='string',
InputData='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 workspace.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the view to associate with the page.
string
[REQUIRED]
The page identifier. Valid system pages include HOME and AGENT_EXPERIENCE. Custom pages cannot use the aws: or connect: prefixes.
string
The URL-friendly identifier for the page.
string
A JSON string containing input parameters for the view, validated against the view's input schema.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the page configurations in a workspace, including the views assigned to each page.
See also: AWS API Documentation
Request Syntax
client.list_workspace_pages(
InstanceId='string',
WorkspaceId='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 workspace.
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
{
'NextToken': 'string',
'WorkspacePageList': [
{
'ResourceArn': 'string',
'Page': 'string',
'Slug': 'string',
'InputData': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
WorkspacePageList (list) --
A list of page configurations in the workspace.
(dict) --
Contains information about a page configuration in a workspace, including the view assigned to the page.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the view associated with this page.
Page (string) --
The page identifier. System pages include HOME and AGENT_EXPERIENCE.
Slug (string) --
The URL-friendly identifier for the page.
InputData (string) --
A JSON string containing input parameters passed to the view when the page is rendered.
Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.
See also: AWS API Documentation
Request Syntax
client.delete_data_table(
InstanceId='string',
DataTableId='string'
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table to delete. Must also accept the table ARN. Fails with an error if the version is provided and is not $LATEST.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists media assets (such as logos) associated with a workspace.
See also: AWS API Documentation
Request Syntax
client.list_workspace_media(
InstanceId='string',
WorkspaceId='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 workspace.
dict
Response Syntax
{
'Media': [
{
'Type': 'IMAGE_LOGO_LIGHT_FAVICON'|'IMAGE_LOGO_DARK_FAVICON'|'IMAGE_LOGO_LIGHT_HORIZONTAL'|'IMAGE_LOGO_DARK_HORIZONTAL',
'Source': 'string'
},
]
}
Response Structure
(dict) --
Media (list) --
A list of media assets for the workspace.
(dict) --
Contains information about a media asset used in a workspace.
Type (string) --
The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL.
Source (string) --
The source URL or data for the media asset.
Updates the configuration of a page in a workspace, including the associated view and input data.
See also: AWS API Documentation
Request Syntax
client.update_workspace_page(
InstanceId='string',
WorkspaceId='string',
Page='string',
NewPage='string',
ResourceArn='string',
Slug='string',
InputData='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 workspace.
string
[REQUIRED]
The current page identifier.
string
The new page identifier, if changing the page name.
string
The Amazon Resource Name (ARN) of the view to associate with the page.
string
The URL-friendly identifier for the page.
string
A JSON string containing input parameters for the view.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using AWS Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.
See also: AWS API Documentation
Request Syntax
client.list_data_table_attributes(
InstanceId='string',
DataTableId='string',
AttributeIds=[
'string',
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table whose attributes should be listed.
list
Optional list of specific attribute IDs to retrieve. Used for CloudFormation to effectively describe attributes by ID. If NextToken is provided, this parameter is ignored.
(string) --
string
Specify the pagination token from a previous request to retrieve the next page of results.
integer
The maximum number of data table attributes to return in one page of results.
dict
Response Syntax
{
'NextToken': 'string',
'Attributes': [
{
'AttributeId': 'string',
'Name': 'string',
'ValueType': 'TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
'Description': 'string',
'DataTableId': 'string',
'DataTableArn': 'string',
'Primary': True|False,
'Version': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string',
'Validation': {
'MinLength': 123,
'MaxLength': 123,
'MinValues': 123,
'MaxValues': 123,
'IgnoreCase': True|False,
'Minimum': 123.0,
'Maximum': 123.0,
'ExclusiveMinimum': 123.0,
'ExclusiveMaximum': 123.0,
'MultipleOf': 123.0,
'Enum': {
'Strict': True|False,
'Values': [
'string',
]
}
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
Specify the pagination token from a previous request to retrieve the next page of results.
Attributes (list) --
A list of data table attributes with their complete configuration and metadata.
(dict) --
Represents an attribute (column) in a data table. Attributes define the schema and validation rules for values that can be stored in the table. They specify the data type, constraints, and whether the attribute is used as a primary key for record identification.
AttributeId (string) --
The unique identifier for the attribute within the data table.
Name (string) --
The human-readable name of the attribute. Must be unique within the data table and conform to Connect naming standards.
ValueType (string) --
The type of value allowed for this attribute. Must be one of TEXT, TEXT_LIST, NUMBER, NUMBER_LIST, or BOOLEAN. Determines how values are validated and processed.
Description (string) --
An optional description explaining the purpose and usage of this attribute.
DataTableId (string) --
The unique identifier of the data table that contains this attribute.
DataTableArn (string) --
The Amazon Resource Name (ARN) of the data table that contains this attribute.
Primary (boolean) --
Boolean indicating whether this attribute is used as a primary key for record identification. Primary attributes must have unique value combinations and cannot contain expressions.
Version (string) --
The version identifier for this attribute, used for versioning and change tracking.
LockVersion (dict) --
The lock version for this attribute, used for optimistic locking to prevent concurrent modification conflicts.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
LastModifiedTime (datetime) --
The timestamp when this attribute was last modified.
LastModifiedRegion (string) --
The AWS region where this attribute was last modified, used for region replication.
Validation (dict) --
The validation rules applied to values of this attribute. Based on JSON Schema Draft 2020-12 with additional Connect-specific validations for data integrity.
MinLength (integer) --
The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.
MaxLength (integer) --
The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.
MinValues (integer) --
The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.
MaxValues (integer) --
The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.
IgnoreCase (boolean) --
Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.
Minimum (float) --
The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.
Maximum (float) --
The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMinimum (float) --
The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMaximum (float) --
The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.
MultipleOf (float) --
Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.
Enum (dict) --
Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.
Strict (boolean) --
Boolean that defaults to false. When true, only values specified in the enum list are allowed. When false, custom values beyond the enumerated list are permitted.
Values (list) --
A list of predefined values that are allowed for this attribute. These values are always permitted regardless of the Strict setting.
(string) --
Associate security profiles with an Entity in an Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.associate_security_profiles(
InstanceId='string',
SecurityProfiles=[
{
'Id': 'string'
},
],
EntityType='USER'|'AI_AGENT',
EntityArn='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.
list
[REQUIRED]
List of Security Profile Object.
(dict) --
Security profile items.
Id (string) --
Id of a security profile item.
string
[REQUIRED]
Only supported type is AI_AGENT.
string
[REQUIRED]
Arn of a Q in Connect AI Agent.
None
Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.
See also: AWS API Documentation
Request Syntax
client.update_data_table_attribute(
InstanceId='string',
DataTableId='string',
AttributeName='string',
Name='string',
ValueType='TEXT'|'NUMBER'|'BOOLEAN'|'TEXT_LIST'|'NUMBER_LIST',
Description='string',
Primary=True|False,
Validation={
'MinLength': 123,
'MaxLength': 123,
'MinValues': 123,
'MaxValues': 123,
'IgnoreCase': True|False,
'Minimum': 123.0,
'Maximum': 123.0,
'ExclusiveMinimum': 123.0,
'ExclusiveMaximum': 123.0,
'MultipleOf': 123.0,
'Enum': {
'Strict': True|False,
'Values': [
'string',
]
}
}
)
string
[REQUIRED]
The unique identifier for the Amazon Connect instance.
string
[REQUIRED]
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.
string
[REQUIRED]
The current name of the attribute to update. Used as an identifier since attribute names can be changed.
string
[REQUIRED]
The new name for the attribute. Must conform to Connect human readable string specification and be unique within the data table.
string
[REQUIRED]
The updated value type for the attribute. When changing value types, existing values are not deleted but may return default values if incompatible.
string
The updated description for the attribute.
boolean
Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing values to maintain uniqueness.
dict
The updated validation rules for the attribute. Changes do not affect existing values until they are modified.
MinLength (integer) --
The minimum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be less than or equal to MaxLength.
MaxLength (integer) --
The maximum number of characters a text value can contain. Applies to TEXT value type and values within a TEXT_LIST. Must be greater than or equal to MinLength.
MinValues (integer) --
The minimum number of values in a list. Must be an integer greater than or equal to 0 and less than or equal to MaxValues. Applies to all list types.
MaxValues (integer) --
The maximum number of values in a list. Must be an integer greater than or equal to 0 and greater than or equal to MinValues. Applies to all list types.
IgnoreCase (boolean) --
Boolean that defaults to false. Applies to text lists and text primary attributes. When true, enforces case-insensitive uniqueness for primary attributes and allows case-insensitive lookups.
Minimum (float) --
The smallest inclusive numeric value for NUMBER value type. Cannot be provided when ExclusiveMinimum is also provided. Must be less than or equal to Maximum and less than ExclusiveMaximum. Applies to NUMBER and values within NUMBER_LIST.
Maximum (float) --
The largest inclusive numeric value for NUMBER value type. Can be provided alongside ExclusiveMaximum where both operate independently. Must be greater than or equal to Minimum and greater than ExclusiveMinimum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMinimum (float) --
The smallest exclusive numeric value for NUMBER value type. Can be provided alongside Minimum where both operate independently. Must be less than ExclusiveMaximum and Maximum. Applies to NUMBER and values within NUMBER_LIST.
ExclusiveMaximum (float) --
The largest exclusive numeric value for NUMBER value type. Can be provided alongside Maximum where both operate independently. Must be greater than ExclusiveMinimum and Minimum. Applies to NUMBER and values within NUMBER_LIST.
MultipleOf (float) --
Specifies that numeric values must be multiples of this number. Must be greater than 0. The result of dividing a value by this multiple must result in an integer. Applies to NUMBER and values within NUMBER_LIST.
Enum (dict) --
Defines enumeration constraints for attribute values. Can specify a list of allowed values and whether custom values are permitted beyond the enumerated list.
Strict (boolean) --
Boolean that defaults to false. When true, only values specified in the enum list are allowed. When false, custom values beyond the enumerated list are permitted.
Values (list) --
A list of predefined values that are allowed for this attribute. These values are always permitted regardless of the Strict setting.
(string) --
dict
Response Syntax
{
'Name': 'string',
'LockVersion': {
'DataTable': 'string',
'Attribute': 'string',
'PrimaryValues': 'string',
'Value': 'string'
}
}
Response Structure
(dict) --
Name (string) --
The trimmed name and identifier for the updated attribute.
LockVersion (dict) --
The new lock version for the attribute after the update.
DataTable (string) --
The lock version for the data table itself. Used for optimistic locking and table versioning. Changes with each update to the table's metadata or structure.
Attribute (string) --
The lock version for a specific attribute. When the ValueLockLevel is ATTRIBUTE, this version changes when any value for the attribute changes. For other lock levels, it only changes when the attribute's properties are directly updated.
PrimaryValues (string) --
The lock version for a specific set of primary values (record). This includes the default record even if the table does not have any primary attributes. Used for record-level locking.
Value (string) --
The lock version for a specific value. Changes each time the individual value is modified. Used for the finest-grained locking control.
Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.
See also: AWS API Documentation
Request Syntax
client.create_workspace(
InstanceId='string',
Name='string',
Description='string',
Theme={
'Light': {
'Palette': {
'Header': {
'Background': 'string',
'Text': 'string',
'TextHover': 'string',
'InvertActionsColors': True|False
},
'Navigation': {
'Background': 'string',
'TextBackgroundHover': 'string',
'TextBackgroundActive': 'string',
'Text': 'string',
'TextHover': 'string',
'TextActive': 'string',
'InvertActionsColors': True|False
},
'Canvas': {
'ContainerBackground': 'string',
'PageBackground': 'string',
'ActiveBackground': 'string'
},
'Primary': {
'Default': 'string',
'Active': 'string',
'ContrastText': 'string'
}
},
'Images': {
'Logo': {
'Default': 'string',
'Favicon': 'string'
}
},
'Typography': {
'FontFamily': {
'Default': 'Arial'|'Courier New'|'Georgia'|'Times New Roman'|'Trebuchet'|'Verdana'
}
}
},
'Dark': {
'Palette': {
'Header': {
'Background': 'string',
'Text': 'string',
'TextHover': 'string',
'InvertActionsColors': True|False
},
'Navigation': {
'Background': 'string',
'TextBackgroundHover': 'string',
'TextBackgroundActive': 'string',
'Text': 'string',
'TextHover': 'string',
'TextActive': 'string',
'InvertActionsColors': True|False
},
'Canvas': {
'ContainerBackground': 'string',
'PageBackground': 'string',
'ActiveBackground': 'string'
},
'Primary': {
'Default': 'string',
'Active': 'string',
'ContrastText': 'string'
}
},
'Images': {
'Logo': {
'Default': 'string',
'Favicon': 'string'
}
},
'Typography': {
'FontFamily': {
'Default': 'Arial'|'Courier New'|'Georgia'|'Times New Roman'|'Trebuchet'|'Verdana'
}
}
}
},
Title='string',
Tags={
'string': '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 name of the workspace. Must be unique within the instance and can contain 1-127 characters.
string
The description of the workspace. Maximum length is 250 characters.
dict
The theme configuration for the workspace, including colors and styling.
Light (dict) --
The theme configuration for light mode.
Palette (dict) --
The color palette configuration for the workspace theme.
Header (dict) --
The color configuration for the header area.
Background (string) --
The background color of the header.
Text (string) --
The text color in the header.
TextHover (string) --
The text color when hovering over header elements.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the header.
Navigation (dict) --
The color configuration for the navigation area.
Background (string) --
The background color of the navigation area.
TextBackgroundHover (string) --
The background color when hovering over navigation text.
TextBackgroundActive (string) --
The background color for active navigation items.
Text (string) --
The text color in the navigation area.
TextHover (string) --
The text color when hovering over navigation items.
TextActive (string) --
The text color for active navigation items.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the navigation area.
Canvas (dict) --
The color configuration for the canvas area.
ContainerBackground (string) --
The background color for container elements.
PageBackground (string) --
The background color for page elements.
ActiveBackground (string) --
The background color for active elements.
Primary (dict) --
The primary color configuration used throughout the workspace.
Default (string) --
The default primary color used throughout the workspace.
Active (string) --
The primary color used for active states.
ContrastText (string) --
The text color that contrasts with the primary color for readability.
Images (dict) --
The image assets used in the workspace theme.
Logo (dict) --
The logo images used in the workspace.
Default (string) --
The default logo image displayed in the workspace.
Favicon (string) --
The favicon image displayed in the browser tab.
Typography (dict) --
The typography configuration for the workspace theme.
FontFamily (dict) --
The font family configuration for text in the workspace.
Default (string) --
The default font family to use in the workspace theme.
Dark (dict) --
The theme configuration for dark mode.
Palette (dict) --
The color palette configuration for the workspace theme.
Header (dict) --
The color configuration for the header area.
Background (string) --
The background color of the header.
Text (string) --
The text color in the header.
TextHover (string) --
The text color when hovering over header elements.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the header.
Navigation (dict) --
The color configuration for the navigation area.
Background (string) --
The background color of the navigation area.
TextBackgroundHover (string) --
The background color when hovering over navigation text.
TextBackgroundActive (string) --
The background color for active navigation items.
Text (string) --
The text color in the navigation area.
TextHover (string) --
The text color when hovering over navigation items.
TextActive (string) --
The text color for active navigation items.
InvertActionsColors (boolean) --
Whether to invert the colors of action buttons in the navigation area.
Canvas (dict) --
The color configuration for the canvas area.
ContainerBackground (string) --
The background color for container elements.
PageBackground (string) --
The background color for page elements.
ActiveBackground (string) --
The background color for active elements.
Primary (dict) --
The primary color configuration used throughout the workspace.
Default (string) --
The default primary color used throughout the workspace.
Active (string) --
The primary color used for active states.
ContrastText (string) --
The text color that contrasts with the primary color for readability.
Images (dict) --
The image assets used in the workspace theme.
Logo (dict) --
The logo images used in the workspace.
Default (string) --
The default logo image displayed in the workspace.
Favicon (string) --
The favicon image displayed in the browser tab.
Typography (dict) --
The typography configuration for the workspace theme.
FontFamily (dict) --
The font family configuration for text in the workspace.
Default (string) --
The default font family to use in the workspace theme.
string
The title displayed for the workspace.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Response Syntax
{
'WorkspaceId': 'string',
'WorkspaceArn': 'string'
}
Response Structure
(dict) --
WorkspaceId (string) --
The identifier of the workspace.
WorkspaceArn (string) --
The Amazon Resource Name (ARN) of the workspace.
{'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}
Creates a new VOICE, EMAIL, or TASK contact.
After a contact is created, you can move it to the desired state by using the InitiateAs parameter. While you can use API to create task contacts that are in the COMPLETED state, you must contact Amazon Web Services Support before using it for bulk import use cases. Bulk import causes your requests to be throttled or fail if your CreateContact limits aren't high enough.
See also: AWS API Documentation
Request Syntax
client.create_contact(
InstanceId='string',
ClientToken='string',
RelatedContactId='string',
Attributes={
'string': 'string'
},
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
},
Channel='VOICE'|'CHAT'|'TASK'|'EMAIL',
InitiationMethod='INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW',
ExpiryDurationInMinutes=123,
UserInfo={
'UserId': 'string'
},
InitiateAs='CONNECTED_TO_USER'|'COMPLETED',
Name='string',
Description='string',
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
PreviousContactId='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
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
string
The identifier of the contact in this instance of Amazon Connect.
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.
(string) --
(string) --
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
string
[REQUIRED]
The channel for the contact.
string
[REQUIRED]
Indicates how the contact was initiated.
integer
Number of minutes the contact will be active for before expiring
dict
User details for the contact
UserId (string) --
The user identifier for the contact.
string
Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.
string
The name of a the contact.
string
A description of the contact.
dict
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to set Segment Contact Expiry as a duration in minutes.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
string
The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice systems in the Amazon Connect Administrator Guide.
dict
Response Syntax
{
'ContactId': 'string',
'ContactArn': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of the contact in this instance of Amazon Connect.
ContactArn (string) --
The Amazon Resource Name (ARN) of the created contact.
{'AsDraft': 'boolean',
'Items': {'Question': {'Enablement': {'Condition': {'Operands': {'Expression': {'Comparator': {'ALL_IN',
'EXACT'}}}}},
'QuestionType': {'MULTISELECT', 'DATETIME'},
'QuestionTypeProperties': {'MultiSelect': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'},
'DefaultOptionRefIds': ['string'],
'Options': [{'RuleCategory': {'Category': 'string',
'Condition': 'PRESENT '
'| '
'NOT_PRESENT',
'OptionRefIds': ['string']}}]},
'DisplayAs': 'DROPDOWN '
'| '
'CHECKBOX',
'Options': [{'RefId': 'string',
'Text': 'string'}]},
'Numeric': {'Automation': {'PropertyValue': {'Label': {'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT',
'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'}}}}}}},
'LanguageConfiguration': {'FormLanguage': 'de-DE | en-US | es-ES | fr-FR | '
'it-IT | pt-BR'},
'TargetConfiguration': {'ContactInteractionType': 'AGENT | AUTOMATED'}}
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.
See also: AWS API Documentation
Request Syntax
client.create_evaluation_form(
InstanceId='string',
Title='string',
Description='string',
Items=[
{
'Section': {
'Title': 'string',
'RefId': 'string',
'Instructions': 'string',
'Items': {'... recursive ...'},
'Weight': 123.0
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'Automation': {
'PropertyValue': {
'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'
},
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'SingleSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'DisplayAs': 'DROPDOWN'|'RADIO',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefId': 'string'
}
},
],
'DefaultOptionRefId': 'string',
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'Text': {
'Automation': {
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'MultiSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string'
},
],
'DisplayAs': 'DROPDOWN'|'CHECKBOX',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefIds': [
'string',
]
}
},
],
'DefaultOptionRefIds': [
'string',
],
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0
}
},
],
ScoringStrategy={
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
'Status': 'ENABLED'|'DISABLED'
},
AutoEvaluationConfiguration={
'Enabled': True|False
},
ClientToken='string',
AsDraft=True|False,
Tags={
'string': 'string'
},
TargetConfiguration={
'ContactInteractionType': 'AGENT'|'AUTOMATED'
},
LanguageConfiguration={
'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'
}
)
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 title of the evaluation form.
string
The description of the evaluation form.
list
[REQUIRED]
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
(dict) --
Information about an item from an evaluation form. The item must be either a section or a question.
Section (dict) --
The information of the section.
Title (string) -- [REQUIRED]
The title of the section.
RefId (string) -- [REQUIRED]
The identifier of the section. An identifier must be unique within the evaluation form.
Instructions (string) --
The instructions of the section.
Items (list) --
The items of the section.
Weight (float) --
The scoring weight of the section.
Question (dict) --
The information of the question.
Title (string) -- [REQUIRED]
The title of the question.
Instructions (string) --
The instructions of the section.
RefId (string) -- [REQUIRED]
The identifier of the question. An identifier must be unique within the evaluation form.
NotApplicableEnabled (boolean) --
The flag to enable not applicable answers to the question.
QuestionType (string) -- [REQUIRED]
The type of the question.
QuestionTypeProperties (dict) --
The properties of the type of question. Text questions do not have to define question type properties.
Numeric (dict) --
The properties of the numeric question.
MinValue (integer) -- [REQUIRED]
The minimum answer value.
MaxValue (integer) -- [REQUIRED]
The maximum answer value.
Options (list) --
The scoring options of the numeric question.
(dict) --
Information about the option range used for scoring in numeric questions.
MinValue (integer) -- [REQUIRED]
The minimum answer value of the range option.
MaxValue (integer) -- [REQUIRED]
The maximum answer value of the range option.
Score (integer) --
The score assigned to answer values within the range option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
A configuration for automatic fail.
TargetSection (string) --
The referenceId of the target section for auto failure.
Automation (dict) --
The automation properties of the numeric question.
PropertyValue (dict) --
The property value of the automation.
Label (string) -- [REQUIRED]
The property label of the automation.
AnswerSource (dict) --
A source of automation answer for numeric question.
SourceType (string) -- [REQUIRED]
The automation answer source type.
SingleSelect (dict) --
The properties of the numeric question.
Options (list) -- [REQUIRED]
The answer options of the single select question.
(dict) --
Information about the automation configuration in single select questions.
RefId (string) -- [REQUIRED]
The identifier of the answer option. An identifier must be unique within the question.
Text (string) -- [REQUIRED]
The title of the answer option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Whether automatic fail is configured on a single select question.
TargetSection (string) --
The referenceId of the target section for auto failure.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) --
The automation options of the single select question.
(dict) --
Information about the automation option of a single select question.
RuleCategory (dict) --
The automation option based on a rule category for the single select question.
Category (string) -- [REQUIRED]
The category name, as defined in Rules.
Condition (string) -- [REQUIRED]
The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.
OptionRefId (string) -- [REQUIRED]
The identifier of the answer option.
DefaultOptionRefId (string) --
The identifier of the default answer option, when none of the automation options match the criteria.
AnswerSource (dict) --
Automation answer source.
SourceType (string) -- [REQUIRED]
The automation answer source type.
Text (dict) --
The properties of the text question.
Automation (dict) --
The automation properties of the text question.
AnswerSource (dict) --
Automation answer source.
SourceType (string) -- [REQUIRED]
The automation answer source type.
MultiSelect (dict) --
Properties for multi-select question types.
Options (list) -- [REQUIRED]
Options available for this multi-select question.
(dict) --
An option for a multi-select question in an evaluation form.
RefId (string) -- [REQUIRED]
Reference identifier for this option.
Text (string) -- [REQUIRED]
Display text for this option.
DisplayAs (string) --
Display format for the multi-select question.
Automation (dict) --
Automation configuration for this multi-select question.
Options (list) --
Automation options for the multi-select question.
(dict) --
An automation option for a multi-select question.
RuleCategory (dict) --
Rule category configuration for this automation option.
Category (string) -- [REQUIRED]
The category name for this automation rule.
Condition (string) -- [REQUIRED]
The condition for this automation rule.
OptionRefIds (list) -- [REQUIRED]
Reference IDs of options for this automation rule.
(string) --
DefaultOptionRefIds (list) --
Reference IDs of default options.
(string) --
AnswerSource (dict) --
A question automation answer.
SourceType (string) -- [REQUIRED]
The automation answer source type.
Enablement (dict) --
A question conditional enablement.
Condition (dict) -- [REQUIRED]
A condition for item enablement configuration.
Operands (list) -- [REQUIRED]
Operands of the enablement condition.
(dict) --
An operand of the enablement condition.
Expression (dict) --
An expression of the enablement condition.
Source (dict) -- [REQUIRED]
A source item of enablement expression.
Type (string) -- [REQUIRED]
A type of source item.
RefId (string) --
A referenceId of the source item.
Values (list) -- [REQUIRED]
A list of values from source item.
(dict) --
An enablement expression source value.
Type (string) -- [REQUIRED]
A type of source item value.
RefId (string) --
A referenceId of the source value.
Comparator (string) -- [REQUIRED]
A comparator to be used against list of values.
Condition (dict) --
A condition for item enablement.
Operator (string) --
The operator to be used to be applied to operands if more than one provided.
Action (string) -- [REQUIRED]
An enablement action that if condition is satisfied.
DefaultAction (string) --
An enablement action that if condition is not satisfied.
Weight (float) --
The scoring weight of the section.
dict
A scoring strategy of the evaluation form.
Mode (string) -- [REQUIRED]
The scoring mode of the evaluation form.
Status (string) -- [REQUIRED]
The scoring status of the evaluation form.
dict
Configuration information about automated evaluations.
Enabled (boolean) -- [REQUIRED]
When automated evaluation is enabled.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
boolean
A boolean flag indicating whether to create evaluation form in draft state.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Configuration that specifies the target for the evaluation form.
ContactInteractionType (string) -- [REQUIRED]
The contact interaction type for this evaluation form.
dict
Configuration for language settings of the evaluation form.
FormLanguage (string) --
The language for the evaluation form.
dict
Response Syntax
{
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string'
}
Response Structure
(dict) --
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
{'IntegrationType': {'MESSAGE_PROCESSOR'}}
Creates an Amazon Web Services resource association with an Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.create_integration_association(
InstanceId='string',
IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR'|'COGNITO_USER_POOL'|'MESSAGE_PROCESSOR',
IntegrationArn='string',
SourceApplicationUrl='string',
SourceApplicationName='string',
SourceType='SALESFORCE'|'ZENDESK'|'CASES',
Tags={
'string': '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 type of information to be ingested.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the integration.
string
The URL for the external application. This field is only required for the EVENT integration type.
string
The name of the external application. This field is only required for the EVENT integration type.
string
The type of the data source. This field is only required for the EVENT integration type.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Response Syntax
{
'IntegrationAssociationId': 'string',
'IntegrationAssociationArn': 'string'
}
Response Structure
(dict) --
IntegrationAssociationId (string) --
The identifier for the integration association.
IntegrationAssociationArn (string) --
The Amazon Resource Name (ARN) for the association.
{'QuickConnectConfig': {'FlowConfig': {'ContactFlowId': 'string'},
'QuickConnectType': {'FLOW'}}}
Creates a quick connect for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.create_quick_connect(
InstanceId='string',
Name='string',
Description='string',
QuickConnectConfig={
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'|'FLOW',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
},
'FlowConfig': {
'ContactFlowId': 'string'
}
},
Tags={
'string': '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 name of the quick connect.
string
The description of the quick connect.
dict
[REQUIRED]
Configuration settings for the quick connect.
QuickConnectType (string) -- [REQUIRED]
The type of quick connect. In the Amazon Connect admin website, 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) -- [REQUIRED]
The identifier of the user.
ContactFlowId (string) -- [REQUIRED]
The identifier of the flow.
QueueConfig (dict) --
The queue configuration. This is required only if QuickConnectType is QUEUE.
QueueId (string) -- [REQUIRED]
The identifier for the queue.
ContactFlowId (string) -- [REQUIRED]
The identifier of the flow.
PhoneConfig (dict) --
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
PhoneNumber (string) -- [REQUIRED]
The phone number in E.164 format.
FlowConfig (dict) --
Flow configuration for quick connect setup.
ContactFlowId (string) -- [REQUIRED]
The contact flow ID for the quick connect configuration.
dict
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
Response Syntax
{
'QuickConnectARN': 'string',
'QuickConnectId': 'string'
}
Response Structure
(dict) --
QuickConnectARN (string) --
The Amazon Resource Name (ARN) for the quick connect.
QuickConnectId (string) --
The identifier for the quick connect.
{'Actions': {'TaskAction': {'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}}}
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
See also: AWS API Documentation
Request Syntax
client.create_rule(
InstanceId='string',
Name='string',
TriggerEventSource={
'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach',
'IntegrationAssociationId': 'string'
},
Function='string',
Actions=[
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {}
,
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
}
},
'CreateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
}
},
],
'TemplateId': 'string'
},
'UpdateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
}
},
]
},
'AssignSlaAction': {
'SlaAssignmentType': 'CASES',
'CaseSlaConfiguration': {
'Name': 'string',
'Type': 'CaseField',
'FieldId': 'string',
'TargetFieldValues': [
{
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
},
],
'TargetSlaMinutes': 123
}
},
'EndAssociatedTasksAction': {}
,
'SubmitAutoEvaluationAction': {
'EvaluationFormId': 'string'
}
},
],
PublishStatus='DRAFT'|'PUBLISHED',
ClientToken='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 name for the rule.
dict
[REQUIRED]
The event source to trigger the rule.
EventSourceName (string) -- [REQUIRED]
The name of the event source.
IntegrationAssociationId (string) --
The identifier for the integration association.
string
[REQUIRED]
The conditions of the rule.
list
[REQUIRED]
A list of actions to be run when the rule is triggered.
(dict) --
Information about the action to be performed when a rule is triggered.
ActionType (string) -- [REQUIRED]
The type of action that creates a rule.
TaskAction (dict) --
Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
Name (string) -- [REQUIRED]
The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
ContactFlowId (string) -- [REQUIRED]
The identifier of the flow.
References (dict) --
Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
EventBridgeAction (dict) --
Information about the EventBridge action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Name (string) -- [REQUIRED]
The name.
AssignContactCategoryAction (dict) --
Information about the contact category action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationAction (dict) --
Information about the send notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
DeliveryMethod (string) -- [REQUIRED]
Notification delivery method.
Subject (string) --
The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Content (string) -- [REQUIRED]
Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
ContentType (string) -- [REQUIRED]
Content type format.
Recipient (dict) -- [REQUIRED]
Notification recipient.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
Exclusion (dict) --
Recipients to exclude from notification.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
CreateCaseAction (dict) --
Information about the create case action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.
Fields (list) -- [REQUIRED]
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) -- [REQUIRED]
Unique identifier of a field.
Value (dict) -- [REQUIRED]
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TemplateId (string) -- [REQUIRED]
A unique identifier of a template.
UpdateCaseAction (dict) --
Information about the update case action.
Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.
Fields (list) -- [REQUIRED]
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) -- [REQUIRED]
Unique identifier of a field.
Value (dict) -- [REQUIRED]
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
AssignSlaAction (dict) --
Information about the assign SLA action.
SlaAssignmentType (string) -- [REQUIRED]
Type of SLA assignment.
CaseSlaConfiguration (dict) --
The SLA configuration for Case SLA Assignment.
Name (string) -- [REQUIRED]
Name of an SLA.
Type (string) -- [REQUIRED]
Type of SLA for Case SlaAssignmentType.
FieldId (string) --
Unique identifier of a Case field.
TargetFieldValues (list) --
Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.
(dict) --
Object to store union of Field values.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TargetSlaMinutes (integer) -- [REQUIRED]
Target duration in minutes within which an SLA should be completed.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
SubmitAutoEvaluationAction (dict) --
Information about the submit automated evaluation action.
EvaluationFormId (string) -- [REQUIRED]
The identifier of the auto-evaluation enabled form.
string
[REQUIRED]
The publish status of the rule.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RuleArn': 'string',
'RuleId': 'string'
}
Response Structure
(dict) --
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
RuleId (string) --
A unique identifier for the rule.
{'AllowedFlowModules': [{'FlowModuleId': 'string', 'Type': 'MCP'}],
'Applications': {'Type': 'MCP | THIRD_PARTY_APPLICATION'},
'GranularAccessControlConfiguration': {'DataTableAccessControlConfiguration': {'PrimaryAttributeAccessControlConfiguration': {'PrimaryAttributeValues': [{'AccessType': 'ALLOW',
'AttributeName': 'string',
'Values': ['string']}]}}}}
Creates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
See also: AWS API Documentation
Request Syntax
client.create_security_profile(
SecurityProfileName='string',
Description='string',
Permissions=[
'string',
],
InstanceId='string',
Tags={
'string': 'string'
},
AllowedAccessControlTags={
'string': 'string'
},
TagRestrictedResources=[
'string',
],
Applications=[
{
'Namespace': 'string',
'ApplicationPermissions': [
'string',
],
'Type': 'MCP'|'THIRD_PARTY_APPLICATION'
},
],
HierarchyRestrictedResources=[
'string',
],
AllowedAccessControlHierarchyGroupId='string',
AllowedFlowModules=[
{
'Type': 'MCP',
'FlowModuleId': 'string'
},
],
GranularAccessControlConfiguration={
'DataTableAccessControlConfiguration': {
'PrimaryAttributeAccessControlConfiguration': {
'PrimaryAttributeValues': [
{
'AccessType': 'ALLOW',
'AttributeName': 'string',
'Values': [
'string',
]
},
]
}
}
}
)
string
[REQUIRED]
The name of the security profile.
string
The description of the security profile.
list
Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.
(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
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
dict
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
(string) --
(string) --
list
The list of resources that a security profile applies tag restrictions to in Amazon Connect. For a list of Amazon Connect resources that you can tag, see Add tags to resources in Amazon Connect in the Amazon Connect Administrator Guide.
(string) --
list
A list of third-party applications or MCP Servers that the security profile will give access to.
(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. For third-party applications, only the ACCESS permission is supported. For MCP Servers, the permissions are tool Identifiers accepted by MCP Server.
(string) --
Type (string) --
Type of Application.
list
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.
(string) --
string
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
list
A list of Flow Modules an AI Agent can invoke as a tool.
(dict) --
A list of Flow Modules an AI Agent can invoke as a tool
Type (string) --
Only Type we support is MCP.
FlowModuleId (string) --
If of Flow Modules invocable as tool
dict
The granular access control configuration for the security profile, including data table permissions.
DataTableAccessControlConfiguration (dict) --
The access control configuration for data tables.
PrimaryAttributeAccessControlConfiguration (dict) --
The configuration's primary attribute access control configuration.
PrimaryAttributeValues (list) --
The item's primary attribute values.
(dict) --
A primary attribute value.
AccessType (string) --
The value's access type.
AttributeName (string) --
The value's attribute name.
Values (list) --
The value's values.
(string) --
dict
Response Syntax
{
'SecurityProfileId': 'string',
'SecurityProfileArn': 'string'
}
Response Structure
(dict) --
SecurityProfileId (string) --
The identifier for the security profle.
SecurityProfileArn (string) --
The Amazon Resource Name (ARN) for the security profile.
{'Contact': {'NextContacts': [{'NextContactMetadata': {'QuickConnectContactData': {'ContactId': 'string',
'InitiationTimestamp': 'timestamp',
'QuickConnectId': 'string',
'QuickConnectName': 'string',
'QuickConnectType': 'USER '
'| '
'QUEUE '
'| '
'PHONE_NUMBER '
'| '
'FLOW'}},
'Type': 'QUICK_CONNECT'}],
'Recordings': {'UnprocessedTranscriptLocation': 'string'},
'WisdomInfo': {'AiAgents': [{'AiAgentEscalated': 'boolean',
'AiAgentVersionId': 'string',
'AiUseCase': 'AgentAssistance | '
'SelfService'}]}}}
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
Use cases
Following are common uses cases for this API:
Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions.
Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the ContactTraceRecord to detect this event and then re-queue the chat for followup.
Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the contact event stream.
Important things to know
SystemEndpoint is not populated for contacts with initiation method of MONITOR, QUEUE_TRANSFER, or CALLBACK
Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.
Endpoints: See Amazon Connect endpoints and quotas.
See also: AWS API Documentation
Request Syntax
client.describe_contact(
InstanceId='string',
ContactId='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 contact.
dict
Response Syntax
{
'Contact': {
'Arn': 'string',
'Id': 'string',
'InitialContactId': 'string',
'PreviousContactId': 'string',
'ContactAssociationId': 'string',
'InitiationMethod': 'INBOUND'|'OUTBOUND'|'TRANSFER'|'QUEUE_TRANSFER'|'CALLBACK'|'API'|'DISCONNECT'|'MONITOR'|'EXTERNAL_OUTBOUND'|'WEBRTC_API'|'AGENT_REPLY'|'FLOW',
'Name': 'string',
'Description': 'string',
'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
'QueueInfo': {
'Id': 'string',
'EnqueueTimestamp': datetime(2015, 1, 1)
},
'AgentInfo': {
'Id': 'string',
'AcceptedByAgentTimestamp': datetime(2015, 1, 1),
'PreviewEndTimestamp': datetime(2015, 1, 1),
'ConnectedToAgentTimestamp': datetime(2015, 1, 1),
'AgentPauseDurationInSeconds': 123,
'HierarchyGroups': {
'Level1': {
'Arn': 'string'
},
'Level2': {
'Arn': 'string'
},
'Level3': {
'Arn': 'string'
},
'Level4': {
'Arn': 'string'
},
'Level5': {
'Arn': 'string'
}
},
'DeviceInfo': {
'PlatformName': 'string',
'PlatformVersion': 'string',
'OperatingSystem': 'string'
},
'Capabilities': {
'Video': 'SEND',
'ScreenShare': 'SEND'
},
'AfterContactWorkDuration': 123,
'AfterContactWorkStartTimestamp': datetime(2015, 1, 1),
'AfterContactWorkEndTimestamp': datetime(2015, 1, 1),
'AgentInitiatedHoldDuration': 123,
'StateTransitions': [
{
'State': 'INITIAL'|'CONNECTED'|'DISCONNECTED'|'MISSED',
'StateStartTimestamp': datetime(2015, 1, 1),
'StateEndTimestamp': datetime(2015, 1, 1)
},
]
},
'InitiationTimestamp': datetime(2015, 1, 1),
'DisconnectTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'LastPausedTimestamp': datetime(2015, 1, 1),
'LastResumedTimestamp': datetime(2015, 1, 1),
'RingStartTimestamp': datetime(2015, 1, 1),
'TotalPauseCount': 123,
'TotalPauseDurationInSeconds': 123,
'ScheduledTimestamp': datetime(2015, 1, 1),
'RelatedContactId': 'string',
'WisdomInfo': {
'SessionArn': 'string',
'AiAgents': [
{
'AiUseCase': 'AgentAssistance'|'SelfService',
'AiAgentVersionId': 'string',
'AiAgentEscalated': True|False
},
]
},
'CustomerId': 'string',
'CustomerEndpoint': {
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string',
'DisplayName': 'string'
},
'SystemEndpoint': {
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string',
'DisplayName': 'string'
},
'QueueTimeAdjustmentSeconds': 123,
'QueuePriority': 123,
'Tags': {
'string': 'string'
},
'ConnectedToSystemTimestamp': datetime(2015, 1, 1),
'RoutingCriteria': {
'Steps': [
{
'Expiry': {
'DurationInSeconds': 123,
'ExpiryTimestamp': datetime(2015, 1, 1)
},
'Expression': {
'AttributeCondition': {
'Name': 'string',
'Value': 'string',
'ProficiencyLevel': ...,
'Range': {
'MinProficiencyLevel': ...,
'MaxProficiencyLevel': ...
},
'MatchCriteria': {
'AgentsCriteria': {
'AgentIds': [
'string',
]
}
},
'ComparisonOperator': 'string'
},
'AndExpression': [
{'... recursive ...'},
],
'OrExpression': [
{'... recursive ...'},
],
'NotAttributeCondition': {
'Name': 'string',
'Value': 'string',
'ProficiencyLevel': ...,
'Range': {
'MinProficiencyLevel': ...,
'MaxProficiencyLevel': ...
},
'MatchCriteria': {
'AgentsCriteria': {
'AgentIds': [
'string',
]
}
},
'ComparisonOperator': 'string'
}
},
'Status': 'ACTIVE'|'INACTIVE'|'JOINED'|'EXPIRED'
},
],
'ActivationTimestamp': datetime(2015, 1, 1),
'Index': 123
},
'Customer': {
'DeviceInfo': {
'PlatformName': 'string',
'PlatformVersion': 'string',
'OperatingSystem': 'string'
},
'Capabilities': {
'Video': 'SEND',
'ScreenShare': 'SEND'
}
},
'Campaign': {
'CampaignId': 'string'
},
'AnsweringMachineDetectionStatus': 'ANSWERED'|'UNDETECTED'|'ERROR'|'HUMAN_ANSWERED'|'SIT_TONE_DETECTED'|'SIT_TONE_BUSY'|'SIT_TONE_INVALID_NUMBER'|'FAX_MACHINE_DETECTED'|'VOICEMAIL_BEEP'|'VOICEMAIL_NO_BEEP'|'AMD_UNRESOLVED'|'AMD_UNANSWERED'|'AMD_ERROR'|'AMD_NOT_APPLICABLE',
'CustomerVoiceActivity': {
'GreetingStartTimestamp': datetime(2015, 1, 1),
'GreetingEndTimestamp': datetime(2015, 1, 1)
},
'QualityMetrics': {
'Agent': {
'Audio': {
'QualityScore': ...,
'PotentialQualityIssues': [
'string',
]
}
},
'Customer': {
'Audio': {
'QualityScore': ...,
'PotentialQualityIssues': [
'string',
]
}
}
},
'ChatMetrics': {
'ChatContactMetrics': {
'MultiParty': True|False,
'TotalMessages': 123,
'TotalBotMessages': 123,
'TotalBotMessageLengthInChars': 123,
'ConversationCloseTimeInMillis': 123,
'ConversationTurnCount': 123,
'AgentFirstResponseTimestamp': datetime(2015, 1, 1),
'AgentFirstResponseTimeInMillis': 123
},
'AgentMetrics': {
'ParticipantId': 'string',
'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
'ConversationAbandon': True|False,
'MessagesSent': 123,
'NumResponses': 123,
'MessageLengthInChars': 123,
'TotalResponseTimeInMillis': 123,
'MaxResponseTimeInMillis': 123,
'LastMessageTimestamp': datetime(2015, 1, 1)
},
'CustomerMetrics': {
'ParticipantId': 'string',
'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
'ConversationAbandon': True|False,
'MessagesSent': 123,
'NumResponses': 123,
'MessageLengthInChars': 123,
'TotalResponseTimeInMillis': 123,
'MaxResponseTimeInMillis': 123,
'LastMessageTimestamp': datetime(2015, 1, 1)
}
},
'DisconnectDetails': {
'PotentialDisconnectIssue': 'string'
},
'AdditionalEmailRecipients': {
'ToList': [
{
'Address': 'string',
'DisplayName': 'string'
},
],
'CcList': [
{
'Address': 'string',
'DisplayName': 'string'
},
]
},
'SegmentAttributes': {
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
'Recordings': [
{
'StorageType': 'S3'|'KINESIS_VIDEO_STREAM'|'KINESIS_STREAM'|'KINESIS_FIREHOSE',
'Location': 'string',
'MediaStreamType': 'AUDIO'|'VIDEO',
'ParticipantType': 'ALL'|'MANAGER'|'AGENT'|'CUSTOMER'|'THIRDPARTY',
'FragmentStartNumber': 'string',
'FragmentStopNumber': 'string',
'StartTimestamp': datetime(2015, 1, 1),
'StopTimestamp': datetime(2015, 1, 1),
'Status': 'AVAILABLE'|'DELETED',
'DeletionReason': 'string',
'UnprocessedTranscriptLocation': 'string'
},
],
'DisconnectReason': 'string',
'ContactEvaluations': {
'string': {
'FormId': 'string',
'EvaluationArn': 'string',
'Status': 'COMPLETE'|'IN_PROGRESS'|'DELETED',
'StartTimestamp': datetime(2015, 1, 1),
'EndTimestamp': datetime(2015, 1, 1),
'DeleteTimestamp': datetime(2015, 1, 1),
'ExportLocation': 'string'
}
},
'TaskTemplateInfo': {
'Arn': 'string',
'Name': 'string'
},
'ContactDetails': {
'Name': 'string',
'Description': 'string'
},
'OutboundStrategy': {
'Type': 'AGENT_FIRST',
'Config': {
'AgentFirst': {
'Preview': {
'PostAcceptTimeoutConfig': {
'DurationInSeconds': 123
},
'AllowedUserActions': [
'CALL'|'DISCARD',
]
}
}
}
},
'Attributes': {
'string': 'string'
},
'NextContacts': [
{
'Type': 'QUICK_CONNECT',
'NextContactMetadata': {
'QuickConnectContactData': {
'ContactId': 'string',
'InitiationTimestamp': datetime(2015, 1, 1),
'QuickConnectId': 'string',
'QuickConnectName': 'string',
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'|'FLOW'
}
}
},
]
}
}
Response Structure
(dict) --
Contact (dict) --
Information about the contact.
Arn (string) --
The Amazon Resource Name (ARN) for the contact.
Id (string) --
The identifier for the contact.
InitialContactId (string) --
If this contact is related to other contacts, this is the ID of the initial contact.
PreviousContactId (string) --
If this contact is not the first contact, this is the ID of the previous contact.
ContactAssociationId (string) --
This is the root contactId which is used as a unique identifier for all subsequent contacts in a contact tree.
InitiationMethod (string) --
Indicates how the contact was initiated.
Name (string) --
The name of the contact.
Description (string) --
The description of the contact.
Channel (string) --
How the contact reached your contact center.
QueueInfo (dict) --
If this contact was queued, this contains information about the queue.
Id (string) --
The unique identifier for the queue.
EnqueueTimestamp (datetime) --
The timestamp when the contact was added to the queue.
AgentInfo (dict) --
Information about the agent who accepted the contact.
Id (string) --
The identifier of the agent who accepted the contact.
AcceptedByAgentTimestamp (datetime) --
The timestamp when the contact was accepted by the agent.
PreviewEndTimestamp (datetime) --
The timestamp when the agent finished previewing the contact.
ConnectedToAgentTimestamp (datetime) --
The timestamp when the contact was connected to the agent.
AgentPauseDurationInSeconds (integer) --
Agent pause duration for a contact in seconds.
HierarchyGroups (dict) --
The agent hierarchy groups for the agent.
Level1 (dict) --
The group at level one of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
Level2 (dict) --
The group at level two of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
Level3 (dict) --
The group at level three of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
Level4 (dict) --
The group at level four of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
Level5 (dict) --
The group at level five of the agent hierarchy.
Arn (string) --
The Amazon Resource Name (ARN) of the group.
DeviceInfo (dict) --
Information regarding Agent’s device.
PlatformName (string) --
Name of the platform that the participant used for the call.
PlatformVersion (string) --
Version of the platform that the participant used for the call.
OperatingSystem (string) --
Operating system that the participant used for the call.
Capabilities (dict) --
The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.
Video (string) --
The configuration having the video and screen sharing capabilities for participants over the call.
ScreenShare (string) --
The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
AfterContactWorkDuration (integer) --
The difference in time, in whole seconds, between AfterContactWorkStartTimestamp and AfterContactWorkEndTimestamp.
AfterContactWorkStartTimestamp (datetime) --
The date and time when the agent started doing After Contact Work for the contact, in UTC time.
AfterContactWorkEndTimestamp (datetime) --
The date and time when the agent ended After Contact Work for the contact, in UTC time. In cases when agent finishes doing AfterContactWork for chat contacts and switches their activity status to offline or equivalent without clearing the contact in CCP, discrepancies may be noticed for AfterContactWorkEndTimestamp.
AgentInitiatedHoldDuration (integer) --
The total hold duration in seconds initiated by the agent.
StateTransitions (list) --
List of StateTransition for a supervisor.
(dict) --
Information about the state transition of a supervisor.
State (string) --
The state of the transition.
StateStartTimestamp (datetime) --
The date and time when the state started in UTC time.
StateEndTimestamp (datetime) --
The date and time when the state ended in UTC time.
InitiationTimestamp (datetime) --
The date and time this contact was initiated, in UTC time. For INBOUND, this is when the contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was initiated. For API, this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started dialing the external participant. For MONITOR, this is when the supervisor started listening to a contact.
DisconnectTimestamp (datetime) --
The date and time that the customer endpoint disconnected from the current contact, in UTC time. In transfer scenarios, the DisconnectTimestamp of the previous contact indicates the date and time when that contact ended.
LastUpdateTimestamp (datetime) --
The timestamp when contact was last updated.
LastPausedTimestamp (datetime) --
The timestamp when the contact was last paused.
LastResumedTimestamp (datetime) --
The timestamp when the contact was last resumed.
RingStartTimestamp (datetime) --
The timestamp when ringing started for a campaign call.
TotalPauseCount (integer) --
Total pause count for a contact.
TotalPauseDurationInSeconds (integer) --
Total pause duration for a contact in seconds.
ScheduledTimestamp (datetime) --
The timestamp, in Unix epoch time format, at which to start running the inbound flow.
RelatedContactId (string) --
The contactId that is related to this contact.
WisdomInfo (dict) --
Information about Amazon Connect Wisdom.
SessionArn (string) --
The Amazon Resource Name (ARN) of the Wisdom session.
AiAgents (list) --
The array of AI agents involved in the contact.
(dict) --
Information of the AI agent involved in the contact.
AiUseCase (string) --
The use case or scenario for which the AI agent is involved in the contact
AiAgentVersionId (string) --
The unique identifier that specifies both the AI agent ID and its version number that was involved in the contact
AiAgentEscalated (boolean) --
A boolean flag indicating whether the contact initially handled by this AI agent was escalated to a human agent.
CustomerId (string) --
The customer's identification number. For example, the CustomerId may be a customer number from your CRM. You can create a Lambda function to pull the unique customer ID of the caller from your CRM system. If you enable Amazon Connect Voice ID capability, this attribute is populated with the CustomerSpeakerId of the caller.
CustomerEndpoint (dict) --
The customer or external third party participant endpoint.
Type (string) --
Type of endpoint.
Address (string) --
Address of the endpoint.
DisplayName (string) --
Display name of the endpoint.
SystemEndpoint (dict) --
The system endpoint. For INBOUND, this is the phone number or email address that the customer dialed. For OUTBOUND and EXTERNAL_OUTBOUND, this is the outbound caller ID number assigned to the outbound queue that is used to dial the customer. For callback, this shows up as Softphone for calls handled by agents with softphone.
Type (string) --
Type of endpoint.
Address (string) --
Address of the endpoint.
DisplayName (string) --
Display name of the endpoint.
QueueTimeAdjustmentSeconds (integer) --
An integer that represents the queue time adjust to be applied to the contact, in seconds (longer / larger queue time are routed preferentially). Cannot be specified if the QueuePriority is specified. Must be statically defined and a valid integer value.
QueuePriority (integer) --
An integer that represents the queue priority to be applied to the contact (lower priorities are routed preferentially). Cannot be specified if the QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be larger than zero, and a valid integer value. Default Value is 5.
Tags (dict) --
Tags associated with the contact. This contains both Amazon Web Services generated and user-defined tags.
(string) --
(string) --
ConnectedToSystemTimestamp (datetime) --
The timestamp when customer endpoint connected to Amazon Connect.
RoutingCriteria (dict) --
Latest routing criteria on the contact.
Steps (list) --
List of routing steps. When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.
(dict) --
Step signifies the criteria to be used for routing to an agent
Expiry (dict) --
An object to specify the expiration of a routing step.
DurationInSeconds (integer) --
The number of seconds to wait before expiring the routing step.
ExpiryTimestamp (datetime) --
The timestamp indicating when the routing step expires.
Expression (dict) --
A tagged union to specify expression for a routing step.
AttributeCondition (dict) --
An object to specify the predefined attribute condition.
Name (string) --
The name of predefined attribute.
Value (string) --
The value of predefined attribute.
ProficiencyLevel (float) --
The proficiency level of the condition.
Range (dict) --
An Object to define the minimum and maximum proficiency levels.
MinProficiencyLevel (float) --
The minimum proficiency level of the range.
MaxProficiencyLevel (float) --
The maximum proficiency level of the range.
MatchCriteria (dict) --
An object to define AgentsCriteria.
AgentsCriteria (dict) --
An object to define agentIds.
AgentIds (list) --
An object to specify a list of agents, by user ID.
(string) --
ComparisonOperator (string) --
The operator of the condition.
AndExpression (list) --
List of routing expressions which will be AND-ed together.
(dict) --
A tagged union to specify expression for a routing step.
OrExpression (list) --
List of routing expressions which will be OR-ed together.
(dict) --
A tagged union to specify expression for a routing step.
NotAttributeCondition (dict) --
An object to specify the predefined attribute condition.
Name (string) --
The name of predefined attribute.
Value (string) --
The value of predefined attribute.
ProficiencyLevel (float) --
The proficiency level of the condition.
Range (dict) --
An Object to define the minimum and maximum proficiency levels.
MinProficiencyLevel (float) --
The minimum proficiency level of the range.
MaxProficiencyLevel (float) --
The maximum proficiency level of the range.
MatchCriteria (dict) --
An object to define AgentsCriteria.
AgentsCriteria (dict) --
An object to define agentIds.
AgentIds (list) --
An object to specify a list of agents, by user ID.
(string) --
ComparisonOperator (string) --
The operator of the condition.
Status (string) --
Represents status of the Routing step.
ActivationTimestamp (datetime) --
The timestamp indicating when the routing criteria is set to active. A routing criteria is activated when contact is transferred to a queue. ActivationTimestamp will be set on routing criteria for contacts in agent queue even though Routing criteria is never activated for contacts in agent queue.
Index (integer) --
Information about the index of the routing criteria.
Customer (dict) --
Information about the Customer on the contact.
DeviceInfo (dict) --
Information regarding Customer’s device.
PlatformName (string) --
Name of the platform that the participant used for the call.
PlatformVersion (string) --
Version of the platform that the participant used for the call.
OperatingSystem (string) --
Operating system that the participant used for the call.
Capabilities (dict) --
The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.
Video (string) --
The configuration having the video and screen sharing capabilities for participants over the call.
ScreenShare (string) --
The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
Campaign (dict) --
Information associated with a campaign.
CampaignId (string) --
A unique identifier for a campaign.
AnsweringMachineDetectionStatus (string) --
Indicates how an outbound campaign call is actually disposed if the contact is connected to Amazon Connect.
CustomerVoiceActivity (dict) --
Information about customer’s voice activity.
GreetingStartTimestamp (datetime) --
Timestamp that measures the beginning of the customer greeting from an outbound voice call.
GreetingEndTimestamp (datetime) --
Timestamp that measures the end of the customer greeting from an outbound voice call.
QualityMetrics (dict) --
Information about the quality of the participant's media connection.
Agent (dict) --
Information about the quality of Agent media connection.
Audio (dict) --
Information about the audio quality of the Agent
QualityScore (float) --
Number measuring the estimated quality of the media connection.
PotentialQualityIssues (list) --
List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
(string) --
Customer (dict) --
Information about the quality of Customer media connection.
Audio (dict) --
Information about the audio quality of the Customer
QualityScore (float) --
Number measuring the estimated quality of the media connection.
PotentialQualityIssues (list) --
List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.
Valid values: HighPacketLoss | HighRoundTripTime | HighJitterBuffer
(string) --
ChatMetrics (dict) --
Information about how agent, bot, and customer interact in a chat contact.
ChatContactMetrics (dict) --
Information about the overall participant interactions at the contact level.
MultiParty (boolean) --
A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact.
TotalMessages (integer) --
The number of chat messages on the contact.
TotalBotMessages (integer) --
The total number of bot and automated messages on a chat contact.
TotalBotMessageLengthInChars (integer) --
The total number of characters from bot and automated messages on a chat contact.
ConversationCloseTimeInMillis (integer) --
The time it took for a contact to end after the last customer message.
ConversationTurnCount (integer) --
The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between customer and other participants.
AgentFirstResponseTimestamp (datetime) --
The agent first response timestamp for a chat contact.
AgentFirstResponseTimeInMillis (integer) --
The time for an agent to respond after obtaining a chat contact.
AgentMetrics (dict) --
Information about agent interactions in a contact.
ParticipantId (string) --
The Participant's ID.
ParticipantType (string) --
Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].
ConversationAbandon (boolean) --
A boolean flag indicating whether the chat conversation was abandoned by a Participant.
MessagesSent (integer) --
Number of chat messages sent by Participant.
NumResponses (integer) --
Number of chat messages sent by Participant.
MessageLengthInChars (integer) --
Number of chat characters sent by Participant.
TotalResponseTimeInMillis (integer) --
Total chat response time by Participant.
MaxResponseTimeInMillis (integer) --
Maximum chat response time by Participant.
LastMessageTimestamp (datetime) --
Timestamp of last chat message by Participant.
CustomerMetrics (dict) --
Information about customer interactions in a contact.
ParticipantId (string) --
The Participant's ID.
ParticipantType (string) --
Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].
ConversationAbandon (boolean) --
A boolean flag indicating whether the chat conversation was abandoned by a Participant.
MessagesSent (integer) --
Number of chat messages sent by Participant.
NumResponses (integer) --
Number of chat messages sent by Participant.
MessageLengthInChars (integer) --
Number of chat characters sent by Participant.
TotalResponseTimeInMillis (integer) --
Total chat response time by Participant.
MaxResponseTimeInMillis (integer) --
Maximum chat response time by Participant.
LastMessageTimestamp (datetime) --
Timestamp of last chat message by Participant.
DisconnectDetails (dict) --
Information about the call disconnect experience.
PotentialDisconnectIssue (string) --
Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.
AdditionalEmailRecipients (dict) --
List of additional email addresses for an email contact.
ToList (list) --
List of additional TO email recipients for an email contact.
(dict) --
Information about the email recipient
Address (string) --
Address of the email recipient.
DisplayName (string) --
Display name of the email recipient.
CcList (list) --
List of additional CC email recipients for an email contact.
(dict) --
Information about the email recipient
Address (string) --
Address of the email recipient.
DisplayName (string) --
Display name of the email recipient.
SegmentAttributes (dict) --
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes and can be accessed in flows. Attribute keys can include only alphanumeric, -, and _ characters. This field can be used to show channel subtype. For example, connect:Guide or connect:SMS.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
Recordings (list) --
If recording was enabled, this is information about the recordings.
(dict) --
Information about a voice recording, chat transcript, or screen recording.
StorageType (string) --
Where the recording/transcript is stored.
Location (string) --
The location, in Amazon S3, for the recording/transcript.
MediaStreamType (string) --
Information about the media stream used during the conversation.
ParticipantType (string) --
Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:
All
Manager
Agent
Customer
Thirdparty
Supervisor
FragmentStartNumber (string) --
The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.
FragmentStopNumber (string) --
The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.
StartTimestamp (datetime) --
When the conversation of the last leg of the recording started in UTC time.
StopTimestamp (datetime) --
When the conversation of the last leg of recording stopped in UTC time.
Status (string) --
The status of the recording/transcript.
DeletionReason (string) --
If the recording/transcript was deleted, this is the reason entered for the deletion.
UnprocessedTranscriptLocation (string) --
The location, in Amazon S3, for the unprocessed transcript if any media processing was performed.
DisconnectReason (string) --
The disconnect reason for the contact. For a list and description of all the possible disconnect reasons by channel, see DisconnectReason under ContactTraceRecord in the Amazon Connect Administrator Guide.
ContactEvaluations (dict) --
Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
(string) --
(dict) --
Information about the contact evaluations where the key is the FormId, which is a unique identifier for the form.
FormId (string) --
The FormId of the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name for the evaluation form. It is always present.
Status (string) --
The status of the evaluation.
StartTimestamp (datetime) --
The date and time when the evaluation was started, in UTC time.
EndTimestamp (datetime) --
The date and time when the evaluation was submitted, in UTC time.
DeleteTimestamp (datetime) --
The date and time when the evaluation was deleted, in UTC time.
ExportLocation (string) --
The path where evaluation was exported.
TaskTemplateInfo (dict) --
If this contact was created using a task template, this contains information about the task template.
Arn (string) --
The Amazon Resource Name (ARN) of the task template used to create this contact.
Name (string) --
The name of the task template used to create this contact.
ContactDetails (dict) --
A map of string key/value pairs that contain user-defined attributes which are lightly typed within the contact. This object is used only for task contacts.
Name (string) --
The name of the contact details.
Description (string) --
Teh description of the contact details.
OutboundStrategy (dict) --
Information about the outbound strategy.
Type (string) --
Type of the outbound strategy.
Config (dict) --
Config of the outbound strategy.
AgentFirst (dict) --
The config of agent first outbound strategy.
Preview (dict) --
Information about preview configuration of agent first outbound strategy
PostAcceptTimeoutConfig (dict) --
Countdown timer configuration after the agent accepted the preview outbound contact.
DurationInSeconds (integer) --
Duration in seconds for the countdown timer after the agent accepted the contact.
AllowedUserActions (list) --
The actions the agent can perform after accepting the preview outbound contact.
(string) --
Attributes (dict) --
The attributes of the contact.
(string) --
(string) --
NextContacts (list) --
List of next contact entries for the contact.
(dict) --
Entry representing the next contact in a sequence.
Type (string) --
The type of the next contact entry.
NextContactMetadata (dict) --
Metadata for the next contact entry.
QuickConnectContactData (dict) --
Quick connect contact data for the next contact metadata.
ContactId (string) --
The contact ID for quick connect contact data.
InitiationTimestamp (datetime) --
Timestamp when the quick connect contact was initiated.
QuickConnectId (string) --
The quick connect ID.
QuickConnectName (string) --
The name of the quick connect.
QuickConnectType (string) --
The type of the quick connect.
{'Evaluation': {'Answers': {'SuggestedAnswers': {'Value': {'DateTimeValue': 'string',
'StringValues': ['string']}},
'SystemSuggestedValue': {'DateTimeValue': 'string',
'StringValues': ['string']},
'Value': {'DateTimeValue': 'string',
'StringValues': ['string']}},
'Metadata': {'ContactParticipant': {'ContactParticipantId': 'string',
'ContactParticipantRole': 'AGENT '
'| '
'SYSTEM '
'| '
'CUSTOM_BOT'},
'SamplingJobId': 'string',
'Score': {'AppliedWeight': 'double'}},
'Scores': {'AppliedWeight': 'double'}},
'EvaluationForm': {'Items': {'Question': {'Enablement': {'Condition': {'Operands': {'Expression': {'Comparator': {'ALL_IN',
'EXACT'}}}}},
'QuestionType': {'DATETIME',
'MULTISELECT'},
'QuestionTypeProperties': {'MultiSelect': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'},
'DefaultOptionRefIds': ['string'],
'Options': [{'RuleCategory': {'Category': 'string',
'Condition': 'PRESENT '
'| '
'NOT_PRESENT',
'OptionRefIds': ['string']}}]},
'DisplayAs': 'DROPDOWN '
'| '
'CHECKBOX',
'Options': [{'RefId': 'string',
'Text': 'string'}]},
'Numeric': {'Automation': {'PropertyValue': {'Label': {'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT',
'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'}}}}}}},
'LanguageConfiguration': {'FormLanguage': 'de-DE | en-US | '
'es-ES | fr-FR | '
'it-IT | pt-BR'},
'TargetConfiguration': {'ContactInteractionType': 'AGENT | '
'AUTOMATED'}}}
Describes a contact evaluation in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.describe_contact_evaluation(
InstanceId='string',
EvaluationId='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 contact evaluation.
dict
Response Syntax
{
'Evaluation': {
'EvaluationId': 'string',
'EvaluationArn': 'string',
'Metadata': {
'ContactId': 'string',
'EvaluatorArn': 'string',
'ContactAgentId': 'string',
'CalibrationSessionId': 'string',
'Score': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False,
'AppliedWeight': 123.0
},
'AutoEvaluation': {
'AutoEvaluationEnabled': True|False,
'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
},
'Acknowledgement': {
'AcknowledgedTime': datetime(2015, 1, 1),
'AcknowledgedBy': 'string',
'AcknowledgerComment': 'string'
},
'ContactParticipant': {
'ContactParticipantRole': 'AGENT'|'SYSTEM'|'CUSTOM_BOT',
'ContactParticipantId': 'string'
},
'SamplingJobId': 'string'
},
'Answers': {
'string': {
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'StringValues': [
'string',
],
'DateTimeValue': 'string',
'NotApplicable': True|False
},
'SystemSuggestedValue': {
'StringValue': 'string',
'NumericValue': 123.0,
'StringValues': [
'string',
],
'DateTimeValue': 'string',
'NotApplicable': True|False
},
'SuggestedAnswers': [
{
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'StringValues': [
'string',
],
'DateTimeValue': 'string',
'NotApplicable': True|False
},
'Status': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'Input': {
'TranscriptType': 'RAW'|'REDACTED'
},
'AnalysisType': 'CONTACT_LENS_DATA'|'GEN_AI',
'AnalysisDetails': {
'GenAI': {
'Justification': 'string',
'PointsOfInterest': [
{
'MillisecondOffsets': {
'BeginOffsetMillis': 123
},
'TranscriptSegment': 'string'
},
]
},
'ContactLens': {
'MatchedRuleCategories': [
{
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'PointsOfInterest': [
{
'MillisecondOffsets': {
'BeginOffsetMillis': 123
},
'TranscriptSegment': 'string'
},
]
},
]
}
}
},
]
}
},
'Notes': {
'string': {
'Value': 'string'
}
},
'Status': 'DRAFT'|'SUBMITTED',
'Scores': {
'string': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False,
'AppliedWeight': 123.0
}
},
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'EvaluationType': 'STANDARD'|'CALIBRATION',
'Tags': {
'string': 'string'
}
},
'EvaluationForm': {
'EvaluationFormVersion': 123,
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string',
'Title': 'string',
'Description': 'string',
'Items': [
{
'Section': {
'Title': 'string',
'RefId': 'string',
'Instructions': 'string',
'Items': {'... recursive ...'},
'Weight': 123.0
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'Automation': {
'PropertyValue': {
'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'
},
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'SingleSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'DisplayAs': 'DROPDOWN'|'RADIO',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefId': 'string'
}
},
],
'DefaultOptionRefId': 'string',
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'Text': {
'Automation': {
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'MultiSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string'
},
],
'DisplayAs': 'DROPDOWN'|'CHECKBOX',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefIds': [
'string',
]
}
},
],
'DefaultOptionRefIds': [
'string',
],
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0
}
},
],
'ScoringStrategy': {
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
'Status': 'ENABLED'|'DISABLED'
},
'AutoEvaluationConfiguration': {
'Enabled': True|False
},
'TargetConfiguration': {
'ContactInteractionType': 'AGENT'|'AUTOMATED'
},
'LanguageConfiguration': {
'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'
}
}
}
Response Structure
(dict) --
Evaluation (dict) --
Information about the evaluation form completed for a specific contact.
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
Metadata (dict) --
Metadata about the contact evaluation.
ContactId (string) --
The identifier of the contact in this instance of Amazon Connect.
EvaluatorArn (string) --
The Amazon Resource Name (ARN) of the user who last updated the evaluation.
ContactAgentId (string) --
The identifier of the agent who performed the contact.
CalibrationSessionId (string) --
The calibration session ID that this evaluation belongs to.
Score (dict) --
The overall score of the contact evaluation.
Percentage (float) --
The score percentage for an item in a contact evaluation.
NotApplicable (boolean) --
The flag to mark the item as not applicable for scoring.
AutomaticFail (boolean) --
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
AppliedWeight (float) --
Weight applied to this evaluation score.
AutoEvaluation (dict) --
Information related to automated evaluation.
AutoEvaluationEnabled (boolean) --
Whether automated evaluation is enabled.
AutoEvaluationStatus (string) --
The status of the contact auto-evaluation.
Acknowledgement (dict) --
Information related to evaluation acknowledgement.
AcknowledgedTime (datetime) --
When the agent acknowledged the evaluation.
AcknowledgedBy (string) --
The agent who acknowledged the evaluation.
AcknowledgerComment (string) --
A comment from the agent when they confirmed they acknowledged the evaluation.
ContactParticipant (dict) --
Information about a contact participant in this evaluation.
ContactParticipantRole (string) --
The role of the contact participant.
ContactParticipantId (string) --
The identifier for the contact participant.
SamplingJobId (string) --
Identifier of the sampling job.
Answers (dict) --
A map of question identifiers to answer value.
(string) --
(dict) --
Information about output answers for a contact evaluation.
Value (dict) --
The value for an answer in a contact evaluation.
StringValue (string) --
The string value for an answer in a contact evaluation.
NumericValue (float) --
The numeric value for an answer in a contact evaluation.
StringValues (list) --
String values provided as answers to evaluation questions.
(string) --
DateTimeValue (string) --
Date and time value provided as an answer to an evaluation question.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
SystemSuggestedValue (dict) --
The system suggested value for an answer in a contact evaluation.
StringValue (string) --
The string value for an answer in a contact evaluation.
NumericValue (float) --
The numeric value for an answer in a contact evaluation.
StringValues (list) --
String values provided as answers to evaluation questions.
(string) --
DateTimeValue (string) --
Date and time value provided as an answer to an evaluation question.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
SuggestedAnswers (list) --
Automation suggested answers for the questions.
(dict) --
The information about the suggested answer for the question.
Value (dict) --
Information about answer data for a contact evaluation. Answer data must be either string, numeric, or not applicable.
StringValue (string) --
The string value for an answer in a contact evaluation.
NumericValue (float) --
The numeric value for an answer in a contact evaluation.
StringValues (list) --
String values provided as answers to evaluation questions.
(string) --
DateTimeValue (string) --
Date and time value provided as an answer to an evaluation question.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
Status (string) --
The status of the suggested answer. D
Input (dict) --
Details about the input used to question automation.
TranscriptType (string) --
Transcript type.
AnalysisType (string) --
Type of analysis used to provide suggested answer.
AnalysisDetails (dict) --
Detailed analysis results.
GenAI (dict) --
Analysis results from the generative AI automation for the question.
Justification (string) --
Generative AI automation answer justification.
PointsOfInterest (list) --
Generative AI automation answer analysis points of interest.
(dict) --
Information about the point of interest in transcript provided to evaluation.
MillisecondOffsets (dict) --
Offset in milliseconds from the beginning of transcript.
BeginOffsetMillis (integer) --
Offset in milliseconds from the beginning of the transcript.
TranscriptSegment (string) --
Segment of transcript.
ContactLens (dict) --
Analysis results from the Contact Lens automation for the question.
MatchedRuleCategories (list) --
A list of match rule categories.
(dict) --
The Contact Lens category used by evaluation automation.
Category (string) --
A category label.
Condition (string) --
An automation condition for a Contact Lens category.
PointsOfInterest (list) --
A point of interest in a contact transcript that indicates match of condition.
(dict) --
Information about the point of interest in transcript provided to evaluation.
MillisecondOffsets (dict) --
Offset in milliseconds from the beginning of transcript.
BeginOffsetMillis (integer) --
Offset in milliseconds from the beginning of the transcript.
TranscriptSegment (string) --
Segment of transcript.
Notes (dict) --
A map of question identifiers to note value.
(string) --
(dict) --
Information about notes for a contact evaluation.
Value (string) --
The note for an item (section or question) in a contact evaluation.
Status (string) --
The status of the contact evaluation.
Scores (dict) --
A map of item (section or question) identifiers to score value.
(string) --
(dict) --
Information about scores of a contact evaluation item (section or question).
Percentage (float) --
The score percentage for an item in a contact evaluation.
NotApplicable (boolean) --
The flag to mark the item as not applicable for scoring.
AutomaticFail (boolean) --
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
AppliedWeight (float) --
Weight applied to this evaluation score.
CreatedTime (datetime) --
The timestamp for when the evaluation was created.
LastModifiedTime (datetime) --
The timestamp for when the evaluation was last updated.
EvaluationType (string) --
Type of the evaluation.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
EvaluationForm (dict) --
Information about the evaluation form.
EvaluationFormVersion (integer) --
A version of the evaluation form.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
Title (string) --
A title of the evaluation form.
Description (string) --
The description of the evaluation form.
Items (list) --
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
(dict) --
Information about an item from an evaluation form. The item must be either a section or a question.
Section (dict) --
The information of the section.
Title (string) --
The title of the section.
RefId (string) --
The identifier of the section. An identifier must be unique within the evaluation form.
Instructions (string) --
The instructions of the section.
Items (list) --
The items of the section.
Weight (float) --
The scoring weight of the section.
Question (dict) --
The information of the question.
Title (string) --
The title of the question.
Instructions (string) --
The instructions of the section.
RefId (string) --
The identifier of the question. An identifier must be unique within the evaluation form.
NotApplicableEnabled (boolean) --
The flag to enable not applicable answers to the question.
QuestionType (string) --
The type of the question.
QuestionTypeProperties (dict) --
The properties of the type of question. Text questions do not have to define question type properties.
Numeric (dict) --
The properties of the numeric question.
MinValue (integer) --
The minimum answer value.
MaxValue (integer) --
The maximum answer value.
Options (list) --
The scoring options of the numeric question.
(dict) --
Information about the option range used for scoring in numeric questions.
MinValue (integer) --
The minimum answer value of the range option.
MaxValue (integer) --
The maximum answer value of the range option.
Score (integer) --
The score assigned to answer values within the range option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
A configuration for automatic fail.
TargetSection (string) --
The referenceId of the target section for auto failure.
Automation (dict) --
The automation properties of the numeric question.
PropertyValue (dict) --
The property value of the automation.
Label (string) --
The property label of the automation.
AnswerSource (dict) --
A source of automation answer for numeric question.
SourceType (string) --
The automation answer source type.
SingleSelect (dict) --
The properties of the numeric question.
Options (list) --
The answer options of the single select question.
(dict) --
Information about the automation configuration in single select questions.
RefId (string) --
The identifier of the answer option. An identifier must be unique within the question.
Text (string) --
The title of the answer option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Whether automatic fail is configured on a single select question.
TargetSection (string) --
The referenceId of the target section for auto failure.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) --
The automation options of the single select question.
(dict) --
Information about the automation option of a single select question.
RuleCategory (dict) --
The automation option based on a rule category for the single select question.
Category (string) --
The category name, as defined in Rules.
Condition (string) --
The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.
OptionRefId (string) --
The identifier of the answer option.
DefaultOptionRefId (string) --
The identifier of the default answer option, when none of the automation options match the criteria.
AnswerSource (dict) --
Automation answer source.
SourceType (string) --
The automation answer source type.
Text (dict) --
The properties of the text question.
Automation (dict) --
The automation properties of the text question.
AnswerSource (dict) --
Automation answer source.
SourceType (string) --
The automation answer source type.
MultiSelect (dict) --
Properties for multi-select question types.
Options (list) --
Options available for this multi-select question.
(dict) --
An option for a multi-select question in an evaluation form.
RefId (string) --
Reference identifier for this option.
Text (string) --
Display text for this option.
DisplayAs (string) --
Display format for the multi-select question.
Automation (dict) --
Automation configuration for this multi-select question.
Options (list) --
Automation options for the multi-select question.
(dict) --
An automation option for a multi-select question.
RuleCategory (dict) --
Rule category configuration for this automation option.
Category (string) --
The category name for this automation rule.
Condition (string) --
The condition for this automation rule.
OptionRefIds (list) --
Reference IDs of options for this automation rule.
(string) --
DefaultOptionRefIds (list) --
Reference IDs of default options.
(string) --
AnswerSource (dict) --
A question automation answer.
SourceType (string) --
The automation answer source type.
Enablement (dict) --
A question conditional enablement.
Condition (dict) --
A condition for item enablement configuration.
Operands (list) --
Operands of the enablement condition.
(dict) --
An operand of the enablement condition.
Expression (dict) --
An expression of the enablement condition.
Source (dict) --
A source item of enablement expression.
Type (string) --
A type of source item.
RefId (string) --
A referenceId of the source item.
Values (list) --
A list of values from source item.
(dict) --
An enablement expression source value.
Type (string) --
A type of source item value.
RefId (string) --
A referenceId of the source value.
Comparator (string) --
A comparator to be used against list of values.
Condition (dict) --
A condition for item enablement.
Operator (string) --
The operator to be used to be applied to operands if more than one provided.
Action (string) --
An enablement action that if condition is satisfied.
DefaultAction (string) --
An enablement action that if condition is not satisfied.
Weight (float) --
The scoring weight of the section.
ScoringStrategy (dict) --
A scoring strategy of the evaluation form.
Mode (string) --
The scoring mode of the evaluation form.
Status (string) --
The scoring status of the evaluation form.
AutoEvaluationConfiguration (dict) --
The configuration of the automated evaluation.
Enabled (boolean) --
When automated evaluation is enabled.
TargetConfiguration (dict) --
Configuration that specifies the target for this evaluation form content.
ContactInteractionType (string) --
The contact interaction type for this evaluation form.
LanguageConfiguration (dict) --
Configuration for language settings of this evaluation form content.
FormLanguage (string) --
The language for the evaluation form.
{'EvaluationForm': {'Items': {'Question': {'Enablement': {'Condition': {'Operands': {'Expression': {'Comparator': {'ALL_IN',
'EXACT'}}}}},
'QuestionType': {'DATETIME',
'MULTISELECT'},
'QuestionTypeProperties': {'MultiSelect': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'},
'DefaultOptionRefIds': ['string'],
'Options': [{'RuleCategory': {'Category': 'string',
'Condition': 'PRESENT '
'| '
'NOT_PRESENT',
'OptionRefIds': ['string']}}]},
'DisplayAs': 'DROPDOWN '
'| '
'CHECKBOX',
'Options': [{'RefId': 'string',
'Text': 'string'}]},
'Numeric': {'Automation': {'PropertyValue': {'Label': {'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT',
'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'}}}}}}},
'LanguageConfiguration': {'FormLanguage': 'de-DE | en-US | '
'es-ES | fr-FR | '
'it-IT | pt-BR'},
'TargetConfiguration': {'ContactInteractionType': 'AGENT | '
'AUTOMATED'}}}
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
See also: AWS API Documentation
Request Syntax
client.describe_evaluation_form(
InstanceId='string',
EvaluationFormId='string',
EvaluationFormVersion=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]
A unique identifier for the contact evaluation.
integer
A version of the evaluation form.
dict
Response Syntax
{
'EvaluationForm': {
'EvaluationFormId': 'string',
'EvaluationFormVersion': 123,
'Locked': True|False,
'EvaluationFormArn': 'string',
'Title': 'string',
'Description': 'string',
'Status': 'DRAFT'|'ACTIVE',
'Items': [
{
'Section': {
'Title': 'string',
'RefId': 'string',
'Instructions': 'string',
'Items': {'... recursive ...'},
'Weight': 123.0
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'Automation': {
'PropertyValue': {
'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'
},
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'SingleSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'DisplayAs': 'DROPDOWN'|'RADIO',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefId': 'string'
}
},
],
'DefaultOptionRefId': 'string',
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'Text': {
'Automation': {
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'MultiSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string'
},
],
'DisplayAs': 'DROPDOWN'|'CHECKBOX',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefIds': [
'string',
]
}
},
],
'DefaultOptionRefIds': [
'string',
],
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0
}
},
],
'ScoringStrategy': {
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
'Status': 'ENABLED'|'DISABLED'
},
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedBy': 'string',
'AutoEvaluationConfiguration': {
'Enabled': True|False
},
'Tags': {
'string': 'string'
},
'TargetConfiguration': {
'ContactInteractionType': 'AGENT'|'AUTOMATED'
},
'LanguageConfiguration': {
'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'
}
}
}
Response Structure
(dict) --
EvaluationForm (dict) --
Information about the evaluation form.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormVersion (integer) --
A version of the evaluation form.
Locked (boolean) --
The flag indicating whether the evaluation form is locked for changes.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
Title (string) --
A title of the evaluation form.
Description (string) --
The description of the evaluation form.
Status (string) --
The status of the evaluation form.
Items (list) --
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
(dict) --
Information about an item from an evaluation form. The item must be either a section or a question.
Section (dict) --
The information of the section.
Title (string) --
The title of the section.
RefId (string) --
The identifier of the section. An identifier must be unique within the evaluation form.
Instructions (string) --
The instructions of the section.
Items (list) --
The items of the section.
Weight (float) --
The scoring weight of the section.
Question (dict) --
The information of the question.
Title (string) --
The title of the question.
Instructions (string) --
The instructions of the section.
RefId (string) --
The identifier of the question. An identifier must be unique within the evaluation form.
NotApplicableEnabled (boolean) --
The flag to enable not applicable answers to the question.
QuestionType (string) --
The type of the question.
QuestionTypeProperties (dict) --
The properties of the type of question. Text questions do not have to define question type properties.
Numeric (dict) --
The properties of the numeric question.
MinValue (integer) --
The minimum answer value.
MaxValue (integer) --
The maximum answer value.
Options (list) --
The scoring options of the numeric question.
(dict) --
Information about the option range used for scoring in numeric questions.
MinValue (integer) --
The minimum answer value of the range option.
MaxValue (integer) --
The maximum answer value of the range option.
Score (integer) --
The score assigned to answer values within the range option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
A configuration for automatic fail.
TargetSection (string) --
The referenceId of the target section for auto failure.
Automation (dict) --
The automation properties of the numeric question.
PropertyValue (dict) --
The property value of the automation.
Label (string) --
The property label of the automation.
AnswerSource (dict) --
A source of automation answer for numeric question.
SourceType (string) --
The automation answer source type.
SingleSelect (dict) --
The properties of the numeric question.
Options (list) --
The answer options of the single select question.
(dict) --
Information about the automation configuration in single select questions.
RefId (string) --
The identifier of the answer option. An identifier must be unique within the question.
Text (string) --
The title of the answer option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Whether automatic fail is configured on a single select question.
TargetSection (string) --
The referenceId of the target section for auto failure.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) --
The automation options of the single select question.
(dict) --
Information about the automation option of a single select question.
RuleCategory (dict) --
The automation option based on a rule category for the single select question.
Category (string) --
The category name, as defined in Rules.
Condition (string) --
The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.
OptionRefId (string) --
The identifier of the answer option.
DefaultOptionRefId (string) --
The identifier of the default answer option, when none of the automation options match the criteria.
AnswerSource (dict) --
Automation answer source.
SourceType (string) --
The automation answer source type.
Text (dict) --
The properties of the text question.
Automation (dict) --
The automation properties of the text question.
AnswerSource (dict) --
Automation answer source.
SourceType (string) --
The automation answer source type.
MultiSelect (dict) --
Properties for multi-select question types.
Options (list) --
Options available for this multi-select question.
(dict) --
An option for a multi-select question in an evaluation form.
RefId (string) --
Reference identifier for this option.
Text (string) --
Display text for this option.
DisplayAs (string) --
Display format for the multi-select question.
Automation (dict) --
Automation configuration for this multi-select question.
Options (list) --
Automation options for the multi-select question.
(dict) --
An automation option for a multi-select question.
RuleCategory (dict) --
Rule category configuration for this automation option.
Category (string) --
The category name for this automation rule.
Condition (string) --
The condition for this automation rule.
OptionRefIds (list) --
Reference IDs of options for this automation rule.
(string) --
DefaultOptionRefIds (list) --
Reference IDs of default options.
(string) --
AnswerSource (dict) --
A question automation answer.
SourceType (string) --
The automation answer source type.
Enablement (dict) --
A question conditional enablement.
Condition (dict) --
A condition for item enablement configuration.
Operands (list) --
Operands of the enablement condition.
(dict) --
An operand of the enablement condition.
Expression (dict) --
An expression of the enablement condition.
Source (dict) --
A source item of enablement expression.
Type (string) --
A type of source item.
RefId (string) --
A referenceId of the source item.
Values (list) --
A list of values from source item.
(dict) --
An enablement expression source value.
Type (string) --
A type of source item value.
RefId (string) --
A referenceId of the source value.
Comparator (string) --
A comparator to be used against list of values.
Condition (dict) --
A condition for item enablement.
Operator (string) --
The operator to be used to be applied to operands if more than one provided.
Action (string) --
An enablement action that if condition is satisfied.
DefaultAction (string) --
An enablement action that if condition is not satisfied.
Weight (float) --
The scoring weight of the section.
ScoringStrategy (dict) --
A scoring strategy of the evaluation form.
Mode (string) --
The scoring mode of the evaluation form.
Status (string) --
The scoring status of the evaluation form.
CreatedTime (datetime) --
The timestamp for when the evaluation form was created.
CreatedBy (string) --
The Amazon Resource Name (ARN) of the user who created the evaluation form.
LastModifiedTime (datetime) --
The timestamp for when the evaluation form was last updated.
LastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
AutoEvaluationConfiguration (dict) --
The automatic evaluation configuration of an evaluation form.
Enabled (boolean) --
When automated evaluation is enabled.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
TargetConfiguration (dict) --
Configuration that specifies the target for this evaluation form.
ContactInteractionType (string) --
The contact interaction type for this evaluation form.
LanguageConfiguration (dict) --
Configuration for language settings of this evaluation form.
FormLanguage (string) --
The language for the evaluation form.
{'AttributeType': {'MESSAGE_STREAMING'}}
Response {'Attribute': {'AttributeType': {'MESSAGE_STREAMING'}}}
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
See also: AWS API Documentation
Request Syntax
client.describe_instance_attribute(
InstanceId='string',
AttributeType='INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE'|'MESSAGE_STREAMING'
)
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 type of attribute.
dict
Response Syntax
{
'Attribute': {
'AttributeType': 'INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE'|'MESSAGE_STREAMING',
'Value': 'string'
}
}
Response Structure
(dict) --
Attribute (dict) --
The type of attribute.
AttributeType (string) --
The type of attribute.
Value (string) --
The value of the attribute.
{'QuickConnect': {'QuickConnectConfig': {'FlowConfig': {'ContactFlowId': 'string'},
'QuickConnectType': {'FLOW'}}}}
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'|'FLOW',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
},
'FlowConfig': {
'ContactFlowId': '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 admin website, 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.
FlowConfig (dict) --
Flow configuration for quick connect setup.
ContactFlowId (string) --
The contact flow ID for the quick connect configuration.
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.
{'Rule': {'Actions': {'TaskAction': {'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}}}}
Describes a rule for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.describe_rule(
InstanceId='string',
RuleId='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 rule.
dict
Response Syntax
{
'Rule': {
'Name': 'string',
'RuleId': 'string',
'RuleArn': 'string',
'TriggerEventSource': {
'EventSourceName': 'OnPostCallAnalysisAvailable'|'OnRealTimeCallAnalysisAvailable'|'OnRealTimeChatAnalysisAvailable'|'OnPostChatAnalysisAvailable'|'OnZendeskTicketCreate'|'OnZendeskTicketStatusUpdate'|'OnSalesforceCaseCreate'|'OnContactEvaluationSubmit'|'OnMetricDataUpdate'|'OnCaseCreate'|'OnCaseUpdate'|'OnSlaBreach',
'IntegrationAssociationId': 'string'
},
'Function': 'string',
'Actions': [
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {},
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
}
},
'CreateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {},
'StringValue': 'string'
}
},
],
'TemplateId': 'string'
},
'UpdateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {},
'StringValue': 'string'
}
},
]
},
'AssignSlaAction': {
'SlaAssignmentType': 'CASES',
'CaseSlaConfiguration': {
'Name': 'string',
'Type': 'CaseField',
'FieldId': 'string',
'TargetFieldValues': [
{
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {},
'StringValue': 'string'
},
],
'TargetSlaMinutes': 123
}
},
'EndAssociatedTasksAction': {},
'SubmitAutoEvaluationAction': {
'EvaluationFormId': 'string'
}
},
],
'PublishStatus': 'DRAFT'|'PUBLISHED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Rule (dict) --
Information about the rule.
Name (string) --
The name of the rule.
RuleId (string) --
A unique identifier for the rule.
RuleArn (string) --
The Amazon Resource Name (ARN) of the rule.
TriggerEventSource (dict) --
The event source to trigger the rule.
EventSourceName (string) --
The name of the event source.
IntegrationAssociationId (string) --
The identifier for the integration association.
Function (string) --
The conditions of the rule.
Actions (list) --
A list of actions to be run when the rule is triggered.
(dict) --
Information about the action to be performed when a rule is triggered.
ActionType (string) --
The type of action that creates a rule.
TaskAction (dict) --
Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
Name (string) --
The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
ContactFlowId (string) --
The identifier of the flow.
References (dict) --
Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) --
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
EventBridgeAction (dict) --
Information about the EventBridge action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Name (string) --
The name.
AssignContactCategoryAction (dict) --
Information about the contact category action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationAction (dict) --
Information about the send notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
DeliveryMethod (string) --
Notification delivery method.
Subject (string) --
The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Content (string) --
Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
ContentType (string) --
Content type format.
Recipient (dict) --
Notification recipient.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
Exclusion (dict) --
Recipients to exclude from notification.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
CreateCaseAction (dict) --
Information about the create case action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.
Fields (list) --
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) --
Unique identifier of a field.
Value (dict) --
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TemplateId (string) --
A unique identifier of a template.
UpdateCaseAction (dict) --
Information about the update case action.
Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.
Fields (list) --
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) --
Unique identifier of a field.
Value (dict) --
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
AssignSlaAction (dict) --
Information about the assign SLA action.
SlaAssignmentType (string) --
Type of SLA assignment.
CaseSlaConfiguration (dict) --
The SLA configuration for Case SLA Assignment.
Name (string) --
Name of an SLA.
Type (string) --
Type of SLA for Case SlaAssignmentType.
FieldId (string) --
Unique identifier of a Case field.
TargetFieldValues (list) --
Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.
(dict) --
Object to store union of Field values.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TargetSlaMinutes (integer) --
Target duration in minutes within which an SLA should be completed.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
SubmitAutoEvaluationAction (dict) --
Information about the submit automated evaluation action.
EvaluationFormId (string) --
The identifier of the auto-evaluation enabled form.
PublishStatus (string) --
The publish status of the rule.
CreatedTime (datetime) --
The timestamp for when the rule was created.
LastUpdatedTime (datetime) --
The timestamp for the when the rule was last updated.
LastUpdatedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the rule.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
{'SecurityProfile': {'GranularAccessControlConfiguration': {'DataTableAccessControlConfiguration': {'PrimaryAttributeAccessControlConfiguration': {'PrimaryAttributeValues': [{'AccessType': 'ALLOW',
'AttributeName': 'string',
'Values': ['string']}]}}}}}
Gets basic information about the security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
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',
'HierarchyRestrictedResources': [
'string',
],
'AllowedAccessControlHierarchyGroupId': 'string',
'GranularAccessControlConfiguration': {
'DataTableAccessControlConfiguration': {
'PrimaryAttributeAccessControlConfiguration': {
'PrimaryAttributeValues': [
{
'AccessType': 'ALLOW',
'AttributeName': 'string',
'Values': [
'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 security 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.
HierarchyRestrictedResources (list) --
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.
(string) --
AllowedAccessControlHierarchyGroupId (string) --
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
GranularAccessControlConfiguration (dict) --
The granular access control configuration for the security profile, including data table permissions.
DataTableAccessControlConfiguration (dict) --
The access control configuration for data tables.
PrimaryAttributeAccessControlConfiguration (dict) --
The configuration's primary attribute access control configuration.
PrimaryAttributeValues (list) --
The item's primary attribute values.
(dict) --
A primary attribute value.
AccessType (string) --
The value's access type.
AttributeName (string) --
The value's attribute name.
Values (list) --
The value's values.
(string) --
{'Filters': {'StringCondition': {'Comparison': 'NOT_EXISTS'}},
'Metrics': {'MetricId': 'string'}}
Response {'MetricResults': {'Collections': {'Metric': {'MetricId': 'string'}}}}
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.
For a description of the historical metrics that are supported by GetMetricDataV2 and GetMetricData, see Metrics definitions in the Amazon Connect Administrator Guide.
See also: AWS API Documentation
Request Syntax
client.get_metric_data_v2(
ResourceArn='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Interval={
'TimeZone': 'string',
'IntervalPeriod': 'FIFTEEN_MIN'|'THIRTY_MIN'|'HOUR'|'DAY'|'WEEK'|'TOTAL'
},
Filters=[
{
'FilterKey': 'string',
'FilterValues': [
'string',
],
'StringCondition': {
'Comparison': 'NOT_EXISTS'
}
},
],
Groupings=[
'string',
],
Metrics=[
{
'Name': 'string',
'Threshold': [
{
'Comparison': 'string',
'ThresholdValue': 123.0
},
],
'MetricId': 'string',
'MetricFilters': [
{
'MetricFilterKey': 'string',
'MetricFilterValues': [
'string',
],
'Negate': True|False
},
]
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
datetime
[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 before the end time timestamp. The start and end time depends on the IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.
datetime
[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 later than the start time timestamp. It cannot be later than the current timestamp.
dict
The interval period and timezone to apply to returned metrics.
IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL. For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period. The following list describes restrictions on StartTime and EndTime based on which IntervalPeriod is requested.
FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.
THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.
HOUR: The difference between StartTime and EndTime must be less than 3 days.
DAY: The difference between StartTime and EndTime must be less than 35 days.
WEEK: The difference between StartTime and EndTime must be less than 35 days.
TOTAL: The difference between StartTime and EndTime must be less than 35 days.
TimeZone: The timezone applied to requested metrics.
TimeZone (string) --
The timezone applied to requested metrics.
IntervalPeriod (string) --
IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested.
FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.
THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.
HOUR: The difference between StartTime and EndTime must be less than 3 days.
DAY: The difference between StartTime and EndTime must be less than 35 days.
WEEK: The difference between StartTime and EndTime must be less than 35 days.
TOTAL: The difference between StartTime and EndTime must be less than 35 days.
list
[REQUIRED]
The filters to apply to returned metrics. You can filter on the following resources:
Agents
Campaigns
Channels
Feature
Queues
Routing profiles
Routing step expression
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys: AGENT | AGENT_HIERARCHY_LEVEL_FIVE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_ HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_TWO | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ALIAS | BOT_ID | BOT_INTENT_NAME | BOT_LOCALE | BOT_VERSION | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CASE_STATUS | CASE_TEMPLATE_ARN | CHANNEL | contact/segmentAttributes/connect:Subtype | contact/segmentAttributes/connect:ValidationTestType | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_QUESTION | EVALUATION_SECTION | EVALUATION_SOURCE | EVALUATOR_ID | FEATURE | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_MODULE_RESOURCE_ID | FLOWS_NEXT_RESOURCE_ID | FLOWS_NEXT_RESOURCE_QUEUE_ID | FLOWS_OUTCOME_TYPE | FLOWS_RESOURCE_ID | FORM_VERSION | INITIATING_FLOW | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_ TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | TEST_CASE | TEST_ CASE_EXECUTION_FAILURE_REASON | TEST_CASE_EXECUTION_RESULT | TEST_CASE_EXECUTION_STATE
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics. connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key. ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is. Q_CONNECT_ENABLED. TRUE and FALSE are the only valid filterValues for the Q_CONNECT_ENABLED filter key.
TRUE includes all contacts that had Connect AI Agents enabled as part of the flow.
FALSE includes all contacts that did not have Connect AI Agents enabled as part of the flow
EXPERIENCE_VALIDATION and FLOW_VALIDATION are the only valid filterValues for the contact/segmentAttributes/connect:ValidationTestType filter key
This filter is available only for contact record-driven metrics.
Campaign ARNs are valid filterValues for the CAMPAIGN filter key.
(dict) --
Contains the filter to apply when retrieving metrics with the GetMetricDataV2 API.
FilterKey (string) --
The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.
FilterValues (list) --
The identifiers to use for filtering data. For example, if you have a filter key of QUEUE, you would add queue IDs or ARNs in FilterValues.
(string) --
StringCondition (dict) --
System defined filtering condition. For example, the NOT_EXISTS StringCondition returns documents where the field specified by FilterKey does not exist in the document.
When the NOT_EXISTS StringCondition is added to a FilterV2 object, FilterValues must be null or empty.
Comparison (string) --
The string condition.
list
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.
If no grouping is specified, a summary of all metrics is returned.
Valid grouping keys: AGENT | AGENT_HIERARCHY_LEVEL_ONE | AGENT_HIERARCHY_LEVEL_TWO | AGENT_HIERARCHY_LEVEL_THREE | AGENT_HIERARCHY_LEVEL_FOUR | AGENT_HIERARCHY_LEVEL_FIVE | ANSWERING_MACHINE_DETECTION_STATUS | BOT_ID | BOT_ALIAS | BOT_VERSION | BOT_LOCALE | BOT_INTENT_NAME | CAMPAIGN | CAMPAIGN_DELIVERY_EVENT_TYPE | CAMPAIGN_EXCLUDED_EVENT_TYPE | CAMPAIGN_EXECUTION_TIMESTAMP | CASE_TEMPLATE_ARN | CASE_STATUS | CHANNEL | contact/segmentAttributes/connect:Subtype | DISCONNECT_REASON | EVALUATION_FORM | EVALUATION_SECTION | EVALUATION_QUESTION | EVALUATION_SOURCE | EVALUATOR_ID | FLOWS_RESOURCE_ID | FLOWS_MODULE_RESOURCE_ID | FLOW_ACTION_ID | FLOW_TYPE | FLOWS_OUTCOME_TYPE | FORM_VERSION | INITIATION_METHOD | INVOKING_RESOURCE_PUBLISHED_TIMESTAMP | INVOKING_RESOURCE_TYPE | PARENT_FLOWS_RESOURCE_ID | Q_CONNECT_ENABLED | QUEUE | RESOURCE_PUBLISHED_TIMESTAMP | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | TEST_CASE | TEST_CASE_EXECUTION_FAILURE_REASON | TEST_CASE_INVOCATION_METHOD
API, SCHEDULE, and EVENT are the only valid filterValues for TEST_CASE_INVOCATION_METHOD.
OBSERVE_EVENT, SEND_INSTRUCTION, ASSERT_DATA, and OVERRIDE_SYSTEM_BEHAVIOR are the only valid filterValues for TEST_CASE_EXECUTION_FAILURE_REASON
Type: Array of strings
Array Members: Maximum number of 4 items
Required: No
(string) --
list
[REQUIRED]
The metrics to retrieve. Specify the name or metricId, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Metrics definition in the Amazon Connect Administrator Guide.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Abandonment rate
AGENT_ADHERENT_TIME
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
AGENT_ANSWER_RATE
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
AGENT_NON_ADHERENT_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
AGENT_NON_RESPONSE
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
UI name: Agent non-response without customer abandons
AGENT_OCCUPANCY
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
AGENT_SCHEDULE_ADHERENCE
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
AGENT_SCHEDULED_TIME
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
AVG_ABANDON_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
Valid metric filter key: INITIATION_METHOD
UI name: Average queue abandon time
AVG_ACTIVE_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
AVG_AFTER_CONTACT_WORK_TIME
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average after contact work time
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent concurrency
AVG_AGENT_CONNECTING_TIME
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
AVG_BOT_CONVERSATION_TIME
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation time
AVG_BOT_CONVERSATION_TURNS
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Average bot conversation turns
AVG_CASE_RELATED_CONTACTS
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
AVG_CASE_RESOLUTION_TIME
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
AVG_CONTACT_DURATION
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average contact duration
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Agent average contact first response wait time
AVG_CONVERSATION_CLOSE_TIME
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average conversation close time
AVG_CONVERSATION_DURATION
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average conversation duration
AVG_DIALS_PER_MINUTE
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile
UI name: Average dials per minute
AVG_EVALUATION_SCORE
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average evaluation score
AVG_FIRST_RESPONSE_TIME_AGENT
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent first response time
AVG_FLOW_TIME
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Average flow time
AVG_GREETING_TIME_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent greeting time
AVG_HANDLE_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Unit: Count
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile
UI name: Active AI Agents
AI_HANDOFF_RATE
Unit: Percent
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: Handoff Rate
AI_HANDOFFS
Unit: Count
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: AI Handoff Count
AI_AGENT_INVOCATION_SUCCESS
Unit: Count
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile
UI name: AI Agent Invocation Success Count
Unit: Percent
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile
UI name: AI Agent Invocation Success Rate
Unit: Count
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Agent Name Version, AI Use Case, Channel, Queue, Routing Profile
UI name: AI Agent Invocation Count
Unit: Percent
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: AI Response Completion Rate
AI_INVOLVED_CONTACTS
Unit: Count
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: AI Contacts
AI_PROMPT_INVOCATION_SUCCESS
Unit: Count
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile
UI name: AI Prompt Invocation Success Count
Unit: Percent
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile
UI name: AI Prompt Invocation Success Rate
Unit: Count
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile
UI name: AI Tool Invocation Count
Unit: Count
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile
UI name: Average AI Agent Conversation Turns
Unit: Count
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: AI Conversation Turns
AVG_AI_PROMPT_INVOCATION_LATENCY
Unit: Milliseconds
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile
UI name: Average AI Prompt Invocation Latency
Unit: Milliseconds
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile
UI name: Average AI Tool Invocation Latency
Unit: Count
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Use Case, Channel, Knowledge Base Name, Queue, Routing Profile
UI name: KnowledgeBase Reference Count
PROACTIVE_INTENT_ENGAGEMENT_RATE
Unit: Percent
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: Proactive Intent Engagement Rate
PROACTIVE_INTENT_RESPONSE_RATE
Unit: Percent
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: Proactive Intent Response Rate
PROACTIVE_INTENTS_ANSWERED
Unit: Count
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: Proactive Intents Answered
PROACTIVE_INTENTS_DETECTED
Unit: Count
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: Proactive Intents Detected
Unit:
Valid groupings and filters:
UI name:
Unit:
Valid groupings and filters:
UI name:
PROACTIVE_INTENTS_ENGAGED
Unit: Count
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile
UI name: UI name:
AVG_HOLD_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer hold time all contacts
AVG_HOLDS
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average holds
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction and customer hold time
AVG_INTERACTION_TIME
Unit: Seconds
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interaction time
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruptions
AVG_INTERRUPTION_TIME_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent interruption time
AVG_MESSAGE_LENGTH_AGENT
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent message length
AVG_MESSAGE_LENGTH_CUSTOMER
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer message length
AVG_MESSAGES
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average messages
AVG_MESSAGES_AGENT
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent messages
AVG_MESSAGES_BOT
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average bot messages
AVG_MESSAGES_CUSTOMER
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer messages
AVG_NON_TALK_TIME
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average non-talk time
AVG_QUEUE_ANSWER_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Valid metric level filters: INITIATION_METHOD, FEATURE, DISCONNECT_REASON
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy
UI name: Avg. queue answer time - customer first callback
AVG_RESPONSE_TIME_AGENT
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average agent response time
AVG_RESPONSE_TIME_CUSTOMER
Unit: Seconds
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Average customer response time
AVG_RESOLUTION_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
AVG_TALK_TIME
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average talk time
AVG_TALK_TIME_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average agent talk time
AVG_TALK_TIME_CUSTOMER
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average customer talk time
AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.
Unit: Seconds
Valid groupings and filters: Campaign
UI name: Average wait time after customer connection
AVG_WAIT_TIME_AFTER_CUSTOMER_FIRST_CALLBACK_CONNECTION
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy
UI name: Avg. wait time after customer connection - customer first callback
AVG_WEIGHTED_EVALUATION_SCORE
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Average weighted evaluation score
BOT_CONVERSATIONS_COMPLETED
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot conversations completed
BOT_INTENTS_COMPLETED
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Bot intents completed
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Count
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X
CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.
Unit: Percent
Valid groupings and filters: Agent, Campaign
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter GT (for Greater than).
UI name: Campaign contacts abandoned after X rate
CAMPAIGN_INTERACTIONS
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
CAMPAIGN_PROGRESS_RATE
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Percent
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Campaign progress rate
CAMPAIGN_SEND_ATTEMPTS
This metric is available only for outbound campaigns.
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype
UI name: Campaign send attempts
CAMPAIGN_SEND_EXCLUSIONS
This metric is available only for outbound campaigns.
Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE
Unit: Count
Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp
UI name: Campaign send exclusions
CASES_CREATED
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
CONTACTS_CREATED
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts created
Unit: Count
Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contacts handled
Unit: Count
Valid metric filter key: INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts handled (connected to agent timestamp)
CONTACTS_HOLD_ABANDONS
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts hold disconnect
CONTACTS_ON_HOLD_AGENT_DISCONNECT
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
CONTACTS_PUT_ON_HOLD
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
CONTACTS_TRANSFERRED_OUT_EXTERNAL
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
CONTACTS_TRANSFERRED_OUT_INTERNAL
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
CONTACTS_QUEUED
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
CONTACTS_QUEUED_BY_ENQUEUE
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
CONTACTS_REMOVED_FROM_QUEUE_IN_X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").
UI name: Contacts removed from queue in X seconds
CONTACTS_RESOLVED_IN_X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").
UI name: Contacts resolved in X
CONTACTS_TRANSFERRED_OUT
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out by agent
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts transferred out queue
CURRENT_CASES
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
CONVERSATIONS_ABANDONED
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect
UI name: Conversations abandoned
DELIVERY_ATTEMPTS
This metric is available only for outbound campaigns.
Unit: Count
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempts
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Percent
Valid metric filter key: ANSWERING_MACHINE_DETECTION_STATUS, CAMPAIGN_DELIVERY_EVENT_TYPE, DISCONNECT_REASON
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile
UI name: Delivery attempt disposition rate
Unit: Count
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Evaluations performed
FLOWS_OUTCOME
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome
FLOWS_STARTED
Unit: Count
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows started
HUMAN_ANSWERED_CALLS
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.
Unit: Count
Valid groupings and filters: Agent, Campaign
UI name: Human answered
MAX_FLOW_TIME
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Maximum flow time
MAX_QUEUED_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Maximum queued time
MIN_FLOW_TIME
Unit: Seconds
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Minimum flow time
PERCENT_AUTOMATIC_FAILS
Unit: Percent
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile
UI name: Automatic fails percent
PERCENT_BOT_CONVERSATIONS_OUTCOME
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot conversations outcome
PERCENT_BOT_INTENTS_OUTCOME
Unit: Percent
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID
UI name: Percent bot intents outcome
PERCENT_CASES_FIRST_CONTACT_RESOLVED
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
PERCENT_CONTACTS_STEP_EXPIRED
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
PERCENT_CONTACTS_STEP_JOINED
Unit: Percent
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
PERCENT_FLOWS_OUTCOME
Unit: Percent
Valid metric filter key: FLOWS_OUTCOME_TYPE
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp
UI name: Flows outcome percentage.
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Non-talk time percent
PERCENT_TALK_TIME
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Talk time percent
PERCENT_TALK_TIME_AGENT
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Agent talk time percent
PERCENT_TALK_TIME_CUSTOMER
This metric is available only for contacts analyzed by Contact Lens conversational analytics.
Unit: Percentage
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Customer talk time percent
RECIPIENTS_ATTEMPTED
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Count
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Recipients attempted
RECIPIENTS_INTERACTED
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Unit: Count
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp
UI name: Recipients interacted
RECIPIENTS_TARGETED
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.
Unit: Count
Valid groupings and filters: Campaign, Campaign Execution Timestamp
UI name: Recipients targeted
REOPENED_CASE_ACTIONS
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
RESOLVED_CASE_ACTIONS
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
SERVICE_LEVEL
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").
UI name: Service level X
STEP_CONTACTS_QUEUED
Unit: Count
Valid groupings and filters: Queue, RoutingStepExpression
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.
SUM_AFTER_CONTACT_WORK_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
SUM_CONNECTING_TIME_AGENT
Unit: Seconds
Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API | CALLBACK_CUSTOMER_FIRST_DIALED
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
Unit: Count
Metric filter:
Valid values: API``| ``INCOMING | OUTBOUND | TRANSFER | CALLBACK | QUEUE_TRANSFER``| ``Disconnect | CALLBACK_CUSTOMER_FIRST_DIALED
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
SUM_CONTACTS_ABANDONED_IN_X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").
UI name: Contacts abandoned in X seconds
SUM_CONTACTS_ANSWERED_IN_X
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you can use LT (for "Less than") or LTE (for "Less than equal").
UI name: Contacts answered in X seconds
SUM_CONTACT_FLOW_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
SUM_CONTACT_TIME_AGENT
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
SUM_CONTACTS_DISCONNECTED
Valid metric filter key: DISCONNECT_REASON
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contact disconnected
SUM_ERROR_STATUS_TIME_AGENT
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
SUM_HANDLE_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
SUM_HOLD_TIME
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
SUM_IDLE_TIME_AGENT
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
SUM_INTERACTION_AND_HOLD_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
SUM_INTERACTION_TIME
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
SUM_NON_PRODUCTIVE_TIME_AGENT
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-productive time
SUM_ONLINE_TIME_AGENT
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
SUM_RETRY_CALLBACK_ATTEMPTS
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
(dict) --
Contains information about the metric.
Name (string) --
The name of the metric.
Threshold (list) --
Contains information about the threshold for service level metrics.
(dict) --
Contains information about the threshold for service level metrics.
Comparison (string) --
The type of comparison. Currently, "less than" (LT), "less than equal" (LTE), and "greater than" (GT) comparisons are supported.
ThresholdValue (float) --
The threshold value to compare.
MetricId (string) --
Historical metrics or custom metrics can be referenced via this field. This field is a valid Amazon Connect Arn or a UUID
MetricFilters (list) --
Contains the filters to be used when returning data.
(dict) --
Contains information about the filter used when retrieving metrics. MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME, CONTACTS_CREATED, CONTACTS_HANDLED, SUM_CONTACTS_DISCONNECTED.
MetricFilterKey (string) --
The key to use for filtering data.
Valid metric filter keys:
ANSWERING_MACHINE_DETECTION_STATUS
CASE_STATUS
DISCONNECT_REASON
FLOWS_ACTION_IDENTIFIER
FLOWS_NEXT_ACTION_IDENTIFIER
FLOWS_OUTCOME_TYPE
FLOWS_RESOURCE_TYPE
INITIATION_METHOD
MetricFilterValues (list) --
The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
(string) --
Negate (boolean) --
If set to true, the API response contains results that filter out the results matched by the metric-level filters condition. By default, Negate is set to false.
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
{
'NextToken': 'string',
'MetricResults': [
{
'Dimensions': {
'string': 'string'
},
'MetricInterval': {
'Interval': 'FIFTEEN_MIN'|'THIRTY_MIN'|'HOUR'|'DAY'|'WEEK'|'TOTAL',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
'Collections': [
{
'Metric': {
'Name': 'string',
'Threshold': [
{
'Comparison': 'string',
'ThresholdValue': 123.0
},
],
'MetricId': 'string',
'MetricFilters': [
{
'MetricFilterKey': 'string',
'MetricFilterValues': [
'string',
],
'Negate': True|False
},
]
},
'Value': 123.0
},
]
},
]
}
Response Structure
(dict) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
MetricResults (list) --
Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.
(dict) --
Contains information about the metric results.
Dimensions (dict) --
The dimension for the metrics.
(string) --
(string) --
MetricInterval (dict) --
The interval period with the start and end time for the metrics.
Interval (string) --
The interval period provided in the API request.
StartTime (datetime) --
The timestamp, in UNIX Epoch time format. Start time is based on the interval period selected.
EndTime (datetime) --
The timestamp, in UNIX Epoch time format. End time is based on the interval period selected. For example, If IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime in the API request differs by 1 day, then 48 results are returned in the response. Each result is aggregated by the 30 minutes period, with each StartTime and EndTime differing by 30 minutes.
Collections (list) --
The set of metrics.
(dict) --
Contains the name, thresholds, and metric filters.
Metric (dict) --
The metric name or metricId, thresholds, and metric filters of the returned metric.
Name (string) --
The name of the metric.
Threshold (list) --
Contains information about the threshold for service level metrics.
(dict) --
Contains information about the threshold for service level metrics.
Comparison (string) --
The type of comparison. Currently, "less than" (LT), "less than equal" (LTE), and "greater than" (GT) comparisons are supported.
ThresholdValue (float) --
The threshold value to compare.
MetricId (string) --
Historical metrics or custom metrics can be referenced via this field. This field is a valid Amazon Connect Arn or a UUID
MetricFilters (list) --
Contains the filters to be used when returning data.
(dict) --
Contains information about the filter used when retrieving metrics. MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME, CONTACTS_CREATED, CONTACTS_HANDLED, SUM_CONTACTS_DISCONNECTED.
MetricFilterKey (string) --
The key to use for filtering data.
Valid metric filter keys:
ANSWERING_MACHINE_DETECTION_STATUS
CASE_STATUS
DISCONNECT_REASON
FLOWS_ACTION_IDENTIFIER
FLOWS_NEXT_ACTION_IDENTIFIER
FLOWS_OUTCOME_TYPE
FLOWS_RESOURCE_TYPE
INITIATION_METHOD
MetricFilterValues (list) --
The values to use for filtering data. Values for metric-level filters can be either a fixed set of values or a customized list, depending on the use case.
For valid values of metric-level filters INITIATION_METHOD, DISCONNECT_REASON, and ANSWERING_MACHINE_DETECTION_STATUS, see ContactTraceRecord in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter FLOWS_OUTCOME_TYPE, see the description for the Flow outcome metric in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_CONVERSATION_OUTCOME_TYPE, see the description for the Bot conversations completed in the Amazon Connect Administrator Guide.
For valid values of the metric-level filter BOT_INTENT_OUTCOME_TYPE, see the description for the Bot intents completed metric in the Amazon Connect Administrator Guide.
(string) --
Negate (boolean) --
If set to true, the API response contains results that filter out the results matched by the metric-level filters condition. By default, Negate is set to false.
Value (float) --
The corresponding value of the metric returned in the response.
{'EvaluationSummaryList': {'ContactParticipant': {'ContactParticipantId': 'string',
'ContactParticipantRole': 'AGENT '
'| '
'SYSTEM '
'| '
'CUSTOM_BOT'},
'Score': {'AppliedWeight': 'double'}}}
Lists contact evaluations in the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_contact_evaluations(
InstanceId='string',
ContactId='string',
NextToken='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 contact in this instance of Amazon Connect.
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.
dict
Response Syntax
{
'EvaluationSummaryList': [
{
'EvaluationId': 'string',
'EvaluationArn': 'string',
'EvaluationFormTitle': 'string',
'EvaluationFormId': 'string',
'CalibrationSessionId': 'string',
'Status': 'DRAFT'|'SUBMITTED',
'AutoEvaluationEnabled': True|False,
'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'EvaluatorArn': 'string',
'Score': {
'Percentage': 123.0,
'NotApplicable': True|False,
'AutomaticFail': True|False,
'AppliedWeight': 123.0
},
'Acknowledgement': {
'AcknowledgedTime': datetime(2015, 1, 1),
'AcknowledgedBy': 'string',
'AcknowledgerComment': 'string'
},
'EvaluationType': 'STANDARD'|'CALIBRATION',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'ContactParticipant': {
'ContactParticipantRole': 'AGENT'|'SYSTEM'|'CUSTOM_BOT',
'ContactParticipantId': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EvaluationSummaryList (list) --
Provides details about a list of contact evaluations belonging to an instance.
(dict) --
Summary information about a contact evaluation.
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
EvaluationFormTitle (string) --
A title of the evaluation form.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
CalibrationSessionId (string) --
The calibration session ID that this evaluation belongs to.
Status (string) --
The status of the contact evaluation.
AutoEvaluationEnabled (boolean) --
Whether automated evaluation is enabled.
AutoEvaluationStatus (string) --
The status of the contact auto evaluation.
EvaluatorArn (string) --
The Amazon Resource Name (ARN) of the user who last updated the evaluation.
Score (dict) --
The overall score of the contact evaluation.
Percentage (float) --
The score percentage for an item in a contact evaluation.
NotApplicable (boolean) --
The flag to mark the item as not applicable for scoring.
AutomaticFail (boolean) --
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag will be true.
AppliedWeight (float) --
Weight applied to this evaluation score.
Acknowledgement (dict) --
Information related to evaluation acknowledgement.
AcknowledgedTime (datetime) --
The time when an agent acknowledged the evaluation.
AcknowledgedBy (string) --
The agent who acknowledged the evaluation.
AcknowledgerComment (string) --
A comment from the agent when they confirmed they acknowledged the evaluation.
EvaluationType (string) --
Type of the evaluation.
CreatedTime (datetime) --
The timestamp for when the evaluation was created.
LastModifiedTime (datetime) --
The timestamp for when the evaluation was last updated.
ContactParticipant (dict) --
Information about a contact participant in the evaluation.
ContactParticipantRole (string) --
The role of the contact participant.
ContactParticipantId (string) --
The identifier for the contact participant.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'ReferenceTypes': {'EMAIL_MESSAGE_PLAIN_TEXT'}}
Response {'ReferenceSummaryList': {'EmailMessagePlainText': {'Arn': 'string',
'Name': 'string'}}}
This API is in preview release for Amazon Connect and is subject to change.
For the specified referenceTypes, returns a list of references associated with the contact. References are links to documents that are related to a contact, such as emails, attachments, or URLs.
See also: AWS API Documentation
Request Syntax
client.list_contact_references(
InstanceId='string',
ContactId='string',
ReferenceTypes=[
'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
],
NextToken='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 initial contact.
list
[REQUIRED]
The type of reference.
(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.
dict
Response Syntax
{
'ReferenceSummaryList': [
{
'Url': {
'Name': 'string',
'Value': 'string'
},
'Attachment': {
'Name': 'string',
'Value': 'string',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string'
},
'EmailMessage': {
'Name': 'string',
'Arn': 'string'
},
'EmailMessagePlainText': {
'Name': 'string',
'Arn': 'string'
},
'String': {
'Name': 'string',
'Value': 'string'
},
'Number': {
'Name': 'string',
'Value': 'string'
},
'Date': {
'Name': 'string',
'Value': 'string'
},
'Email': {
'Name': 'string',
'Value': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ReferenceSummaryList (list) --
Information about the flows.
(dict) --
Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.
Url (dict) --
Information about the reference when the referenceType is URL. Otherwise, null.
Name (string) --
Identifier of the URL reference.
Value (string) --
A valid URL.
Attachment (dict) --
Information about the reference when the referenceType is ATTACHMENT. Otherwise, null.
Name (string) --
Identifier of the attachment reference.
Value (string) --
The location path of the attachment reference.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the attachment reference.
EmailMessage (dict) --
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Name (string) --
The name of the email message reference
Arn (string) --
The Amazon Resource Name (ARN) of the email message reference
EmailMessagePlainText (dict) --
Information about the reference when the referenceType is EMAIL_MESSAGE. Otherwise, null.
Name (string) --
The name of the email message reference
Arn (string) --
The Amazon Resource Name (ARN) of the email message reference
String (dict) --
Information about a reference when the referenceType is STRING. Otherwise, null.
Name (string) --
Identifier of the string reference.
Value (string) --
A valid string.
Number (dict) --
Information about a reference when the referenceType is NUMBER. Otherwise, null.
Name (string) --
Identifier of the number reference.
Value (string) --
A valid number.
Date (dict) --
Information about a reference when the referenceType is DATE. Otherwise, null.
Name (string) --
Identifier of the date reference.
Value (string) --
A valid date.
Email (dict) --
Information about a reference when the referenceType is EMAIL. Otherwise, null.
Name (string) --
Identifier of the email reference.
Value (string) --
A valid email address.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'Attributes': {'AttributeType': {'MESSAGE_STREAMING'}}}
This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
See also: AWS API Documentation
Request Syntax
client.list_instance_attributes(
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.
dict
Response Syntax
{
'Attributes': [
{
'AttributeType': 'INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE'|'MESSAGE_STREAMING',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Attributes (list) --
The attribute types.
(dict) --
A toggle for an individual feature at the instance level.
AttributeType (string) --
The type of attribute.
Value (string) --
The value of the attribute.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'IntegrationType': {'MESSAGE_PROCESSOR'}}
Response {'IntegrationAssociationSummaryList': {'IntegrationType': {'MESSAGE_PROCESSOR'}}}
Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
See also: AWS API Documentation
Request Syntax
client.list_integration_associations(
InstanceId='string',
IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR'|'COGNITO_USER_POOL'|'MESSAGE_PROCESSOR',
NextToken='string',
MaxResults=123,
IntegrationArn='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
The integration type.
string
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
integer
The maximum number of results to return per page.
string
The Amazon Resource Name (ARN) of the integration.
dict
Response Syntax
{
'IntegrationAssociationSummaryList': [
{
'IntegrationAssociationId': 'string',
'IntegrationAssociationArn': 'string',
'InstanceId': 'string',
'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR'|'COGNITO_USER_POOL'|'MESSAGE_PROCESSOR',
'IntegrationArn': 'string',
'SourceApplicationUrl': 'string',
'SourceApplicationName': 'string',
'SourceType': 'SALESFORCE'|'ZENDESK'|'CASES'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
IntegrationAssociationSummaryList (list) --
The associations.
(dict) --
Contains summary information about the associated AppIntegrations.
IntegrationAssociationId (string) --
The identifier for the AppIntegration association.
IntegrationAssociationArn (string) --
The Amazon Resource Name (ARN) for the AppIntegration association.
InstanceId (string) --
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
IntegrationType (string) --
The integration type.
IntegrationArn (string) --
The Amazon Resource Name (ARN) for the AppIntegration.
SourceApplicationUrl (string) --
The URL for the external application.
SourceApplicationName (string) --
The user-provided, friendly name for the external application.
SourceType (string) --
The name of the source.
NextToken (string) --
If there are additional results, this is the token for the next set of results.
{'QuickConnectSummaryList': {'QuickConnectType': {'FLOW'}}}
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'|'FLOW',
'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 admin website, 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.
{'QuickConnectTypes': {'FLOW'}}
Response {'QuickConnectSummaryList': {'QuickConnectType': {'FLOW'}}}
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'|'FLOW',
]
)
string
[REQUIRED]
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. Both Instance ID and Instance ARN are supported input formats.
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 admin website, 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'|'FLOW',
'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 admin website, 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.
{'Applications': {'Type': 'MCP | THIRD_PARTY_APPLICATION'}}
Returns a list of third-party applications or MCP Servers 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',
],
'Type': 'MCP'|'THIRD_PARTY_APPLICATION'
},
],
'NextToken': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
}
Response Structure
(dict) --
Applications (list) --
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. For third-party applications, only the ACCESS permission is supported. For MCP Servers, the permissions are tool Identifiers accepted by MCP Server.
(string) --
Type (string) --
Type of Application.
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.
{'EvaluationSearchSummaryList': {'EvaluationFormTitle': 'string',
'Metadata': {'ContactParticipantId': 'string',
'ContactParticipantRole': 'AGENT '
'| '
'SYSTEM '
'| '
'CUSTOM_BOT',
'ReviewId': 'string',
'SamplingJobId': 'string'}}}
Searches contact evaluations in an Amazon Connect instance, with optional filtering.
Use cases
Following are common uses cases for this API:
Find contact evaluations by using specific search criteria.
Find contact evaluations that are tagged with a specific set of tags.
Important things to know
A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds. Contact Evaluations may not be fully backfilled with historical data in all regions yet, however all recently created Contact Evaluations should be available for search.
Endpoints: See Amazon Connect endpoints and quotas.
See also: AWS API Documentation
Request Syntax
client.search_contact_evaluations(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'NumberCondition': {
'FieldName': 'string',
'MinValue': 123,
'MaxValue': 123,
'ComparisonType': 'GREATER_OR_EQUAL'|'GREATER'|'LESSER_OR_EQUAL'|'LESSER'|'EQUAL'|'NOT_EQUAL'|'RANGE'
},
'BooleanCondition': {
'FieldName': 'string',
'ComparisonType': 'IS_TRUE'|'IS_FALSE'
},
'DateTimeCondition': {
'FieldName': 'string',
'MinValue': 'string',
'MaxValue': 'string',
'ComparisonType': 'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'RANGE'
},
'DecimalCondition': {
'FieldName': 'string',
'MinValue': 123.0,
'MaxValue': 123.0,
'ComparisonType': 'GREATER_OR_EQUAL'|'GREATER'|'LESSER_OR_EQUAL'|'LESSER'|'EQUAL'|'NOT_EQUAL'|'RANGE'
}
},
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
'TagCondition': {
'TagKey': 'string',
'TagValue': '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
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
The search criteria to be used to return contact evaluations.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return evaluations.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return evaluations.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
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.
NumberCondition (dict) --
A leaf node condition which can be used to specify a numeric condition.
FieldName (string) --
The name of the field in the number condition.
MinValue (integer) --
The minValue to be used while evaluating the number condition.
MaxValue (integer) --
The maxValue to be used while evaluating the number condition.
ComparisonType (string) --
The type of comparison to be made when evaluating the number condition.
BooleanCondition (dict) --
The boolean condition search criteria for searching evaluations.
FieldName (string) --
A name of the property to be searched.
ComparisonType (string) --
Boolean property comparison type.
DateTimeCondition (dict) --
The datetime condition search criteria for searching evaluations.
FieldName (string) --
A name of the datetime property to be searched
MinValue (string) --
A minimum value of the property.
MaxValue (string) --
A maximum value of the property.
ComparisonType (string) --
Datetime property comparison type.
DecimalCondition (dict) --
The decimal condition search criteria for searching evaluations.
FieldName (string) --
A name of the decimal property to be searched.
MinValue (float) --
A minimum value of the decimal property.
MaxValue (float) --
A maximum value of the decimal property.
ComparisonType (string) --
The type of comparison to be made when evaluating the decimal condition.
dict
Filters to be applied to search results.
AttributeFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The 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.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
Response Syntax
{
'EvaluationSearchSummaryList': [
{
'EvaluationId': 'string',
'EvaluationArn': 'string',
'EvaluationFormId': 'string',
'EvaluationFormVersion': 123,
'EvaluationFormTitle': 'string',
'Metadata': {
'ContactId': 'string',
'EvaluatorArn': 'string',
'ContactAgentId': 'string',
'CalibrationSessionId': 'string',
'ScorePercentage': 123.0,
'ScoreAutomaticFail': True|False,
'ScoreNotApplicable': True|False,
'AutoEvaluationEnabled': True|False,
'AutoEvaluationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
'AcknowledgedTime': datetime(2015, 1, 1),
'AcknowledgedBy': 'string',
'AcknowledgerComment': 'string',
'SamplingJobId': 'string',
'ReviewId': 'string',
'ContactParticipantRole': 'AGENT'|'SYSTEM'|'CUSTOM_BOT',
'ContactParticipantId': 'string'
},
'Status': 'DRAFT'|'SUBMITTED',
'EvaluationType': 'STANDARD'|'CALIBRATION',
'CreatedTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
EvaluationSearchSummaryList (list) --
Contains information about contact evaluations.
(dict) --
Summary of evaluation obtained from the search operation.
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormVersion (integer) --
A version of the evaluation form.
EvaluationFormTitle (string) --
Title of the evaluation form.
Metadata (dict) --
Summary information about the evaluation search.
ContactId (string) --
The identifier of the contact in this instance of Amazon Connect.
EvaluatorArn (string) --
The Amazon Resource Name (ARN) of the person who evaluated the contact.
ContactAgentId (string) --
The unique ID of the agent who handled the contact.
CalibrationSessionId (string) --
The calibration session ID that this evaluation belongs to.
ScorePercentage (float) --
The total evaluation score expressed as a percentage.
ScoreAutomaticFail (boolean) --
The flag that marks the item as automatic fail. If the item or a child item gets an automatic fail answer, this flag is true.
ScoreNotApplicable (boolean) --
The flag to mark the item as not applicable for scoring.
AutoEvaluationEnabled (boolean) --
Whether auto-evaluation is enabled.
AutoEvaluationStatus (string) --
The status of the contact auto evaluation.
AcknowledgedTime (datetime) --
When the evaluation was acknowledged by the agent.
AcknowledgedBy (string) --
The agent who acknowledged the evaluation.
AcknowledgerComment (string) --
The comment from the agent when they acknowledged the evaluation.
SamplingJobId (string) --
Identifier of the sampling job.
ReviewId (string) --
Identifier for the review.
ContactParticipantRole (string) --
Role of a contact participant in the evaluation.
ContactParticipantId (string) --
Identifier for a contact participant in the evaluation.
Status (string) --
The status of the evaluation.
EvaluationType (string) --
Type of the evaluation.
CreatedTime (datetime) --
The date and time when the evaluation was created, in UTC time.
LastModifiedTime (datetime) --
The date and time when the evaluation was modified last time, in UTC time.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of contact evaluations that matched your search query.
{'SearchFilter': {'FlowAttributeFilter': {'AndCondition': {'ContactFlowTypeCondition': {'ContactFlowType': 'CONTACT_FLOW '
'| '
'CUSTOMER_QUEUE '
'| '
'CUSTOMER_HOLD '
'| '
'CUSTOMER_WHISPER '
'| '
'AGENT_HOLD '
'| '
'AGENT_WHISPER '
'| '
'OUTBOUND_WHISPER '
'| '
'AGENT_TRANSFER '
'| '
'QUEUE_TRANSFER '
'| '
'CAMPAIGN'},
'TagConditions': [{'TagKey': 'string',
'TagValue': 'string'}]},
'ContactFlowTypeCondition': {'ContactFlowType': 'CONTACT_FLOW '
'| '
'CUSTOMER_QUEUE '
'| '
'CUSTOMER_HOLD '
'| '
'CUSTOMER_WHISPER '
'| '
'AGENT_HOLD '
'| '
'AGENT_WHISPER '
'| '
'OUTBOUND_WHISPER '
'| '
'AGENT_TRANSFER '
'| '
'QUEUE_TRANSFER '
'| '
'CAMPAIGN'},
'OrConditions': [{'ContactFlowTypeCondition': {'ContactFlowType': 'CONTACT_FLOW '
'| '
'CUSTOMER_QUEUE '
'| '
'CUSTOMER_HOLD '
'| '
'CUSTOMER_WHISPER '
'| '
'AGENT_HOLD '
'| '
'AGENT_WHISPER '
'| '
'OUTBOUND_WHISPER '
'| '
'AGENT_TRANSFER '
'| '
'QUEUE_TRANSFER '
'| '
'CAMPAIGN'},
'TagConditions': [{'TagKey': 'string',
'TagValue': 'string'}]}],
'TagCondition': {'TagKey': 'string',
'TagValue': 'string'}}}}
Searches the flows in an Amazon Connect instance, with optional filtering.
See also: AWS API Documentation
Request Syntax
client.search_contact_flows(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchFilter={
'TagFilter': {
'OrConditions': [
[
{
'TagKey': 'string',
'TagValue': 'string'
},
],
],
'AndConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
}
},
'FlowAttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'ContactFlowTypeCondition': {
'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN'
}
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
],
'ContactFlowTypeCondition': {
'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN'
}
},
'TagCondition': {
'TagKey': 'string',
'TagValue': 'string'
},
'ContactFlowTypeCondition': {
'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN'
}
}
},
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'TypeCondition': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN',
'StateCondition': 'ACTIVE'|'ARCHIVED',
'StatusCondition': 'PUBLISHED'|'SAVED'
}
)
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.
FlowAttributeFilter (dict) --
Flow attribute filter for contact flow search operations.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
Tag-based conditions for contact flow filtering.
(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.
ContactFlowTypeCondition (dict) --
Contact flow type condition.
ContactFlowType (string) --
Contact flow type of the contact flow type condition.
AndCondition (dict) --
A list of conditions which would be applied together with a AND condition.
TagConditions (list) --
Tag-based conditions for contact flow filtering.
(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.
ContactFlowTypeCondition (dict) --
Contact flow type condition.
ContactFlowType (string) --
Contact flow type of the contact flow type condition.
TagCondition (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.
ContactFlowTypeCondition (dict) --
Contact flow type condition within attribute filter.
ContactFlowType (string) --
Contact flow type of the contact flow type condition.
dict
The search criteria to be used to return flows.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return flows.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return flows.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
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.
TypeCondition (string) --
The type of flow.
StateCondition (string) --
The state of the flow.
StatusCondition (string) --
The status of the flow.
dict
Response Syntax
{
'ContactFlows': [
{
'Arn': 'string',
'Id': 'string',
'Name': 'string',
'Type': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN',
'State': 'ACTIVE'|'ARCHIVED',
'Status': 'PUBLISHED'|'SAVED',
'Description': 'string',
'Content': 'string',
'Tags': {
'string': 'string'
},
'FlowContentSha256': 'string',
'Version': 123,
'VersionDescription': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedRegion': 'string'
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
ContactFlows (list) --
Information about the flows.
(dict) --
Contains information about a flow.
Arn (string) --
The Amazon Resource Name (ARN) of the flow.
Id (string) --
The identifier of the flow.
Name (string) --
The name of the flow.
Type (string) --
The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
State (string) --
The type of flow.
Status (string) --
The status of the flow.
Description (string) --
The description of the flow.
Content (string) --
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
FlowContentSha256 (string) --
Indicates the checksum value of the flow content.
Version (integer) --
The identifier of the flow version.
VersionDescription (string) --
The description of the flow version.
LastModifiedTime (datetime) --
The time at which the flow was last modified.
LastModifiedRegion (string) --
The region in which the flow 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 flows which matched your search query.
{'EvaluationFormSearchSummaryList': {'ContactInteractionType': 'AGENT | '
'AUTOMATED',
'EvaluationFormLanguage': 'de-DE | en-US '
'| es-ES | '
'fr-FR | it-IT '
'| pt-BR'}}
Searches evaluation forms in an Amazon Connect instance, with optional filtering.
Use cases
Following are common uses cases for this API:
List all evaluation forms in an instance.
Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more.
Find all evaluation forms that are tagged with a specific set of tags.
Important things to know
A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.
Endpoints: See Amazon Connect endpoints and quotas.
See also: AWS API Documentation
Request Syntax
client.search_evaluation_forms(
InstanceId='string',
NextToken='string',
MaxResults=123,
SearchCriteria={
'OrConditions': [
{'... recursive ...'},
],
'AndConditions': [
{'... recursive ...'},
],
'StringCondition': {
'FieldName': 'string',
'Value': 'string',
'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
},
'NumberCondition': {
'FieldName': 'string',
'MinValue': 123,
'MaxValue': 123,
'ComparisonType': 'GREATER_OR_EQUAL'|'GREATER'|'LESSER_OR_EQUAL'|'LESSER'|'EQUAL'|'NOT_EQUAL'|'RANGE'
},
'BooleanCondition': {
'FieldName': 'string',
'ComparisonType': 'IS_TRUE'|'IS_FALSE'
},
'DateTimeCondition': {
'FieldName': 'string',
'MinValue': 'string',
'MaxValue': 'string',
'ComparisonType': 'GREATER_THAN'|'LESS_THAN'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'EQUAL_TO'|'RANGE'
}
},
SearchFilter={
'AttributeFilter': {
'OrConditions': [
{
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
],
'AndCondition': {
'TagConditions': [
{
'TagKey': 'string',
'TagValue': 'string'
},
]
},
'TagCondition': {
'TagKey': 'string',
'TagValue': '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
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
The search criteria to be used to return evaluation forms.
OrConditions (list) --
A list of conditions which would be applied together with an OR condition.
(dict) --
The search criteria to be used to return evaluation forms.
AndConditions (list) --
A list of conditions which would be applied together with an AND condition.
(dict) --
The search criteria to be used to return evaluation forms.
StringCondition (dict) --
A leaf node condition which can be used to specify a string condition.
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.
NumberCondition (dict) --
A leaf node condition which can be used to specify a numeric condition.
FieldName (string) --
The name of the field in the number condition.
MinValue (integer) --
The minValue to be used while evaluating the number condition.
MaxValue (integer) --
The maxValue to be used while evaluating the number condition.
ComparisonType (string) --
The type of comparison to be made when evaluating the number condition.
BooleanCondition (dict) --
Boolean search condition.
FieldName (string) --
A name of the property to be searched.
ComparisonType (string) --
Boolean property comparison type.
DateTimeCondition (dict) --
Datetime search condition.
FieldName (string) --
A name of the datetime property to be searched
MinValue (string) --
A minimum value of the property.
MaxValue (string) --
A maximum value of the property.
ComparisonType (string) --
Datetime property comparison type.
dict
Filters to be applied to search results.
AttributeFilter (dict) --
An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR or AND (List of List) input where:
The top level list specifies conditions that need to be applied with OR operator.
The 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.
(dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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.
AndCondition (dict) --
A list of conditions which would be applied together with an AND condition.
TagConditions (list) --
A leaf node condition which can be used to specify a tag 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, for example, HAVE BPO = 123.
TagKey (string) --
The tag key in the tag condition.
TagValue (string) --
The tag value in the tag condition.
dict
Response Syntax
{
'EvaluationFormSearchSummaryList': [
{
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string',
'Title': 'string',
'Status': 'DRAFT'|'ACTIVE',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastModifiedTime': datetime(2015, 1, 1),
'LastModifiedBy': 'string',
'LastActivatedTime': datetime(2015, 1, 1),
'LastActivatedBy': 'string',
'LatestVersion': 123,
'ActiveVersion': 123,
'AutoEvaluationEnabled': True|False,
'EvaluationFormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR',
'ContactInteractionType': 'AGENT'|'AUTOMATED',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string',
'ApproximateTotalCount': 123
}
Response Structure
(dict) --
EvaluationFormSearchSummaryList (list) --
Information about the returned evaluation forms.
(dict) --
Information about the returned evaluation forms.
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the evaluation form resource.
Title (string) --
The title of the evaluation form.
Status (string) --
The status of the evaluation form.
Description (string) --
The description of the evaluation form.
CreatedTime (datetime) --
When the evaluation form was created.
CreatedBy (string) --
Who created the evaluation form.
LastModifiedTime (datetime) --
When the evaluation form was last changed.
LastModifiedBy (string) --
Who changed the evaluation form.
LastActivatedTime (datetime) --
When the evaluation format was last activated.
LastActivatedBy (string) --
The ID of user who last activated evaluation form.
LatestVersion (integer) --
Latest version of the evaluation form.
ActiveVersion (integer) --
Active version of the evaluation form.
AutoEvaluationEnabled (boolean) --
Whether automated evaluation is enabled.
EvaluationFormLanguage (string) --
The language of the evaluation form.
ContactInteractionType (string) --
The contact interaction type for this evaluation form.
Tags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
(string) --
(string) --
NextToken (string) --
If there are additional results, this is the token for the next set of results.
ApproximateTotalCount (integer) --
The total number of evaluation forms that matched your search query.
{'QuickConnects': {'QuickConnectConfig': {'FlowConfig': {'ContactFlowId': 'string'},
'QuickConnectType': {'FLOW'}}}}
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.
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'|'FLOW',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
},
'FlowConfig': {
'ContactFlowId': '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 admin website, 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.
FlowConfig (dict) --
Flow configuration for quick connect setup.
ContactFlowId (string) --
The contact flow ID for the quick connect configuration.
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.
{'ParticipantConfiguration': {'ResponseMode': 'INCREMENTAL | COMPLETE'}}
Initiates a 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 must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in the following situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.
For more information about chat, see the following topics in the Amazon Connect Administrator Guide:
See also: AWS API Documentation
Request Syntax
client.start_chat_contact(
InstanceId='string',
ContactFlowId='string',
Attributes={
'string': 'string'
},
ParticipantDetails={
'DisplayName': 'string'
},
ParticipantConfiguration={
'ResponseMode': 'INCREMENTAL'|'COMPLETE'
},
InitialMessage={
'ContentType': 'string',
'Content': 'string'
},
ClientToken='string',
ChatDurationInMinutes=123,
SupportedMessagingContentTypes=[
'string',
],
PersistentChat={
'RehydrationType': 'ENTIRE_PAST_SESSION'|'FROM_SEGMENT',
'SourceContactId': 'string'
},
RelatedContactId='string',
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
CustomerId='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 flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in 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.
(string) --
(string) --
dict
[REQUIRED]
Information identifying the participant.
DisplayName (string) -- [REQUIRED]
Display name of the participant.
dict
The configuration of the participant.
ResponseMode (string) --
The mode in which responses should be sent to the participant.
dict
The initial message to be sent to the newly created chat.
ContentType (string) -- [REQUIRED]
The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.
Content (string) -- [REQUIRED]
The content of the chat message.
For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
integer
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).
list
The supported chat message content types. Supported types are text/plain, text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and application/vnd.amazonaws.connect.message.interactive.response.
Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain: [text/plain, text/markdown, application/json], [text/markdown, text/plain], [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response].
(string) --
dict
Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
RehydrationType (string) --
The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.
ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat.
FROM_SEGMENT: Rehydrates a chat from the past chat contact that is specified in the sourceContactId field.
The actual contactId used for rehydration is provided in the response of this API.
SourceContactId (string) --
The contactId from which a persistent chat session must be started.
string
The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.
dict
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
string
The customer's identification number. For example, the CustomerId may be a customer number from your CRM.
dict
Response Syntax
{
'ContactId': 'string',
'ParticipantId': 'string',
'ParticipantToken': 'string',
'ContinuedFromContactId': '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.
ContinuedFromContactId (string) --
The contactId from which a persistent chat session is started. This field is populated only for persistent chats.
{'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}
Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.
See also: AWS API Documentation
Request Syntax
client.start_email_contact(
InstanceId='string',
FromEmailAddress={
'EmailAddress': 'string',
'DisplayName': 'string'
},
DestinationEmailAddress='string',
Description='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
},
Name='string',
EmailMessage={
'MessageSourceType': 'RAW',
'RawMessage': {
'Subject': 'string',
'Body': 'string',
'ContentType': 'string',
'Headers': {
'string': 'string'
}
}
},
AdditionalRecipients={
'ToAddresses': [
{
'EmailAddress': 'string',
'DisplayName': 'string'
},
],
'CcAddresses': [
{
'EmailAddress': 'string',
'DisplayName': 'string'
},
]
},
Attachments=[
{
'FileName': 'string',
'S3Url': 'string'
},
],
ContactFlowId='string',
RelatedContactId='string',
Attributes={
'string': 'string'
},
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
ClientToken='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
[REQUIRED]
The email address of the customer.
EmailAddress (string) -- [REQUIRED]
The email address, including the domain.
DisplayName (string) --
The display name of email address.
string
[REQUIRED]
The email address associated with the Amazon Connect instance.
string
A description of the email contact.
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE. EMAIL | EMAIL_MESSAGE | ATTACHMENT are not a supported reference type during email creation.
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
string
The name of a email that is shown to an agent in the Contact Control Panel (CCP).
dict
[REQUIRED]
The email message body to be sent to the newly created email.
MessageSourceType (string) -- [REQUIRED]
The message source type, that is, RAW.
RawMessage (dict) --
The raw email body content.
Subject (string) -- [REQUIRED]
The email subject.
Body (string) -- [REQUIRED]
The email message body.
ContentType (string) -- [REQUIRED]
Type of content, that is, text/plain or text/html.
Headers (dict) --
Headers present in inbound email.
(string) --
(string) --
dict
The additional recipients address of the email.
ToAddresses (list) --
The additional recipients information present in to list. You must have 1 required recipient ( DestinationEmailAddress). You can then specify up to 49 additional recipients (across ToAddresses and CcAddresses), for a total of 50 recipients.
(dict) --
Contains information about a source or destination email address.
EmailAddress (string) -- [REQUIRED]
The email address, including the domain.
DisplayName (string) --
The display name of email address.
CcAddresses (list) --
The additional recipients information present in cc list. You must have 1 required recipient ( DestinationEmailAddress). You can then specify up to 49 additional recipients (across ToAddresses and CcAddresses), for a total of 50 recipients.
(dict) --
Contains information about a source or destination email address.
EmailAddress (string) -- [REQUIRED]
The email address, including the domain.
DisplayName (string) --
The display name of email address.
list
List of S3 presigned URLs of email attachments and their file name.
(dict) --
Information about the email attachment files.
FileName (string) -- [REQUIRED]
A case-sensitive name of the attached file being uploaded.
S3Url (string) -- [REQUIRED]
The pre-signed URLs for the S3 bucket where the email attachment is stored.
string
The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
string
The contactId that is related to this contact. Linking emails together by using RelatedContactID copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.
(string) --
(string) --
dict
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
{'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}
Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 60 seconds, it fails.
See also: AWS API Documentation
Request Syntax
client.start_outbound_voice_contact(
Name='string',
Description='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
},
RelatedContactId='string',
DestinationPhoneNumber='string',
ContactFlowId='string',
InstanceId='string',
ClientToken='string',
SourcePhoneNumber='string',
QueueId='string',
Attributes={
'string': 'string'
},
AnswerMachineDetectionConfig={
'EnableAnswerMachineDetection': True|False,
'AwaitAnswerMachinePrompt': True|False
},
CampaignId='string',
TrafficType='GENERAL'|'CAMPAIGN',
OutboundStrategy={
'Type': 'AGENT_FIRST',
'Config': {
'AgentFirst': {
'Preview': {
'PostAcceptTimeoutConfig': {
'DurationInSeconds': 123
},
'AllowedUserActions': [
'CALL'|'DISCARD',
]
}
}
}
},
RingTimeoutInSeconds=123
)
string
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).
string
A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see Download and review CCP logs in the Amazon Connect Administrator Guide.
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during voice contact creation.
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
string
The contactId that is related to this contact. Linking voice, task, or chat by using RelatedContactID copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
string
[REQUIRED]
The phone number of the customer, in E.164 format.
string
[REQUIRED]
The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
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
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
This field is autopopulated if not provided.
string
The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
string
The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.
(string) --
(string) --
dict
Configuration of the answering machine detection for this outbound call.
EnableAnswerMachineDetection (boolean) --
The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true, TrafficType must be set as CAMPAIGN.
AwaitAnswerMachinePrompt (boolean) --
Wait for the answering machine prompt.
string
The campaign identifier of the outbound communication.
string
Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL. Use CAMPAIGN if EnableAnswerMachineDetection is set to true. For all other cases, use GENERAL.
dict
Information about the outbound strategy.
Type (string) -- [REQUIRED]
Type of the outbound strategy.
Config (dict) --
Config of the outbound strategy.
AgentFirst (dict) --
The config of agent first outbound strategy.
Preview (dict) --
Information about preview configuration of agent first outbound strategy
PostAcceptTimeoutConfig (dict) -- [REQUIRED]
Countdown timer configuration after the agent accepted the preview outbound contact.
DurationInSeconds (integer) -- [REQUIRED]
Duration in seconds for the countdown timer after the agent accepted the contact.
AllowedUserActions (list) -- [REQUIRED]
The actions the agent can perform after accepting the preview outbound contact.
(string) --
integer
The maximum time the outbound call will wait for the destination to answer the call, in seconds
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
{'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}
Initiates a flow to start a new task contact. For more information about task contacts, see Concepts: Tasks in Amazon Connect in the Amazon Connect Administrator Guide.
When using PreviousContactId and RelatedContactId input parameters, note the following:
PreviousContactId
Any updates to user-defined task contact attributes on any contact linked through the same PreviousContactId will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same PreviousContactId.
RelatedContactId
Copies contact attributes from the related task contact to the new contact.
Any update on attributes in a new task contact does not update attributes on previous contact.
There’s no limit on the number of task contacts that can be created that use the same RelatedContactId.
In addition, when calling StartTaskContact include only one of these parameters: ContactFlowID, QuickConnectID, or TaskTemplateID. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the TaskTemplateID is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.
A ServiceQuotaExceededException occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same PreviousContactId. For more information about service quotas for task contacts, see Amazon Connect service quotas in the Amazon Connect Administrator Guide.
See also: AWS API Documentation
Request Syntax
client.start_task_contact(
InstanceId='string',
PreviousContactId='string',
ContactFlowId='string',
Attributes={
'string': 'string'
},
Name='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
},
Description='string',
ClientToken='string',
ScheduledTime=datetime(2015, 1, 1),
TaskTemplateId='string',
QuickConnectId='string',
RelatedContactId='string',
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': '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
The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same PreviousContactID will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.
string
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.
(string) --
(string) --
string
[REQUIRED]
The name of a task that is shown to an agent in the Contact Control Panel (CCP).
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
string
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
datetime
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.
string
A unique identifier for the task template. For more information about task templates, see Create task templates in the Amazon Connect Administrator Guide.
string
The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see Create quick connects.
string
The contactId that is related to this contact. Linking tasks together by using RelatedContactID copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using PreviousContactID. There are no limits to the number of contacts that can be linked by using RelatedContactId.
dict
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
dict
Response Syntax
{
'ContactId': 'string'
}
Response Structure
(dict) --
ContactId (string) --
The identifier of this contact within the Amazon Connect instance.
{'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}
Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).
See also: AWS API Documentation
Request Syntax
client.start_web_rtc_contact(
Attributes={
'string': 'string'
},
ClientToken='string',
ContactFlowId='string',
InstanceId='string',
AllowedCapabilities={
'Customer': {
'Video': 'SEND',
'ScreenShare': 'SEND'
},
'Agent': {
'Video': 'SEND',
'ScreenShare': 'SEND'
}
},
ParticipantDetails={
'DisplayName': 'string'
},
RelatedContactId='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
},
Description='string'
)
dict
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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, -, and _ characters.
(string) --
(string) --
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.
This field is autopopulated if not provided.
string
[REQUIRED]
The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
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
Information about the video sharing capabilities of the participants (customer, agent).
Customer (dict) --
Information about the customer's video sharing capabilities.
Video (string) --
The configuration having the video and screen sharing capabilities for participants over the call.
ScreenShare (string) --
The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
Agent (dict) --
Information about the agent's video sharing capabilities.
Video (string) --
The configuration having the video and screen sharing capabilities for participants over the call.
ScreenShare (string) --
The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.
dict
[REQUIRED]
The customer's details.
DisplayName (string) -- [REQUIRED]
Display name of the participant.
string
The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
dict
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
string
A description of the task that is shown to an agent in the Contact Control Panel (CCP).
dict
Response Syntax
{
'ConnectionData': {
'Attendee': {
'AttendeeId': 'string',
'JoinToken': 'string'
},
'Meeting': {
'MediaRegion': 'string',
'MediaPlacement': {
'AudioHostUrl': 'string',
'AudioFallbackUrl': 'string',
'SignalingUrl': 'string',
'TurnControlUrl': 'string',
'EventIngestionUrl': 'string'
},
'MeetingFeatures': {
'Audio': {
'EchoReduction': 'AVAILABLE'|'UNAVAILABLE'
}
},
'MeetingId': 'string'
}
},
'ContactId': 'string',
'ParticipantId': 'string',
'ParticipantToken': 'string'
}
Response Structure
(dict) --
ConnectionData (dict) --
Information required for the client application (mobile application or website) to connect to the call.
Attendee (dict) --
The attendee information, including attendee ID and join token.
AttendeeId (string) --
The Amazon Chime SDK attendee ID.
JoinToken (string) --
The join token used by the Amazon Chime SDK attendee.
Meeting (dict) --
A meeting created using the Amazon Chime SDK.
MediaRegion (string) --
The Amazon Web Services Region in which you create the meeting.
MediaPlacement (dict) --
The media placement for the meeting.
AudioHostUrl (string) --
The audio host URL.
AudioFallbackUrl (string) --
The audio fallback URL.
SignalingUrl (string) --
The signaling URL.
TurnControlUrl (string) --
The turn control URL.
EventIngestionUrl (string) --
The event ingestion URL to which you send client meeting events.
MeetingFeatures (dict) --
The configuration settings of the features available to a meeting.
Audio (dict) --
The configuration settings for the audio features available to a meeting.
EchoReduction (string) --
Makes echo reduction available to clients who connect to the meeting.
MeetingId (string) --
The Amazon Chime SDK meeting ID.
ContactId (string) --
The identifier of the contact in this instance of Amazon Connect.
ParticipantId (string) --
The identifier for a contact participant. The ParticipantId for a contact participant is the same throughout the contact lifecycle.
ParticipantToken (string) --
The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.
{'Answers': {'Value': {'DateTimeValue': 'string', 'StringValues': ['string']}}}
Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object ( {}) to the question identifier.
If a contact evaluation is already in submitted state, this operation will trigger a resubmission.
See also: AWS API Documentation
Request Syntax
client.submit_contact_evaluation(
InstanceId='string',
EvaluationId='string',
Answers={
'string': {
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'StringValues': [
'string',
],
'DateTimeValue': 'string',
'NotApplicable': True|False
}
}
},
Notes={
'string': {
'Value': 'string'
}
},
SubmittedBy={
'ConnectUserArn': '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 contact evaluation.
dict
A map of question identifiers to answer value.
(string) --
(dict) --
Information about input answers for a contact evaluation.
Value (dict) --
The value for an answer in a contact evaluation.
StringValue (string) --
The string value for an answer in a contact evaluation.
NumericValue (float) --
The numeric value for an answer in a contact evaluation.
StringValues (list) --
String values provided as answers to evaluation questions.
(string) --
DateTimeValue (string) --
Date and time value provided as an answer to an evaluation question.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
dict
A map of question identifiers to note value.
(string) --
(dict) --
Information about notes for a contact evaluation.
Value (string) --
The note for an item (section or question) in a contact evaluation.
dict
The ID of the user who submitted the contact evaluation.
ConnectUserArn (string) --
Represents the Amazon Connect ARN of the user.
dict
Response Syntax
{
'EvaluationId': 'string',
'EvaluationArn': 'string'
}
Response Structure
(dict) --
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
{'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}
This API is in preview release for Amazon Connect and is subject to change.
Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.
See also: AWS API Documentation
Request Syntax
client.update_contact(
InstanceId='string',
ContactId='string',
Name='string',
Description='string',
References={
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
},
SegmentAttributes={
'string': {
'ValueString': 'string',
'ValueMap': {
'string': {'... recursive ...'}
},
'ValueInteger': 123,
'ValueList': [
{'... recursive ...'},
],
'ValueArn': 'string'
}
},
QueueInfo={
'Id': 'string'
},
UserInfo={
'UserId': 'string'
},
CustomerEndpoint={
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': 'string'
},
SystemEndpoint={
'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
'Address': '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 contact. This is the identifier of the contact associated with the first interaction with your contact center.
string
The name of the contact.
string
The description of the contact.
dict
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
dict
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
Attribute keys can include only alphanumeric, -, and _.
This field can be used to show channel subtype, such as connect:Guide.
Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueString (string) --
The value of a segment attribute.
ValueMap (dict) --
The value of a segment attribute.
(string) --
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueInteger (integer) --
The value of a segment attribute.
ValueList (list) --
The value of a segment attribute. This is only supported for system-defined attributes, not for user-defined attributes.
(dict) --
A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.
ValueArn (string) --
The value of a segment attribute that has to be a valid ARN. This is only supported for system-defined attributes, not for user-defined attributes.
dict
Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
Id (string) --
The identifier of the queue.
dict
Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
UserId (string) --
The user identifier for the contact.
dict
The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
Type (string) --
Type of the endpoint.
Address (string) --
Address of the endpoint.
dict
External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
Type (string) --
Type of the endpoint.
Address (string) --
Address of the endpoint.
dict
Response Syntax
{}
Response Structure
(dict) --
{'Answers': {'Value': {'DateTimeValue': 'string', 'StringValues': ['string']}}}
Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object ( {}) to the question identifier.
See also: AWS API Documentation
Request Syntax
client.update_contact_evaluation(
InstanceId='string',
EvaluationId='string',
Answers={
'string': {
'Value': {
'StringValue': 'string',
'NumericValue': 123.0,
'StringValues': [
'string',
],
'DateTimeValue': 'string',
'NotApplicable': True|False
}
}
},
Notes={
'string': {
'Value': 'string'
}
},
UpdatedBy={
'ConnectUserArn': '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 contact evaluation.
dict
A map of question identifiers to answer value.
(string) --
(dict) --
Information about input answers for a contact evaluation.
Value (dict) --
The value for an answer in a contact evaluation.
StringValue (string) --
The string value for an answer in a contact evaluation.
NumericValue (float) --
The numeric value for an answer in a contact evaluation.
StringValues (list) --
String values provided as answers to evaluation questions.
(string) --
DateTimeValue (string) --
Date and time value provided as an answer to an evaluation question.
NotApplicable (boolean) --
The flag to mark the question as not applicable.
dict
A map of question identifiers to note value.
(string) --
(dict) --
Information about notes for a contact evaluation.
Value (string) --
The note for an item (section or question) in a contact evaluation.
dict
The ID of the user who updated the contact evaluation.
ConnectUserArn (string) --
Represents the Amazon Connect ARN of the user.
dict
Response Syntax
{
'EvaluationId': 'string',
'EvaluationArn': 'string'
}
Response Structure
(dict) --
EvaluationId (string) --
A unique identifier for the contact evaluation.
EvaluationArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
{'AsDraft': 'boolean',
'Items': {'Question': {'Enablement': {'Condition': {'Operands': {'Expression': {'Comparator': {'ALL_IN',
'EXACT'}}}}},
'QuestionType': {'MULTISELECT', 'DATETIME'},
'QuestionTypeProperties': {'MultiSelect': {'Automation': {'AnswerSource': {'SourceType': 'CONTACT_LENS_DATA '
'| '
'GEN_AI'},
'DefaultOptionRefIds': ['string'],
'Options': [{'RuleCategory': {'Category': 'string',
'Condition': 'PRESENT '
'| '
'NOT_PRESENT',
'OptionRefIds': ['string']}}]},
'DisplayAs': 'DROPDOWN '
'| '
'CHECKBOX',
'Options': [{'RefId': 'string',
'Text': 'string'}]},
'Numeric': {'Automation': {'PropertyValue': {'Label': {'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT',
'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'}}}}}}},
'LanguageConfiguration': {'FormLanguage': 'de-DE | en-US | es-ES | fr-FR | '
'it-IT | pt-BR'},
'TargetConfiguration': {'ContactInteractionType': 'AGENT | AUTOMATED'}}
Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.
This operation does not support partial updates. Instead it does a full update of evaluation form content.
See also: AWS API Documentation
Request Syntax
client.update_evaluation_form(
InstanceId='string',
EvaluationFormId='string',
EvaluationFormVersion=123,
CreateNewVersion=True|False,
Title='string',
Description='string',
Items=[
{
'Section': {
'Title': 'string',
'RefId': 'string',
'Instructions': 'string',
'Items': {'... recursive ...'},
'Weight': 123.0
},
'Question': {
'Title': 'string',
'Instructions': 'string',
'RefId': 'string',
'NotApplicableEnabled': True|False,
'QuestionType': 'TEXT'|'SINGLESELECT'|'NUMERIC'|'MULTISELECT'|'DATETIME',
'QuestionTypeProperties': {
'Numeric': {
'MinValue': 123,
'MaxValue': 123,
'Options': [
{
'MinValue': 123,
'MaxValue': 123,
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'Automation': {
'PropertyValue': {
'Label': 'OVERALL_CUSTOMER_SENTIMENT_SCORE'|'OVERALL_AGENT_SENTIMENT_SCORE'|'CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT'|'CUSTOMER_SENTIMENT_SCORE_WITH_AGENT'|'NON_TALK_TIME'|'NON_TALK_TIME_PERCENTAGE'|'NUMBER_OF_INTERRUPTIONS'|'CONTACT_DURATION'|'AGENT_INTERACTION_DURATION'|'CUSTOMER_HOLD_TIME'|'LONGEST_HOLD_DURATION'|'NUMBER_OF_HOLDS'|'AGENT_INTERACTION_AND_HOLD_DURATION'
},
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'SingleSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string',
'Score': 123,
'AutomaticFail': True|False,
'AutomaticFailConfiguration': {
'TargetSection': 'string'
}
},
],
'DisplayAs': 'DROPDOWN'|'RADIO',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefId': 'string'
}
},
],
'DefaultOptionRefId': 'string',
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'Text': {
'Automation': {
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
},
'MultiSelect': {
'Options': [
{
'RefId': 'string',
'Text': 'string'
},
],
'DisplayAs': 'DROPDOWN'|'CHECKBOX',
'Automation': {
'Options': [
{
'RuleCategory': {
'Category': 'string',
'Condition': 'PRESENT'|'NOT_PRESENT',
'OptionRefIds': [
'string',
]
}
},
],
'DefaultOptionRefIds': [
'string',
],
'AnswerSource': {
'SourceType': 'CONTACT_LENS_DATA'|'GEN_AI'
}
}
}
},
'Enablement': {
'Condition': {
'Operands': [
{
'Expression': {
'Source': {
'Type': 'QUESTION_REF_ID',
'RefId': 'string'
},
'Values': [
{
'Type': 'OPTION_REF_ID',
'RefId': 'string'
},
],
'Comparator': 'IN'|'NOT_IN'|'ALL_IN'|'EXACT'
},
'Condition': {'... recursive ...'}
},
],
'Operator': 'OR'|'AND'
},
'Action': 'DISABLE'|'ENABLE',
'DefaultAction': 'DISABLE'|'ENABLE'
},
'Weight': 123.0
}
},
],
ScoringStrategy={
'Mode': 'QUESTION_ONLY'|'SECTION_ONLY',
'Status': 'ENABLED'|'DISABLED'
},
AutoEvaluationConfiguration={
'Enabled': True|False
},
AsDraft=True|False,
ClientToken='string',
TargetConfiguration={
'ContactInteractionType': 'AGENT'|'AUTOMATED'
},
LanguageConfiguration={
'FormLanguage': 'de-DE'|'en-US'|'es-ES'|'fr-FR'|'it-IT'|'pt-BR'
}
)
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 unique identifier for the evaluation form.
integer
[REQUIRED]
A version of the evaluation form to update.
boolean
A flag indicating whether the operation must create a new version.
string
[REQUIRED]
A title of the evaluation form.
string
The description of the evaluation form.
list
[REQUIRED]
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.
(dict) --
Information about an item from an evaluation form. The item must be either a section or a question.
Section (dict) --
The information of the section.
Title (string) -- [REQUIRED]
The title of the section.
RefId (string) -- [REQUIRED]
The identifier of the section. An identifier must be unique within the evaluation form.
Instructions (string) --
The instructions of the section.
Items (list) --
The items of the section.
Weight (float) --
The scoring weight of the section.
Question (dict) --
The information of the question.
Title (string) -- [REQUIRED]
The title of the question.
Instructions (string) --
The instructions of the section.
RefId (string) -- [REQUIRED]
The identifier of the question. An identifier must be unique within the evaluation form.
NotApplicableEnabled (boolean) --
The flag to enable not applicable answers to the question.
QuestionType (string) -- [REQUIRED]
The type of the question.
QuestionTypeProperties (dict) --
The properties of the type of question. Text questions do not have to define question type properties.
Numeric (dict) --
The properties of the numeric question.
MinValue (integer) -- [REQUIRED]
The minimum answer value.
MaxValue (integer) -- [REQUIRED]
The maximum answer value.
Options (list) --
The scoring options of the numeric question.
(dict) --
Information about the option range used for scoring in numeric questions.
MinValue (integer) -- [REQUIRED]
The minimum answer value of the range option.
MaxValue (integer) -- [REQUIRED]
The maximum answer value of the range option.
Score (integer) --
The score assigned to answer values within the range option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
A configuration for automatic fail.
TargetSection (string) --
The referenceId of the target section for auto failure.
Automation (dict) --
The automation properties of the numeric question.
PropertyValue (dict) --
The property value of the automation.
Label (string) -- [REQUIRED]
The property label of the automation.
AnswerSource (dict) --
A source of automation answer for numeric question.
SourceType (string) -- [REQUIRED]
The automation answer source type.
SingleSelect (dict) --
The properties of the numeric question.
Options (list) -- [REQUIRED]
The answer options of the single select question.
(dict) --
Information about the automation configuration in single select questions.
RefId (string) -- [REQUIRED]
The identifier of the answer option. An identifier must be unique within the question.
Text (string) -- [REQUIRED]
The title of the answer option.
Score (integer) --
The score assigned to the answer option.
AutomaticFail (boolean) --
The flag to mark the option as automatic fail. If an automatic fail answer is provided, the overall evaluation gets a score of 0.
AutomaticFailConfiguration (dict) --
Whether automatic fail is configured on a single select question.
TargetSection (string) --
The referenceId of the target section for auto failure.
DisplayAs (string) --
The display mode of the single select question.
Automation (dict) --
The display mode of the single select question.
Options (list) --
The automation options of the single select question.
(dict) --
Information about the automation option of a single select question.
RuleCategory (dict) --
The automation option based on a rule category for the single select question.
Category (string) -- [REQUIRED]
The category name, as defined in Rules.
Condition (string) -- [REQUIRED]
The condition to apply for the automation option. If the condition is PRESENT, then the option is applied when the contact data includes the category. Similarly, if the condition is NOT_PRESENT, then the option is applied when the contact data does not include the category.
OptionRefId (string) -- [REQUIRED]
The identifier of the answer option.
DefaultOptionRefId (string) --
The identifier of the default answer option, when none of the automation options match the criteria.
AnswerSource (dict) --
Automation answer source.
SourceType (string) -- [REQUIRED]
The automation answer source type.
Text (dict) --
The properties of the text question.
Automation (dict) --
The automation properties of the text question.
AnswerSource (dict) --
Automation answer source.
SourceType (string) -- [REQUIRED]
The automation answer source type.
MultiSelect (dict) --
Properties for multi-select question types.
Options (list) -- [REQUIRED]
Options available for this multi-select question.
(dict) --
An option for a multi-select question in an evaluation form.
RefId (string) -- [REQUIRED]
Reference identifier for this option.
Text (string) -- [REQUIRED]
Display text for this option.
DisplayAs (string) --
Display format for the multi-select question.
Automation (dict) --
Automation configuration for this multi-select question.
Options (list) --
Automation options for the multi-select question.
(dict) --
An automation option for a multi-select question.
RuleCategory (dict) --
Rule category configuration for this automation option.
Category (string) -- [REQUIRED]
The category name for this automation rule.
Condition (string) -- [REQUIRED]
The condition for this automation rule.
OptionRefIds (list) -- [REQUIRED]
Reference IDs of options for this automation rule.
(string) --
DefaultOptionRefIds (list) --
Reference IDs of default options.
(string) --
AnswerSource (dict) --
A question automation answer.
SourceType (string) -- [REQUIRED]
The automation answer source type.
Enablement (dict) --
A question conditional enablement.
Condition (dict) -- [REQUIRED]
A condition for item enablement configuration.
Operands (list) -- [REQUIRED]
Operands of the enablement condition.
(dict) --
An operand of the enablement condition.
Expression (dict) --
An expression of the enablement condition.
Source (dict) -- [REQUIRED]
A source item of enablement expression.
Type (string) -- [REQUIRED]
A type of source item.
RefId (string) --
A referenceId of the source item.
Values (list) -- [REQUIRED]
A list of values from source item.
(dict) --
An enablement expression source value.
Type (string) -- [REQUIRED]
A type of source item value.
RefId (string) --
A referenceId of the source value.
Comparator (string) -- [REQUIRED]
A comparator to be used against list of values.
Condition (dict) --
A condition for item enablement.
Operator (string) --
The operator to be used to be applied to operands if more than one provided.
Action (string) -- [REQUIRED]
An enablement action that if condition is satisfied.
DefaultAction (string) --
An enablement action that if condition is not satisfied.
Weight (float) --
The scoring weight of the section.
dict
A scoring strategy of the evaluation form.
Mode (string) -- [REQUIRED]
The scoring mode of the evaluation form.
Status (string) -- [REQUIRED]
The scoring status of the evaluation form.
dict
Whether automated evaluations are enabled.
Enabled (boolean) -- [REQUIRED]
When automated evaluation is enabled.
boolean
A boolean flag indicating whether to update evaluation form to draft state.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
Configuration that specifies the target for the evaluation form.
ContactInteractionType (string) -- [REQUIRED]
The contact interaction type for this evaluation form.
dict
Configuration for language settings of the evaluation form.
FormLanguage (string) --
The language for the evaluation form.
dict
Response Syntax
{
'EvaluationFormId': 'string',
'EvaluationFormArn': 'string',
'EvaluationFormVersion': 123
}
Response Structure
(dict) --
EvaluationFormId (string) --
The unique identifier for the evaluation form.
EvaluationFormArn (string) --
The Amazon Resource Name (ARN) for the contact evaluation resource.
EvaluationFormVersion (integer) --
The version of the updated evaluation form resource.
{'AttributeType': {'MESSAGE_STREAMING'}}
This API is in preview release for Amazon Connect and is subject to change.
Updates the value for the specified attribute type.
See also: AWS API Documentation
Request Syntax
client.update_instance_attribute(
InstanceId='string',
AttributeType='INBOUND_CALLS'|'OUTBOUND_CALLS'|'CONTACTFLOW_LOGS'|'CONTACT_LENS'|'AUTO_RESOLVE_BEST_VOICES'|'USE_CUSTOM_TTS_VOICES'|'EARLY_MEDIA'|'MULTI_PARTY_CONFERENCE'|'HIGH_VOLUME_OUTBOUND'|'ENHANCED_CONTACT_MONITORING'|'ENHANCED_CHAT_MONITORING'|'MULTI_PARTY_CHAT_CONFERENCE'|'MESSAGE_STREAMING',
Value='string',
ClientToken='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 type of attribute.
string
[REQUIRED]
The value for the attribute. Maximum character limit is 100.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
None
{'QuickConnectConfig': {'FlowConfig': {'ContactFlowId': 'string'},
'QuickConnectType': {'FLOW'}}}
Updates the configuration settings for the specified quick connect.
See also: AWS API Documentation
Request Syntax
client.update_quick_connect_config(
InstanceId='string',
QuickConnectId='string',
QuickConnectConfig={
'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'|'FLOW',
'UserConfig': {
'UserId': 'string',
'ContactFlowId': 'string'
},
'QueueConfig': {
'QueueId': 'string',
'ContactFlowId': 'string'
},
'PhoneConfig': {
'PhoneNumber': 'string'
},
'FlowConfig': {
'ContactFlowId': '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
[REQUIRED]
Information about the configuration settings for the quick connect.
QuickConnectType (string) -- [REQUIRED]
The type of quick connect. In the Amazon Connect admin website, 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) -- [REQUIRED]
The identifier of the user.
ContactFlowId (string) -- [REQUIRED]
The identifier of the flow.
QueueConfig (dict) --
The queue configuration. This is required only if QuickConnectType is QUEUE.
QueueId (string) -- [REQUIRED]
The identifier for the queue.
ContactFlowId (string) -- [REQUIRED]
The identifier of the flow.
PhoneConfig (dict) --
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
PhoneNumber (string) -- [REQUIRED]
The phone number in E.164 format.
FlowConfig (dict) --
Flow configuration for quick connect setup.
ContactFlowId (string) -- [REQUIRED]
The contact flow ID for the quick connect configuration.
None
{'Actions': {'TaskAction': {'References': {'Type': {'EMAIL_MESSAGE_PLAIN_TEXT'}}}}}
Updates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
See also: AWS API Documentation
Request Syntax
client.update_rule(
RuleId='string',
InstanceId='string',
Name='string',
Function='string',
Actions=[
{
'ActionType': 'CREATE_TASK'|'ASSIGN_CONTACT_CATEGORY'|'GENERATE_EVENTBRIDGE_EVENT'|'SEND_NOTIFICATION'|'CREATE_CASE'|'UPDATE_CASE'|'ASSIGN_SLA'|'END_ASSOCIATED_TASKS'|'SUBMIT_AUTO_EVALUATION',
'TaskAction': {
'Name': 'string',
'Description': 'string',
'ContactFlowId': 'string',
'References': {
'string': {
'Value': 'string',
'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE'|'EMAIL_MESSAGE_PLAIN_TEXT',
'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
'Arn': 'string',
'StatusReason': 'string'
}
}
},
'EventBridgeAction': {
'Name': 'string'
},
'AssignContactCategoryAction': {}
,
'SendNotificationAction': {
'DeliveryMethod': 'EMAIL',
'Subject': 'string',
'Content': 'string',
'ContentType': 'PLAIN_TEXT',
'Recipient': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
},
'Exclusion': {
'UserTags': {
'string': 'string'
},
'UserIds': [
'string',
]
}
},
'CreateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
}
},
],
'TemplateId': 'string'
},
'UpdateCaseAction': {
'Fields': [
{
'Id': 'string',
'Value': {
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
}
},
]
},
'AssignSlaAction': {
'SlaAssignmentType': 'CASES',
'CaseSlaConfiguration': {
'Name': 'string',
'Type': 'CaseField',
'FieldId': 'string',
'TargetFieldValues': [
{
'BooleanValue': True|False,
'DoubleValue': 123.0,
'EmptyValue': {}
,
'StringValue': 'string'
},
],
'TargetSlaMinutes': 123
}
},
'EndAssociatedTasksAction': {}
,
'SubmitAutoEvaluationAction': {
'EvaluationFormId': 'string'
}
},
],
PublishStatus='DRAFT'|'PUBLISHED'
)
string
[REQUIRED]
A unique identifier for the rule.
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 name of the rule. You can change the name only if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
string
[REQUIRED]
The conditions of the rule.
list
[REQUIRED]
A list of actions to be run when the rule is triggered.
(dict) --
Information about the action to be performed when a rule is triggered.
ActionType (string) -- [REQUIRED]
The type of action that creates a rule.
TaskAction (dict) --
Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
Name (string) -- [REQUIRED]
The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Description (string) --
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
ContactFlowId (string) -- [REQUIRED]
The identifier of the flow.
References (dict) --
Information about the reference when the referenceType is URL. Otherwise, null. (Supports variable injection in the Value field.)
(string) --
(dict) --
Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.
Value (string) --
A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).
Type (string) -- [REQUIRED]
The type of the reference. DATE must be of type Epoch timestamp.
Status (string) --
Status of the attachment reference type.
Arn (string) --
The Amazon Resource Name (ARN) of the reference
StatusReason (string) --
Relevant details why the reference was not successfully created.
EventBridgeAction (dict) --
Information about the EventBridge action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
Name (string) -- [REQUIRED]
The name.
AssignContactCategoryAction (dict) --
Information about the contact category action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
SendNotificationAction (dict) --
Information about the send notification action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
DeliveryMethod (string) -- [REQUIRED]
Notification delivery method.
Subject (string) --
The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
Content (string) -- [REQUIRED]
Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide.
ContentType (string) -- [REQUIRED]
Content type format.
Recipient (dict) -- [REQUIRED]
Notification recipient.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
Exclusion (dict) --
Recipients to exclude from notification.
UserTags (dict) --
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users with the specified tags will be notified.
(string) --
(string) --
UserIds (list) --
A list of user IDs. Supports variable injection of $.ContactLens.ContactEvaluation.Agent.AgentId for OnContactEvaluationSubmit event source.
(string) --
CreateCaseAction (dict) --
Information about the create case action.
Supported only for TriggerEventSource values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable.
Fields (list) -- [REQUIRED]
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) -- [REQUIRED]
Unique identifier of a field.
Value (dict) -- [REQUIRED]
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TemplateId (string) -- [REQUIRED]
A unique identifier of a template.
UpdateCaseAction (dict) --
Information about the update case action.
Supported only for TriggerEventSource values: OnCaseCreate | OnCaseUpdate.
Fields (list) -- [REQUIRED]
An array of objects with Field ID and Value data.
(dict) --
Object for case field values.
Id (string) -- [REQUIRED]
Unique identifier of a field.
Value (dict) -- [REQUIRED]
Union of potential field value types.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
AssignSlaAction (dict) --
Information about the assign SLA action.
SlaAssignmentType (string) -- [REQUIRED]
Type of SLA assignment.
CaseSlaConfiguration (dict) --
The SLA configuration for Case SLA Assignment.
Name (string) -- [REQUIRED]
Name of an SLA.
Type (string) -- [REQUIRED]
Type of SLA for Case SlaAssignmentType.
FieldId (string) --
Unique identifier of a Case field.
TargetFieldValues (list) --
Represents a list of target field values for the fieldId specified in CaseSlaConfiguration. The SLA is considered met if any one of these target field values matches the actual field value.
(dict) --
Object to store union of Field values.
BooleanValue (boolean) --
A Boolean number value type.
DoubleValue (float) --
A Double number value type.
EmptyValue (dict) --
An empty value.
StringValue (string) --
String value type.
TargetSlaMinutes (integer) -- [REQUIRED]
Target duration in minutes within which an SLA should be completed.
EndAssociatedTasksAction (dict) --
Information about the end associated tasks action.
Supported only for TriggerEventSource values: OnCaseUpdate.
SubmitAutoEvaluationAction (dict) --
Information about the submit automated evaluation action.
EvaluationFormId (string) -- [REQUIRED]
The identifier of the auto-evaluation enabled form.
string
[REQUIRED]
The publish status of the rule.
None
{'AllowedFlowModules': [{'FlowModuleId': 'string', 'Type': 'MCP'}],
'Applications': {'Type': 'MCP | THIRD_PARTY_APPLICATION'},
'GranularAccessControlConfiguration': {'DataTableAccessControlConfiguration': {'PrimaryAttributeAccessControlConfiguration': {'PrimaryAttributeValues': [{'AccessType': 'ALLOW',
'AttributeName': 'string',
'Values': ['string']}]}}}}
Updates a security profile.
For information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide. For a mapping of the API name and user interface name of the security profile permissions, see List of security profile permissions.
See also: AWS API Documentation
Request Syntax
client.update_security_profile(
Description='string',
Permissions=[
'string',
],
SecurityProfileId='string',
InstanceId='string',
AllowedAccessControlTags={
'string': 'string'
},
TagRestrictedResources=[
'string',
],
Applications=[
{
'Namespace': 'string',
'ApplicationPermissions': [
'string',
],
'Type': 'MCP'|'THIRD_PARTY_APPLICATION'
},
],
HierarchyRestrictedResources=[
'string',
],
AllowedAccessControlHierarchyGroupId='string',
AllowedFlowModules=[
{
'Type': 'MCP',
'FlowModuleId': 'string'
},
],
GranularAccessControlConfiguration={
'DataTableAccessControlConfiguration': {
'PrimaryAttributeAccessControlConfiguration': {
'PrimaryAttributeValues': [
{
'AccessType': 'ALLOW',
'AttributeName': 'string',
'Values': [
'string',
]
},
]
}
}
}
)
string
The description of the security profile.
list
The permissions granted to a security profile. For a list of valid permissions, see List of security profile permissions.
(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
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
(string) --
(string) --
list
The list of resources that a security profile applies tag restrictions to in Amazon Connect.
(string) --
list
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. For third-party applications, only the ACCESS permission is supported. For MCP Servers, the permissions are tool Identifiers accepted by MCP Server.
(string) --
Type (string) --
Type of Application.
list
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: User.
(string) --
string
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
list
A list of Flow Modules an AI Agent can invoke as a tool
(dict) --
A list of Flow Modules an AI Agent can invoke as a tool
Type (string) --
Only Type we support is MCP.
FlowModuleId (string) --
If of Flow Modules invocable as tool
dict
The granular access control configuration for the security profile, including data table permissions.
DataTableAccessControlConfiguration (dict) --
The access control configuration for data tables.
PrimaryAttributeAccessControlConfiguration (dict) --
The configuration's primary attribute access control configuration.
PrimaryAttributeValues (list) --
The item's primary attribute values.
(dict) --
A primary attribute value.
AccessType (string) --
The value's access type.
AttributeName (string) --
The value's attribute name.
Values (list) --
The value's values.
(string) --
None