aws-sdk-connect 1.226.0 → 1.227.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +3577 -150
- data/lib/aws-sdk-connect/client_api.rb +1956 -12
- data/lib/aws-sdk-connect/types.rb +9031 -4344
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +1220 -29
- data/sig/types.rbs +1211 -24
- metadata +1 -1
|
@@ -1379,6 +1379,46 @@ module Aws::Connect
|
|
|
1379
1379
|
req.send_request(options)
|
|
1380
1380
|
end
|
|
1381
1381
|
|
|
1382
|
+
# Associate security profiles with an Entity in an Amazon Connect
|
|
1383
|
+
# instance.
|
|
1384
|
+
#
|
|
1385
|
+
# @option params [required, String] :instance_id
|
|
1386
|
+
# The identifier of the Amazon Connect instance. You can find the
|
|
1387
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
1388
|
+
#
|
|
1389
|
+
# @option params [required, Array<Types::SecurityProfileItem>] :security_profiles
|
|
1390
|
+
# List of Security Profile Object.
|
|
1391
|
+
#
|
|
1392
|
+
# @option params [required, String] :entity_type
|
|
1393
|
+
# Only supported type is AI\_AGENT.
|
|
1394
|
+
#
|
|
1395
|
+
# @option params [required, String] :entity_arn
|
|
1396
|
+
# Arn of a Q in Connect AI Agent.
|
|
1397
|
+
#
|
|
1398
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1399
|
+
#
|
|
1400
|
+
# @example Request syntax with placeholder values
|
|
1401
|
+
#
|
|
1402
|
+
# resp = client.associate_security_profiles({
|
|
1403
|
+
# instance_id: "InstanceId", # required
|
|
1404
|
+
# security_profiles: [ # required
|
|
1405
|
+
# {
|
|
1406
|
+
# id: "SecurityProfileId",
|
|
1407
|
+
# },
|
|
1408
|
+
# ],
|
|
1409
|
+
# entity_type: "USER", # required, accepts USER, AI_AGENT
|
|
1410
|
+
# entity_arn: "EntityArn", # required
|
|
1411
|
+
# })
|
|
1412
|
+
#
|
|
1413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateSecurityProfiles AWS API Documentation
|
|
1414
|
+
#
|
|
1415
|
+
# @overload associate_security_profiles(params = {})
|
|
1416
|
+
# @param [Hash] params ({})
|
|
1417
|
+
def associate_security_profiles(params = {}, options = {})
|
|
1418
|
+
req = build_request(:associate_security_profiles, params)
|
|
1419
|
+
req.send_request(options)
|
|
1420
|
+
end
|
|
1421
|
+
|
|
1382
1422
|
# Associates an agent with a traffic distribution group. This API can be
|
|
1383
1423
|
# called only in the Region where the traffic distribution group is
|
|
1384
1424
|
# created.
|
|
@@ -1455,6 +1495,55 @@ module Aws::Connect
|
|
|
1455
1495
|
req.send_request(options)
|
|
1456
1496
|
end
|
|
1457
1497
|
|
|
1498
|
+
# Associates a workspace with one or more users or routing profiles,
|
|
1499
|
+
# allowing them to access the workspace's configured views and pages.
|
|
1500
|
+
#
|
|
1501
|
+
# @option params [required, String] :instance_id
|
|
1502
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
1503
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
1504
|
+
#
|
|
1505
|
+
#
|
|
1506
|
+
#
|
|
1507
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
1508
|
+
#
|
|
1509
|
+
# @option params [required, String] :workspace_id
|
|
1510
|
+
# The identifier of the workspace.
|
|
1511
|
+
#
|
|
1512
|
+
# @option params [required, Array<String>] :resource_arns
|
|
1513
|
+
# The Amazon Resource Names (ARNs) of the resources to associate with
|
|
1514
|
+
# the workspace. Valid resource types are users and routing profiles.
|
|
1515
|
+
#
|
|
1516
|
+
# @return [Types::AssociateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1517
|
+
#
|
|
1518
|
+
# * {Types::AssociateWorkspaceResponse#successful_list #successful_list} => Array<Types::SuccessfulBatchAssociationSummary>
|
|
1519
|
+
# * {Types::AssociateWorkspaceResponse#failed_list #failed_list} => Array<Types::FailedBatchAssociationSummary>
|
|
1520
|
+
#
|
|
1521
|
+
# @example Request syntax with placeholder values
|
|
1522
|
+
#
|
|
1523
|
+
# resp = client.associate_workspace({
|
|
1524
|
+
# instance_id: "InstanceId", # required
|
|
1525
|
+
# workspace_id: "WorkspaceId", # required
|
|
1526
|
+
# resource_arns: ["ARN"], # required
|
|
1527
|
+
# })
|
|
1528
|
+
#
|
|
1529
|
+
# @example Response structure
|
|
1530
|
+
#
|
|
1531
|
+
# resp.successful_list #=> Array
|
|
1532
|
+
# resp.successful_list[0].resource_arn #=> String
|
|
1533
|
+
# resp.failed_list #=> Array
|
|
1534
|
+
# resp.failed_list[0].resource_arn #=> String
|
|
1535
|
+
# resp.failed_list[0].error_code #=> String
|
|
1536
|
+
# resp.failed_list[0].error_message #=> String
|
|
1537
|
+
#
|
|
1538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateWorkspace AWS API Documentation
|
|
1539
|
+
#
|
|
1540
|
+
# @overload associate_workspace(params = {})
|
|
1541
|
+
# @param [Hash] params ({})
|
|
1542
|
+
def associate_workspace(params = {}, options = {})
|
|
1543
|
+
req = build_request(:associate_workspace, params)
|
|
1544
|
+
req.send_request(options)
|
|
1545
|
+
end
|
|
1546
|
+
|
|
1458
1547
|
# Associates a list of analytics datasets for a given Amazon Connect
|
|
1459
1548
|
# instance to a target account. You can associate multiple datasets in a
|
|
1460
1549
|
# single call.
|
|
@@ -1510,6 +1599,234 @@ module Aws::Connect
|
|
|
1510
1599
|
req.send_request(options)
|
|
1511
1600
|
end
|
|
1512
1601
|
|
|
1602
|
+
# Creates values for attributes in a data table. The value may be a
|
|
1603
|
+
# default or it may be associated with a primary value. The value must
|
|
1604
|
+
# pass all customer defined validation as well as the default validation
|
|
1605
|
+
# for the value type. The operation must conform to Batch Operation API
|
|
1606
|
+
# Standards. Although the standard specifies that successful and failed
|
|
1607
|
+
# entities are listed separately in the response, authorization fails if
|
|
1608
|
+
# any primary values or attributes are unauthorized. The combination of
|
|
1609
|
+
# primary values and the attribute name serve as the identifier for the
|
|
1610
|
+
# individual item request.
|
|
1611
|
+
#
|
|
1612
|
+
# @option params [required, String] :instance_id
|
|
1613
|
+
# The unique identifier for the Amazon Connect instance.
|
|
1614
|
+
#
|
|
1615
|
+
# @option params [required, String] :data_table_id
|
|
1616
|
+
# The unique identifier for the data table. Must also accept the table
|
|
1617
|
+
# ARN with or without a version alias. If no alias is provided, the
|
|
1618
|
+
# default behavior is identical to providing the $LATEST alias.
|
|
1619
|
+
#
|
|
1620
|
+
# @option params [required, Array<Types::DataTableValue>] :values
|
|
1621
|
+
# A list of values to create. Each value must specify the attribute name
|
|
1622
|
+
# and optionally primary values if the table has primary attributes.
|
|
1623
|
+
#
|
|
1624
|
+
# @return [Types::BatchCreateDataTableValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1625
|
+
#
|
|
1626
|
+
# * {Types::BatchCreateDataTableValueResponse#successful #successful} => Array<Types::BatchCreateDataTableValueSuccessResult>
|
|
1627
|
+
# * {Types::BatchCreateDataTableValueResponse#failed #failed} => Array<Types::BatchCreateDataTableValueFailureResult>
|
|
1628
|
+
#
|
|
1629
|
+
# @example Request syntax with placeholder values
|
|
1630
|
+
#
|
|
1631
|
+
# resp = client.batch_create_data_table_value({
|
|
1632
|
+
# instance_id: "InstanceId", # required
|
|
1633
|
+
# data_table_id: "DataTableId", # required
|
|
1634
|
+
# values: [ # required
|
|
1635
|
+
# {
|
|
1636
|
+
# primary_values: [
|
|
1637
|
+
# {
|
|
1638
|
+
# attribute_name: "DataTableName", # required
|
|
1639
|
+
# value: "String", # required
|
|
1640
|
+
# },
|
|
1641
|
+
# ],
|
|
1642
|
+
# attribute_name: "DataTableName", # required
|
|
1643
|
+
# value: "String", # required
|
|
1644
|
+
# lock_version: {
|
|
1645
|
+
# data_table: "String",
|
|
1646
|
+
# attribute: "String",
|
|
1647
|
+
# primary_values: "String",
|
|
1648
|
+
# value: "String",
|
|
1649
|
+
# },
|
|
1650
|
+
# last_modified_time: Time.now,
|
|
1651
|
+
# last_modified_region: "RegionName",
|
|
1652
|
+
# },
|
|
1653
|
+
# ],
|
|
1654
|
+
# })
|
|
1655
|
+
#
|
|
1656
|
+
# @example Response structure
|
|
1657
|
+
#
|
|
1658
|
+
# resp.successful #=> Array
|
|
1659
|
+
# resp.successful[0].primary_values #=> Array
|
|
1660
|
+
# resp.successful[0].primary_values[0].attribute_name #=> String
|
|
1661
|
+
# resp.successful[0].primary_values[0].value #=> String
|
|
1662
|
+
# resp.successful[0].attribute_name #=> String
|
|
1663
|
+
# resp.successful[0].record_id #=> String
|
|
1664
|
+
# resp.successful[0].lock_version.data_table #=> String
|
|
1665
|
+
# resp.successful[0].lock_version.attribute #=> String
|
|
1666
|
+
# resp.successful[0].lock_version.primary_values #=> String
|
|
1667
|
+
# resp.successful[0].lock_version.value #=> String
|
|
1668
|
+
# resp.failed #=> Array
|
|
1669
|
+
# resp.failed[0].primary_values #=> Array
|
|
1670
|
+
# resp.failed[0].primary_values[0].attribute_name #=> String
|
|
1671
|
+
# resp.failed[0].primary_values[0].value #=> String
|
|
1672
|
+
# resp.failed[0].attribute_name #=> String
|
|
1673
|
+
# resp.failed[0].message #=> String
|
|
1674
|
+
#
|
|
1675
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchCreateDataTableValue AWS API Documentation
|
|
1676
|
+
#
|
|
1677
|
+
# @overload batch_create_data_table_value(params = {})
|
|
1678
|
+
# @param [Hash] params ({})
|
|
1679
|
+
def batch_create_data_table_value(params = {}, options = {})
|
|
1680
|
+
req = build_request(:batch_create_data_table_value, params)
|
|
1681
|
+
req.send_request(options)
|
|
1682
|
+
end
|
|
1683
|
+
|
|
1684
|
+
# Deletes multiple values from a data table. API users may delete values
|
|
1685
|
+
# at any time. When deletion is requested from the admin website, a
|
|
1686
|
+
# warning is shown alerting the user of the most recent time the
|
|
1687
|
+
# attribute and its values were accessed. System managed values are not
|
|
1688
|
+
# deletable by customers.
|
|
1689
|
+
#
|
|
1690
|
+
# @option params [required, String] :instance_id
|
|
1691
|
+
# The unique identifier for the Amazon Connect instance.
|
|
1692
|
+
#
|
|
1693
|
+
# @option params [required, String] :data_table_id
|
|
1694
|
+
# The unique identifier for the data table. Must also accept the table
|
|
1695
|
+
# ARN with or without a version alias.
|
|
1696
|
+
#
|
|
1697
|
+
# @option params [required, Array<Types::DataTableDeleteValueIdentifier>] :values
|
|
1698
|
+
# A list of value identifiers to delete, each specifying primary values,
|
|
1699
|
+
# attribute name, and lock version information.
|
|
1700
|
+
#
|
|
1701
|
+
# @return [Types::BatchDeleteDataTableValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1702
|
+
#
|
|
1703
|
+
# * {Types::BatchDeleteDataTableValueResponse#successful #successful} => Array<Types::BatchDeleteDataTableValueSuccessResult>
|
|
1704
|
+
# * {Types::BatchDeleteDataTableValueResponse#failed #failed} => Array<Types::BatchDeleteDataTableValueFailureResult>
|
|
1705
|
+
#
|
|
1706
|
+
# @example Request syntax with placeholder values
|
|
1707
|
+
#
|
|
1708
|
+
# resp = client.batch_delete_data_table_value({
|
|
1709
|
+
# instance_id: "InstanceId", # required
|
|
1710
|
+
# data_table_id: "DataTableId", # required
|
|
1711
|
+
# values: [ # required
|
|
1712
|
+
# {
|
|
1713
|
+
# primary_values: [
|
|
1714
|
+
# {
|
|
1715
|
+
# attribute_name: "DataTableName", # required
|
|
1716
|
+
# value: "String", # required
|
|
1717
|
+
# },
|
|
1718
|
+
# ],
|
|
1719
|
+
# attribute_name: "DataTableName", # required
|
|
1720
|
+
# lock_version: { # required
|
|
1721
|
+
# data_table: "String",
|
|
1722
|
+
# attribute: "String",
|
|
1723
|
+
# primary_values: "String",
|
|
1724
|
+
# value: "String",
|
|
1725
|
+
# },
|
|
1726
|
+
# },
|
|
1727
|
+
# ],
|
|
1728
|
+
# })
|
|
1729
|
+
#
|
|
1730
|
+
# @example Response structure
|
|
1731
|
+
#
|
|
1732
|
+
# resp.successful #=> Array
|
|
1733
|
+
# resp.successful[0].primary_values #=> Array
|
|
1734
|
+
# resp.successful[0].primary_values[0].attribute_name #=> String
|
|
1735
|
+
# resp.successful[0].primary_values[0].value #=> String
|
|
1736
|
+
# resp.successful[0].attribute_name #=> String
|
|
1737
|
+
# resp.successful[0].lock_version.data_table #=> String
|
|
1738
|
+
# resp.successful[0].lock_version.attribute #=> String
|
|
1739
|
+
# resp.successful[0].lock_version.primary_values #=> String
|
|
1740
|
+
# resp.successful[0].lock_version.value #=> String
|
|
1741
|
+
# resp.failed #=> Array
|
|
1742
|
+
# resp.failed[0].primary_values #=> Array
|
|
1743
|
+
# resp.failed[0].primary_values[0].attribute_name #=> String
|
|
1744
|
+
# resp.failed[0].primary_values[0].value #=> String
|
|
1745
|
+
# resp.failed[0].attribute_name #=> String
|
|
1746
|
+
# resp.failed[0].message #=> String
|
|
1747
|
+
#
|
|
1748
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchDeleteDataTableValue AWS API Documentation
|
|
1749
|
+
#
|
|
1750
|
+
# @overload batch_delete_data_table_value(params = {})
|
|
1751
|
+
# @param [Hash] params ({})
|
|
1752
|
+
def batch_delete_data_table_value(params = {}, options = {})
|
|
1753
|
+
req = build_request(:batch_delete_data_table_value, params)
|
|
1754
|
+
req.send_request(options)
|
|
1755
|
+
end
|
|
1756
|
+
|
|
1757
|
+
# Retrieves multiple values from a data table without evaluating
|
|
1758
|
+
# expressions. Returns the raw stored values along with metadata such as
|
|
1759
|
+
# lock versions and modification timestamps. "Describe" is a
|
|
1760
|
+
# deprecated term but is allowed to maintain consistency with existing
|
|
1761
|
+
# operations.
|
|
1762
|
+
#
|
|
1763
|
+
# @option params [required, String] :instance_id
|
|
1764
|
+
# The unique identifier for the Amazon Connect instance.
|
|
1765
|
+
#
|
|
1766
|
+
# @option params [required, String] :data_table_id
|
|
1767
|
+
# The unique identifier for the data table. Must also accept the table
|
|
1768
|
+
# ARN with or without a version alias.
|
|
1769
|
+
#
|
|
1770
|
+
# @option params [required, Array<Types::DataTableValueIdentifier>] :values
|
|
1771
|
+
# A list of value identifiers to retrieve, each specifying primary
|
|
1772
|
+
# values and attribute names.
|
|
1773
|
+
#
|
|
1774
|
+
# @return [Types::BatchDescribeDataTableValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1775
|
+
#
|
|
1776
|
+
# * {Types::BatchDescribeDataTableValueResponse#successful #successful} => Array<Types::BatchDescribeDataTableValueSuccessResult>
|
|
1777
|
+
# * {Types::BatchDescribeDataTableValueResponse#failed #failed} => Array<Types::BatchDescribeDataTableValueFailureResult>
|
|
1778
|
+
#
|
|
1779
|
+
# @example Request syntax with placeholder values
|
|
1780
|
+
#
|
|
1781
|
+
# resp = client.batch_describe_data_table_value({
|
|
1782
|
+
# instance_id: "InstanceId", # required
|
|
1783
|
+
# data_table_id: "DataTableId", # required
|
|
1784
|
+
# values: [ # required
|
|
1785
|
+
# {
|
|
1786
|
+
# primary_values: [
|
|
1787
|
+
# {
|
|
1788
|
+
# attribute_name: "DataTableName", # required
|
|
1789
|
+
# value: "String", # required
|
|
1790
|
+
# },
|
|
1791
|
+
# ],
|
|
1792
|
+
# attribute_name: "DataTableName", # required
|
|
1793
|
+
# },
|
|
1794
|
+
# ],
|
|
1795
|
+
# })
|
|
1796
|
+
#
|
|
1797
|
+
# @example Response structure
|
|
1798
|
+
#
|
|
1799
|
+
# resp.successful #=> Array
|
|
1800
|
+
# resp.successful[0].record_id #=> String
|
|
1801
|
+
# resp.successful[0].attribute_id #=> String
|
|
1802
|
+
# resp.successful[0].primary_values #=> Array
|
|
1803
|
+
# resp.successful[0].primary_values[0].attribute_name #=> String
|
|
1804
|
+
# resp.successful[0].primary_values[0].attribute_id #=> String
|
|
1805
|
+
# resp.successful[0].primary_values[0].value #=> String
|
|
1806
|
+
# resp.successful[0].attribute_name #=> String
|
|
1807
|
+
# resp.successful[0].value #=> String
|
|
1808
|
+
# resp.successful[0].lock_version.data_table #=> String
|
|
1809
|
+
# resp.successful[0].lock_version.attribute #=> String
|
|
1810
|
+
# resp.successful[0].lock_version.primary_values #=> String
|
|
1811
|
+
# resp.successful[0].lock_version.value #=> String
|
|
1812
|
+
# resp.successful[0].last_modified_time #=> Time
|
|
1813
|
+
# resp.successful[0].last_modified_region #=> String
|
|
1814
|
+
# resp.failed #=> Array
|
|
1815
|
+
# resp.failed[0].primary_values #=> Array
|
|
1816
|
+
# resp.failed[0].primary_values[0].attribute_name #=> String
|
|
1817
|
+
# resp.failed[0].primary_values[0].value #=> String
|
|
1818
|
+
# resp.failed[0].attribute_name #=> String
|
|
1819
|
+
# resp.failed[0].message #=> String
|
|
1820
|
+
#
|
|
1821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchDescribeDataTableValue AWS API Documentation
|
|
1822
|
+
#
|
|
1823
|
+
# @overload batch_describe_data_table_value(params = {})
|
|
1824
|
+
# @param [Hash] params ({})
|
|
1825
|
+
def batch_describe_data_table_value(params = {}, options = {})
|
|
1826
|
+
req = build_request(:batch_describe_data_table_value, params)
|
|
1827
|
+
req.send_request(options)
|
|
1828
|
+
end
|
|
1829
|
+
|
|
1513
1830
|
# Removes a list of analytics datasets associated with a given Amazon
|
|
1514
1831
|
# Connect instance. You can disassociate multiple datasets in a single
|
|
1515
1832
|
# call.
|
|
@@ -1781,6 +2098,81 @@ module Aws::Connect
|
|
|
1781
2098
|
req.send_request(options)
|
|
1782
2099
|
end
|
|
1783
2100
|
|
|
2101
|
+
# Updates multiple data table values using all properties from
|
|
2102
|
+
# BatchCreateDataTableValue. System managed values are not modifiable by
|
|
2103
|
+
# customers. The operation requires proper lock versions to prevent
|
|
2104
|
+
# concurrent modification conflicts.
|
|
2105
|
+
#
|
|
2106
|
+
# @option params [required, String] :instance_id
|
|
2107
|
+
# The unique identifier for the Amazon Connect instance.
|
|
2108
|
+
#
|
|
2109
|
+
# @option params [required, String] :data_table_id
|
|
2110
|
+
# The unique identifier for the data table. Must also accept the table
|
|
2111
|
+
# ARN with or without a version alias.
|
|
2112
|
+
#
|
|
2113
|
+
# @option params [required, Array<Types::DataTableValue>] :values
|
|
2114
|
+
# A list of values to update, each including the current lock version to
|
|
2115
|
+
# ensure optimistic locking.
|
|
2116
|
+
#
|
|
2117
|
+
# @return [Types::BatchUpdateDataTableValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2118
|
+
#
|
|
2119
|
+
# * {Types::BatchUpdateDataTableValueResponse#successful #successful} => Array<Types::BatchUpdateDataTableValueSuccessResult>
|
|
2120
|
+
# * {Types::BatchUpdateDataTableValueResponse#failed #failed} => Array<Types::BatchUpdateDataTableValueFailureResult>
|
|
2121
|
+
#
|
|
2122
|
+
# @example Request syntax with placeholder values
|
|
2123
|
+
#
|
|
2124
|
+
# resp = client.batch_update_data_table_value({
|
|
2125
|
+
# instance_id: "InstanceId", # required
|
|
2126
|
+
# data_table_id: "DataTableId", # required
|
|
2127
|
+
# values: [ # required
|
|
2128
|
+
# {
|
|
2129
|
+
# primary_values: [
|
|
2130
|
+
# {
|
|
2131
|
+
# attribute_name: "DataTableName", # required
|
|
2132
|
+
# value: "String", # required
|
|
2133
|
+
# },
|
|
2134
|
+
# ],
|
|
2135
|
+
# attribute_name: "DataTableName", # required
|
|
2136
|
+
# value: "String", # required
|
|
2137
|
+
# lock_version: {
|
|
2138
|
+
# data_table: "String",
|
|
2139
|
+
# attribute: "String",
|
|
2140
|
+
# primary_values: "String",
|
|
2141
|
+
# value: "String",
|
|
2142
|
+
# },
|
|
2143
|
+
# last_modified_time: Time.now,
|
|
2144
|
+
# last_modified_region: "RegionName",
|
|
2145
|
+
# },
|
|
2146
|
+
# ],
|
|
2147
|
+
# })
|
|
2148
|
+
#
|
|
2149
|
+
# @example Response structure
|
|
2150
|
+
#
|
|
2151
|
+
# resp.successful #=> Array
|
|
2152
|
+
# resp.successful[0].primary_values #=> Array
|
|
2153
|
+
# resp.successful[0].primary_values[0].attribute_name #=> String
|
|
2154
|
+
# resp.successful[0].primary_values[0].value #=> String
|
|
2155
|
+
# resp.successful[0].attribute_name #=> String
|
|
2156
|
+
# resp.successful[0].lock_version.data_table #=> String
|
|
2157
|
+
# resp.successful[0].lock_version.attribute #=> String
|
|
2158
|
+
# resp.successful[0].lock_version.primary_values #=> String
|
|
2159
|
+
# resp.successful[0].lock_version.value #=> String
|
|
2160
|
+
# resp.failed #=> Array
|
|
2161
|
+
# resp.failed[0].primary_values #=> Array
|
|
2162
|
+
# resp.failed[0].primary_values[0].attribute_name #=> String
|
|
2163
|
+
# resp.failed[0].primary_values[0].value #=> String
|
|
2164
|
+
# resp.failed[0].attribute_name #=> String
|
|
2165
|
+
# resp.failed[0].message #=> String
|
|
2166
|
+
#
|
|
2167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchUpdateDataTableValue AWS API Documentation
|
|
2168
|
+
#
|
|
2169
|
+
# @overload batch_update_data_table_value(params = {})
|
|
2170
|
+
# @param [Hash] params ({})
|
|
2171
|
+
def batch_update_data_table_value(params = {}, options = {})
|
|
2172
|
+
req = build_request(:batch_update_data_table_value, params)
|
|
2173
|
+
req.send_request(options)
|
|
2174
|
+
end
|
|
2175
|
+
|
|
1784
2176
|
# Claims an available phone number to your Amazon Connect instance or
|
|
1785
2177
|
# traffic distribution group. You can call this API only in the same
|
|
1786
2178
|
# Amazon Web Services Region where the Amazon Connect instance or
|
|
@@ -2140,7 +2532,7 @@ module Aws::Connect
|
|
|
2140
2532
|
# references: {
|
|
2141
2533
|
# "ReferenceKey" => {
|
|
2142
2534
|
# value: "ReferenceValue",
|
|
2143
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
2535
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
2144
2536
|
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
|
2145
2537
|
# arn: "ReferenceArn",
|
|
2146
2538
|
# status_reason: "ReferenceStatusReason",
|
|
@@ -2514,6 +2906,181 @@ module Aws::Connect
|
|
|
2514
2906
|
req.send_request(options)
|
|
2515
2907
|
end
|
|
2516
2908
|
|
|
2909
|
+
# Creates a new data table with the specified properties. Supports the
|
|
2910
|
+
# creation of all table properties except for attributes and values. A
|
|
2911
|
+
# table with no attributes and values is a valid state for a table. The
|
|
2912
|
+
# number of tables per instance is limited to 100 per instance.
|
|
2913
|
+
# Customers can request an increase by using AWS Service Quotas.
|
|
2914
|
+
#
|
|
2915
|
+
# @option params [required, String] :instance_id
|
|
2916
|
+
# The unique identifier for the Amazon Connect instance where the data
|
|
2917
|
+
# table will be created.
|
|
2918
|
+
#
|
|
2919
|
+
# @option params [required, String] :name
|
|
2920
|
+
# The name for the data table. Must conform to Connect human readable
|
|
2921
|
+
# string specification and have 1-127 characters. Whitespace must be
|
|
2922
|
+
# trimmed first. Must not start with the reserved case insensitive
|
|
2923
|
+
# values 'connect:' and 'aws:'. Must be unique for the instance
|
|
2924
|
+
# using case-insensitive comparison.
|
|
2925
|
+
#
|
|
2926
|
+
# @option params [String] :description
|
|
2927
|
+
# An optional description for the data table. Must conform to Connect
|
|
2928
|
+
# human readable string specification and have 0-250 characters.
|
|
2929
|
+
# Whitespace must be trimmed first.
|
|
2930
|
+
#
|
|
2931
|
+
# @option params [required, String] :time_zone
|
|
2932
|
+
# The IANA timezone identifier to use when resolving time based dynamic
|
|
2933
|
+
# values. Required even if no time slices are specified.
|
|
2934
|
+
#
|
|
2935
|
+
# @option params [required, String] :value_lock_level
|
|
2936
|
+
# The data level that concurrent value edits are locked on. One of
|
|
2937
|
+
# DATA\_TABLE, PRIMARY\_VALUE, ATTRIBUTE, VALUE, and NONE. NONE is the
|
|
2938
|
+
# default if unspecified. This determines how concurrent edits are
|
|
2939
|
+
# handled when multiple users attempt to modify values simultaneously.
|
|
2940
|
+
#
|
|
2941
|
+
# @option params [required, String] :status
|
|
2942
|
+
# The status of the data table. One of PUBLISHED or SAVED. Required
|
|
2943
|
+
# parameter that determines the initial state of the table.
|
|
2944
|
+
#
|
|
2945
|
+
# @option params [Hash<String,String>] :tags
|
|
2946
|
+
# Key value pairs for attribute based access control (TBAC or ABAC).
|
|
2947
|
+
# Optional tags to apply to the data table for organization and access
|
|
2948
|
+
# control purposes.
|
|
2949
|
+
#
|
|
2950
|
+
# @return [Types::CreateDataTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2951
|
+
#
|
|
2952
|
+
# * {Types::CreateDataTableResponse#id #id} => String
|
|
2953
|
+
# * {Types::CreateDataTableResponse#arn #arn} => String
|
|
2954
|
+
# * {Types::CreateDataTableResponse#lock_version #lock_version} => Types::DataTableLockVersion
|
|
2955
|
+
#
|
|
2956
|
+
# @example Request syntax with placeholder values
|
|
2957
|
+
#
|
|
2958
|
+
# resp = client.create_data_table({
|
|
2959
|
+
# instance_id: "InstanceId", # required
|
|
2960
|
+
# name: "DataTableName", # required
|
|
2961
|
+
# description: "DataTableDescription",
|
|
2962
|
+
# time_zone: "TimeZone", # required
|
|
2963
|
+
# value_lock_level: "NONE", # required, accepts NONE, DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE
|
|
2964
|
+
# status: "PUBLISHED", # required, accepts PUBLISHED
|
|
2965
|
+
# tags: {
|
|
2966
|
+
# "TagKey" => "TagValue",
|
|
2967
|
+
# },
|
|
2968
|
+
# })
|
|
2969
|
+
#
|
|
2970
|
+
# @example Response structure
|
|
2971
|
+
#
|
|
2972
|
+
# resp.id #=> String
|
|
2973
|
+
# resp.arn #=> String
|
|
2974
|
+
# resp.lock_version.data_table #=> String
|
|
2975
|
+
# resp.lock_version.attribute #=> String
|
|
2976
|
+
# resp.lock_version.primary_values #=> String
|
|
2977
|
+
# resp.lock_version.value #=> String
|
|
2978
|
+
#
|
|
2979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateDataTable AWS API Documentation
|
|
2980
|
+
#
|
|
2981
|
+
# @overload create_data_table(params = {})
|
|
2982
|
+
# @param [Hash] params ({})
|
|
2983
|
+
def create_data_table(params = {}, options = {})
|
|
2984
|
+
req = build_request(:create_data_table, params)
|
|
2985
|
+
req.send_request(options)
|
|
2986
|
+
end
|
|
2987
|
+
|
|
2988
|
+
# Adds an attribute to an existing data table. Creating a new primary
|
|
2989
|
+
# attribute uses the empty value for the specified value type for all
|
|
2990
|
+
# existing records. This should not affect uniqueness of published data
|
|
2991
|
+
# tables since the existing primary values will already be unique.
|
|
2992
|
+
# Creating attributes does not create any values. System managed tables
|
|
2993
|
+
# may not allow customers to create new attributes.
|
|
2994
|
+
#
|
|
2995
|
+
# @option params [required, String] :instance_id
|
|
2996
|
+
# The unique identifier for the Amazon Connect instance.
|
|
2997
|
+
#
|
|
2998
|
+
# @option params [required, String] :data_table_id
|
|
2999
|
+
# The unique identifier for the data table. Must also accept the table
|
|
3000
|
+
# ARN with or without a version alias. If the version is provided as
|
|
3001
|
+
# part of the identifier or ARN, the version must be one of the two
|
|
3002
|
+
# available system managed aliases, $SAVED or $LATEST.
|
|
3003
|
+
#
|
|
3004
|
+
# @option params [required, String] :name
|
|
3005
|
+
# The name for the attribute. Must conform to Connect human readable
|
|
3006
|
+
# string specification and have 1-127 characters. Must not start with
|
|
3007
|
+
# the reserved case insensitive values 'connect:' and 'aws:'.
|
|
3008
|
+
# Whitespace trimmed before persisting. Must be unique for the data
|
|
3009
|
+
# table using case-insensitive comparison.
|
|
3010
|
+
#
|
|
3011
|
+
# @option params [required, String] :value_type
|
|
3012
|
+
# The type of value allowed or the resultant type after the value's
|
|
3013
|
+
# expression is evaluated. Must be one of TEXT, TEXT\_LIST, NUMBER,
|
|
3014
|
+
# NUMBER\_LIST, and BOOLEAN.
|
|
3015
|
+
#
|
|
3016
|
+
# @option params [String] :description
|
|
3017
|
+
# An optional description for the attribute. Must conform to Connect
|
|
3018
|
+
# human readable string specification and have 0-250 characters.
|
|
3019
|
+
# Whitespace trimmed before persisting.
|
|
3020
|
+
#
|
|
3021
|
+
# @option params [Boolean] :primary
|
|
3022
|
+
# Optional boolean that defaults to false. Determines if the value is
|
|
3023
|
+
# used to identify a record in the table. Values for primary attributes
|
|
3024
|
+
# must not be expressions.
|
|
3025
|
+
#
|
|
3026
|
+
# @option params [Types::Validation] :validation
|
|
3027
|
+
# Optional validation rules for the attribute. Borrows heavily from JSON
|
|
3028
|
+
# Schema - Draft 2020-12. The maximum length of arrays within
|
|
3029
|
+
# validations and depth of validations is 5. There are default limits
|
|
3030
|
+
# that apply to all types. Customer specified limits in excess of the
|
|
3031
|
+
# default limits are not permitted.
|
|
3032
|
+
#
|
|
3033
|
+
# @return [Types::CreateDataTableAttributeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3034
|
+
#
|
|
3035
|
+
# * {Types::CreateDataTableAttributeResponse#name #name} => String
|
|
3036
|
+
# * {Types::CreateDataTableAttributeResponse#attribute_id #attribute_id} => String
|
|
3037
|
+
# * {Types::CreateDataTableAttributeResponse#lock_version #lock_version} => Types::DataTableLockVersion
|
|
3038
|
+
#
|
|
3039
|
+
# @example Request syntax with placeholder values
|
|
3040
|
+
#
|
|
3041
|
+
# resp = client.create_data_table_attribute({
|
|
3042
|
+
# instance_id: "InstanceId", # required
|
|
3043
|
+
# data_table_id: "DataTableId", # required
|
|
3044
|
+
# name: "DataTableName", # required
|
|
3045
|
+
# value_type: "TEXT", # required, accepts TEXT, NUMBER, BOOLEAN, TEXT_LIST, NUMBER_LIST
|
|
3046
|
+
# description: "DataTableDescription",
|
|
3047
|
+
# primary: false,
|
|
3048
|
+
# validation: {
|
|
3049
|
+
# min_length: 1,
|
|
3050
|
+
# max_length: 1,
|
|
3051
|
+
# min_values: 1,
|
|
3052
|
+
# max_values: 1,
|
|
3053
|
+
# ignore_case: false,
|
|
3054
|
+
# minimum: 1.0,
|
|
3055
|
+
# maximum: 1.0,
|
|
3056
|
+
# exclusive_minimum: 1.0,
|
|
3057
|
+
# exclusive_maximum: 1.0,
|
|
3058
|
+
# multiple_of: 1.0,
|
|
3059
|
+
# enum: {
|
|
3060
|
+
# strict: false,
|
|
3061
|
+
# values: ["String"],
|
|
3062
|
+
# },
|
|
3063
|
+
# },
|
|
3064
|
+
# })
|
|
3065
|
+
#
|
|
3066
|
+
# @example Response structure
|
|
3067
|
+
#
|
|
3068
|
+
# resp.name #=> String
|
|
3069
|
+
# resp.attribute_id #=> String
|
|
3070
|
+
# resp.lock_version.data_table #=> String
|
|
3071
|
+
# resp.lock_version.attribute #=> String
|
|
3072
|
+
# resp.lock_version.primary_values #=> String
|
|
3073
|
+
# resp.lock_version.value #=> String
|
|
3074
|
+
#
|
|
3075
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateDataTableAttribute AWS API Documentation
|
|
3076
|
+
#
|
|
3077
|
+
# @overload create_data_table_attribute(params = {})
|
|
3078
|
+
# @param [Hash] params ({})
|
|
3079
|
+
def create_data_table_attribute(params = {}, options = {})
|
|
3080
|
+
req = build_request(:create_data_table_attribute, params)
|
|
3081
|
+
req.send_request(options)
|
|
3082
|
+
end
|
|
3083
|
+
|
|
2517
3084
|
# Create new email address in the specified Amazon Connect instance. For
|
|
2518
3085
|
# more information about email addresses, see [Create email
|
|
2519
3086
|
# addresses][1] in the Amazon Connect Administrator Guide.
|
|
@@ -2629,11 +3196,21 @@ module Aws::Connect
|
|
|
2629
3196
|
#
|
|
2630
3197
|
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
2631
3198
|
#
|
|
3199
|
+
# @option params [Boolean] :as_draft
|
|
3200
|
+
# A boolean flag indicating whether to create evaluation form in draft
|
|
3201
|
+
# state.
|
|
3202
|
+
#
|
|
2632
3203
|
# @option params [Hash<String,String>] :tags
|
|
2633
3204
|
# The tags used to organize, track, or control access for this resource.
|
|
2634
3205
|
# For example, \{ "Tags": \{"key1":"value1", "key2":"value2"}
|
|
2635
3206
|
# }.
|
|
2636
3207
|
#
|
|
3208
|
+
# @option params [Types::EvaluationFormTargetConfiguration] :target_configuration
|
|
3209
|
+
# Configuration that specifies the target for the evaluation form.
|
|
3210
|
+
#
|
|
3211
|
+
# @option params [Types::EvaluationFormLanguageConfiguration] :language_configuration
|
|
3212
|
+
# Configuration for language settings of the evaluation form.
|
|
3213
|
+
#
|
|
2637
3214
|
# @return [Types::CreateEvaluationFormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2638
3215
|
#
|
|
2639
3216
|
# * {Types::CreateEvaluationFormResponse#evaluation_form_id #evaluation_form_id} => String
|
|
@@ -2661,7 +3238,7 @@ module Aws::Connect
|
|
|
2661
3238
|
# instructions: "EvaluationFormQuestionInstructions",
|
|
2662
3239
|
# ref_id: "ReferenceId", # required
|
|
2663
3240
|
# not_applicable_enabled: false,
|
|
2664
|
-
# question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC
|
|
3241
|
+
# question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC, MULTISELECT, DATETIME
|
|
2665
3242
|
# question_type_properties: {
|
|
2666
3243
|
# numeric: {
|
|
2667
3244
|
# min_value: 1, # required
|
|
@@ -2679,7 +3256,7 @@ module Aws::Connect
|
|
|
2679
3256
|
# ],
|
|
2680
3257
|
# automation: {
|
|
2681
3258
|
# property_value: {
|
|
2682
|
-
# label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts OVERALL_CUSTOMER_SENTIMENT_SCORE, OVERALL_AGENT_SENTIMENT_SCORE, 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
|
|
3259
|
+
# label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts 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
|
|
2683
3260
|
# },
|
|
2684
3261
|
# answer_source: {
|
|
2685
3262
|
# source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
|
|
@@ -2722,6 +3299,30 @@ module Aws::Connect
|
|
|
2722
3299
|
# },
|
|
2723
3300
|
# },
|
|
2724
3301
|
# },
|
|
3302
|
+
# multi_select: {
|
|
3303
|
+
# options: [ # required
|
|
3304
|
+
# {
|
|
3305
|
+
# ref_id: "ReferenceId", # required
|
|
3306
|
+
# text: "EvaluationFormMultiSelectQuestionOptionText", # required
|
|
3307
|
+
# },
|
|
3308
|
+
# ],
|
|
3309
|
+
# display_as: "DROPDOWN", # accepts DROPDOWN, CHECKBOX
|
|
3310
|
+
# automation: {
|
|
3311
|
+
# options: [
|
|
3312
|
+
# {
|
|
3313
|
+
# rule_category: {
|
|
3314
|
+
# category: "MultiSelectQuestionRuleCategoryAutomationLabel", # required
|
|
3315
|
+
# condition: "PRESENT", # required, accepts PRESENT, NOT_PRESENT
|
|
3316
|
+
# option_ref_ids: ["ReferenceId"], # required
|
|
3317
|
+
# },
|
|
3318
|
+
# },
|
|
3319
|
+
# ],
|
|
3320
|
+
# default_option_ref_ids: ["ReferenceId"],
|
|
3321
|
+
# answer_source: {
|
|
3322
|
+
# source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
|
|
3323
|
+
# },
|
|
3324
|
+
# },
|
|
3325
|
+
# },
|
|
2725
3326
|
# },
|
|
2726
3327
|
# enablement: {
|
|
2727
3328
|
# condition: { # required
|
|
@@ -2738,7 +3339,7 @@ module Aws::Connect
|
|
|
2738
3339
|
# ref_id: "ReferenceId",
|
|
2739
3340
|
# },
|
|
2740
3341
|
# ],
|
|
2741
|
-
# comparator: "IN", # required, accepts IN, NOT_IN
|
|
3342
|
+
# comparator: "IN", # required, accepts IN, NOT_IN, ALL_IN, EXACT
|
|
2742
3343
|
# },
|
|
2743
3344
|
# condition: {
|
|
2744
3345
|
# # recursive EvaluationFormItemEnablementCondition
|
|
@@ -2762,9 +3363,16 @@ module Aws::Connect
|
|
|
2762
3363
|
# enabled: false, # required
|
|
2763
3364
|
# },
|
|
2764
3365
|
# client_token: "ClientToken",
|
|
3366
|
+
# as_draft: false,
|
|
2765
3367
|
# tags: {
|
|
2766
3368
|
# "TagKey" => "TagValue",
|
|
2767
3369
|
# },
|
|
3370
|
+
# target_configuration: {
|
|
3371
|
+
# contact_interaction_type: "AGENT", # required, accepts AGENT, AUTOMATED
|
|
3372
|
+
# },
|
|
3373
|
+
# language_configuration: {
|
|
3374
|
+
# form_language: "de-DE", # accepts de-DE, en-US, es-ES, fr-FR, it-IT, pt-BR
|
|
3375
|
+
# },
|
|
2768
3376
|
# })
|
|
2769
3377
|
#
|
|
2770
3378
|
# @example Response structure
|
|
@@ -3048,7 +3656,7 @@ module Aws::Connect
|
|
|
3048
3656
|
#
|
|
3049
3657
|
# resp = client.create_integration_association({
|
|
3050
3658
|
# instance_id: "InstanceId", # required
|
|
3051
|
-
# integration_type: "EVENT", # required, accepts 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
|
|
3659
|
+
# integration_type: "EVENT", # required, accepts 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
|
|
3052
3660
|
# integration_arn: "ARN", # required
|
|
3053
3661
|
# source_application_url: "URI",
|
|
3054
3662
|
# source_application_name: "SourceApplicationName",
|
|
@@ -3631,7 +4239,7 @@ module Aws::Connect
|
|
|
3631
4239
|
# name: "QuickConnectName", # required
|
|
3632
4240
|
# description: "QuickConnectDescription",
|
|
3633
4241
|
# quick_connect_config: { # required
|
|
3634
|
-
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
|
4242
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER, FLOW
|
|
3635
4243
|
# user_config: {
|
|
3636
4244
|
# user_id: "UserId", # required
|
|
3637
4245
|
# contact_flow_id: "ContactFlowId", # required
|
|
@@ -3643,6 +4251,9 @@ module Aws::Connect
|
|
|
3643
4251
|
# phone_config: {
|
|
3644
4252
|
# phone_number: "PhoneNumber", # required
|
|
3645
4253
|
# },
|
|
4254
|
+
# flow_config: {
|
|
4255
|
+
# contact_flow_id: "ContactFlowId", # required
|
|
4256
|
+
# },
|
|
3646
4257
|
# },
|
|
3647
4258
|
# tags: {
|
|
3648
4259
|
# "TagKey" => "TagValue",
|
|
@@ -3849,7 +4460,7 @@ module Aws::Connect
|
|
|
3849
4460
|
# references: {
|
|
3850
4461
|
# "ReferenceKey" => {
|
|
3851
4462
|
# value: "ReferenceValue",
|
|
3852
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
4463
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
3853
4464
|
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
|
3854
4465
|
# arn: "ReferenceArn",
|
|
3855
4466
|
# status_reason: "ReferenceStatusReason",
|
|
@@ -4005,8 +4616,8 @@ module Aws::Connect
|
|
|
4005
4616
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html
|
|
4006
4617
|
#
|
|
4007
4618
|
# @option params [Array<Types::Application>] :applications
|
|
4008
|
-
# A list of third-party applications that the security
|
|
4009
|
-
# access to.
|
|
4619
|
+
# A list of third-party applications or MCP Servers that the security
|
|
4620
|
+
# profile will give access to.
|
|
4010
4621
|
#
|
|
4011
4622
|
# @option params [Array<String>] :hierarchy_restricted_resources
|
|
4012
4623
|
# The list of resources that a security profile applies hierarchy
|
|
@@ -4017,6 +4628,13 @@ module Aws::Connect
|
|
|
4017
4628
|
# The identifier of the hierarchy group that a security profile uses to
|
|
4018
4629
|
# restrict access to resources in Amazon Connect.
|
|
4019
4630
|
#
|
|
4631
|
+
# @option params [Array<Types::FlowModule>] :allowed_flow_modules
|
|
4632
|
+
# A list of Flow Modules an AI Agent can invoke as a tool.
|
|
4633
|
+
#
|
|
4634
|
+
# @option params [Types::GranularAccessControlConfiguration] :granular_access_control_configuration
|
|
4635
|
+
# The granular access control configuration for the security profile,
|
|
4636
|
+
# including data table permissions.
|
|
4637
|
+
#
|
|
4020
4638
|
# @return [Types::CreateSecurityProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4021
4639
|
#
|
|
4022
4640
|
# * {Types::CreateSecurityProfileResponse#security_profile_id #security_profile_id} => String
|
|
@@ -4040,10 +4658,30 @@ module Aws::Connect
|
|
|
4040
4658
|
# {
|
|
4041
4659
|
# namespace: "Namespace",
|
|
4042
4660
|
# application_permissions: ["Permission"],
|
|
4661
|
+
# type: "MCP", # accepts MCP, THIRD_PARTY_APPLICATION
|
|
4043
4662
|
# },
|
|
4044
4663
|
# ],
|
|
4045
4664
|
# hierarchy_restricted_resources: ["HierarchyRestrictedResourceName"],
|
|
4046
4665
|
# allowed_access_control_hierarchy_group_id: "HierarchyGroupId",
|
|
4666
|
+
# allowed_flow_modules: [
|
|
4667
|
+
# {
|
|
4668
|
+
# type: "MCP", # accepts MCP
|
|
4669
|
+
# flow_module_id: "FlowModuleId",
|
|
4670
|
+
# },
|
|
4671
|
+
# ],
|
|
4672
|
+
# granular_access_control_configuration: {
|
|
4673
|
+
# data_table_access_control_configuration: {
|
|
4674
|
+
# primary_attribute_access_control_configuration: {
|
|
4675
|
+
# primary_attribute_values: [
|
|
4676
|
+
# {
|
|
4677
|
+
# access_type: "ALLOW", # accepts ALLOW
|
|
4678
|
+
# attribute_name: "PrimaryAttributeContextKeyName",
|
|
4679
|
+
# values: ["IAMRestrictedPrimaryValue"],
|
|
4680
|
+
# },
|
|
4681
|
+
# ],
|
|
4682
|
+
# },
|
|
4683
|
+
# },
|
|
4684
|
+
# },
|
|
4047
4685
|
# })
|
|
4048
4686
|
#
|
|
4049
4687
|
# @example Response structure
|
|
@@ -4742,9 +5380,8 @@ module Aws::Connect
|
|
|
4742
5380
|
req.send_request(options)
|
|
4743
5381
|
end
|
|
4744
5382
|
|
|
4745
|
-
#
|
|
4746
|
-
#
|
|
4747
|
-
# users to start new evaluations based on the form.
|
|
5383
|
+
# Creates a workspace that defines the user experience by mapping views
|
|
5384
|
+
# to pages. Workspaces can be assigned to users or routing profiles.
|
|
4748
5385
|
#
|
|
4749
5386
|
# @option params [required, String] :instance_id
|
|
4750
5387
|
# The identifier of the Amazon Connect instance. You can [find the
|
|
@@ -4754,10 +5391,204 @@ module Aws::Connect
|
|
|
4754
5391
|
#
|
|
4755
5392
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
4756
5393
|
#
|
|
4757
|
-
# @option params [required, String] :
|
|
4758
|
-
# The unique
|
|
5394
|
+
# @option params [required, String] :name
|
|
5395
|
+
# The name of the workspace. Must be unique within the instance and can
|
|
5396
|
+
# contain 1-127 characters.
|
|
4759
5397
|
#
|
|
4760
|
-
# @option params [
|
|
5398
|
+
# @option params [String] :description
|
|
5399
|
+
# The description of the workspace. Maximum length is 250 characters.
|
|
5400
|
+
#
|
|
5401
|
+
# @option params [Types::WorkspaceTheme] :theme
|
|
5402
|
+
# The theme configuration for the workspace, including colors and
|
|
5403
|
+
# styling.
|
|
5404
|
+
#
|
|
5405
|
+
# @option params [String] :title
|
|
5406
|
+
# The title displayed for the workspace.
|
|
5407
|
+
#
|
|
5408
|
+
# @option params [Hash<String,String>] :tags
|
|
5409
|
+
# The tags used to organize, track, or control access for this resource.
|
|
5410
|
+
# For example, `{ "Tags": {"key1":"value1", "key2":"value2"} }`.
|
|
5411
|
+
#
|
|
5412
|
+
# @return [Types::CreateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5413
|
+
#
|
|
5414
|
+
# * {Types::CreateWorkspaceResponse#workspace_id #workspace_id} => String
|
|
5415
|
+
# * {Types::CreateWorkspaceResponse#workspace_arn #workspace_arn} => String
|
|
5416
|
+
#
|
|
5417
|
+
# @example Request syntax with placeholder values
|
|
5418
|
+
#
|
|
5419
|
+
# resp = client.create_workspace({
|
|
5420
|
+
# instance_id: "InstanceId", # required
|
|
5421
|
+
# name: "WorkspaceName", # required
|
|
5422
|
+
# description: "WorkspaceDescription",
|
|
5423
|
+
# theme: {
|
|
5424
|
+
# light: {
|
|
5425
|
+
# palette: {
|
|
5426
|
+
# header: {
|
|
5427
|
+
# background: "ThemeString",
|
|
5428
|
+
# text: "ThemeString",
|
|
5429
|
+
# text_hover: "ThemeString",
|
|
5430
|
+
# invert_actions_colors: false,
|
|
5431
|
+
# },
|
|
5432
|
+
# navigation: {
|
|
5433
|
+
# background: "ThemeString",
|
|
5434
|
+
# text_background_hover: "ThemeString",
|
|
5435
|
+
# text_background_active: "ThemeString",
|
|
5436
|
+
# text: "ThemeString",
|
|
5437
|
+
# text_hover: "ThemeString",
|
|
5438
|
+
# text_active: "ThemeString",
|
|
5439
|
+
# invert_actions_colors: false,
|
|
5440
|
+
# },
|
|
5441
|
+
# canvas: {
|
|
5442
|
+
# container_background: "ThemeString",
|
|
5443
|
+
# page_background: "ThemeString",
|
|
5444
|
+
# active_background: "ThemeString",
|
|
5445
|
+
# },
|
|
5446
|
+
# primary: {
|
|
5447
|
+
# default: "ThemeString",
|
|
5448
|
+
# active: "ThemeString",
|
|
5449
|
+
# contrast_text: "ThemeString",
|
|
5450
|
+
# },
|
|
5451
|
+
# },
|
|
5452
|
+
# images: {
|
|
5453
|
+
# logo: {
|
|
5454
|
+
# default: "ThemeImageLink",
|
|
5455
|
+
# favicon: "ThemeImageLink",
|
|
5456
|
+
# },
|
|
5457
|
+
# },
|
|
5458
|
+
# typography: {
|
|
5459
|
+
# font_family: {
|
|
5460
|
+
# default: "Arial", # accepts Arial, Courier New, Georgia, Times New Roman, Trebuchet, Verdana
|
|
5461
|
+
# },
|
|
5462
|
+
# },
|
|
5463
|
+
# },
|
|
5464
|
+
# dark: {
|
|
5465
|
+
# palette: {
|
|
5466
|
+
# header: {
|
|
5467
|
+
# background: "ThemeString",
|
|
5468
|
+
# text: "ThemeString",
|
|
5469
|
+
# text_hover: "ThemeString",
|
|
5470
|
+
# invert_actions_colors: false,
|
|
5471
|
+
# },
|
|
5472
|
+
# navigation: {
|
|
5473
|
+
# background: "ThemeString",
|
|
5474
|
+
# text_background_hover: "ThemeString",
|
|
5475
|
+
# text_background_active: "ThemeString",
|
|
5476
|
+
# text: "ThemeString",
|
|
5477
|
+
# text_hover: "ThemeString",
|
|
5478
|
+
# text_active: "ThemeString",
|
|
5479
|
+
# invert_actions_colors: false,
|
|
5480
|
+
# },
|
|
5481
|
+
# canvas: {
|
|
5482
|
+
# container_background: "ThemeString",
|
|
5483
|
+
# page_background: "ThemeString",
|
|
5484
|
+
# active_background: "ThemeString",
|
|
5485
|
+
# },
|
|
5486
|
+
# primary: {
|
|
5487
|
+
# default: "ThemeString",
|
|
5488
|
+
# active: "ThemeString",
|
|
5489
|
+
# contrast_text: "ThemeString",
|
|
5490
|
+
# },
|
|
5491
|
+
# },
|
|
5492
|
+
# images: {
|
|
5493
|
+
# logo: {
|
|
5494
|
+
# default: "ThemeImageLink",
|
|
5495
|
+
# favicon: "ThemeImageLink",
|
|
5496
|
+
# },
|
|
5497
|
+
# },
|
|
5498
|
+
# typography: {
|
|
5499
|
+
# font_family: {
|
|
5500
|
+
# default: "Arial", # accepts Arial, Courier New, Georgia, Times New Roman, Trebuchet, Verdana
|
|
5501
|
+
# },
|
|
5502
|
+
# },
|
|
5503
|
+
# },
|
|
5504
|
+
# },
|
|
5505
|
+
# title: "WorkspaceTitle",
|
|
5506
|
+
# tags: {
|
|
5507
|
+
# "TagKey" => "TagValue",
|
|
5508
|
+
# },
|
|
5509
|
+
# })
|
|
5510
|
+
#
|
|
5511
|
+
# @example Response structure
|
|
5512
|
+
#
|
|
5513
|
+
# resp.workspace_id #=> String
|
|
5514
|
+
# resp.workspace_arn #=> String
|
|
5515
|
+
#
|
|
5516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateWorkspace AWS API Documentation
|
|
5517
|
+
#
|
|
5518
|
+
# @overload create_workspace(params = {})
|
|
5519
|
+
# @param [Hash] params ({})
|
|
5520
|
+
def create_workspace(params = {}, options = {})
|
|
5521
|
+
req = build_request(:create_workspace, params)
|
|
5522
|
+
req.send_request(options)
|
|
5523
|
+
end
|
|
5524
|
+
|
|
5525
|
+
# Associates a view with a page in a workspace, defining what users see
|
|
5526
|
+
# when they navigate to that page.
|
|
5527
|
+
#
|
|
5528
|
+
# @option params [required, String] :instance_id
|
|
5529
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
5530
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
5531
|
+
#
|
|
5532
|
+
#
|
|
5533
|
+
#
|
|
5534
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
5535
|
+
#
|
|
5536
|
+
# @option params [required, String] :workspace_id
|
|
5537
|
+
# The identifier of the workspace.
|
|
5538
|
+
#
|
|
5539
|
+
# @option params [required, String] :resource_arn
|
|
5540
|
+
# The Amazon Resource Name (ARN) of the view to associate with the page.
|
|
5541
|
+
#
|
|
5542
|
+
# @option params [required, String] :page
|
|
5543
|
+
# The page identifier. Valid system pages include `HOME` and
|
|
5544
|
+
# `AGENT_EXPERIENCE`. Custom pages cannot use the `aws:` or `connect:`
|
|
5545
|
+
# prefixes.
|
|
5546
|
+
#
|
|
5547
|
+
# @option params [String] :slug
|
|
5548
|
+
# The URL-friendly identifier for the page.
|
|
5549
|
+
#
|
|
5550
|
+
# @option params [String] :input_data
|
|
5551
|
+
# A JSON string containing input parameters for the view, validated
|
|
5552
|
+
# against the view's input schema.
|
|
5553
|
+
#
|
|
5554
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
5555
|
+
#
|
|
5556
|
+
# @example Request syntax with placeholder values
|
|
5557
|
+
#
|
|
5558
|
+
# resp = client.create_workspace_page({
|
|
5559
|
+
# instance_id: "InstanceId", # required
|
|
5560
|
+
# workspace_id: "WorkspaceId", # required
|
|
5561
|
+
# resource_arn: "ARN", # required
|
|
5562
|
+
# page: "Page", # required
|
|
5563
|
+
# slug: "Slug",
|
|
5564
|
+
# input_data: "InputData",
|
|
5565
|
+
# })
|
|
5566
|
+
#
|
|
5567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateWorkspacePage AWS API Documentation
|
|
5568
|
+
#
|
|
5569
|
+
# @overload create_workspace_page(params = {})
|
|
5570
|
+
# @param [Hash] params ({})
|
|
5571
|
+
def create_workspace_page(params = {}, options = {})
|
|
5572
|
+
req = build_request(:create_workspace_page, params)
|
|
5573
|
+
req.send_request(options)
|
|
5574
|
+
end
|
|
5575
|
+
|
|
5576
|
+
# Deactivates an evaluation form in the specified Amazon Connect
|
|
5577
|
+
# instance. After a form is deactivated, it is no longer available for
|
|
5578
|
+
# users to start new evaluations based on the form.
|
|
5579
|
+
#
|
|
5580
|
+
# @option params [required, String] :instance_id
|
|
5581
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
5582
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
5583
|
+
#
|
|
5584
|
+
#
|
|
5585
|
+
#
|
|
5586
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
5587
|
+
#
|
|
5588
|
+
# @option params [required, String] :evaluation_form_id
|
|
5589
|
+
# The unique identifier for the evaluation form.
|
|
5590
|
+
#
|
|
5591
|
+
# @option params [required, Integer] :evaluation_form_version
|
|
4761
5592
|
# A version of the evaluation form. If the version property is not
|
|
4762
5593
|
# provided, the latest version of the evaluation form is deactivated.
|
|
4763
5594
|
#
|
|
@@ -5031,6 +5862,79 @@ module Aws::Connect
|
|
|
5031
5862
|
req.send_request(options)
|
|
5032
5863
|
end
|
|
5033
5864
|
|
|
5865
|
+
# Deletes a data table and all associated attributes, versions, audits,
|
|
5866
|
+
# and values. Does not update any references to the data table, even
|
|
5867
|
+
# from other data tables. This includes dynamic values and conditional
|
|
5868
|
+
# validations. System managed data tables are not deletable by
|
|
5869
|
+
# customers. API users may delete the table at any time. When deletion
|
|
5870
|
+
# is requested from the admin website, a warning is shown alerting the
|
|
5871
|
+
# user of the most recent time the table and its values were accessed.
|
|
5872
|
+
#
|
|
5873
|
+
# @option params [required, String] :instance_id
|
|
5874
|
+
# The unique identifier for the Amazon Connect instance.
|
|
5875
|
+
#
|
|
5876
|
+
# @option params [required, String] :data_table_id
|
|
5877
|
+
# The unique identifier for the data table to delete. Must also accept
|
|
5878
|
+
# the table ARN. Fails with an error if the version is provided and is
|
|
5879
|
+
# not $LATEST.
|
|
5880
|
+
#
|
|
5881
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
5882
|
+
#
|
|
5883
|
+
# @example Request syntax with placeholder values
|
|
5884
|
+
#
|
|
5885
|
+
# resp = client.delete_data_table({
|
|
5886
|
+
# instance_id: "InstanceId", # required
|
|
5887
|
+
# data_table_id: "DataTableId", # required
|
|
5888
|
+
# })
|
|
5889
|
+
#
|
|
5890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteDataTable AWS API Documentation
|
|
5891
|
+
#
|
|
5892
|
+
# @overload delete_data_table(params = {})
|
|
5893
|
+
# @param [Hash] params ({})
|
|
5894
|
+
def delete_data_table(params = {}, options = {})
|
|
5895
|
+
req = build_request(:delete_data_table, params)
|
|
5896
|
+
req.send_request(options)
|
|
5897
|
+
end
|
|
5898
|
+
|
|
5899
|
+
# Deletes an attribute and all its values from a data table.
|
|
5900
|
+
#
|
|
5901
|
+
# @option params [required, String] :instance_id
|
|
5902
|
+
# The unique identifier for the Amazon Connect instance.
|
|
5903
|
+
#
|
|
5904
|
+
# @option params [required, String] :data_table_id
|
|
5905
|
+
# The unique identifier for the data table.
|
|
5906
|
+
#
|
|
5907
|
+
# @option params [required, String] :attribute_name
|
|
5908
|
+
# The name of the attribute to delete.
|
|
5909
|
+
#
|
|
5910
|
+
# @return [Types::DeleteDataTableAttributeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5911
|
+
#
|
|
5912
|
+
# * {Types::DeleteDataTableAttributeResponse#lock_version #lock_version} => Types::DataTableLockVersion
|
|
5913
|
+
#
|
|
5914
|
+
# @example Request syntax with placeholder values
|
|
5915
|
+
#
|
|
5916
|
+
# resp = client.delete_data_table_attribute({
|
|
5917
|
+
# instance_id: "InstanceId", # required
|
|
5918
|
+
# data_table_id: "DataTableId", # required
|
|
5919
|
+
# attribute_name: "DataTableName", # required
|
|
5920
|
+
# })
|
|
5921
|
+
#
|
|
5922
|
+
# @example Response structure
|
|
5923
|
+
#
|
|
5924
|
+
# resp.lock_version.data_table #=> String
|
|
5925
|
+
# resp.lock_version.attribute #=> String
|
|
5926
|
+
# resp.lock_version.primary_values #=> String
|
|
5927
|
+
# resp.lock_version.value #=> String
|
|
5928
|
+
#
|
|
5929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteDataTableAttribute AWS API Documentation
|
|
5930
|
+
#
|
|
5931
|
+
# @overload delete_data_table_attribute(params = {})
|
|
5932
|
+
# @param [Hash] params ({})
|
|
5933
|
+
def delete_data_table_attribute(params = {}, options = {})
|
|
5934
|
+
req = build_request(:delete_data_table_attribute, params)
|
|
5935
|
+
req.send_request(options)
|
|
5936
|
+
end
|
|
5937
|
+
|
|
5034
5938
|
# Deletes email address from the specified Amazon Connect instance.
|
|
5035
5939
|
#
|
|
5036
5940
|
# @option params [required, String] :instance_id
|
|
@@ -5805,6 +6709,110 @@ module Aws::Connect
|
|
|
5805
6709
|
req.send_request(options)
|
|
5806
6710
|
end
|
|
5807
6711
|
|
|
6712
|
+
# Deletes a workspace and removes all associated view and resource
|
|
6713
|
+
# assignments.
|
|
6714
|
+
#
|
|
6715
|
+
# @option params [required, String] :instance_id
|
|
6716
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
6717
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
6718
|
+
#
|
|
6719
|
+
#
|
|
6720
|
+
#
|
|
6721
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
6722
|
+
#
|
|
6723
|
+
# @option params [required, String] :workspace_id
|
|
6724
|
+
# The identifier of the workspace.
|
|
6725
|
+
#
|
|
6726
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
6727
|
+
#
|
|
6728
|
+
# @example Request syntax with placeholder values
|
|
6729
|
+
#
|
|
6730
|
+
# resp = client.delete_workspace({
|
|
6731
|
+
# instance_id: "InstanceId", # required
|
|
6732
|
+
# workspace_id: "WorkspaceId", # required
|
|
6733
|
+
# })
|
|
6734
|
+
#
|
|
6735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteWorkspace AWS API Documentation
|
|
6736
|
+
#
|
|
6737
|
+
# @overload delete_workspace(params = {})
|
|
6738
|
+
# @param [Hash] params ({})
|
|
6739
|
+
def delete_workspace(params = {}, options = {})
|
|
6740
|
+
req = build_request(:delete_workspace, params)
|
|
6741
|
+
req.send_request(options)
|
|
6742
|
+
end
|
|
6743
|
+
|
|
6744
|
+
# Deletes a media asset (such as a logo) from a workspace.
|
|
6745
|
+
#
|
|
6746
|
+
# @option params [required, String] :instance_id
|
|
6747
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
6748
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
6749
|
+
#
|
|
6750
|
+
#
|
|
6751
|
+
#
|
|
6752
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
6753
|
+
#
|
|
6754
|
+
# @option params [required, String] :workspace_id
|
|
6755
|
+
# The identifier of the workspace.
|
|
6756
|
+
#
|
|
6757
|
+
# @option params [required, String] :media_type
|
|
6758
|
+
# The type of media to delete. Valid values are: `IMAGE_LOGO_FAVICON`
|
|
6759
|
+
# and `IMAGE_LOGO_HORIZONTAL`.
|
|
6760
|
+
#
|
|
6761
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
6762
|
+
#
|
|
6763
|
+
# @example Request syntax with placeholder values
|
|
6764
|
+
#
|
|
6765
|
+
# resp = client.delete_workspace_media({
|
|
6766
|
+
# instance_id: "InstanceId", # required
|
|
6767
|
+
# workspace_id: "WorkspaceId", # required
|
|
6768
|
+
# media_type: "IMAGE_LOGO_LIGHT_FAVICON", # required, accepts IMAGE_LOGO_LIGHT_FAVICON, IMAGE_LOGO_DARK_FAVICON, IMAGE_LOGO_LIGHT_HORIZONTAL, IMAGE_LOGO_DARK_HORIZONTAL
|
|
6769
|
+
# })
|
|
6770
|
+
#
|
|
6771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteWorkspaceMedia AWS API Documentation
|
|
6772
|
+
#
|
|
6773
|
+
# @overload delete_workspace_media(params = {})
|
|
6774
|
+
# @param [Hash] params ({})
|
|
6775
|
+
def delete_workspace_media(params = {}, options = {})
|
|
6776
|
+
req = build_request(:delete_workspace_media, params)
|
|
6777
|
+
req.send_request(options)
|
|
6778
|
+
end
|
|
6779
|
+
|
|
6780
|
+
# Removes the association between a view and a page in a workspace. The
|
|
6781
|
+
# page will display the default view after deletion.
|
|
6782
|
+
#
|
|
6783
|
+
# @option params [required, String] :instance_id
|
|
6784
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
6785
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
6786
|
+
#
|
|
6787
|
+
#
|
|
6788
|
+
#
|
|
6789
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
6790
|
+
#
|
|
6791
|
+
# @option params [required, String] :workspace_id
|
|
6792
|
+
# The identifier of the workspace.
|
|
6793
|
+
#
|
|
6794
|
+
# @option params [required, String] :page
|
|
6795
|
+
# The page identifier.
|
|
6796
|
+
#
|
|
6797
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
6798
|
+
#
|
|
6799
|
+
# @example Request syntax with placeholder values
|
|
6800
|
+
#
|
|
6801
|
+
# resp = client.delete_workspace_page({
|
|
6802
|
+
# instance_id: "InstanceId", # required
|
|
6803
|
+
# workspace_id: "WorkspaceId", # required
|
|
6804
|
+
# page: "Page", # required
|
|
6805
|
+
# })
|
|
6806
|
+
#
|
|
6807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteWorkspacePage AWS API Documentation
|
|
6808
|
+
#
|
|
6809
|
+
# @overload delete_workspace_page(params = {})
|
|
6810
|
+
# @param [Hash] params ({})
|
|
6811
|
+
def delete_workspace_page(params = {}, options = {})
|
|
6812
|
+
req = build_request(:delete_workspace_page, params)
|
|
6813
|
+
req.send_request(options)
|
|
6814
|
+
end
|
|
6815
|
+
|
|
5808
6816
|
# Describes an agent status.
|
|
5809
6817
|
#
|
|
5810
6818
|
# @option params [required, String] :instance_id
|
|
@@ -6017,6 +7025,10 @@ module Aws::Connect
|
|
|
6017
7025
|
# resp.contact.scheduled_timestamp #=> Time
|
|
6018
7026
|
# resp.contact.related_contact_id #=> String
|
|
6019
7027
|
# resp.contact.wisdom_info.session_arn #=> String
|
|
7028
|
+
# resp.contact.wisdom_info.ai_agents #=> Array
|
|
7029
|
+
# resp.contact.wisdom_info.ai_agents[0].ai_use_case #=> String, one of "AgentAssistance", "SelfService"
|
|
7030
|
+
# resp.contact.wisdom_info.ai_agents[0].ai_agent_version_id #=> String
|
|
7031
|
+
# resp.contact.wisdom_info.ai_agents[0].ai_agent_escalated #=> Boolean
|
|
6020
7032
|
# resp.contact.customer_id #=> String
|
|
6021
7033
|
# resp.contact.customer_endpoint.type #=> String, one of "TELEPHONE_NUMBER", "VOIP", "CONTACT_FLOW", "CONNECT_PHONENUMBER_ARN", "EMAIL_ADDRESS"
|
|
6022
7034
|
# resp.contact.customer_endpoint.address #=> String
|
|
@@ -6122,6 +7134,7 @@ module Aws::Connect
|
|
|
6122
7134
|
# resp.contact.recordings[0].stop_timestamp #=> Time
|
|
6123
7135
|
# resp.contact.recordings[0].status #=> String, one of "AVAILABLE", "DELETED"
|
|
6124
7136
|
# resp.contact.recordings[0].deletion_reason #=> String
|
|
7137
|
+
# resp.contact.recordings[0].unprocessed_transcript_location #=> String
|
|
6125
7138
|
# resp.contact.disconnect_reason #=> String
|
|
6126
7139
|
# resp.contact.contact_evaluations #=> Hash
|
|
6127
7140
|
# resp.contact.contact_evaluations["EvaluationId"].form_id #=> String
|
|
@@ -6141,6 +7154,13 @@ module Aws::Connect
|
|
|
6141
7154
|
# resp.contact.outbound_strategy.config.agent_first.preview.allowed_user_actions[0] #=> String, one of "CALL", "DISCARD"
|
|
6142
7155
|
# resp.contact.attributes #=> Hash
|
|
6143
7156
|
# resp.contact.attributes["AttributeName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
|
|
7157
|
+
# resp.contact.next_contacts #=> Array
|
|
7158
|
+
# resp.contact.next_contacts[0].type #=> String, one of "QUICK_CONNECT"
|
|
7159
|
+
# resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.contact_id #=> String
|
|
7160
|
+
# resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.initiation_timestamp #=> Time
|
|
7161
|
+
# resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.quick_connect_id #=> String
|
|
7162
|
+
# resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.quick_connect_name #=> String
|
|
7163
|
+
# resp.contact.next_contacts[0].next_contact_metadata.quick_connect_contact_data.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
|
|
6144
7164
|
#
|
|
6145
7165
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContact AWS API Documentation
|
|
6146
7166
|
#
|
|
@@ -6188,21 +7208,34 @@ module Aws::Connect
|
|
|
6188
7208
|
# resp.evaluation.metadata.score.percentage #=> Float
|
|
6189
7209
|
# resp.evaluation.metadata.score.not_applicable #=> Boolean
|
|
6190
7210
|
# resp.evaluation.metadata.score.automatic_fail #=> Boolean
|
|
7211
|
+
# resp.evaluation.metadata.score.applied_weight #=> Float
|
|
6191
7212
|
# resp.evaluation.metadata.auto_evaluation.auto_evaluation_enabled #=> Boolean
|
|
6192
7213
|
# resp.evaluation.metadata.auto_evaluation.auto_evaluation_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
|
|
6193
7214
|
# resp.evaluation.metadata.acknowledgement.acknowledged_time #=> Time
|
|
6194
7215
|
# resp.evaluation.metadata.acknowledgement.acknowledged_by #=> String
|
|
6195
7216
|
# resp.evaluation.metadata.acknowledgement.acknowledger_comment #=> String
|
|
7217
|
+
# resp.evaluation.metadata.contact_participant.contact_participant_role #=> String, one of "AGENT", "SYSTEM", "CUSTOM_BOT"
|
|
7218
|
+
# resp.evaluation.metadata.contact_participant.contact_participant_id #=> String
|
|
7219
|
+
# resp.evaluation.metadata.sampling_job_id #=> String
|
|
6196
7220
|
# resp.evaluation.answers #=> Hash
|
|
6197
7221
|
# resp.evaluation.answers["ResourceId"].value.string_value #=> String
|
|
6198
7222
|
# resp.evaluation.answers["ResourceId"].value.numeric_value #=> Float
|
|
7223
|
+
# resp.evaluation.answers["ResourceId"].value.string_values #=> Array
|
|
7224
|
+
# resp.evaluation.answers["ResourceId"].value.string_values[0] #=> String
|
|
7225
|
+
# resp.evaluation.answers["ResourceId"].value.date_time_value #=> String
|
|
6199
7226
|
# resp.evaluation.answers["ResourceId"].value.not_applicable #=> Boolean
|
|
6200
7227
|
# resp.evaluation.answers["ResourceId"].system_suggested_value.string_value #=> String
|
|
6201
7228
|
# resp.evaluation.answers["ResourceId"].system_suggested_value.numeric_value #=> Float
|
|
7229
|
+
# resp.evaluation.answers["ResourceId"].system_suggested_value.string_values #=> Array
|
|
7230
|
+
# resp.evaluation.answers["ResourceId"].system_suggested_value.string_values[0] #=> String
|
|
7231
|
+
# resp.evaluation.answers["ResourceId"].system_suggested_value.date_time_value #=> String
|
|
6202
7232
|
# resp.evaluation.answers["ResourceId"].system_suggested_value.not_applicable #=> Boolean
|
|
6203
7233
|
# resp.evaluation.answers["ResourceId"].suggested_answers #=> Array
|
|
6204
7234
|
# resp.evaluation.answers["ResourceId"].suggested_answers[0].value.string_value #=> String
|
|
6205
7235
|
# resp.evaluation.answers["ResourceId"].suggested_answers[0].value.numeric_value #=> Float
|
|
7236
|
+
# resp.evaluation.answers["ResourceId"].suggested_answers[0].value.string_values #=> Array
|
|
7237
|
+
# resp.evaluation.answers["ResourceId"].suggested_answers[0].value.string_values[0] #=> String
|
|
7238
|
+
# resp.evaluation.answers["ResourceId"].suggested_answers[0].value.date_time_value #=> String
|
|
6206
7239
|
# resp.evaluation.answers["ResourceId"].suggested_answers[0].value.not_applicable #=> Boolean
|
|
6207
7240
|
# resp.evaluation.answers["ResourceId"].suggested_answers[0].status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
|
|
6208
7241
|
# resp.evaluation.answers["ResourceId"].suggested_answers[0].input.transcript_type #=> String, one of "RAW", "REDACTED"
|
|
@@ -6224,6 +7257,7 @@ module Aws::Connect
|
|
|
6224
7257
|
# resp.evaluation.scores["ResourceId"].percentage #=> Float
|
|
6225
7258
|
# resp.evaluation.scores["ResourceId"].not_applicable #=> Boolean
|
|
6226
7259
|
# resp.evaluation.scores["ResourceId"].automatic_fail #=> Boolean
|
|
7260
|
+
# resp.evaluation.scores["ResourceId"].applied_weight #=> Float
|
|
6227
7261
|
# resp.evaluation.created_time #=> Time
|
|
6228
7262
|
# resp.evaluation.last_modified_time #=> Time
|
|
6229
7263
|
# resp.evaluation.evaluation_type #=> String, one of "STANDARD", "CALIBRATION"
|
|
@@ -6244,7 +7278,7 @@ module Aws::Connect
|
|
|
6244
7278
|
# resp.evaluation_form.items[0].question.instructions #=> String
|
|
6245
7279
|
# resp.evaluation_form.items[0].question.ref_id #=> String
|
|
6246
7280
|
# resp.evaluation_form.items[0].question.not_applicable_enabled #=> Boolean
|
|
6247
|
-
# resp.evaluation_form.items[0].question.question_type #=> String, one of "TEXT", "SINGLESELECT", "NUMERIC"
|
|
7281
|
+
# resp.evaluation_form.items[0].question.question_type #=> String, one of "TEXT", "SINGLESELECT", "NUMERIC", "MULTISELECT", "DATETIME"
|
|
6248
7282
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.min_value #=> Integer
|
|
6249
7283
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.max_value #=> Integer
|
|
6250
7284
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options #=> Array
|
|
@@ -6253,7 +7287,7 @@ module Aws::Connect
|
|
|
6253
7287
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].score #=> Integer
|
|
6254
7288
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail #=> Boolean
|
|
6255
7289
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail_configuration.target_section #=> String
|
|
6256
|
-
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.property_value.label #=> String, one of "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "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"
|
|
7290
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.property_value.label #=> String, one of "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"
|
|
6257
7291
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
6258
7292
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options #=> Array
|
|
6259
7293
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].ref_id #=> String
|
|
@@ -6269,13 +7303,25 @@ module Aws::Connect
|
|
|
6269
7303
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.default_option_ref_id #=> String
|
|
6270
7304
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
6271
7305
|
# resp.evaluation_form.items[0].question.question_type_properties.text.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
7306
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options #=> Array
|
|
7307
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].ref_id #=> String
|
|
7308
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].text #=> String
|
|
7309
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.display_as #=> String, one of "DROPDOWN", "CHECKBOX"
|
|
7310
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options #=> Array
|
|
7311
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.category #=> String
|
|
7312
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.condition #=> String, one of "PRESENT", "NOT_PRESENT"
|
|
7313
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.option_ref_ids #=> Array
|
|
7314
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.option_ref_ids[0] #=> String
|
|
7315
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.default_option_ref_ids #=> Array
|
|
7316
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.default_option_ref_ids[0] #=> String
|
|
7317
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
6272
7318
|
# resp.evaluation_form.items[0].question.enablement.condition.operands #=> Array
|
|
6273
7319
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.source.type #=> String, one of "QUESTION_REF_ID"
|
|
6274
7320
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.source.ref_id #=> String
|
|
6275
7321
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values #=> Array
|
|
6276
7322
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values[0].type #=> String, one of "OPTION_REF_ID"
|
|
6277
7323
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values[0].ref_id #=> String
|
|
6278
|
-
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.comparator #=> String, one of "IN", "NOT_IN"
|
|
7324
|
+
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.comparator #=> String, one of "IN", "NOT_IN", "ALL_IN", "EXACT"
|
|
6279
7325
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].condition #=> Types::EvaluationFormItemEnablementCondition
|
|
6280
7326
|
# resp.evaluation_form.items[0].question.enablement.condition.operator #=> String, one of "OR", "AND"
|
|
6281
7327
|
# resp.evaluation_form.items[0].question.enablement.action #=> String, one of "DISABLE", "ENABLE"
|
|
@@ -6284,6 +7330,8 @@ module Aws::Connect
|
|
|
6284
7330
|
# resp.evaluation_form.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY"
|
|
6285
7331
|
# resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
|
|
6286
7332
|
# resp.evaluation_form.auto_evaluation_configuration.enabled #=> Boolean
|
|
7333
|
+
# resp.evaluation_form.target_configuration.contact_interaction_type #=> String, one of "AGENT", "AUTOMATED"
|
|
7334
|
+
# resp.evaluation_form.language_configuration.form_language #=> String, one of "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "pt-BR"
|
|
6287
7335
|
#
|
|
6288
7336
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactEvaluation AWS API Documentation
|
|
6289
7337
|
#
|
|
@@ -6464,6 +7512,127 @@ module Aws::Connect
|
|
|
6464
7512
|
req.send_request(options)
|
|
6465
7513
|
end
|
|
6466
7514
|
|
|
7515
|
+
# Returns all properties for a data table except for attributes and
|
|
7516
|
+
# values. All properties from CreateDataTable are returned as well as
|
|
7517
|
+
# properties for region replication, versioning, and system tables.
|
|
7518
|
+
# "Describe" is a deprecated term but is allowed to maintain
|
|
7519
|
+
# consistency with existing operations.
|
|
7520
|
+
#
|
|
7521
|
+
# @option params [required, String] :instance_id
|
|
7522
|
+
# The unique identifier for the Amazon Connect instance.
|
|
7523
|
+
#
|
|
7524
|
+
# @option params [required, String] :data_table_id
|
|
7525
|
+
# The unique identifier for the data table. Must also accept the table
|
|
7526
|
+
# ARN with or without a version alias. If no alias is provided, the
|
|
7527
|
+
# default behavior is identical to providing the $LATEST alias.
|
|
7528
|
+
#
|
|
7529
|
+
# @return [Types::DescribeDataTableResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7530
|
+
#
|
|
7531
|
+
# * {Types::DescribeDataTableResponse#data_table #data_table} => Types::DataTable
|
|
7532
|
+
#
|
|
7533
|
+
# @example Request syntax with placeholder values
|
|
7534
|
+
#
|
|
7535
|
+
# resp = client.describe_data_table({
|
|
7536
|
+
# instance_id: "InstanceId", # required
|
|
7537
|
+
# data_table_id: "DataTableId", # required
|
|
7538
|
+
# })
|
|
7539
|
+
#
|
|
7540
|
+
# @example Response structure
|
|
7541
|
+
#
|
|
7542
|
+
# resp.data_table.name #=> String
|
|
7543
|
+
# resp.data_table.id #=> String
|
|
7544
|
+
# resp.data_table.arn #=> String
|
|
7545
|
+
# resp.data_table.time_zone #=> String
|
|
7546
|
+
# resp.data_table.description #=> String
|
|
7547
|
+
# resp.data_table.value_lock_level #=> String, one of "NONE", "DATA_TABLE", "PRIMARY_VALUE", "ATTRIBUTE", "VALUE"
|
|
7548
|
+
# resp.data_table.lock_version.data_table #=> String
|
|
7549
|
+
# resp.data_table.lock_version.attribute #=> String
|
|
7550
|
+
# resp.data_table.lock_version.primary_values #=> String
|
|
7551
|
+
# resp.data_table.lock_version.value #=> String
|
|
7552
|
+
# resp.data_table.version #=> String
|
|
7553
|
+
# resp.data_table.version_description #=> String
|
|
7554
|
+
# resp.data_table.status #=> String, one of "PUBLISHED"
|
|
7555
|
+
# resp.data_table.created_time #=> Time
|
|
7556
|
+
# resp.data_table.last_modified_time #=> Time
|
|
7557
|
+
# resp.data_table.last_modified_region #=> String
|
|
7558
|
+
# resp.data_table.tags #=> Hash
|
|
7559
|
+
# resp.data_table.tags["TagKey"] #=> String
|
|
7560
|
+
#
|
|
7561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeDataTable AWS API Documentation
|
|
7562
|
+
#
|
|
7563
|
+
# @overload describe_data_table(params = {})
|
|
7564
|
+
# @param [Hash] params ({})
|
|
7565
|
+
def describe_data_table(params = {}, options = {})
|
|
7566
|
+
req = build_request(:describe_data_table, params)
|
|
7567
|
+
req.send_request(options)
|
|
7568
|
+
end
|
|
7569
|
+
|
|
7570
|
+
# Returns detailed information for a specific data table attribute
|
|
7571
|
+
# including its configuration, validation rules, and metadata.
|
|
7572
|
+
# "Describe" is a deprecated term but is allowed to maintain
|
|
7573
|
+
# consistency with existing operations.
|
|
7574
|
+
#
|
|
7575
|
+
# @option params [required, String] :instance_id
|
|
7576
|
+
# The unique identifier for the Amazon Connect instance.
|
|
7577
|
+
#
|
|
7578
|
+
# @option params [required, String] :data_table_id
|
|
7579
|
+
# The unique identifier for the data table. Must also accept the table
|
|
7580
|
+
# ARN with or without a version alias.
|
|
7581
|
+
#
|
|
7582
|
+
# @option params [required, String] :attribute_name
|
|
7583
|
+
# The name of the attribute to retrieve detailed information for.
|
|
7584
|
+
#
|
|
7585
|
+
# @return [Types::DescribeDataTableAttributeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7586
|
+
#
|
|
7587
|
+
# * {Types::DescribeDataTableAttributeResponse#attribute #attribute} => Types::DataTableAttribute
|
|
7588
|
+
#
|
|
7589
|
+
# @example Request syntax with placeholder values
|
|
7590
|
+
#
|
|
7591
|
+
# resp = client.describe_data_table_attribute({
|
|
7592
|
+
# instance_id: "InstanceId", # required
|
|
7593
|
+
# data_table_id: "DataTableId", # required
|
|
7594
|
+
# attribute_name: "DataTableName", # required
|
|
7595
|
+
# })
|
|
7596
|
+
#
|
|
7597
|
+
# @example Response structure
|
|
7598
|
+
#
|
|
7599
|
+
# resp.attribute.attribute_id #=> String
|
|
7600
|
+
# resp.attribute.name #=> String
|
|
7601
|
+
# resp.attribute.value_type #=> String, one of "TEXT", "NUMBER", "BOOLEAN", "TEXT_LIST", "NUMBER_LIST"
|
|
7602
|
+
# resp.attribute.description #=> String
|
|
7603
|
+
# resp.attribute.data_table_id #=> String
|
|
7604
|
+
# resp.attribute.data_table_arn #=> String
|
|
7605
|
+
# resp.attribute.primary #=> Boolean
|
|
7606
|
+
# resp.attribute.version #=> String
|
|
7607
|
+
# resp.attribute.lock_version.data_table #=> String
|
|
7608
|
+
# resp.attribute.lock_version.attribute #=> String
|
|
7609
|
+
# resp.attribute.lock_version.primary_values #=> String
|
|
7610
|
+
# resp.attribute.lock_version.value #=> String
|
|
7611
|
+
# resp.attribute.last_modified_time #=> Time
|
|
7612
|
+
# resp.attribute.last_modified_region #=> String
|
|
7613
|
+
# resp.attribute.validation.min_length #=> Integer
|
|
7614
|
+
# resp.attribute.validation.max_length #=> Integer
|
|
7615
|
+
# resp.attribute.validation.min_values #=> Integer
|
|
7616
|
+
# resp.attribute.validation.max_values #=> Integer
|
|
7617
|
+
# resp.attribute.validation.ignore_case #=> Boolean
|
|
7618
|
+
# resp.attribute.validation.minimum #=> Float
|
|
7619
|
+
# resp.attribute.validation.maximum #=> Float
|
|
7620
|
+
# resp.attribute.validation.exclusive_minimum #=> Float
|
|
7621
|
+
# resp.attribute.validation.exclusive_maximum #=> Float
|
|
7622
|
+
# resp.attribute.validation.multiple_of #=> Float
|
|
7623
|
+
# resp.attribute.validation.enum.strict #=> Boolean
|
|
7624
|
+
# resp.attribute.validation.enum.values #=> Array
|
|
7625
|
+
# resp.attribute.validation.enum.values[0] #=> String
|
|
7626
|
+
#
|
|
7627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeDataTableAttribute AWS API Documentation
|
|
7628
|
+
#
|
|
7629
|
+
# @overload describe_data_table_attribute(params = {})
|
|
7630
|
+
# @param [Hash] params ({})
|
|
7631
|
+
def describe_data_table_attribute(params = {}, options = {})
|
|
7632
|
+
req = build_request(:describe_data_table_attribute, params)
|
|
7633
|
+
req.send_request(options)
|
|
7634
|
+
end
|
|
7635
|
+
|
|
6467
7636
|
# Describe email address form the specified Amazon Connect instance.
|
|
6468
7637
|
#
|
|
6469
7638
|
# @option params [required, String] :instance_id
|
|
@@ -6568,7 +7737,7 @@ module Aws::Connect
|
|
|
6568
7737
|
# resp.evaluation_form.items[0].question.instructions #=> String
|
|
6569
7738
|
# resp.evaluation_form.items[0].question.ref_id #=> String
|
|
6570
7739
|
# resp.evaluation_form.items[0].question.not_applicable_enabled #=> Boolean
|
|
6571
|
-
# resp.evaluation_form.items[0].question.question_type #=> String, one of "TEXT", "SINGLESELECT", "NUMERIC"
|
|
7740
|
+
# resp.evaluation_form.items[0].question.question_type #=> String, one of "TEXT", "SINGLESELECT", "NUMERIC", "MULTISELECT", "DATETIME"
|
|
6572
7741
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.min_value #=> Integer
|
|
6573
7742
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.max_value #=> Integer
|
|
6574
7743
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options #=> Array
|
|
@@ -6577,7 +7746,7 @@ module Aws::Connect
|
|
|
6577
7746
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].score #=> Integer
|
|
6578
7747
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail #=> Boolean
|
|
6579
7748
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail_configuration.target_section #=> String
|
|
6580
|
-
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.property_value.label #=> String, one of "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "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"
|
|
7749
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.property_value.label #=> String, one of "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"
|
|
6581
7750
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
6582
7751
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options #=> Array
|
|
6583
7752
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].ref_id #=> String
|
|
@@ -6593,13 +7762,25 @@ module Aws::Connect
|
|
|
6593
7762
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.default_option_ref_id #=> String
|
|
6594
7763
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
6595
7764
|
# resp.evaluation_form.items[0].question.question_type_properties.text.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
7765
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options #=> Array
|
|
7766
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].ref_id #=> String
|
|
7767
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].text #=> String
|
|
7768
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.display_as #=> String, one of "DROPDOWN", "CHECKBOX"
|
|
7769
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options #=> Array
|
|
7770
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.category #=> String
|
|
7771
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.condition #=> String, one of "PRESENT", "NOT_PRESENT"
|
|
7772
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.option_ref_ids #=> Array
|
|
7773
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.option_ref_ids[0] #=> String
|
|
7774
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.default_option_ref_ids #=> Array
|
|
7775
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.default_option_ref_ids[0] #=> String
|
|
7776
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
6596
7777
|
# resp.evaluation_form.items[0].question.enablement.condition.operands #=> Array
|
|
6597
7778
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.source.type #=> String, one of "QUESTION_REF_ID"
|
|
6598
7779
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.source.ref_id #=> String
|
|
6599
7780
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values #=> Array
|
|
6600
7781
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values[0].type #=> String, one of "OPTION_REF_ID"
|
|
6601
7782
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.values[0].ref_id #=> String
|
|
6602
|
-
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.comparator #=> String, one of "IN", "NOT_IN"
|
|
7783
|
+
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].expression.comparator #=> String, one of "IN", "NOT_IN", "ALL_IN", "EXACT"
|
|
6603
7784
|
# resp.evaluation_form.items[0].question.enablement.condition.operands[0].condition #=> Types::EvaluationFormItemEnablementCondition
|
|
6604
7785
|
# resp.evaluation_form.items[0].question.enablement.condition.operator #=> String, one of "OR", "AND"
|
|
6605
7786
|
# resp.evaluation_form.items[0].question.enablement.action #=> String, one of "DISABLE", "ENABLE"
|
|
@@ -6614,6 +7795,8 @@ module Aws::Connect
|
|
|
6614
7795
|
# resp.evaluation_form.auto_evaluation_configuration.enabled #=> Boolean
|
|
6615
7796
|
# resp.evaluation_form.tags #=> Hash
|
|
6616
7797
|
# resp.evaluation_form.tags["TagKey"] #=> String
|
|
7798
|
+
# resp.evaluation_form.target_configuration.contact_interaction_type #=> String, one of "AGENT", "AUTOMATED"
|
|
7799
|
+
# resp.evaluation_form.language_configuration.form_language #=> String, one of "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "pt-BR"
|
|
6617
7800
|
#
|
|
6618
7801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEvaluationForm AWS API Documentation
|
|
6619
7802
|
#
|
|
@@ -6809,12 +7992,12 @@ module Aws::Connect
|
|
|
6809
7992
|
#
|
|
6810
7993
|
# resp = client.describe_instance_attribute({
|
|
6811
7994
|
# instance_id: "InstanceId", # required
|
|
6812
|
-
# attribute_type: "INBOUND_CALLS", # required, accepts 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
|
|
7995
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts 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
|
|
6813
7996
|
# })
|
|
6814
7997
|
#
|
|
6815
7998
|
# @example Response structure
|
|
6816
7999
|
#
|
|
6817
|
-
# resp.attribute.attribute_type #=> String, one of "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"
|
|
8000
|
+
# resp.attribute.attribute_type #=> String, one of "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"
|
|
6818
8001
|
# resp.attribute.value #=> String
|
|
6819
8002
|
#
|
|
6820
8003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstanceAttribute AWS API Documentation
|
|
@@ -7123,12 +8306,13 @@ module Aws::Connect
|
|
|
7123
8306
|
# resp.quick_connect.quick_connect_id #=> String
|
|
7124
8307
|
# resp.quick_connect.name #=> String
|
|
7125
8308
|
# resp.quick_connect.description #=> String
|
|
7126
|
-
# resp.quick_connect.quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
|
8309
|
+
# resp.quick_connect.quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
|
|
7127
8310
|
# resp.quick_connect.quick_connect_config.user_config.user_id #=> String
|
|
7128
8311
|
# resp.quick_connect.quick_connect_config.user_config.contact_flow_id #=> String
|
|
7129
8312
|
# resp.quick_connect.quick_connect_config.queue_config.queue_id #=> String
|
|
7130
8313
|
# resp.quick_connect.quick_connect_config.queue_config.contact_flow_id #=> String
|
|
7131
8314
|
# resp.quick_connect.quick_connect_config.phone_config.phone_number #=> String
|
|
8315
|
+
# resp.quick_connect.quick_connect_config.flow_config.contact_flow_id #=> String
|
|
7132
8316
|
# resp.quick_connect.tags #=> Hash
|
|
7133
8317
|
# resp.quick_connect.tags["TagKey"] #=> String
|
|
7134
8318
|
# resp.quick_connect.last_modified_time #=> Time
|
|
@@ -7252,7 +8436,7 @@ module Aws::Connect
|
|
|
7252
8436
|
# resp.rule.actions[0].task_action.contact_flow_id #=> String
|
|
7253
8437
|
# resp.rule.actions[0].task_action.references #=> Hash
|
|
7254
8438
|
# resp.rule.actions[0].task_action.references["ReferenceKey"].value #=> String
|
|
7255
|
-
# resp.rule.actions[0].task_action.references["ReferenceKey"].type #=> String, one of "URL", "ATTACHMENT", "CONTACT_ANALYSIS", "NUMBER", "STRING", "DATE", "EMAIL", "EMAIL_MESSAGE"
|
|
8439
|
+
# resp.rule.actions[0].task_action.references["ReferenceKey"].type #=> String, one of "URL", "ATTACHMENT", "CONTACT_ANALYSIS", "NUMBER", "STRING", "DATE", "EMAIL", "EMAIL_MESSAGE", "EMAIL_MESSAGE_PLAIN_TEXT"
|
|
7256
8440
|
# resp.rule.actions[0].task_action.references["ReferenceKey"].status #=> String, one of "AVAILABLE", "DELETED", "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
|
7257
8441
|
# resp.rule.actions[0].task_action.references["ReferenceKey"].arn #=> String
|
|
7258
8442
|
# resp.rule.actions[0].task_action.references["ReferenceKey"].status_reason #=> String
|
|
@@ -7358,6 +8542,11 @@ module Aws::Connect
|
|
|
7358
8542
|
# resp.security_profile.hierarchy_restricted_resources #=> Array
|
|
7359
8543
|
# resp.security_profile.hierarchy_restricted_resources[0] #=> String
|
|
7360
8544
|
# resp.security_profile.allowed_access_control_hierarchy_group_id #=> String
|
|
8545
|
+
# resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values #=> Array
|
|
8546
|
+
# resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values[0].access_type #=> String, one of "ALLOW"
|
|
8547
|
+
# resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values[0].attribute_name #=> String
|
|
8548
|
+
# resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values[0].values #=> Array
|
|
8549
|
+
# resp.security_profile.granular_access_control_configuration.data_table_access_control_configuration.primary_attribute_access_control_configuration.primary_attribute_values[0].values[0] #=> String
|
|
7361
8550
|
#
|
|
7362
8551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeSecurityProfile AWS API Documentation
|
|
7363
8552
|
#
|
|
@@ -7707,6 +8896,93 @@ module Aws::Connect
|
|
|
7707
8896
|
req.send_request(options)
|
|
7708
8897
|
end
|
|
7709
8898
|
|
|
8899
|
+
# Retrieves details about a workspace, including its configuration and
|
|
8900
|
+
# metadata.
|
|
8901
|
+
#
|
|
8902
|
+
# @option params [required, String] :instance_id
|
|
8903
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
8904
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
8905
|
+
#
|
|
8906
|
+
#
|
|
8907
|
+
#
|
|
8908
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
8909
|
+
#
|
|
8910
|
+
# @option params [required, String] :workspace_id
|
|
8911
|
+
# The identifier of the workspace.
|
|
8912
|
+
#
|
|
8913
|
+
# @return [Types::DescribeWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8914
|
+
#
|
|
8915
|
+
# * {Types::DescribeWorkspaceResponse#workspace #workspace} => Types::Workspace
|
|
8916
|
+
#
|
|
8917
|
+
# @example Request syntax with placeholder values
|
|
8918
|
+
#
|
|
8919
|
+
# resp = client.describe_workspace({
|
|
8920
|
+
# instance_id: "InstanceId", # required
|
|
8921
|
+
# workspace_id: "WorkspaceId", # required
|
|
8922
|
+
# })
|
|
8923
|
+
#
|
|
8924
|
+
# @example Response structure
|
|
8925
|
+
#
|
|
8926
|
+
# resp.workspace.visibility #=> String, one of "ALL", "ASSIGNED", "NONE"
|
|
8927
|
+
# resp.workspace.id #=> String
|
|
8928
|
+
# resp.workspace.name #=> String
|
|
8929
|
+
# resp.workspace.arn #=> String
|
|
8930
|
+
# resp.workspace.description #=> String
|
|
8931
|
+
# resp.workspace.theme.light.palette.header.background #=> String
|
|
8932
|
+
# resp.workspace.theme.light.palette.header.text #=> String
|
|
8933
|
+
# resp.workspace.theme.light.palette.header.text_hover #=> String
|
|
8934
|
+
# resp.workspace.theme.light.palette.header.invert_actions_colors #=> Boolean
|
|
8935
|
+
# resp.workspace.theme.light.palette.navigation.background #=> String
|
|
8936
|
+
# resp.workspace.theme.light.palette.navigation.text_background_hover #=> String
|
|
8937
|
+
# resp.workspace.theme.light.palette.navigation.text_background_active #=> String
|
|
8938
|
+
# resp.workspace.theme.light.palette.navigation.text #=> String
|
|
8939
|
+
# resp.workspace.theme.light.palette.navigation.text_hover #=> String
|
|
8940
|
+
# resp.workspace.theme.light.palette.navigation.text_active #=> String
|
|
8941
|
+
# resp.workspace.theme.light.palette.navigation.invert_actions_colors #=> Boolean
|
|
8942
|
+
# resp.workspace.theme.light.palette.canvas.container_background #=> String
|
|
8943
|
+
# resp.workspace.theme.light.palette.canvas.page_background #=> String
|
|
8944
|
+
# resp.workspace.theme.light.palette.canvas.active_background #=> String
|
|
8945
|
+
# resp.workspace.theme.light.palette.primary.default #=> String
|
|
8946
|
+
# resp.workspace.theme.light.palette.primary.active #=> String
|
|
8947
|
+
# resp.workspace.theme.light.palette.primary.contrast_text #=> String
|
|
8948
|
+
# resp.workspace.theme.light.images.logo.default #=> String
|
|
8949
|
+
# resp.workspace.theme.light.images.logo.favicon #=> String
|
|
8950
|
+
# resp.workspace.theme.light.typography.font_family.default #=> String, one of "Arial", "Courier New", "Georgia", "Times New Roman", "Trebuchet", "Verdana"
|
|
8951
|
+
# resp.workspace.theme.dark.palette.header.background #=> String
|
|
8952
|
+
# resp.workspace.theme.dark.palette.header.text #=> String
|
|
8953
|
+
# resp.workspace.theme.dark.palette.header.text_hover #=> String
|
|
8954
|
+
# resp.workspace.theme.dark.palette.header.invert_actions_colors #=> Boolean
|
|
8955
|
+
# resp.workspace.theme.dark.palette.navigation.background #=> String
|
|
8956
|
+
# resp.workspace.theme.dark.palette.navigation.text_background_hover #=> String
|
|
8957
|
+
# resp.workspace.theme.dark.palette.navigation.text_background_active #=> String
|
|
8958
|
+
# resp.workspace.theme.dark.palette.navigation.text #=> String
|
|
8959
|
+
# resp.workspace.theme.dark.palette.navigation.text_hover #=> String
|
|
8960
|
+
# resp.workspace.theme.dark.palette.navigation.text_active #=> String
|
|
8961
|
+
# resp.workspace.theme.dark.palette.navigation.invert_actions_colors #=> Boolean
|
|
8962
|
+
# resp.workspace.theme.dark.palette.canvas.container_background #=> String
|
|
8963
|
+
# resp.workspace.theme.dark.palette.canvas.page_background #=> String
|
|
8964
|
+
# resp.workspace.theme.dark.palette.canvas.active_background #=> String
|
|
8965
|
+
# resp.workspace.theme.dark.palette.primary.default #=> String
|
|
8966
|
+
# resp.workspace.theme.dark.palette.primary.active #=> String
|
|
8967
|
+
# resp.workspace.theme.dark.palette.primary.contrast_text #=> String
|
|
8968
|
+
# resp.workspace.theme.dark.images.logo.default #=> String
|
|
8969
|
+
# resp.workspace.theme.dark.images.logo.favicon #=> String
|
|
8970
|
+
# resp.workspace.theme.dark.typography.font_family.default #=> String, one of "Arial", "Courier New", "Georgia", "Times New Roman", "Trebuchet", "Verdana"
|
|
8971
|
+
# resp.workspace.title #=> String
|
|
8972
|
+
# resp.workspace.last_modified_time #=> Time
|
|
8973
|
+
# resp.workspace.last_modified_region #=> String
|
|
8974
|
+
# resp.workspace.tags #=> Hash
|
|
8975
|
+
# resp.workspace.tags["TagKey"] #=> String
|
|
8976
|
+
#
|
|
8977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeWorkspace AWS API Documentation
|
|
8978
|
+
#
|
|
8979
|
+
# @overload describe_workspace(params = {})
|
|
8980
|
+
# @param [Hash] params ({})
|
|
8981
|
+
def describe_workspace(params = {}, options = {})
|
|
8982
|
+
req = build_request(:describe_workspace, params)
|
|
8983
|
+
req.send_request(options)
|
|
8984
|
+
end
|
|
8985
|
+
|
|
7710
8986
|
# Removes the dataset ID associated with a given Amazon Connect
|
|
7711
8987
|
# instance.
|
|
7712
8988
|
#
|
|
@@ -8360,9 +9636,49 @@ module Aws::Connect
|
|
|
8360
9636
|
req.send_request(options)
|
|
8361
9637
|
end
|
|
8362
9638
|
|
|
8363
|
-
# Disassociates
|
|
8364
|
-
#
|
|
8365
|
-
#
|
|
9639
|
+
# Disassociates a security profile attached to a Q in Connect AI Agent
|
|
9640
|
+
# Entity in an Amazon Connect instance.
|
|
9641
|
+
#
|
|
9642
|
+
# @option params [required, String] :instance_id
|
|
9643
|
+
# The identifier of the Amazon Connect instance. You can find the
|
|
9644
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
9645
|
+
#
|
|
9646
|
+
# @option params [required, Array<Types::SecurityProfileItem>] :security_profiles
|
|
9647
|
+
# List of Security Profile Object.
|
|
9648
|
+
#
|
|
9649
|
+
# @option params [required, String] :entity_type
|
|
9650
|
+
# Only supported type is AI\_AGENT.
|
|
9651
|
+
#
|
|
9652
|
+
# @option params [required, String] :entity_arn
|
|
9653
|
+
# ARN of a Q in Connect AI Agent.
|
|
9654
|
+
#
|
|
9655
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
9656
|
+
#
|
|
9657
|
+
# @example Request syntax with placeholder values
|
|
9658
|
+
#
|
|
9659
|
+
# resp = client.disassociate_security_profiles({
|
|
9660
|
+
# instance_id: "InstanceId", # required
|
|
9661
|
+
# security_profiles: [ # required
|
|
9662
|
+
# {
|
|
9663
|
+
# id: "SecurityProfileId",
|
|
9664
|
+
# },
|
|
9665
|
+
# ],
|
|
9666
|
+
# entity_type: "USER", # required, accepts USER, AI_AGENT
|
|
9667
|
+
# entity_arn: "EntityArn", # required
|
|
9668
|
+
# })
|
|
9669
|
+
#
|
|
9670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateSecurityProfiles AWS API Documentation
|
|
9671
|
+
#
|
|
9672
|
+
# @overload disassociate_security_profiles(params = {})
|
|
9673
|
+
# @param [Hash] params ({})
|
|
9674
|
+
def disassociate_security_profiles(params = {}, options = {})
|
|
9675
|
+
req = build_request(:disassociate_security_profiles, params)
|
|
9676
|
+
req.send_request(options)
|
|
9677
|
+
end
|
|
9678
|
+
|
|
9679
|
+
# Disassociates an agent from a traffic distribution group. This API can
|
|
9680
|
+
# be called only in the Region where the traffic distribution group is
|
|
9681
|
+
# created.
|
|
8366
9682
|
#
|
|
8367
9683
|
# @option params [required, String] :traffic_distribution_group_id
|
|
8368
9684
|
# The identifier of the traffic distribution group. This can be the ID
|
|
@@ -8435,6 +9751,55 @@ module Aws::Connect
|
|
|
8435
9751
|
req.send_request(options)
|
|
8436
9752
|
end
|
|
8437
9753
|
|
|
9754
|
+
# Removes the association between a workspace and one or more users or
|
|
9755
|
+
# routing profiles.
|
|
9756
|
+
#
|
|
9757
|
+
# @option params [required, String] :instance_id
|
|
9758
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
9759
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
9760
|
+
#
|
|
9761
|
+
#
|
|
9762
|
+
#
|
|
9763
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
9764
|
+
#
|
|
9765
|
+
# @option params [required, String] :workspace_id
|
|
9766
|
+
# The identifier of the workspace.
|
|
9767
|
+
#
|
|
9768
|
+
# @option params [required, Array<String>] :resource_arns
|
|
9769
|
+
# The Amazon Resource Names (ARNs) of the resources to disassociate from
|
|
9770
|
+
# the workspace.
|
|
9771
|
+
#
|
|
9772
|
+
# @return [Types::DisassociateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
9773
|
+
#
|
|
9774
|
+
# * {Types::DisassociateWorkspaceResponse#successful_list #successful_list} => Array<Types::SuccessfulBatchAssociationSummary>
|
|
9775
|
+
# * {Types::DisassociateWorkspaceResponse#failed_list #failed_list} => Array<Types::FailedBatchAssociationSummary>
|
|
9776
|
+
#
|
|
9777
|
+
# @example Request syntax with placeholder values
|
|
9778
|
+
#
|
|
9779
|
+
# resp = client.disassociate_workspace({
|
|
9780
|
+
# instance_id: "InstanceId", # required
|
|
9781
|
+
# workspace_id: "WorkspaceId", # required
|
|
9782
|
+
# resource_arns: ["ARN"], # required
|
|
9783
|
+
# })
|
|
9784
|
+
#
|
|
9785
|
+
# @example Response structure
|
|
9786
|
+
#
|
|
9787
|
+
# resp.successful_list #=> Array
|
|
9788
|
+
# resp.successful_list[0].resource_arn #=> String
|
|
9789
|
+
# resp.failed_list #=> Array
|
|
9790
|
+
# resp.failed_list[0].resource_arn #=> String
|
|
9791
|
+
# resp.failed_list[0].error_code #=> String
|
|
9792
|
+
# resp.failed_list[0].error_message #=> String
|
|
9793
|
+
#
|
|
9794
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateWorkspace AWS API Documentation
|
|
9795
|
+
#
|
|
9796
|
+
# @overload disassociate_workspace(params = {})
|
|
9797
|
+
# @param [Hash] params ({})
|
|
9798
|
+
def disassociate_workspace(params = {}, options = {})
|
|
9799
|
+
req = build_request(:disassociate_workspace, params)
|
|
9800
|
+
req.send_request(options)
|
|
9801
|
+
end
|
|
9802
|
+
|
|
8438
9803
|
# Dismisses contacts from an agent’s CCP and returns the agent to an
|
|
8439
9804
|
# available state, which allows the agent to receive a new routed
|
|
8440
9805
|
# contact. Contacts can only be dismissed if they are in a `MISSED`,
|
|
@@ -8473,6 +9838,89 @@ module Aws::Connect
|
|
|
8473
9838
|
req.send_request(options)
|
|
8474
9839
|
end
|
|
8475
9840
|
|
|
9841
|
+
# Evaluates values at the time of the request and returns them. It
|
|
9842
|
+
# considers the request's timezone or the table's timezone, in that
|
|
9843
|
+
# order, when accessing time based tables. When a value is accessed, the
|
|
9844
|
+
# accessor's identity and the time of access are saved alongside the
|
|
9845
|
+
# value to help identify values that are actively in use. The term
|
|
9846
|
+
# "Batch" is not included in the operation name since it does not meet
|
|
9847
|
+
# all the criteria for a batch operation as specified in Batch
|
|
9848
|
+
# Operations: AWS API Standards.
|
|
9849
|
+
#
|
|
9850
|
+
# @option params [required, String] :instance_id
|
|
9851
|
+
# The unique identifier for the Amazon Connect instance.
|
|
9852
|
+
#
|
|
9853
|
+
# @option params [required, String] :data_table_id
|
|
9854
|
+
# The unique identifier for the data table. Must also accept the table
|
|
9855
|
+
# ARN with or without a version alias.
|
|
9856
|
+
#
|
|
9857
|
+
# @option params [required, Array<Types::DataTableValueEvaluationSet>] :values
|
|
9858
|
+
# A list of value evaluation sets specifying which primary values and
|
|
9859
|
+
# attributes to evaluate.
|
|
9860
|
+
#
|
|
9861
|
+
# @option params [String] :time_zone
|
|
9862
|
+
# Optional IANA timezone identifier to use when resolving time based
|
|
9863
|
+
# dynamic values. Defaults to the data table time zone if not provided.
|
|
9864
|
+
#
|
|
9865
|
+
# @option params [String] :next_token
|
|
9866
|
+
# Specify the pagination token from a previous request to retrieve the
|
|
9867
|
+
# next page of results.
|
|
9868
|
+
#
|
|
9869
|
+
# @option params [Integer] :max_results
|
|
9870
|
+
# The maximum number of data table values to return in one page of
|
|
9871
|
+
# results.
|
|
9872
|
+
#
|
|
9873
|
+
# @return [Types::EvaluateDataTableValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
9874
|
+
#
|
|
9875
|
+
# * {Types::EvaluateDataTableValuesResponse#values #values} => Array<Types::DataTableEvaluatedValue>
|
|
9876
|
+
# * {Types::EvaluateDataTableValuesResponse#next_token #next_token} => String
|
|
9877
|
+
#
|
|
9878
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
9879
|
+
#
|
|
9880
|
+
# @example Request syntax with placeholder values
|
|
9881
|
+
#
|
|
9882
|
+
# resp = client.evaluate_data_table_values({
|
|
9883
|
+
# instance_id: "InstanceId", # required
|
|
9884
|
+
# data_table_id: "DataTableId", # required
|
|
9885
|
+
# values: [ # required
|
|
9886
|
+
# {
|
|
9887
|
+
# primary_values: [
|
|
9888
|
+
# {
|
|
9889
|
+
# attribute_name: "DataTableName", # required
|
|
9890
|
+
# value: "String", # required
|
|
9891
|
+
# },
|
|
9892
|
+
# ],
|
|
9893
|
+
# attribute_names: ["DataTableName"], # required
|
|
9894
|
+
# },
|
|
9895
|
+
# ],
|
|
9896
|
+
# time_zone: "TimeZone",
|
|
9897
|
+
# next_token: "NextToken",
|
|
9898
|
+
# max_results: 1,
|
|
9899
|
+
# })
|
|
9900
|
+
#
|
|
9901
|
+
# @example Response structure
|
|
9902
|
+
#
|
|
9903
|
+
# resp.values #=> Array
|
|
9904
|
+
# resp.values[0].record_id #=> String
|
|
9905
|
+
# resp.values[0].primary_values #=> Array
|
|
9906
|
+
# resp.values[0].primary_values[0].attribute_name #=> String
|
|
9907
|
+
# resp.values[0].primary_values[0].value #=> String
|
|
9908
|
+
# resp.values[0].attribute_name #=> String
|
|
9909
|
+
# resp.values[0].value_type #=> String, one of "TEXT", "NUMBER", "BOOLEAN", "TEXT_LIST", "NUMBER_LIST"
|
|
9910
|
+
# resp.values[0].found #=> Boolean
|
|
9911
|
+
# resp.values[0].error #=> Boolean
|
|
9912
|
+
# resp.values[0].evaluated_value #=> String
|
|
9913
|
+
# resp.next_token #=> String
|
|
9914
|
+
#
|
|
9915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluateDataTableValues AWS API Documentation
|
|
9916
|
+
#
|
|
9917
|
+
# @overload evaluate_data_table_values(params = {})
|
|
9918
|
+
# @param [Hash] params ({})
|
|
9919
|
+
def evaluate_data_table_values(params = {}, options = {})
|
|
9920
|
+
req = build_request(:evaluate_data_table_values, params)
|
|
9921
|
+
req.send_request(options)
|
|
9922
|
+
end
|
|
9923
|
+
|
|
8476
9924
|
# Provides a pre-signed URL for download of an approved attached file.
|
|
8477
9925
|
# This API also returns metadata about the attached file. It will only
|
|
8478
9926
|
# return a downloadURL if the status of the attached file is `APPROVED`.
|
|
@@ -9769,24 +11217,27 @@ module Aws::Connect
|
|
|
9769
11217
|
#
|
|
9770
11218
|
# * **Filter keys**: A maximum of 5 filter keys are supported in a
|
|
9771
11219
|
# single request. Valid filter keys: `AGENT` \|
|
|
9772
|
-
# `
|
|
9773
|
-
# `
|
|
9774
|
-
# `
|
|
9775
|
-
# \| `
|
|
9776
|
-
# `
|
|
9777
|
-
#
|
|
9778
|
-
# `
|
|
9779
|
-
#
|
|
9780
|
-
#
|
|
9781
|
-
# `
|
|
11220
|
+
# `AGENT_HIERARCHY_LEVEL_FIVE` \| `AGENT_HIERARCHY_LEVEL_FOUR` \|
|
|
11221
|
+
# `AGENT_ HIERARCHY_LEVEL_ONE` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
|
11222
|
+
# `AGENT_HIERARCHY_LEVEL_TWO` \| ` ANSWERING_MACHINE_DETECTION_STATUS`
|
|
11223
|
+
# \| `BOT_ALIAS` \| `BOT_ID` \| `BOT_INTENT_NAME` \| `BOT_LOCALE` \|
|
|
11224
|
+
# `BOT_VERSION` \| `CAMPAIGN` \| `CAMPAIGN_DELIVERY_EVENT_TYPE` \| `
|
|
11225
|
+
# CAMPAIGN_EXCLUDED_EVENT_TYPE` \| `CASE_STATUS` \|
|
|
11226
|
+
# `CASE_TEMPLATE_ARN` \| `CHANNEL` \| `
|
|
11227
|
+
# contact/segmentAttributes/connect:Subtype` \|
|
|
11228
|
+
# `contact/segmentAttributes/connect:ValidationTestType` \| `
|
|
11229
|
+
# DISCONNECT_REASON` \| `EVALUATION_FORM` \| `EVALUATION_QUESTION` \|
|
|
11230
|
+
# `EVALUATION_SECTION` \| `EVALUATION_SOURCE` \| `EVALUATOR_ID` \|
|
|
9782
11231
|
# `FEATURE` \| `FLOW_ACTION_ID` \| `FLOW_TYPE` \|
|
|
9783
11232
|
# `FLOWS_MODULE_RESOURCE_ID` \| `FLOWS_NEXT_RESOURCE_ID` \|
|
|
9784
11233
|
# `FLOWS_NEXT_RESOURCE_QUEUE_ID` \| `FLOWS_OUTCOME_TYPE` \|
|
|
9785
|
-
# `FLOWS_RESOURCE_ID` \| `FORM_VERSION` \| `
|
|
9786
|
-
# `
|
|
9787
|
-
#
|
|
9788
|
-
# `
|
|
9789
|
-
# `
|
|
11234
|
+
# `FLOWS_RESOURCE_ID` \| `FORM_VERSION` \| `INITIATING_FLOW` \|
|
|
11235
|
+
# `INITIATION_METHOD` \| `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` \|
|
|
11236
|
+
# `INVOKING_RESOURCE_TYPE` \| `PARENT_FLOWS_RESOURCE_ID` \|
|
|
11237
|
+
# `Q_CONNECT_ENABLED` \| `QUEUE` \| `RESOURCE_PUBLISHED_ TIMESTAMP` \|
|
|
11238
|
+
# `ROUTING_PROFILE` \| `ROUTING_STEP_EXPRESSION` \| `TEST_CASE` \|
|
|
11239
|
+
# `TEST_ CASE_EXECUTION_FAILURE_REASON` \|
|
|
11240
|
+
# `TEST_CASE_EXECUTION_RESULT` \| `TEST_CASE_EXECUTION_STATE`
|
|
9790
11241
|
#
|
|
9791
11242
|
# * **Filter values**: A maximum of 100 filter values are supported in a
|
|
9792
11243
|
# single request. VOICE, CHAT, and TASK are valid `filterValue` for
|
|
@@ -9811,11 +11262,15 @@ module Aws::Connect
|
|
|
9811
11262
|
# `Q_CONNECT_ENABLED`. TRUE and FALSE are the only valid filterValues
|
|
9812
11263
|
# for the `Q_CONNECT_ENABLED` filter key.
|
|
9813
11264
|
#
|
|
9814
|
-
# * TRUE includes all contacts that had
|
|
11265
|
+
# * TRUE includes all contacts that had Connect AI Agents enabled as
|
|
9815
11266
|
# part of the flow.
|
|
9816
11267
|
#
|
|
9817
|
-
# * FALSE includes all contacts that did not have
|
|
11268
|
+
# * FALSE includes all contacts that did not have Connect AI Agents
|
|
9818
11269
|
# enabled as part of the flow
|
|
11270
|
+
#
|
|
11271
|
+
# * EXPERIENCE\_VALIDATION and FLOW\_VALIDATION are the only valid
|
|
11272
|
+
# filterValues for the
|
|
11273
|
+
# contact/segmentAttributes/connect:ValidationTestType filter key
|
|
9819
11274
|
# This filter is available only for contact record-driven metrics.
|
|
9820
11275
|
#
|
|
9821
11276
|
# [Campaign][2] ARNs are valid `filterValues` for the `CAMPAIGN`
|
|
@@ -9849,7 +11304,15 @@ module Aws::Connect
|
|
|
9849
11304
|
# `INITIATION_METHOD` \| `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` \|
|
|
9850
11305
|
# `INVOKING_RESOURCE_TYPE` \| `PARENT_FLOWS_RESOURCE_ID` \|
|
|
9851
11306
|
# `Q_CONNECT_ENABLED` \| `QUEUE` \| `RESOURCE_PUBLISHED_TIMESTAMP` \|
|
|
9852
|
-
# `ROUTING_PROFILE` \| `ROUTING_STEP_EXPRESSION`
|
|
11307
|
+
# `ROUTING_PROFILE` \| `ROUTING_STEP_EXPRESSION` \| `TEST_CASE` \|
|
|
11308
|
+
# `TEST_CASE_EXECUTION_FAILURE_REASON` \| `TEST_CASE_INVOCATION_METHOD`
|
|
11309
|
+
#
|
|
11310
|
+
# API, SCHEDULE, and EVENT are the only valid filterValues for
|
|
11311
|
+
# TEST\_CASE\_INVOCATION\_METHOD.
|
|
11312
|
+
#
|
|
11313
|
+
# OBSERVE\_EVENT, SEND\_INSTRUCTION, ASSERT\_DATA, and
|
|
11314
|
+
# OVERRIDE\_SYSTEM\_BEHAVIOR are the only valid filterValues for
|
|
11315
|
+
# TEST\_CASE\_EXECUTION\_FAILURE\_REASON
|
|
9853
11316
|
#
|
|
9854
11317
|
# Type: Array of strings
|
|
9855
11318
|
#
|
|
@@ -9858,10 +11321,16 @@ module Aws::Connect
|
|
|
9858
11321
|
# Required: No
|
|
9859
11322
|
#
|
|
9860
11323
|
# @option params [required, Array<Types::MetricV2>] :metrics
|
|
9861
|
-
# The metrics to retrieve. Specify the name, groupings, and
|
|
9862
|
-
# each metric. The following historical metrics are
|
|
9863
|
-
# description of each metric, see [Metrics
|
|
9864
|
-
# Connect Administrator Guide*.
|
|
11324
|
+
# The metrics to retrieve. Specify the name or metricId, groupings, and
|
|
11325
|
+
# filters for each metric. The following historical metrics are
|
|
11326
|
+
# available. For a description of each metric, see [Metrics
|
|
11327
|
+
# definition][1] in the *Amazon Connect Administrator Guide*.
|
|
11328
|
+
#
|
|
11329
|
+
# <note markdown="1"> MetricId should be used to reference custom metrics or out of the box
|
|
11330
|
+
# metrics as Arn. If using MetricId, the limit is 20 MetricId per
|
|
11331
|
+
# request.
|
|
11332
|
+
#
|
|
11333
|
+
# </note>
|
|
9865
11334
|
#
|
|
9866
11335
|
# ABANDONMENT\_RATE
|
|
9867
11336
|
#
|
|
@@ -10190,6 +11659,252 @@ module Aws::Connect
|
|
|
10190
11659
|
#
|
|
10191
11660
|
# </note>
|
|
10192
11661
|
#
|
|
11662
|
+
# ACTIVE\_AI\_AGENTS
|
|
11663
|
+
#
|
|
11664
|
+
# : Unit: Count
|
|
11665
|
+
#
|
|
11666
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type,
|
|
11667
|
+
# AI Use Case, Channel, Queue, Routing Profile
|
|
11668
|
+
#
|
|
11669
|
+
# UI name: Active AI Agents
|
|
11670
|
+
#
|
|
11671
|
+
# AI\_HANDOFF\_RATE
|
|
11672
|
+
#
|
|
11673
|
+
# : Unit: Percent
|
|
11674
|
+
#
|
|
11675
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11676
|
+
# Profile
|
|
11677
|
+
#
|
|
11678
|
+
# UI name: Handoff Rate
|
|
11679
|
+
#
|
|
11680
|
+
# AI\_HANDOFFS
|
|
11681
|
+
#
|
|
11682
|
+
# : Unit: Count
|
|
11683
|
+
#
|
|
11684
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11685
|
+
# Profile
|
|
11686
|
+
#
|
|
11687
|
+
# UI name: AI Handoff Count
|
|
11688
|
+
#
|
|
11689
|
+
# AI\_AGENT\_INVOCATION\_SUCCESS
|
|
11690
|
+
#
|
|
11691
|
+
# : Unit: Count
|
|
11692
|
+
#
|
|
11693
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name
|
|
11694
|
+
# Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile
|
|
11695
|
+
#
|
|
11696
|
+
# UI name: AI Agent Invocation Success Count
|
|
11697
|
+
#
|
|
11698
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11699
|
+
#
|
|
11700
|
+
# </note>
|
|
11701
|
+
#
|
|
11702
|
+
# AI\_AGENT\_INVOCATION\_SUCCESS\_RATE
|
|
11703
|
+
#
|
|
11704
|
+
# : Unit: Percent
|
|
11705
|
+
#
|
|
11706
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name
|
|
11707
|
+
# Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile
|
|
11708
|
+
#
|
|
11709
|
+
# UI name: AI Agent Invocation Success Rate
|
|
11710
|
+
#
|
|
11711
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11712
|
+
#
|
|
11713
|
+
# </note>
|
|
11714
|
+
#
|
|
11715
|
+
# AI\_AGENT\_INVOCATIONS
|
|
11716
|
+
#
|
|
11717
|
+
# : Unit: Count
|
|
11718
|
+
#
|
|
11719
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type,
|
|
11720
|
+
# AI Agent Name Version, AI Use Case, Channel, Queue, Routing Profile
|
|
11721
|
+
#
|
|
11722
|
+
# UI name: AI Agent Invocation Count
|
|
11723
|
+
#
|
|
11724
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11725
|
+
#
|
|
11726
|
+
# </note>
|
|
11727
|
+
#
|
|
11728
|
+
# AI\_RESPONSE\_COMPLETION\_RATE
|
|
11729
|
+
#
|
|
11730
|
+
# : Unit: Percent
|
|
11731
|
+
#
|
|
11732
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11733
|
+
# Profile
|
|
11734
|
+
#
|
|
11735
|
+
# UI name: AI Response Completion Rate
|
|
11736
|
+
#
|
|
11737
|
+
# AI\_INVOLVED\_CONTACTS
|
|
11738
|
+
#
|
|
11739
|
+
# : Unit: Count
|
|
11740
|
+
#
|
|
11741
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11742
|
+
# Profile
|
|
11743
|
+
#
|
|
11744
|
+
# UI name: AI Contacts
|
|
11745
|
+
#
|
|
11746
|
+
# AI\_PROMPT\_INVOCATION\_SUCCESS
|
|
11747
|
+
#
|
|
11748
|
+
# : Unit: Count
|
|
11749
|
+
#
|
|
11750
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name
|
|
11751
|
+
# Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI
|
|
11752
|
+
# Prompt Type, AI Use Case, Channel, Queue, Routing Profile
|
|
11753
|
+
#
|
|
11754
|
+
# UI name: AI Prompt Invocation Success Count
|
|
11755
|
+
#
|
|
11756
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11757
|
+
#
|
|
11758
|
+
# </note>
|
|
11759
|
+
#
|
|
11760
|
+
# AI\_PROMPT\_INVOCATION\_SUCCESS\_RATE
|
|
11761
|
+
#
|
|
11762
|
+
# : Unit: Percent
|
|
11763
|
+
#
|
|
11764
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name
|
|
11765
|
+
# Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI
|
|
11766
|
+
# Prompt Type, AI Use Case, Channel, Queue, Routing Profile
|
|
11767
|
+
#
|
|
11768
|
+
# UI name: AI Prompt Invocation Success Rate
|
|
11769
|
+
#
|
|
11770
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11771
|
+
#
|
|
11772
|
+
# </note>
|
|
11773
|
+
#
|
|
11774
|
+
# AI\_TOOL\_INVOCATIONS
|
|
11775
|
+
#
|
|
11776
|
+
# : Unit: Count
|
|
11777
|
+
#
|
|
11778
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name
|
|
11779
|
+
# Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI
|
|
11780
|
+
# Use Case, Channel, Queue, Routing Profile
|
|
11781
|
+
#
|
|
11782
|
+
# UI name: AI Tool Invocation Count
|
|
11783
|
+
#
|
|
11784
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11785
|
+
#
|
|
11786
|
+
# </note>
|
|
11787
|
+
#
|
|
11788
|
+
# AVG\_AI\_AGENT\_CONVERSATION\_TURNS
|
|
11789
|
+
#
|
|
11790
|
+
# : Unit: Count
|
|
11791
|
+
#
|
|
11792
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name
|
|
11793
|
+
# Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile
|
|
11794
|
+
#
|
|
11795
|
+
# UI name: Average AI Agent Conversation Turns
|
|
11796
|
+
#
|
|
11797
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11798
|
+
#
|
|
11799
|
+
# </note>
|
|
11800
|
+
#
|
|
11801
|
+
# AVG\_AI\_CONVERSATION\_TURNS
|
|
11802
|
+
#
|
|
11803
|
+
# : Unit: Count
|
|
11804
|
+
#
|
|
11805
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11806
|
+
# Profile
|
|
11807
|
+
#
|
|
11808
|
+
# UI name: AI Conversation Turns
|
|
11809
|
+
#
|
|
11810
|
+
# AVG\_AI\_PROMPT\_INVOCATION\_LATENCY
|
|
11811
|
+
#
|
|
11812
|
+
# : Unit: Milliseconds
|
|
11813
|
+
#
|
|
11814
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name
|
|
11815
|
+
# Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI
|
|
11816
|
+
# Prompt Type, AI Use Case, Channel, Queue, Routing Profile
|
|
11817
|
+
#
|
|
11818
|
+
# UI name: Average AI Prompt Invocation Latency
|
|
11819
|
+
#
|
|
11820
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11821
|
+
#
|
|
11822
|
+
# </note>
|
|
11823
|
+
#
|
|
11824
|
+
# AVG\_AI\_TOOL\_INVOCATION\_LATENCY
|
|
11825
|
+
#
|
|
11826
|
+
# : Unit: Milliseconds
|
|
11827
|
+
#
|
|
11828
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name
|
|
11829
|
+
# Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI
|
|
11830
|
+
# Use Case, Channel, Queue, Routing Profile
|
|
11831
|
+
#
|
|
11832
|
+
# UI name: Average AI Tool Invocation Latency
|
|
11833
|
+
#
|
|
11834
|
+
# <note markdown="1"> AI Agent Name Version is not a valid filter but a valid grouping.
|
|
11835
|
+
#
|
|
11836
|
+
# </note>
|
|
11837
|
+
#
|
|
11838
|
+
# KNOWLEDGE\_CONTENT\_REFERENCES
|
|
11839
|
+
#
|
|
11840
|
+
# : Unit: Count
|
|
11841
|
+
#
|
|
11842
|
+
# Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type,
|
|
11843
|
+
# AI Use Case, Channel, Knowledge Base Name, Queue, Routing Profile
|
|
11844
|
+
#
|
|
11845
|
+
# UI name: KnowledgeBase Reference Count
|
|
11846
|
+
#
|
|
11847
|
+
# PROACTIVE\_INTENT\_ENGAGEMENT\_RATE
|
|
11848
|
+
#
|
|
11849
|
+
# : Unit: Percent
|
|
11850
|
+
#
|
|
11851
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11852
|
+
# Profile
|
|
11853
|
+
#
|
|
11854
|
+
# UI name: Proactive Intent Engagement Rate
|
|
11855
|
+
#
|
|
11856
|
+
# PROACTIVE\_INTENT\_RESPONSE\_RATE
|
|
11857
|
+
#
|
|
11858
|
+
# : Unit: Percent
|
|
11859
|
+
#
|
|
11860
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11861
|
+
# Profile
|
|
11862
|
+
#
|
|
11863
|
+
# UI name: Proactive Intent Response Rate
|
|
11864
|
+
#
|
|
11865
|
+
# PROACTIVE\_INTENTS\_ANSWERED
|
|
11866
|
+
#
|
|
11867
|
+
# : Unit: Count
|
|
11868
|
+
#
|
|
11869
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11870
|
+
# Profile
|
|
11871
|
+
#
|
|
11872
|
+
# UI name: Proactive Intents Answered
|
|
11873
|
+
#
|
|
11874
|
+
# PROACTIVE\_INTENTS\_DETECTED
|
|
11875
|
+
#
|
|
11876
|
+
# : Unit: Count
|
|
11877
|
+
#
|
|
11878
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11879
|
+
# Profile
|
|
11880
|
+
#
|
|
11881
|
+
# UI name: Proactive Intents Detected
|
|
11882
|
+
#
|
|
11883
|
+
#
|
|
11884
|
+
#
|
|
11885
|
+
# : Unit:
|
|
11886
|
+
#
|
|
11887
|
+
# Valid groupings and filters:
|
|
11888
|
+
#
|
|
11889
|
+
# UI name:
|
|
11890
|
+
#
|
|
11891
|
+
#
|
|
11892
|
+
#
|
|
11893
|
+
# : Unit:
|
|
11894
|
+
#
|
|
11895
|
+
# Valid groupings and filters:
|
|
11896
|
+
#
|
|
11897
|
+
# UI name:
|
|
11898
|
+
#
|
|
11899
|
+
# PROACTIVE\_INTENTS\_ENGAGED
|
|
11900
|
+
#
|
|
11901
|
+
# : Unit: Count
|
|
11902
|
+
#
|
|
11903
|
+
# Valid groupings and filters: AI Use Case, Channel, Queue, Routing
|
|
11904
|
+
# Profile
|
|
11905
|
+
#
|
|
11906
|
+
# UI name: UI name:
|
|
11907
|
+
#
|
|
10193
11908
|
# AVG\_HOLD\_TIME
|
|
10194
11909
|
#
|
|
10195
11910
|
# : Unit: Seconds
|
|
@@ -11476,6 +13191,9 @@ module Aws::Connect
|
|
|
11476
13191
|
# {
|
|
11477
13192
|
# filter_key: "ResourceArnOrId",
|
|
11478
13193
|
# filter_values: ["ResourceArnOrId"],
|
|
13194
|
+
# string_condition: {
|
|
13195
|
+
# comparison: "NOT_EXISTS", # accepts NOT_EXISTS
|
|
13196
|
+
# },
|
|
11479
13197
|
# },
|
|
11480
13198
|
# ],
|
|
11481
13199
|
# groupings: ["GroupingV2"],
|
|
@@ -11488,6 +13206,7 @@ module Aws::Connect
|
|
|
11488
13206
|
# threshold_value: 1.0,
|
|
11489
13207
|
# },
|
|
11490
13208
|
# ],
|
|
13209
|
+
# metric_id: "MetricId",
|
|
11491
13210
|
# metric_filters: [
|
|
11492
13211
|
# {
|
|
11493
13212
|
# metric_filter_key: "String",
|
|
@@ -11515,6 +13234,7 @@ module Aws::Connect
|
|
|
11515
13234
|
# resp.metric_results[0].collections[0].metric.threshold #=> Array
|
|
11516
13235
|
# resp.metric_results[0].collections[0].metric.threshold[0].comparison #=> String
|
|
11517
13236
|
# resp.metric_results[0].collections[0].metric.threshold[0].threshold_value #=> Float
|
|
13237
|
+
# resp.metric_results[0].collections[0].metric.metric_id #=> String
|
|
11518
13238
|
# resp.metric_results[0].collections[0].metric.metric_filters #=> Array
|
|
11519
13239
|
# resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_key #=> String
|
|
11520
13240
|
# resp.metric_results[0].collections[0].metric.metric_filters[0].metric_filter_values #=> Array
|
|
@@ -11797,7 +13517,7 @@ module Aws::Connect
|
|
|
11797
13517
|
req.send_request(options)
|
|
11798
13518
|
end
|
|
11799
13519
|
|
|
11800
|
-
#
|
|
13520
|
+
# Imports a media asset (such as a logo) for use in a workspace.
|
|
11801
13521
|
#
|
|
11802
13522
|
# @option params [required, String] :instance_id
|
|
11803
13523
|
# The identifier of the Amazon Connect instance. You can [find the
|
|
@@ -11807,9 +13527,50 @@ module Aws::Connect
|
|
|
11807
13527
|
#
|
|
11808
13528
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
11809
13529
|
#
|
|
11810
|
-
# @option params [String] :
|
|
11811
|
-
# The
|
|
11812
|
-
#
|
|
13530
|
+
# @option params [required, String] :workspace_id
|
|
13531
|
+
# The identifier of the workspace.
|
|
13532
|
+
#
|
|
13533
|
+
# @option params [required, String] :media_type
|
|
13534
|
+
# The type of media. Valid values are: `IMAGE_LOGO_FAVICON` and
|
|
13535
|
+
# `IMAGE_LOGO_HORIZONTAL`.
|
|
13536
|
+
#
|
|
13537
|
+
# @option params [required, String] :media_source
|
|
13538
|
+
# The media source. Can be an S3 presigned URL or a base64-encoded
|
|
13539
|
+
# string.
|
|
13540
|
+
#
|
|
13541
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
13542
|
+
#
|
|
13543
|
+
# @example Request syntax with placeholder values
|
|
13544
|
+
#
|
|
13545
|
+
# resp = client.import_workspace_media({
|
|
13546
|
+
# instance_id: "InstanceId", # required
|
|
13547
|
+
# workspace_id: "WorkspaceId", # required
|
|
13548
|
+
# media_type: "IMAGE_LOGO_LIGHT_FAVICON", # required, accepts IMAGE_LOGO_LIGHT_FAVICON, IMAGE_LOGO_DARK_FAVICON, IMAGE_LOGO_LIGHT_HORIZONTAL, IMAGE_LOGO_DARK_HORIZONTAL
|
|
13549
|
+
# media_source: "MediaSource", # required
|
|
13550
|
+
# })
|
|
13551
|
+
#
|
|
13552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ImportWorkspaceMedia AWS API Documentation
|
|
13553
|
+
#
|
|
13554
|
+
# @overload import_workspace_media(params = {})
|
|
13555
|
+
# @param [Hash] params ({})
|
|
13556
|
+
def import_workspace_media(params = {}, options = {})
|
|
13557
|
+
req = build_request(:import_workspace_media, params)
|
|
13558
|
+
req.send_request(options)
|
|
13559
|
+
end
|
|
13560
|
+
|
|
13561
|
+
# Lists agent statuses.
|
|
13562
|
+
#
|
|
13563
|
+
# @option params [required, String] :instance_id
|
|
13564
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
13565
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
13566
|
+
#
|
|
13567
|
+
#
|
|
13568
|
+
#
|
|
13569
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
13570
|
+
#
|
|
13571
|
+
# @option params [String] :next_token
|
|
13572
|
+
# The token for the next set of results. Use the value returned in the
|
|
13573
|
+
# previous response in the next request to retrieve the next set of
|
|
11813
13574
|
# results.
|
|
11814
13575
|
#
|
|
11815
13576
|
# @option params [Integer] :max_results
|
|
@@ -12236,12 +13997,15 @@ module Aws::Connect
|
|
|
12236
13997
|
# resp.evaluation_summary_list[0].score.percentage #=> Float
|
|
12237
13998
|
# resp.evaluation_summary_list[0].score.not_applicable #=> Boolean
|
|
12238
13999
|
# resp.evaluation_summary_list[0].score.automatic_fail #=> Boolean
|
|
14000
|
+
# resp.evaluation_summary_list[0].score.applied_weight #=> Float
|
|
12239
14001
|
# resp.evaluation_summary_list[0].acknowledgement.acknowledged_time #=> Time
|
|
12240
14002
|
# resp.evaluation_summary_list[0].acknowledgement.acknowledged_by #=> String
|
|
12241
14003
|
# resp.evaluation_summary_list[0].acknowledgement.acknowledger_comment #=> String
|
|
12242
14004
|
# resp.evaluation_summary_list[0].evaluation_type #=> String, one of "STANDARD", "CALIBRATION"
|
|
12243
14005
|
# resp.evaluation_summary_list[0].created_time #=> Time
|
|
12244
14006
|
# resp.evaluation_summary_list[0].last_modified_time #=> Time
|
|
14007
|
+
# resp.evaluation_summary_list[0].contact_participant.contact_participant_role #=> String, one of "AGENT", "SYSTEM", "CUSTOM_BOT"
|
|
14008
|
+
# resp.evaluation_summary_list[0].contact_participant.contact_participant_id #=> String
|
|
12245
14009
|
# resp.next_token #=> String
|
|
12246
14010
|
#
|
|
12247
14011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactEvaluations AWS API Documentation
|
|
@@ -12584,7 +14348,7 @@ module Aws::Connect
|
|
|
12584
14348
|
# resp = client.list_contact_references({
|
|
12585
14349
|
# instance_id: "InstanceId", # required
|
|
12586
14350
|
# contact_id: "ContactId", # required
|
|
12587
|
-
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
14351
|
+
# reference_types: ["URL"], # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
12588
14352
|
# next_token: "NextToken",
|
|
12589
14353
|
# })
|
|
12590
14354
|
#
|
|
@@ -12599,6 +14363,8 @@ module Aws::Connect
|
|
|
12599
14363
|
# resp.reference_summary_list[0].attachment.arn #=> String
|
|
12600
14364
|
# resp.reference_summary_list[0].email_message.name #=> String
|
|
12601
14365
|
# resp.reference_summary_list[0].email_message.arn #=> String
|
|
14366
|
+
# resp.reference_summary_list[0].email_message_plain_text.name #=> String
|
|
14367
|
+
# resp.reference_summary_list[0].email_message_plain_text.arn #=> String
|
|
12602
14368
|
# resp.reference_summary_list[0].string.name #=> String
|
|
12603
14369
|
# resp.reference_summary_list[0].string.value #=> String
|
|
12604
14370
|
# resp.reference_summary_list[0].number.name #=> String
|
|
@@ -12618,6 +14384,287 @@ module Aws::Connect
|
|
|
12618
14384
|
req.send_request(options)
|
|
12619
14385
|
end
|
|
12620
14386
|
|
|
14387
|
+
# Returns all attributes for a specified data table. A maximum of 100
|
|
14388
|
+
# attributes per data table is allowed. Customers can request an
|
|
14389
|
+
# increase by using AWS Service Quotas. The response can be filtered by
|
|
14390
|
+
# specific attribute IDs for CloudFormation integration.
|
|
14391
|
+
#
|
|
14392
|
+
# @option params [required, String] :instance_id
|
|
14393
|
+
# The unique identifier for the Amazon Connect instance.
|
|
14394
|
+
#
|
|
14395
|
+
# @option params [required, String] :data_table_id
|
|
14396
|
+
# The unique identifier for the data table whose attributes should be
|
|
14397
|
+
# listed.
|
|
14398
|
+
#
|
|
14399
|
+
# @option params [Array<String>] :attribute_ids
|
|
14400
|
+
# Optional list of specific attribute IDs to retrieve. Used for
|
|
14401
|
+
# CloudFormation to effectively describe attributes by ID. If NextToken
|
|
14402
|
+
# is provided, this parameter is ignored.
|
|
14403
|
+
#
|
|
14404
|
+
# @option params [String] :next_token
|
|
14405
|
+
# Specify the pagination token from a previous request to retrieve the
|
|
14406
|
+
# next page of results.
|
|
14407
|
+
#
|
|
14408
|
+
# @option params [Integer] :max_results
|
|
14409
|
+
# The maximum number of data table attributes to return in one page of
|
|
14410
|
+
# results.
|
|
14411
|
+
#
|
|
14412
|
+
# @return [Types::ListDataTableAttributesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14413
|
+
#
|
|
14414
|
+
# * {Types::ListDataTableAttributesResponse#next_token #next_token} => String
|
|
14415
|
+
# * {Types::ListDataTableAttributesResponse#attributes #attributes} => Array<Types::DataTableAttribute>
|
|
14416
|
+
#
|
|
14417
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
14418
|
+
#
|
|
14419
|
+
# @example Request syntax with placeholder values
|
|
14420
|
+
#
|
|
14421
|
+
# resp = client.list_data_table_attributes({
|
|
14422
|
+
# instance_id: "InstanceId", # required
|
|
14423
|
+
# data_table_id: "DataTableId", # required
|
|
14424
|
+
# attribute_ids: ["DataTableId"],
|
|
14425
|
+
# next_token: "NextToken",
|
|
14426
|
+
# max_results: 1,
|
|
14427
|
+
# })
|
|
14428
|
+
#
|
|
14429
|
+
# @example Response structure
|
|
14430
|
+
#
|
|
14431
|
+
# resp.next_token #=> String
|
|
14432
|
+
# resp.attributes #=> Array
|
|
14433
|
+
# resp.attributes[0].attribute_id #=> String
|
|
14434
|
+
# resp.attributes[0].name #=> String
|
|
14435
|
+
# resp.attributes[0].value_type #=> String, one of "TEXT", "NUMBER", "BOOLEAN", "TEXT_LIST", "NUMBER_LIST"
|
|
14436
|
+
# resp.attributes[0].description #=> String
|
|
14437
|
+
# resp.attributes[0].data_table_id #=> String
|
|
14438
|
+
# resp.attributes[0].data_table_arn #=> String
|
|
14439
|
+
# resp.attributes[0].primary #=> Boolean
|
|
14440
|
+
# resp.attributes[0].version #=> String
|
|
14441
|
+
# resp.attributes[0].lock_version.data_table #=> String
|
|
14442
|
+
# resp.attributes[0].lock_version.attribute #=> String
|
|
14443
|
+
# resp.attributes[0].lock_version.primary_values #=> String
|
|
14444
|
+
# resp.attributes[0].lock_version.value #=> String
|
|
14445
|
+
# resp.attributes[0].last_modified_time #=> Time
|
|
14446
|
+
# resp.attributes[0].last_modified_region #=> String
|
|
14447
|
+
# resp.attributes[0].validation.min_length #=> Integer
|
|
14448
|
+
# resp.attributes[0].validation.max_length #=> Integer
|
|
14449
|
+
# resp.attributes[0].validation.min_values #=> Integer
|
|
14450
|
+
# resp.attributes[0].validation.max_values #=> Integer
|
|
14451
|
+
# resp.attributes[0].validation.ignore_case #=> Boolean
|
|
14452
|
+
# resp.attributes[0].validation.minimum #=> Float
|
|
14453
|
+
# resp.attributes[0].validation.maximum #=> Float
|
|
14454
|
+
# resp.attributes[0].validation.exclusive_minimum #=> Float
|
|
14455
|
+
# resp.attributes[0].validation.exclusive_maximum #=> Float
|
|
14456
|
+
# resp.attributes[0].validation.multiple_of #=> Float
|
|
14457
|
+
# resp.attributes[0].validation.enum.strict #=> Boolean
|
|
14458
|
+
# resp.attributes[0].validation.enum.values #=> Array
|
|
14459
|
+
# resp.attributes[0].validation.enum.values[0] #=> String
|
|
14460
|
+
#
|
|
14461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListDataTableAttributes AWS API Documentation
|
|
14462
|
+
#
|
|
14463
|
+
# @overload list_data_table_attributes(params = {})
|
|
14464
|
+
# @param [Hash] params ({})
|
|
14465
|
+
def list_data_table_attributes(params = {}, options = {})
|
|
14466
|
+
req = build_request(:list_data_table_attributes, params)
|
|
14467
|
+
req.send_request(options)
|
|
14468
|
+
end
|
|
14469
|
+
|
|
14470
|
+
# Lists all primary value combinations for a given data table. Returns
|
|
14471
|
+
# the unique combinations of primary attribute values that identify
|
|
14472
|
+
# records in the table. Up to 100 records are returned per request.
|
|
14473
|
+
#
|
|
14474
|
+
# @option params [required, String] :instance_id
|
|
14475
|
+
# The unique identifier for the Amazon Connect instance.
|
|
14476
|
+
#
|
|
14477
|
+
# @option params [required, String] :data_table_id
|
|
14478
|
+
# The unique identifier for the data table whose primary values should
|
|
14479
|
+
# be listed.
|
|
14480
|
+
#
|
|
14481
|
+
# @option params [Array<String>] :record_ids
|
|
14482
|
+
# Optional list of specific record IDs to retrieve. Used for
|
|
14483
|
+
# CloudFormation to effectively describe records by ID. If NextToken is
|
|
14484
|
+
# provided, this parameter is ignored.
|
|
14485
|
+
#
|
|
14486
|
+
# @option params [Array<Types::PrimaryAttributeValueFilter>] :primary_attribute_values
|
|
14487
|
+
# Optional filter to retrieve primary values matching specific criteria.
|
|
14488
|
+
#
|
|
14489
|
+
# @option params [String] :next_token
|
|
14490
|
+
# Specify the pagination token from a previous request to retrieve the
|
|
14491
|
+
# next page of results.
|
|
14492
|
+
#
|
|
14493
|
+
# @option params [Integer] :max_results
|
|
14494
|
+
# The maximum number of data table primary values to return in one page
|
|
14495
|
+
# of results.
|
|
14496
|
+
#
|
|
14497
|
+
# @return [Types::ListDataTablePrimaryValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14498
|
+
#
|
|
14499
|
+
# * {Types::ListDataTablePrimaryValuesResponse#next_token #next_token} => String
|
|
14500
|
+
# * {Types::ListDataTablePrimaryValuesResponse#primary_values_list #primary_values_list} => Array<Types::RecordPrimaryValue>
|
|
14501
|
+
#
|
|
14502
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
14503
|
+
#
|
|
14504
|
+
# @example Request syntax with placeholder values
|
|
14505
|
+
#
|
|
14506
|
+
# resp = client.list_data_table_primary_values({
|
|
14507
|
+
# instance_id: "InstanceId", # required
|
|
14508
|
+
# data_table_id: "DataTableId", # required
|
|
14509
|
+
# record_ids: ["DataTableId"],
|
|
14510
|
+
# primary_attribute_values: [
|
|
14511
|
+
# {
|
|
14512
|
+
# attribute_name: "DataTableName", # required
|
|
14513
|
+
# values: ["String"], # required
|
|
14514
|
+
# },
|
|
14515
|
+
# ],
|
|
14516
|
+
# next_token: "NextToken",
|
|
14517
|
+
# max_results: 1,
|
|
14518
|
+
# })
|
|
14519
|
+
#
|
|
14520
|
+
# @example Response structure
|
|
14521
|
+
#
|
|
14522
|
+
# resp.next_token #=> String
|
|
14523
|
+
# resp.primary_values_list #=> Array
|
|
14524
|
+
# resp.primary_values_list[0].record_id #=> String
|
|
14525
|
+
# resp.primary_values_list[0].primary_values #=> Array
|
|
14526
|
+
# resp.primary_values_list[0].primary_values[0].attribute_name #=> String
|
|
14527
|
+
# resp.primary_values_list[0].primary_values[0].attribute_id #=> String
|
|
14528
|
+
# resp.primary_values_list[0].primary_values[0].value #=> String
|
|
14529
|
+
# resp.primary_values_list[0].last_modified_time #=> Time
|
|
14530
|
+
# resp.primary_values_list[0].last_modified_region #=> String
|
|
14531
|
+
#
|
|
14532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListDataTablePrimaryValues AWS API Documentation
|
|
14533
|
+
#
|
|
14534
|
+
# @overload list_data_table_primary_values(params = {})
|
|
14535
|
+
# @param [Hash] params ({})
|
|
14536
|
+
def list_data_table_primary_values(params = {}, options = {})
|
|
14537
|
+
req = build_request(:list_data_table_primary_values, params)
|
|
14538
|
+
req.send_request(options)
|
|
14539
|
+
end
|
|
14540
|
+
|
|
14541
|
+
# Lists values stored in a data table with optional filtering by record
|
|
14542
|
+
# IDs or primary attribute values. Returns the raw stored values along
|
|
14543
|
+
# with metadata such as lock versions and modification timestamps.
|
|
14544
|
+
#
|
|
14545
|
+
# @option params [required, String] :instance_id
|
|
14546
|
+
# The unique identifier for the Amazon Connect instance.
|
|
14547
|
+
#
|
|
14548
|
+
# @option params [required, String] :data_table_id
|
|
14549
|
+
# The unique identifier for the data table whose values should be
|
|
14550
|
+
# listed.
|
|
14551
|
+
#
|
|
14552
|
+
# @option params [Array<String>] :record_ids
|
|
14553
|
+
# Optional list of specific record IDs to retrieve values for.
|
|
14554
|
+
#
|
|
14555
|
+
# @option params [Array<Types::PrimaryAttributeValueFilter>] :primary_attribute_values
|
|
14556
|
+
# Optional filter to retrieve values for records matching specific
|
|
14557
|
+
# primary attribute criteria.
|
|
14558
|
+
#
|
|
14559
|
+
# @option params [String] :next_token
|
|
14560
|
+
# Specify the pagination token from a previous request to retrieve the
|
|
14561
|
+
# next page of results.
|
|
14562
|
+
#
|
|
14563
|
+
# @option params [Integer] :max_results
|
|
14564
|
+
# The maximum number of data table values to return in one page of
|
|
14565
|
+
# results.
|
|
14566
|
+
#
|
|
14567
|
+
# @return [Types::ListDataTableValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14568
|
+
#
|
|
14569
|
+
# * {Types::ListDataTableValuesResponse#next_token #next_token} => String
|
|
14570
|
+
# * {Types::ListDataTableValuesResponse#values #values} => Array<Types::DataTableValueSummary>
|
|
14571
|
+
#
|
|
14572
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
14573
|
+
#
|
|
14574
|
+
# @example Request syntax with placeholder values
|
|
14575
|
+
#
|
|
14576
|
+
# resp = client.list_data_table_values({
|
|
14577
|
+
# instance_id: "InstanceId", # required
|
|
14578
|
+
# data_table_id: "DataTableId", # required
|
|
14579
|
+
# record_ids: ["DataTableId"],
|
|
14580
|
+
# primary_attribute_values: [
|
|
14581
|
+
# {
|
|
14582
|
+
# attribute_name: "DataTableName", # required
|
|
14583
|
+
# values: ["String"], # required
|
|
14584
|
+
# },
|
|
14585
|
+
# ],
|
|
14586
|
+
# next_token: "NextToken",
|
|
14587
|
+
# max_results: 1,
|
|
14588
|
+
# })
|
|
14589
|
+
#
|
|
14590
|
+
# @example Response structure
|
|
14591
|
+
#
|
|
14592
|
+
# resp.next_token #=> String
|
|
14593
|
+
# resp.values #=> Array
|
|
14594
|
+
# resp.values[0].record_id #=> String
|
|
14595
|
+
# resp.values[0].attribute_id #=> String
|
|
14596
|
+
# resp.values[0].primary_values #=> Array
|
|
14597
|
+
# resp.values[0].primary_values[0].attribute_name #=> String
|
|
14598
|
+
# resp.values[0].primary_values[0].attribute_id #=> String
|
|
14599
|
+
# resp.values[0].primary_values[0].value #=> String
|
|
14600
|
+
# resp.values[0].attribute_name #=> String
|
|
14601
|
+
# resp.values[0].value_type #=> String, one of "TEXT", "NUMBER", "BOOLEAN", "TEXT_LIST", "NUMBER_LIST"
|
|
14602
|
+
# resp.values[0].value #=> String
|
|
14603
|
+
# resp.values[0].lock_version.data_table #=> String
|
|
14604
|
+
# resp.values[0].lock_version.attribute #=> String
|
|
14605
|
+
# resp.values[0].lock_version.primary_values #=> String
|
|
14606
|
+
# resp.values[0].lock_version.value #=> String
|
|
14607
|
+
# resp.values[0].last_modified_time #=> Time
|
|
14608
|
+
# resp.values[0].last_modified_region #=> String
|
|
14609
|
+
#
|
|
14610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListDataTableValues AWS API Documentation
|
|
14611
|
+
#
|
|
14612
|
+
# @overload list_data_table_values(params = {})
|
|
14613
|
+
# @param [Hash] params ({})
|
|
14614
|
+
def list_data_table_values(params = {}, options = {})
|
|
14615
|
+
req = build_request(:list_data_table_values, params)
|
|
14616
|
+
req.send_request(options)
|
|
14617
|
+
end
|
|
14618
|
+
|
|
14619
|
+
# Lists all data tables for the specified Amazon Connect instance.
|
|
14620
|
+
# Returns summary information for each table including basic metadata
|
|
14621
|
+
# and modification details.
|
|
14622
|
+
#
|
|
14623
|
+
# @option params [required, String] :instance_id
|
|
14624
|
+
# The unique identifier for the Amazon Connect instance whose data
|
|
14625
|
+
# tables should be listed.
|
|
14626
|
+
#
|
|
14627
|
+
# @option params [String] :next_token
|
|
14628
|
+
# Specify the pagination token from a previous request to retrieve the
|
|
14629
|
+
# next page of results.
|
|
14630
|
+
#
|
|
14631
|
+
# @option params [Integer] :max_results
|
|
14632
|
+
# The maximum number of data tables to return in one page of results.
|
|
14633
|
+
#
|
|
14634
|
+
# @return [Types::ListDataTablesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14635
|
+
#
|
|
14636
|
+
# * {Types::ListDataTablesResponse#next_token #next_token} => String
|
|
14637
|
+
# * {Types::ListDataTablesResponse#data_table_summary_list #data_table_summary_list} => Array<Types::DataTableSummary>
|
|
14638
|
+
#
|
|
14639
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
14640
|
+
#
|
|
14641
|
+
# @example Request syntax with placeholder values
|
|
14642
|
+
#
|
|
14643
|
+
# resp = client.list_data_tables({
|
|
14644
|
+
# instance_id: "InstanceId", # required
|
|
14645
|
+
# next_token: "NextToken",
|
|
14646
|
+
# max_results: 1,
|
|
14647
|
+
# })
|
|
14648
|
+
#
|
|
14649
|
+
# @example Response structure
|
|
14650
|
+
#
|
|
14651
|
+
# resp.next_token #=> String
|
|
14652
|
+
# resp.data_table_summary_list #=> Array
|
|
14653
|
+
# resp.data_table_summary_list[0].name #=> String
|
|
14654
|
+
# resp.data_table_summary_list[0].id #=> String
|
|
14655
|
+
# resp.data_table_summary_list[0].arn #=> String
|
|
14656
|
+
# resp.data_table_summary_list[0].last_modified_time #=> Time
|
|
14657
|
+
# resp.data_table_summary_list[0].last_modified_region #=> String
|
|
14658
|
+
#
|
|
14659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListDataTables AWS API Documentation
|
|
14660
|
+
#
|
|
14661
|
+
# @overload list_data_tables(params = {})
|
|
14662
|
+
# @param [Hash] params ({})
|
|
14663
|
+
def list_data_tables(params = {}, options = {})
|
|
14664
|
+
req = build_request(:list_data_tables, params)
|
|
14665
|
+
req.send_request(options)
|
|
14666
|
+
end
|
|
14667
|
+
|
|
12621
14668
|
# Lists the default vocabularies for the specified Amazon Connect
|
|
12622
14669
|
# instance.
|
|
12623
14670
|
#
|
|
@@ -12680,6 +14727,58 @@ module Aws::Connect
|
|
|
12680
14727
|
req.send_request(options)
|
|
12681
14728
|
end
|
|
12682
14729
|
|
|
14730
|
+
# Lists all security profiles attached to a Q in Connect AIAgent Entity
|
|
14731
|
+
# in an Amazon Connect instance.
|
|
14732
|
+
#
|
|
14733
|
+
# @option params [required, String] :instance_id
|
|
14734
|
+
# The identifier of the Amazon Connect instance. You can find the
|
|
14735
|
+
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
14736
|
+
#
|
|
14737
|
+
# @option params [required, String] :entity_type
|
|
14738
|
+
# Only supported type is AI\_AGENT.
|
|
14739
|
+
#
|
|
14740
|
+
# @option params [required, String] :entity_arn
|
|
14741
|
+
# ARN of a Q in Connect AI Agent.
|
|
14742
|
+
#
|
|
14743
|
+
# @option params [String] :next_token
|
|
14744
|
+
# The token for the next set of results. Use the value returned in the
|
|
14745
|
+
# previous response in the next request to retrieve the next set of
|
|
14746
|
+
# results.
|
|
14747
|
+
#
|
|
14748
|
+
# @option params [Integer] :max_results
|
|
14749
|
+
# The maximum number of results to return per page. The default
|
|
14750
|
+
# MaxResult size is 100.
|
|
14751
|
+
#
|
|
14752
|
+
# @return [Types::ListEntitySecurityProfilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
14753
|
+
#
|
|
14754
|
+
# * {Types::ListEntitySecurityProfilesResponse#security_profiles #security_profiles} => Array<Types::SecurityProfileItem>
|
|
14755
|
+
# * {Types::ListEntitySecurityProfilesResponse#next_token #next_token} => String
|
|
14756
|
+
#
|
|
14757
|
+
# @example Request syntax with placeholder values
|
|
14758
|
+
#
|
|
14759
|
+
# resp = client.list_entity_security_profiles({
|
|
14760
|
+
# instance_id: "InstanceId", # required
|
|
14761
|
+
# entity_type: "USER", # required, accepts USER, AI_AGENT
|
|
14762
|
+
# entity_arn: "EntityArn", # required
|
|
14763
|
+
# next_token: "NextToken2500",
|
|
14764
|
+
# max_results: 1,
|
|
14765
|
+
# })
|
|
14766
|
+
#
|
|
14767
|
+
# @example Response structure
|
|
14768
|
+
#
|
|
14769
|
+
# resp.security_profiles #=> Array
|
|
14770
|
+
# resp.security_profiles[0].id #=> String
|
|
14771
|
+
# resp.next_token #=> String
|
|
14772
|
+
#
|
|
14773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListEntitySecurityProfiles AWS API Documentation
|
|
14774
|
+
#
|
|
14775
|
+
# @overload list_entity_security_profiles(params = {})
|
|
14776
|
+
# @param [Hash] params ({})
|
|
14777
|
+
def list_entity_security_profiles(params = {}, options = {})
|
|
14778
|
+
req = build_request(:list_entity_security_profiles, params)
|
|
14779
|
+
req.send_request(options)
|
|
14780
|
+
end
|
|
14781
|
+
|
|
12683
14782
|
# Lists versions of an evaluation form in the specified Amazon Connect
|
|
12684
14783
|
# instance.
|
|
12685
14784
|
#
|
|
@@ -13017,7 +15116,7 @@ module Aws::Connect
|
|
|
13017
15116
|
# @example Response structure
|
|
13018
15117
|
#
|
|
13019
15118
|
# resp.attributes #=> Array
|
|
13020
|
-
# resp.attributes[0].attribute_type #=> String, one of "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"
|
|
15119
|
+
# resp.attributes[0].attribute_type #=> String, one of "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"
|
|
13021
15120
|
# resp.attributes[0].value #=> String
|
|
13022
15121
|
# resp.next_token #=> String
|
|
13023
15122
|
#
|
|
@@ -13187,7 +15286,7 @@ module Aws::Connect
|
|
|
13187
15286
|
#
|
|
13188
15287
|
# resp = client.list_integration_associations({
|
|
13189
15288
|
# instance_id: "InstanceId", # required
|
|
13190
|
-
# integration_type: "EVENT", # accepts 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
|
|
15289
|
+
# integration_type: "EVENT", # accepts 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
|
|
13191
15290
|
# next_token: "NextToken",
|
|
13192
15291
|
# max_results: 1,
|
|
13193
15292
|
# integration_arn: "ARN",
|
|
@@ -13199,7 +15298,7 @@ module Aws::Connect
|
|
|
13199
15298
|
# resp.integration_association_summary_list[0].integration_association_id #=> String
|
|
13200
15299
|
# resp.integration_association_summary_list[0].integration_association_arn #=> String
|
|
13201
15300
|
# resp.integration_association_summary_list[0].instance_id #=> String
|
|
13202
|
-
# resp.integration_association_summary_list[0].integration_type #=> String, one of "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"
|
|
15301
|
+
# resp.integration_association_summary_list[0].integration_type #=> String, one of "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"
|
|
13203
15302
|
# resp.integration_association_summary_list[0].integration_arn #=> String
|
|
13204
15303
|
# resp.integration_association_summary_list[0].source_application_url #=> String
|
|
13205
15304
|
# resp.integration_association_summary_list[0].source_application_name #=> String
|
|
@@ -13688,7 +15787,7 @@ module Aws::Connect
|
|
|
13688
15787
|
# resp.quick_connect_summary_list[0].id #=> String
|
|
13689
15788
|
# resp.quick_connect_summary_list[0].arn #=> String
|
|
13690
15789
|
# resp.quick_connect_summary_list[0].name #=> String
|
|
13691
|
-
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
|
15790
|
+
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
|
|
13692
15791
|
# resp.quick_connect_summary_list[0].last_modified_time #=> Time
|
|
13693
15792
|
# resp.quick_connect_summary_list[0].last_modified_region #=> String
|
|
13694
15793
|
# resp.last_modified_time #=> Time
|
|
@@ -13814,7 +15913,7 @@ module Aws::Connect
|
|
|
13814
15913
|
# instance_id: "InstanceId", # required
|
|
13815
15914
|
# next_token: "NextToken",
|
|
13816
15915
|
# max_results: 1,
|
|
13817
|
-
# quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER
|
|
15916
|
+
# quick_connect_types: ["USER"], # accepts USER, QUEUE, PHONE_NUMBER, FLOW
|
|
13818
15917
|
# })
|
|
13819
15918
|
#
|
|
13820
15919
|
# @example Response structure
|
|
@@ -13823,7 +15922,7 @@ module Aws::Connect
|
|
|
13823
15922
|
# resp.quick_connect_summary_list[0].id #=> String
|
|
13824
15923
|
# resp.quick_connect_summary_list[0].arn #=> String
|
|
13825
15924
|
# resp.quick_connect_summary_list[0].name #=> String
|
|
13826
|
-
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
|
15925
|
+
# resp.quick_connect_summary_list[0].quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
|
|
13827
15926
|
# resp.quick_connect_summary_list[0].last_modified_time #=> Time
|
|
13828
15927
|
# resp.quick_connect_summary_list[0].last_modified_region #=> String
|
|
13829
15928
|
# resp.next_token #=> String
|
|
@@ -14280,8 +16379,8 @@ module Aws::Connect
|
|
|
14280
16379
|
req.send_request(options)
|
|
14281
16380
|
end
|
|
14282
16381
|
|
|
14283
|
-
# Returns a list of third-party applications in a
|
|
14284
|
-
# profile.
|
|
16382
|
+
# Returns a list of third-party applications or MCP Servers in a
|
|
16383
|
+
# specific security profile.
|
|
14285
16384
|
#
|
|
14286
16385
|
# @option params [required, String] :security_profile_id
|
|
14287
16386
|
# The identifier for the security profle.
|
|
@@ -14326,6 +16425,7 @@ module Aws::Connect
|
|
|
14326
16425
|
# resp.applications[0].namespace #=> String
|
|
14327
16426
|
# resp.applications[0].application_permissions #=> Array
|
|
14328
16427
|
# resp.applications[0].application_permissions[0] #=> String
|
|
16428
|
+
# resp.applications[0].type #=> String, one of "MCP", "THIRD_PARTY_APPLICATION"
|
|
14329
16429
|
# resp.next_token #=> String
|
|
14330
16430
|
# resp.last_modified_time #=> Time
|
|
14331
16431
|
# resp.last_modified_region #=> String
|
|
@@ -14339,6 +16439,62 @@ module Aws::Connect
|
|
|
14339
16439
|
req.send_request(options)
|
|
14340
16440
|
end
|
|
14341
16441
|
|
|
16442
|
+
# A list of Flow Modules an AI Agent can invoke as a tool
|
|
16443
|
+
#
|
|
16444
|
+
# @option params [required, String] :security_profile_id
|
|
16445
|
+
# The identifier for the security profile.
|
|
16446
|
+
#
|
|
16447
|
+
# @option params [required, String] :instance_id
|
|
16448
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
16449
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
16450
|
+
#
|
|
16451
|
+
#
|
|
16452
|
+
#
|
|
16453
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
16454
|
+
#
|
|
16455
|
+
# @option params [String] :next_token
|
|
16456
|
+
# The token for the next set of results. Use the value returned in the
|
|
16457
|
+
# previous response in the next request to retrieve the next set of
|
|
16458
|
+
# results.
|
|
16459
|
+
#
|
|
16460
|
+
# @option params [Integer] :max_results
|
|
16461
|
+
# The maximum number of results to return per page. The default
|
|
16462
|
+
# MaxResult size is 100.
|
|
16463
|
+
#
|
|
16464
|
+
# @return [Types::ListSecurityProfileFlowModulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
16465
|
+
#
|
|
16466
|
+
# * {Types::ListSecurityProfileFlowModulesResponse#allowed_flow_modules #allowed_flow_modules} => Array<Types::FlowModule>
|
|
16467
|
+
# * {Types::ListSecurityProfileFlowModulesResponse#next_token #next_token} => String
|
|
16468
|
+
# * {Types::ListSecurityProfileFlowModulesResponse#last_modified_time #last_modified_time} => Time
|
|
16469
|
+
# * {Types::ListSecurityProfileFlowModulesResponse#last_modified_region #last_modified_region} => String
|
|
16470
|
+
#
|
|
16471
|
+
# @example Request syntax with placeholder values
|
|
16472
|
+
#
|
|
16473
|
+
# resp = client.list_security_profile_flow_modules({
|
|
16474
|
+
# security_profile_id: "SecurityProfileId", # required
|
|
16475
|
+
# instance_id: "InstanceId", # required
|
|
16476
|
+
# next_token: "NextToken",
|
|
16477
|
+
# max_results: 1,
|
|
16478
|
+
# })
|
|
16479
|
+
#
|
|
16480
|
+
# @example Response structure
|
|
16481
|
+
#
|
|
16482
|
+
# resp.allowed_flow_modules #=> Array
|
|
16483
|
+
# resp.allowed_flow_modules[0].type #=> String, one of "MCP"
|
|
16484
|
+
# resp.allowed_flow_modules[0].flow_module_id #=> String
|
|
16485
|
+
# resp.next_token #=> String
|
|
16486
|
+
# resp.last_modified_time #=> Time
|
|
16487
|
+
# resp.last_modified_region #=> String
|
|
16488
|
+
#
|
|
16489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListSecurityProfileFlowModules AWS API Documentation
|
|
16490
|
+
#
|
|
16491
|
+
# @overload list_security_profile_flow_modules(params = {})
|
|
16492
|
+
# @param [Hash] params ({})
|
|
16493
|
+
def list_security_profile_flow_modules(params = {}, options = {})
|
|
16494
|
+
req = build_request(:list_security_profile_flow_modules, params)
|
|
16495
|
+
req.send_request(options)
|
|
16496
|
+
end
|
|
16497
|
+
|
|
14342
16498
|
# Lists the permissions granted to a security profile.
|
|
14343
16499
|
#
|
|
14344
16500
|
# For information about security profiles, see [Security Profiles][1] in
|
|
@@ -15018,49 +17174,196 @@ module Aws::Connect
|
|
|
15018
17174
|
req.send_request(options)
|
|
15019
17175
|
end
|
|
15020
17176
|
|
|
15021
|
-
#
|
|
15022
|
-
# (CCP) of the user specified by *userId* will be set to silent
|
|
15023
|
-
# monitoring mode on the contact.
|
|
17177
|
+
# Lists media assets (such as logos) associated with a workspace.
|
|
15024
17178
|
#
|
|
15025
17179
|
# @option params [required, String] :instance_id
|
|
15026
|
-
# The identifier of the Amazon Connect instance. You can find the
|
|
15027
|
-
#
|
|
17180
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
17181
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
15028
17182
|
#
|
|
15029
|
-
# @option params [required, String] :contact_id
|
|
15030
|
-
# The identifier of the contact.
|
|
15031
17183
|
#
|
|
15032
|
-
# @option params [required, String] :user_id
|
|
15033
|
-
# The identifier of the user account.
|
|
15034
17184
|
#
|
|
15035
|
-
#
|
|
15036
|
-
# Specify which monitoring actions the user is allowed to take. For
|
|
15037
|
-
# example, whether the user is allowed to escalate from silent
|
|
15038
|
-
# monitoring to barge. AllowedMonitorCapabilities is required if barge
|
|
15039
|
-
# is enabled.
|
|
17185
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
15040
17186
|
#
|
|
15041
|
-
# @option params [String] :
|
|
15042
|
-
#
|
|
15043
|
-
# idempotency of the request. If not provided, the Amazon Web Services
|
|
15044
|
-
# SDK populates this field. For more information about idempotency, see
|
|
15045
|
-
# [Making retries safe with idempotent APIs][1].
|
|
17187
|
+
# @option params [required, String] :workspace_id
|
|
17188
|
+
# The identifier of the workspace.
|
|
15046
17189
|
#
|
|
15047
|
-
#
|
|
15048
|
-
# not need to pass this option.**
|
|
17190
|
+
# @return [Types::ListWorkspaceMediaResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
15049
17191
|
#
|
|
17192
|
+
# * {Types::ListWorkspaceMediaResponse#media #media} => Array<Types::MediaItem>
|
|
15050
17193
|
#
|
|
17194
|
+
# @example Request syntax with placeholder values
|
|
15051
17195
|
#
|
|
15052
|
-
#
|
|
17196
|
+
# resp = client.list_workspace_media({
|
|
17197
|
+
# instance_id: "InstanceId", # required
|
|
17198
|
+
# workspace_id: "WorkspaceId", # required
|
|
17199
|
+
# })
|
|
15053
17200
|
#
|
|
15054
|
-
# @
|
|
17201
|
+
# @example Response structure
|
|
15055
17202
|
#
|
|
15056
|
-
#
|
|
15057
|
-
#
|
|
17203
|
+
# resp.media #=> Array
|
|
17204
|
+
# resp.media[0].type #=> String, one of "IMAGE_LOGO_LIGHT_FAVICON", "IMAGE_LOGO_DARK_FAVICON", "IMAGE_LOGO_LIGHT_HORIZONTAL", "IMAGE_LOGO_DARK_HORIZONTAL"
|
|
17205
|
+
# resp.media[0].source #=> String
|
|
15058
17206
|
#
|
|
15059
|
-
# @
|
|
17207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListWorkspaceMedia AWS API Documentation
|
|
15060
17208
|
#
|
|
15061
|
-
#
|
|
15062
|
-
#
|
|
15063
|
-
|
|
17209
|
+
# @overload list_workspace_media(params = {})
|
|
17210
|
+
# @param [Hash] params ({})
|
|
17211
|
+
def list_workspace_media(params = {}, options = {})
|
|
17212
|
+
req = build_request(:list_workspace_media, params)
|
|
17213
|
+
req.send_request(options)
|
|
17214
|
+
end
|
|
17215
|
+
|
|
17216
|
+
# Lists the page configurations in a workspace, including the views
|
|
17217
|
+
# assigned to each page.
|
|
17218
|
+
#
|
|
17219
|
+
# @option params [required, String] :instance_id
|
|
17220
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
17221
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
17222
|
+
#
|
|
17223
|
+
#
|
|
17224
|
+
#
|
|
17225
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
17226
|
+
#
|
|
17227
|
+
# @option params [required, String] :workspace_id
|
|
17228
|
+
# The identifier of the workspace.
|
|
17229
|
+
#
|
|
17230
|
+
# @option params [String] :next_token
|
|
17231
|
+
# The token for the next set of results. Use the value returned in the
|
|
17232
|
+
# previous response in the next request to retrieve the next set of
|
|
17233
|
+
# results.
|
|
17234
|
+
#
|
|
17235
|
+
# @option params [Integer] :max_results
|
|
17236
|
+
# The maximum number of results to return per page.
|
|
17237
|
+
#
|
|
17238
|
+
# @return [Types::ListWorkspacePagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17239
|
+
#
|
|
17240
|
+
# * {Types::ListWorkspacePagesResponse#next_token #next_token} => String
|
|
17241
|
+
# * {Types::ListWorkspacePagesResponse#workspace_page_list #workspace_page_list} => Array<Types::WorkspacePage>
|
|
17242
|
+
#
|
|
17243
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
17244
|
+
#
|
|
17245
|
+
# @example Request syntax with placeholder values
|
|
17246
|
+
#
|
|
17247
|
+
# resp = client.list_workspace_pages({
|
|
17248
|
+
# instance_id: "InstanceId", # required
|
|
17249
|
+
# workspace_id: "WorkspaceId", # required
|
|
17250
|
+
# next_token: "NextToken",
|
|
17251
|
+
# max_results: 1,
|
|
17252
|
+
# })
|
|
17253
|
+
#
|
|
17254
|
+
# @example Response structure
|
|
17255
|
+
#
|
|
17256
|
+
# resp.next_token #=> String
|
|
17257
|
+
# resp.workspace_page_list #=> Array
|
|
17258
|
+
# resp.workspace_page_list[0].resource_arn #=> String
|
|
17259
|
+
# resp.workspace_page_list[0].page #=> String
|
|
17260
|
+
# resp.workspace_page_list[0].slug #=> String
|
|
17261
|
+
# resp.workspace_page_list[0].input_data #=> String
|
|
17262
|
+
#
|
|
17263
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListWorkspacePages AWS API Documentation
|
|
17264
|
+
#
|
|
17265
|
+
# @overload list_workspace_pages(params = {})
|
|
17266
|
+
# @param [Hash] params ({})
|
|
17267
|
+
def list_workspace_pages(params = {}, options = {})
|
|
17268
|
+
req = build_request(:list_workspace_pages, params)
|
|
17269
|
+
req.send_request(options)
|
|
17270
|
+
end
|
|
17271
|
+
|
|
17272
|
+
# Lists the workspaces in an Amazon Connect instance.
|
|
17273
|
+
#
|
|
17274
|
+
# @option params [required, String] :instance_id
|
|
17275
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
17276
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
17277
|
+
#
|
|
17278
|
+
#
|
|
17279
|
+
#
|
|
17280
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
17281
|
+
#
|
|
17282
|
+
# @option params [String] :next_token
|
|
17283
|
+
# The token for the next set of results. Use the value returned in the
|
|
17284
|
+
# previous response in the next request to retrieve the next set of
|
|
17285
|
+
# results.
|
|
17286
|
+
#
|
|
17287
|
+
# @option params [Integer] :max_results
|
|
17288
|
+
# The maximum number of results to return per page.
|
|
17289
|
+
#
|
|
17290
|
+
# @return [Types::ListWorkspacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17291
|
+
#
|
|
17292
|
+
# * {Types::ListWorkspacesResponse#next_token #next_token} => String
|
|
17293
|
+
# * {Types::ListWorkspacesResponse#workspace_summary_list #workspace_summary_list} => Array<Types::WorkspaceSummary>
|
|
17294
|
+
#
|
|
17295
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
17296
|
+
#
|
|
17297
|
+
# @example Request syntax with placeholder values
|
|
17298
|
+
#
|
|
17299
|
+
# resp = client.list_workspaces({
|
|
17300
|
+
# instance_id: "InstanceId", # required
|
|
17301
|
+
# next_token: "NextToken",
|
|
17302
|
+
# max_results: 1,
|
|
17303
|
+
# })
|
|
17304
|
+
#
|
|
17305
|
+
# @example Response structure
|
|
17306
|
+
#
|
|
17307
|
+
# resp.next_token #=> String
|
|
17308
|
+
# resp.workspace_summary_list #=> Array
|
|
17309
|
+
# resp.workspace_summary_list[0].id #=> String
|
|
17310
|
+
# resp.workspace_summary_list[0].name #=> String
|
|
17311
|
+
# resp.workspace_summary_list[0].arn #=> String
|
|
17312
|
+
# resp.workspace_summary_list[0].last_modified_time #=> Time
|
|
17313
|
+
# resp.workspace_summary_list[0].last_modified_region #=> String
|
|
17314
|
+
#
|
|
17315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListWorkspaces AWS API Documentation
|
|
17316
|
+
#
|
|
17317
|
+
# @overload list_workspaces(params = {})
|
|
17318
|
+
# @param [Hash] params ({})
|
|
17319
|
+
def list_workspaces(params = {}, options = {})
|
|
17320
|
+
req = build_request(:list_workspaces, params)
|
|
17321
|
+
req.send_request(options)
|
|
17322
|
+
end
|
|
17323
|
+
|
|
17324
|
+
# Initiates silent monitoring of a contact. The Contact Control Panel
|
|
17325
|
+
# (CCP) of the user specified by *userId* will be set to silent
|
|
17326
|
+
# monitoring mode on the contact.
|
|
17327
|
+
#
|
|
17328
|
+
# @option params [required, String] :instance_id
|
|
17329
|
+
# The identifier of the Amazon Connect instance. You can find the
|
|
17330
|
+
# instanceId in the ARN of the instance.
|
|
17331
|
+
#
|
|
17332
|
+
# @option params [required, String] :contact_id
|
|
17333
|
+
# The identifier of the contact.
|
|
17334
|
+
#
|
|
17335
|
+
# @option params [required, String] :user_id
|
|
17336
|
+
# The identifier of the user account.
|
|
17337
|
+
#
|
|
17338
|
+
# @option params [Array<String>] :allowed_monitor_capabilities
|
|
17339
|
+
# Specify which monitoring actions the user is allowed to take. For
|
|
17340
|
+
# example, whether the user is allowed to escalate from silent
|
|
17341
|
+
# monitoring to barge. AllowedMonitorCapabilities is required if barge
|
|
17342
|
+
# is enabled.
|
|
17343
|
+
#
|
|
17344
|
+
# @option params [String] :client_token
|
|
17345
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
17346
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
17347
|
+
# SDK populates this field. For more information about idempotency, see
|
|
17348
|
+
# [Making retries safe with idempotent APIs][1].
|
|
17349
|
+
#
|
|
17350
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
17351
|
+
# not need to pass this option.**
|
|
17352
|
+
#
|
|
17353
|
+
#
|
|
17354
|
+
#
|
|
17355
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
17356
|
+
#
|
|
17357
|
+
# @return [Types::MonitorContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17358
|
+
#
|
|
17359
|
+
# * {Types::MonitorContactResponse#contact_id #contact_id} => String
|
|
17360
|
+
# * {Types::MonitorContactResponse#contact_arn #contact_arn} => String
|
|
17361
|
+
#
|
|
17362
|
+
# @example Request syntax with placeholder values
|
|
17363
|
+
#
|
|
17364
|
+
# resp = client.monitor_contact({
|
|
17365
|
+
# instance_id: "InstanceId", # required
|
|
17366
|
+
# contact_id: "ContactId", # required
|
|
15064
17367
|
# user_id: "AgentResourceId", # required
|
|
15065
17368
|
# allowed_monitor_capabilities: ["SILENT_MONITOR"], # accepts SILENT_MONITOR, BARGE
|
|
15066
17369
|
# client_token: "ClientToken",
|
|
@@ -15686,6 +17989,7 @@ module Aws::Connect
|
|
|
15686
17989
|
# resp.evaluation_search_summary_list[0].evaluation_arn #=> String
|
|
15687
17990
|
# resp.evaluation_search_summary_list[0].evaluation_form_id #=> String
|
|
15688
17991
|
# resp.evaluation_search_summary_list[0].evaluation_form_version #=> Integer
|
|
17992
|
+
# resp.evaluation_search_summary_list[0].evaluation_form_title #=> String
|
|
15689
17993
|
# resp.evaluation_search_summary_list[0].metadata.contact_id #=> String
|
|
15690
17994
|
# resp.evaluation_search_summary_list[0].metadata.evaluator_arn #=> String
|
|
15691
17995
|
# resp.evaluation_search_summary_list[0].metadata.contact_agent_id #=> String
|
|
@@ -15698,6 +18002,10 @@ module Aws::Connect
|
|
|
15698
18002
|
# resp.evaluation_search_summary_list[0].metadata.acknowledged_time #=> Time
|
|
15699
18003
|
# resp.evaluation_search_summary_list[0].metadata.acknowledged_by #=> String
|
|
15700
18004
|
# resp.evaluation_search_summary_list[0].metadata.acknowledger_comment #=> String
|
|
18005
|
+
# resp.evaluation_search_summary_list[0].metadata.sampling_job_id #=> String
|
|
18006
|
+
# resp.evaluation_search_summary_list[0].metadata.review_id #=> String
|
|
18007
|
+
# resp.evaluation_search_summary_list[0].metadata.contact_participant_role #=> String, one of "AGENT", "SYSTEM", "CUSTOM_BOT"
|
|
18008
|
+
# resp.evaluation_search_summary_list[0].metadata.contact_participant_id #=> String
|
|
15701
18009
|
# resp.evaluation_search_summary_list[0].status #=> String, one of "DRAFT", "SUBMITTED"
|
|
15702
18010
|
# resp.evaluation_search_summary_list[0].evaluation_type #=> String, one of "STANDARD", "CALIBRATION"
|
|
15703
18011
|
# resp.evaluation_search_summary_list[0].created_time #=> Time
|
|
@@ -15893,6 +18201,39 @@ module Aws::Connect
|
|
|
15893
18201
|
# tag_value: "String",
|
|
15894
18202
|
# },
|
|
15895
18203
|
# },
|
|
18204
|
+
# flow_attribute_filter: {
|
|
18205
|
+
# or_conditions: [
|
|
18206
|
+
# {
|
|
18207
|
+
# tag_conditions: [
|
|
18208
|
+
# {
|
|
18209
|
+
# tag_key: "String",
|
|
18210
|
+
# tag_value: "String",
|
|
18211
|
+
# },
|
|
18212
|
+
# ],
|
|
18213
|
+
# contact_flow_type_condition: {
|
|
18214
|
+
# contact_flow_type: "CONTACT_FLOW", # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
|
|
18215
|
+
# },
|
|
18216
|
+
# },
|
|
18217
|
+
# ],
|
|
18218
|
+
# and_condition: {
|
|
18219
|
+
# tag_conditions: [
|
|
18220
|
+
# {
|
|
18221
|
+
# tag_key: "String",
|
|
18222
|
+
# tag_value: "String",
|
|
18223
|
+
# },
|
|
18224
|
+
# ],
|
|
18225
|
+
# contact_flow_type_condition: {
|
|
18226
|
+
# contact_flow_type: "CONTACT_FLOW", # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
|
|
18227
|
+
# },
|
|
18228
|
+
# },
|
|
18229
|
+
# tag_condition: {
|
|
18230
|
+
# tag_key: "String",
|
|
18231
|
+
# tag_value: "String",
|
|
18232
|
+
# },
|
|
18233
|
+
# contact_flow_type_condition: {
|
|
18234
|
+
# contact_flow_type: "CONTACT_FLOW", # accepts CONTACT_FLOW, CUSTOMER_QUEUE, CUSTOMER_HOLD, CUSTOMER_WHISPER, AGENT_HOLD, AGENT_WHISPER, OUTBOUND_WHISPER, AGENT_TRANSFER, QUEUE_TRANSFER, CAMPAIGN
|
|
18235
|
+
# },
|
|
18236
|
+
# },
|
|
15896
18237
|
# },
|
|
15897
18238
|
# search_criteria: {
|
|
15898
18239
|
# or_conditions: [
|
|
@@ -16131,6 +18472,123 @@ module Aws::Connect
|
|
|
16131
18472
|
req.send_request(options)
|
|
16132
18473
|
end
|
|
16133
18474
|
|
|
18475
|
+
# Searches for data tables based on the table's ID, name, and
|
|
18476
|
+
# description. In the future, this operation can support searching on
|
|
18477
|
+
# attribute names and possibly primary values. Follows other search
|
|
18478
|
+
# operations closely and supports both search criteria and filters.
|
|
18479
|
+
#
|
|
18480
|
+
# @option params [required, String] :instance_id
|
|
18481
|
+
# The unique identifier for the Amazon Connect instance to search
|
|
18482
|
+
# within.
|
|
18483
|
+
#
|
|
18484
|
+
# @option params [String] :next_token
|
|
18485
|
+
# Specify the pagination token from a previous request to retrieve the
|
|
18486
|
+
# next page of results.
|
|
18487
|
+
#
|
|
18488
|
+
# @option params [Integer] :max_results
|
|
18489
|
+
# The maximum number of data tables to return in one page of results.
|
|
18490
|
+
#
|
|
18491
|
+
# @option params [Types::DataTableSearchFilter] :search_filter
|
|
18492
|
+
# Optional filters to apply to the search results, such as tag-based
|
|
18493
|
+
# filtering for attribute-based access control.
|
|
18494
|
+
#
|
|
18495
|
+
# @option params [Types::DataTableSearchCriteria] :search_criteria
|
|
18496
|
+
# Search criteria including string conditions for matching table names,
|
|
18497
|
+
# descriptions, or resource IDs. Supports STARTS\_WITH, CONTAINS, and
|
|
18498
|
+
# EXACT comparison types.
|
|
18499
|
+
#
|
|
18500
|
+
# @return [Types::SearchDataTablesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
18501
|
+
#
|
|
18502
|
+
# * {Types::SearchDataTablesResponse#data_tables #data_tables} => Array<Types::DataTable>
|
|
18503
|
+
# * {Types::SearchDataTablesResponse#next_token #next_token} => String
|
|
18504
|
+
# * {Types::SearchDataTablesResponse#approximate_total_count #approximate_total_count} => Integer
|
|
18505
|
+
#
|
|
18506
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
18507
|
+
#
|
|
18508
|
+
# @example Request syntax with placeholder values
|
|
18509
|
+
#
|
|
18510
|
+
# resp = client.search_data_tables({
|
|
18511
|
+
# instance_id: "InstanceId", # required
|
|
18512
|
+
# next_token: "NextToken",
|
|
18513
|
+
# max_results: 1,
|
|
18514
|
+
# search_filter: {
|
|
18515
|
+
# attribute_filter: {
|
|
18516
|
+
# or_conditions: [
|
|
18517
|
+
# {
|
|
18518
|
+
# tag_conditions: [
|
|
18519
|
+
# {
|
|
18520
|
+
# tag_key: "String",
|
|
18521
|
+
# tag_value: "String",
|
|
18522
|
+
# },
|
|
18523
|
+
# ],
|
|
18524
|
+
# },
|
|
18525
|
+
# ],
|
|
18526
|
+
# and_condition: {
|
|
18527
|
+
# tag_conditions: [
|
|
18528
|
+
# {
|
|
18529
|
+
# tag_key: "String",
|
|
18530
|
+
# tag_value: "String",
|
|
18531
|
+
# },
|
|
18532
|
+
# ],
|
|
18533
|
+
# },
|
|
18534
|
+
# tag_condition: {
|
|
18535
|
+
# tag_key: "String",
|
|
18536
|
+
# tag_value: "String",
|
|
18537
|
+
# },
|
|
18538
|
+
# },
|
|
18539
|
+
# },
|
|
18540
|
+
# search_criteria: {
|
|
18541
|
+
# or_conditions: [
|
|
18542
|
+
# {
|
|
18543
|
+
# # recursive DataTableSearchCriteria
|
|
18544
|
+
# },
|
|
18545
|
+
# ],
|
|
18546
|
+
# and_conditions: [
|
|
18547
|
+
# {
|
|
18548
|
+
# # recursive DataTableSearchCriteria
|
|
18549
|
+
# },
|
|
18550
|
+
# ],
|
|
18551
|
+
# string_condition: {
|
|
18552
|
+
# field_name: "String",
|
|
18553
|
+
# value: "String",
|
|
18554
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
|
18555
|
+
# },
|
|
18556
|
+
# },
|
|
18557
|
+
# })
|
|
18558
|
+
#
|
|
18559
|
+
# @example Response structure
|
|
18560
|
+
#
|
|
18561
|
+
# resp.data_tables #=> Array
|
|
18562
|
+
# resp.data_tables[0].name #=> String
|
|
18563
|
+
# resp.data_tables[0].id #=> String
|
|
18564
|
+
# resp.data_tables[0].arn #=> String
|
|
18565
|
+
# resp.data_tables[0].time_zone #=> String
|
|
18566
|
+
# resp.data_tables[0].description #=> String
|
|
18567
|
+
# resp.data_tables[0].value_lock_level #=> String, one of "NONE", "DATA_TABLE", "PRIMARY_VALUE", "ATTRIBUTE", "VALUE"
|
|
18568
|
+
# resp.data_tables[0].lock_version.data_table #=> String
|
|
18569
|
+
# resp.data_tables[0].lock_version.attribute #=> String
|
|
18570
|
+
# resp.data_tables[0].lock_version.primary_values #=> String
|
|
18571
|
+
# resp.data_tables[0].lock_version.value #=> String
|
|
18572
|
+
# resp.data_tables[0].version #=> String
|
|
18573
|
+
# resp.data_tables[0].version_description #=> String
|
|
18574
|
+
# resp.data_tables[0].status #=> String, one of "PUBLISHED"
|
|
18575
|
+
# resp.data_tables[0].created_time #=> Time
|
|
18576
|
+
# resp.data_tables[0].last_modified_time #=> Time
|
|
18577
|
+
# resp.data_tables[0].last_modified_region #=> String
|
|
18578
|
+
# resp.data_tables[0].tags #=> Hash
|
|
18579
|
+
# resp.data_tables[0].tags["TagKey"] #=> String
|
|
18580
|
+
# resp.next_token #=> String
|
|
18581
|
+
# resp.approximate_total_count #=> Integer
|
|
18582
|
+
#
|
|
18583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchDataTables AWS API Documentation
|
|
18584
|
+
#
|
|
18585
|
+
# @overload search_data_tables(params = {})
|
|
18586
|
+
# @param [Hash] params ({})
|
|
18587
|
+
def search_data_tables(params = {}, options = {})
|
|
18588
|
+
req = build_request(:search_data_tables, params)
|
|
18589
|
+
req.send_request(options)
|
|
18590
|
+
end
|
|
18591
|
+
|
|
16134
18592
|
# Searches email address in an instance, with optional filtering.
|
|
16135
18593
|
#
|
|
16136
18594
|
# @option params [required, String] :instance_id
|
|
@@ -16372,6 +18830,8 @@ module Aws::Connect
|
|
|
16372
18830
|
# resp.evaluation_form_search_summary_list[0].latest_version #=> Integer
|
|
16373
18831
|
# resp.evaluation_form_search_summary_list[0].active_version #=> Integer
|
|
16374
18832
|
# resp.evaluation_form_search_summary_list[0].auto_evaluation_enabled #=> Boolean
|
|
18833
|
+
# resp.evaluation_form_search_summary_list[0].evaluation_form_language #=> String, one of "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "pt-BR"
|
|
18834
|
+
# resp.evaluation_form_search_summary_list[0].contact_interaction_type #=> String, one of "AGENT", "AUTOMATED"
|
|
16375
18835
|
# resp.evaluation_form_search_summary_list[0].tags #=> Hash
|
|
16376
18836
|
# resp.evaluation_form_search_summary_list[0].tags["TagKey"] #=> String
|
|
16377
18837
|
# resp.next_token #=> String
|
|
@@ -17009,12 +19469,13 @@ module Aws::Connect
|
|
|
17009
19469
|
# resp.quick_connects[0].quick_connect_id #=> String
|
|
17010
19470
|
# resp.quick_connects[0].name #=> String
|
|
17011
19471
|
# resp.quick_connects[0].description #=> String
|
|
17012
|
-
# resp.quick_connects[0].quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER"
|
|
19472
|
+
# resp.quick_connects[0].quick_connect_config.quick_connect_type #=> String, one of "USER", "QUEUE", "PHONE_NUMBER", "FLOW"
|
|
17013
19473
|
# resp.quick_connects[0].quick_connect_config.user_config.user_id #=> String
|
|
17014
19474
|
# resp.quick_connects[0].quick_connect_config.user_config.contact_flow_id #=> String
|
|
17015
19475
|
# resp.quick_connects[0].quick_connect_config.queue_config.queue_id #=> String
|
|
17016
19476
|
# resp.quick_connects[0].quick_connect_config.queue_config.contact_flow_id #=> String
|
|
17017
19477
|
# resp.quick_connects[0].quick_connect_config.phone_config.phone_number #=> String
|
|
19478
|
+
# resp.quick_connects[0].quick_connect_config.flow_config.contact_flow_id #=> String
|
|
17018
19479
|
# resp.quick_connects[0].tags #=> Hash
|
|
17019
19480
|
# resp.quick_connects[0].tags["TagKey"] #=> String
|
|
17020
19481
|
# resp.quick_connects[0].last_modified_time #=> Time
|
|
@@ -17686,8 +20147,7 @@ module Aws::Connect
|
|
|
17686
20147
|
req.send_request(options)
|
|
17687
20148
|
end
|
|
17688
20149
|
|
|
17689
|
-
# Searches
|
|
17690
|
-
# using `State`, `NameStartsWith`, and `LanguageCode`.
|
|
20150
|
+
# Searches views based on name, description, or tags.
|
|
17691
20151
|
#
|
|
17692
20152
|
# @option params [required, String] :instance_id
|
|
17693
20153
|
# The identifier of the Amazon Connect instance. You can [find the
|
|
@@ -17697,52 +20157,170 @@ module Aws::Connect
|
|
|
17697
20157
|
#
|
|
17698
20158
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
17699
20159
|
#
|
|
17700
|
-
# @option params [Integer] :max_results
|
|
17701
|
-
# The maximum number of results to return per page.
|
|
17702
|
-
#
|
|
17703
20160
|
# @option params [String] :next_token
|
|
17704
20161
|
# The token for the next set of results. Use the value returned in the
|
|
17705
20162
|
# previous response in the next request to retrieve the next set of
|
|
17706
20163
|
# results.
|
|
17707
20164
|
#
|
|
17708
|
-
# @option params [
|
|
17709
|
-
# The
|
|
17710
|
-
#
|
|
17711
|
-
# @option params [String] :name_starts_with
|
|
17712
|
-
# The starting pattern of the name of the vocabulary.
|
|
17713
|
-
#
|
|
17714
|
-
# @option params [String] :language_code
|
|
17715
|
-
# The language code of the vocabulary entries. For a list of languages
|
|
17716
|
-
# and their corresponding language codes, see [What is Amazon
|
|
17717
|
-
# Transcribe?][1]
|
|
17718
|
-
#
|
|
20165
|
+
# @option params [Integer] :max_results
|
|
20166
|
+
# The maximum number of results to return per page.
|
|
17719
20167
|
#
|
|
20168
|
+
# @option params [Types::ViewSearchFilter] :search_filter
|
|
20169
|
+
# Filters to apply to the search, such as tag-based filters.
|
|
17720
20170
|
#
|
|
17721
|
-
#
|
|
20171
|
+
# @option params [Types::ViewSearchCriteria] :search_criteria
|
|
20172
|
+
# The search criteria, including field names and comparison types.
|
|
17722
20173
|
#
|
|
17723
|
-
# @return [Types::
|
|
20174
|
+
# @return [Types::SearchViewsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
17724
20175
|
#
|
|
17725
|
-
# * {Types::
|
|
17726
|
-
# * {Types::
|
|
20176
|
+
# * {Types::SearchViewsResponse#views #views} => Array<Types::View>
|
|
20177
|
+
# * {Types::SearchViewsResponse#next_token #next_token} => String
|
|
20178
|
+
# * {Types::SearchViewsResponse#approximate_total_count #approximate_total_count} => Integer
|
|
17727
20179
|
#
|
|
17728
20180
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
17729
20181
|
#
|
|
17730
20182
|
# @example Request syntax with placeholder values
|
|
17731
20183
|
#
|
|
17732
|
-
# resp = client.
|
|
17733
|
-
# instance_id: "
|
|
20184
|
+
# resp = client.search_views({
|
|
20185
|
+
# instance_id: "InstanceIdOrArn", # required
|
|
20186
|
+
# next_token: "NextToken2500",
|
|
17734
20187
|
# max_results: 1,
|
|
17735
|
-
#
|
|
17736
|
-
#
|
|
17737
|
-
#
|
|
17738
|
-
#
|
|
17739
|
-
#
|
|
17740
|
-
#
|
|
17741
|
-
#
|
|
17742
|
-
#
|
|
17743
|
-
#
|
|
17744
|
-
#
|
|
17745
|
-
#
|
|
20188
|
+
# search_filter: {
|
|
20189
|
+
# attribute_filter: {
|
|
20190
|
+
# or_conditions: [
|
|
20191
|
+
# {
|
|
20192
|
+
# tag_conditions: [
|
|
20193
|
+
# {
|
|
20194
|
+
# tag_key: "String",
|
|
20195
|
+
# tag_value: "String",
|
|
20196
|
+
# },
|
|
20197
|
+
# ],
|
|
20198
|
+
# },
|
|
20199
|
+
# ],
|
|
20200
|
+
# and_condition: {
|
|
20201
|
+
# tag_conditions: [
|
|
20202
|
+
# {
|
|
20203
|
+
# tag_key: "String",
|
|
20204
|
+
# tag_value: "String",
|
|
20205
|
+
# },
|
|
20206
|
+
# ],
|
|
20207
|
+
# },
|
|
20208
|
+
# tag_condition: {
|
|
20209
|
+
# tag_key: "String",
|
|
20210
|
+
# tag_value: "String",
|
|
20211
|
+
# },
|
|
20212
|
+
# },
|
|
20213
|
+
# },
|
|
20214
|
+
# search_criteria: {
|
|
20215
|
+
# or_conditions: [
|
|
20216
|
+
# {
|
|
20217
|
+
# # recursive ViewSearchCriteria
|
|
20218
|
+
# },
|
|
20219
|
+
# ],
|
|
20220
|
+
# and_conditions: [
|
|
20221
|
+
# {
|
|
20222
|
+
# # recursive ViewSearchCriteria
|
|
20223
|
+
# },
|
|
20224
|
+
# ],
|
|
20225
|
+
# string_condition: {
|
|
20226
|
+
# field_name: "String",
|
|
20227
|
+
# value: "String",
|
|
20228
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
|
20229
|
+
# },
|
|
20230
|
+
# view_type_condition: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, AWS_MANAGED
|
|
20231
|
+
# view_status_condition: "PUBLISHED", # accepts PUBLISHED, SAVED
|
|
20232
|
+
# },
|
|
20233
|
+
# })
|
|
20234
|
+
#
|
|
20235
|
+
# @example Response structure
|
|
20236
|
+
#
|
|
20237
|
+
# resp.views #=> Array
|
|
20238
|
+
# resp.views[0].id #=> String
|
|
20239
|
+
# resp.views[0].arn #=> String
|
|
20240
|
+
# resp.views[0].name #=> String
|
|
20241
|
+
# resp.views[0].status #=> String, one of "PUBLISHED", "SAVED"
|
|
20242
|
+
# resp.views[0].type #=> String, one of "CUSTOMER_MANAGED", "AWS_MANAGED"
|
|
20243
|
+
# resp.views[0].description #=> String
|
|
20244
|
+
# resp.views[0].version #=> Integer
|
|
20245
|
+
# resp.views[0].version_description #=> String
|
|
20246
|
+
# resp.views[0].content.input_schema #=> String
|
|
20247
|
+
# resp.views[0].content.template #=> String
|
|
20248
|
+
# resp.views[0].content.actions #=> Array
|
|
20249
|
+
# resp.views[0].content.actions[0] #=> String
|
|
20250
|
+
# resp.views[0].tags #=> Hash
|
|
20251
|
+
# resp.views[0].tags["TagKey"] #=> String
|
|
20252
|
+
# resp.views[0].created_time #=> Time
|
|
20253
|
+
# resp.views[0].last_modified_time #=> Time
|
|
20254
|
+
# resp.views[0].view_content_sha_256 #=> String
|
|
20255
|
+
# resp.next_token #=> String
|
|
20256
|
+
# resp.approximate_total_count #=> Integer
|
|
20257
|
+
#
|
|
20258
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchViews AWS API Documentation
|
|
20259
|
+
#
|
|
20260
|
+
# @overload search_views(params = {})
|
|
20261
|
+
# @param [Hash] params ({})
|
|
20262
|
+
def search_views(params = {}, options = {})
|
|
20263
|
+
req = build_request(:search_views, params)
|
|
20264
|
+
req.send_request(options)
|
|
20265
|
+
end
|
|
20266
|
+
|
|
20267
|
+
# Searches for vocabularies within a specific Amazon Connect instance
|
|
20268
|
+
# using `State`, `NameStartsWith`, and `LanguageCode`.
|
|
20269
|
+
#
|
|
20270
|
+
# @option params [required, String] :instance_id
|
|
20271
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
20272
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
20273
|
+
#
|
|
20274
|
+
#
|
|
20275
|
+
#
|
|
20276
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
20277
|
+
#
|
|
20278
|
+
# @option params [Integer] :max_results
|
|
20279
|
+
# The maximum number of results to return per page.
|
|
20280
|
+
#
|
|
20281
|
+
# @option params [String] :next_token
|
|
20282
|
+
# The token for the next set of results. Use the value returned in the
|
|
20283
|
+
# previous response in the next request to retrieve the next set of
|
|
20284
|
+
# results.
|
|
20285
|
+
#
|
|
20286
|
+
# @option params [String] :state
|
|
20287
|
+
# The current state of the custom vocabulary.
|
|
20288
|
+
#
|
|
20289
|
+
# @option params [String] :name_starts_with
|
|
20290
|
+
# The starting pattern of the name of the vocabulary.
|
|
20291
|
+
#
|
|
20292
|
+
# @option params [String] :language_code
|
|
20293
|
+
# The language code of the vocabulary entries. For a list of languages
|
|
20294
|
+
# and their corresponding language codes, see [What is Amazon
|
|
20295
|
+
# Transcribe?][1]
|
|
20296
|
+
#
|
|
20297
|
+
#
|
|
20298
|
+
#
|
|
20299
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html
|
|
20300
|
+
#
|
|
20301
|
+
# @return [Types::SearchVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
20302
|
+
#
|
|
20303
|
+
# * {Types::SearchVocabulariesResponse#vocabulary_summary_list #vocabulary_summary_list} => Array<Types::VocabularySummary>
|
|
20304
|
+
# * {Types::SearchVocabulariesResponse#next_token #next_token} => String
|
|
20305
|
+
#
|
|
20306
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
20307
|
+
#
|
|
20308
|
+
# @example Request syntax with placeholder values
|
|
20309
|
+
#
|
|
20310
|
+
# resp = client.search_vocabularies({
|
|
20311
|
+
# instance_id: "InstanceId", # required
|
|
20312
|
+
# max_results: 1,
|
|
20313
|
+
# next_token: "VocabularyNextToken",
|
|
20314
|
+
# state: "CREATION_IN_PROGRESS", # accepts CREATION_IN_PROGRESS, ACTIVE, CREATION_FAILED, DELETE_IN_PROGRESS
|
|
20315
|
+
# name_starts_with: "VocabularyName",
|
|
20316
|
+
# language_code: "ar-AE", # accepts ar-AE, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, ko-KR, pt-BR, pt-PT, zh-CN, en-NZ, en-ZA, ca-ES, da-DK, fi-FI, id-ID, ms-MY, nl-NL, no-NO, pl-PL, sv-SE, tl-PH
|
|
20317
|
+
# })
|
|
20318
|
+
#
|
|
20319
|
+
# @example Response structure
|
|
20320
|
+
#
|
|
20321
|
+
# resp.vocabulary_summary_list #=> Array
|
|
20322
|
+
# resp.vocabulary_summary_list[0].name #=> String
|
|
20323
|
+
# resp.vocabulary_summary_list[0].id #=> String
|
|
17746
20324
|
# resp.vocabulary_summary_list[0].arn #=> String
|
|
17747
20325
|
# resp.vocabulary_summary_list[0].language_code #=> String, one of "ar-AE", "de-CH", "de-DE", "en-AB", "en-AU", "en-GB", "en-IE", "en-IN", "en-US", "en-WL", "es-ES", "es-US", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "ko-KR", "pt-BR", "pt-PT", "zh-CN", "en-NZ", "en-ZA", "ca-ES", "da-DK", "fi-FI", "id-ID", "ms-MY", "nl-NL", "no-NO", "pl-PL", "sv-SE", "tl-PH"
|
|
17748
20326
|
# resp.vocabulary_summary_list[0].state #=> String, one of "CREATION_IN_PROGRESS", "ACTIVE", "CREATION_FAILED", "DELETE_IN_PROGRESS"
|
|
@@ -17759,6 +20337,219 @@ module Aws::Connect
|
|
|
17759
20337
|
req.send_request(options)
|
|
17760
20338
|
end
|
|
17761
20339
|
|
|
20340
|
+
# Searches for workspace associations with users or routing profiles
|
|
20341
|
+
# based on various criteria.
|
|
20342
|
+
#
|
|
20343
|
+
# @option params [required, String] :instance_id
|
|
20344
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
20345
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
20346
|
+
#
|
|
20347
|
+
#
|
|
20348
|
+
#
|
|
20349
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
20350
|
+
#
|
|
20351
|
+
# @option params [String] :next_token
|
|
20352
|
+
# The token for the next set of results. Use the value returned in the
|
|
20353
|
+
# previous response in the next request to retrieve the next set of
|
|
20354
|
+
# results.
|
|
20355
|
+
#
|
|
20356
|
+
# @option params [Integer] :max_results
|
|
20357
|
+
# The maximum number of results to return per page.
|
|
20358
|
+
#
|
|
20359
|
+
# @option params [Types::WorkspaceAssociationSearchFilter] :search_filter
|
|
20360
|
+
# Filters to apply to the search, such as tag-based filters.
|
|
20361
|
+
#
|
|
20362
|
+
# @option params [Types::WorkspaceAssociationSearchCriteria] :search_criteria
|
|
20363
|
+
# The search criteria, including workspace ID, resource ID, or resource
|
|
20364
|
+
# type.
|
|
20365
|
+
#
|
|
20366
|
+
# @return [Types::SearchWorkspaceAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
20367
|
+
#
|
|
20368
|
+
# * {Types::SearchWorkspaceAssociationsResponse#next_token #next_token} => String
|
|
20369
|
+
# * {Types::SearchWorkspaceAssociationsResponse#workspace_associations #workspace_associations} => Array<Types::WorkspaceAssociationSearchSummary>
|
|
20370
|
+
# * {Types::SearchWorkspaceAssociationsResponse#approximate_total_count #approximate_total_count} => Integer
|
|
20371
|
+
#
|
|
20372
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
20373
|
+
#
|
|
20374
|
+
# @example Request syntax with placeholder values
|
|
20375
|
+
#
|
|
20376
|
+
# resp = client.search_workspace_associations({
|
|
20377
|
+
# instance_id: "InstanceId", # required
|
|
20378
|
+
# next_token: "NextToken2500",
|
|
20379
|
+
# max_results: 1,
|
|
20380
|
+
# search_filter: {
|
|
20381
|
+
# attribute_filter: {
|
|
20382
|
+
# or_conditions: [
|
|
20383
|
+
# {
|
|
20384
|
+
# tag_conditions: [
|
|
20385
|
+
# {
|
|
20386
|
+
# tag_key: "String",
|
|
20387
|
+
# tag_value: "String",
|
|
20388
|
+
# },
|
|
20389
|
+
# ],
|
|
20390
|
+
# },
|
|
20391
|
+
# ],
|
|
20392
|
+
# and_condition: {
|
|
20393
|
+
# tag_conditions: [
|
|
20394
|
+
# {
|
|
20395
|
+
# tag_key: "String",
|
|
20396
|
+
# tag_value: "String",
|
|
20397
|
+
# },
|
|
20398
|
+
# ],
|
|
20399
|
+
# },
|
|
20400
|
+
# tag_condition: {
|
|
20401
|
+
# tag_key: "String",
|
|
20402
|
+
# tag_value: "String",
|
|
20403
|
+
# },
|
|
20404
|
+
# },
|
|
20405
|
+
# },
|
|
20406
|
+
# search_criteria: {
|
|
20407
|
+
# or_conditions: [
|
|
20408
|
+
# {
|
|
20409
|
+
# # recursive WorkspaceAssociationSearchCriteria
|
|
20410
|
+
# },
|
|
20411
|
+
# ],
|
|
20412
|
+
# and_conditions: [
|
|
20413
|
+
# {
|
|
20414
|
+
# # recursive WorkspaceAssociationSearchCriteria
|
|
20415
|
+
# },
|
|
20416
|
+
# ],
|
|
20417
|
+
# string_condition: {
|
|
20418
|
+
# field_name: "String",
|
|
20419
|
+
# value: "String",
|
|
20420
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
|
20421
|
+
# },
|
|
20422
|
+
# },
|
|
20423
|
+
# })
|
|
20424
|
+
#
|
|
20425
|
+
# @example Response structure
|
|
20426
|
+
#
|
|
20427
|
+
# resp.next_token #=> String
|
|
20428
|
+
# resp.workspace_associations #=> Array
|
|
20429
|
+
# resp.workspace_associations[0].workspace_id #=> String
|
|
20430
|
+
# resp.workspace_associations[0].workspace_arn #=> String
|
|
20431
|
+
# resp.workspace_associations[0].resource_id #=> String
|
|
20432
|
+
# resp.workspace_associations[0].resource_arn #=> String
|
|
20433
|
+
# resp.workspace_associations[0].resource_type #=> String
|
|
20434
|
+
# resp.workspace_associations[0].resource_name #=> String
|
|
20435
|
+
# resp.approximate_total_count #=> Integer
|
|
20436
|
+
#
|
|
20437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchWorkspaceAssociations AWS API Documentation
|
|
20438
|
+
#
|
|
20439
|
+
# @overload search_workspace_associations(params = {})
|
|
20440
|
+
# @param [Hash] params ({})
|
|
20441
|
+
def search_workspace_associations(params = {}, options = {})
|
|
20442
|
+
req = build_request(:search_workspace_associations, params)
|
|
20443
|
+
req.send_request(options)
|
|
20444
|
+
end
|
|
20445
|
+
|
|
20446
|
+
# Searches workspaces based on name, description, visibility, or tags.
|
|
20447
|
+
#
|
|
20448
|
+
# @option params [required, String] :instance_id
|
|
20449
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
20450
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
20451
|
+
#
|
|
20452
|
+
#
|
|
20453
|
+
#
|
|
20454
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
20455
|
+
#
|
|
20456
|
+
# @option params [String] :next_token
|
|
20457
|
+
# The token for the next set of results. Use the value returned in the
|
|
20458
|
+
# previous response in the next request to retrieve the next set of
|
|
20459
|
+
# results.
|
|
20460
|
+
#
|
|
20461
|
+
# @option params [Integer] :max_results
|
|
20462
|
+
# The maximum number of results to return per page.
|
|
20463
|
+
#
|
|
20464
|
+
# @option params [Types::WorkspaceSearchFilter] :search_filter
|
|
20465
|
+
# Filters to apply to the search, such as tag-based filters.
|
|
20466
|
+
#
|
|
20467
|
+
# @option params [Types::WorkspaceSearchCriteria] :search_criteria
|
|
20468
|
+
# The search criteria, including field names and comparison types.
|
|
20469
|
+
#
|
|
20470
|
+
# @return [Types::SearchWorkspacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
20471
|
+
#
|
|
20472
|
+
# * {Types::SearchWorkspacesResponse#next_token #next_token} => String
|
|
20473
|
+
# * {Types::SearchWorkspacesResponse#workspaces #workspaces} => Array<Types::WorkspaceSearchSummary>
|
|
20474
|
+
# * {Types::SearchWorkspacesResponse#approximate_total_count #approximate_total_count} => Integer
|
|
20475
|
+
#
|
|
20476
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
20477
|
+
#
|
|
20478
|
+
# @example Request syntax with placeholder values
|
|
20479
|
+
#
|
|
20480
|
+
# resp = client.search_workspaces({
|
|
20481
|
+
# instance_id: "InstanceId", # required
|
|
20482
|
+
# next_token: "NextToken2500",
|
|
20483
|
+
# max_results: 1,
|
|
20484
|
+
# search_filter: {
|
|
20485
|
+
# attribute_filter: {
|
|
20486
|
+
# or_conditions: [
|
|
20487
|
+
# {
|
|
20488
|
+
# tag_conditions: [
|
|
20489
|
+
# {
|
|
20490
|
+
# tag_key: "String",
|
|
20491
|
+
# tag_value: "String",
|
|
20492
|
+
# },
|
|
20493
|
+
# ],
|
|
20494
|
+
# },
|
|
20495
|
+
# ],
|
|
20496
|
+
# and_condition: {
|
|
20497
|
+
# tag_conditions: [
|
|
20498
|
+
# {
|
|
20499
|
+
# tag_key: "String",
|
|
20500
|
+
# tag_value: "String",
|
|
20501
|
+
# },
|
|
20502
|
+
# ],
|
|
20503
|
+
# },
|
|
20504
|
+
# tag_condition: {
|
|
20505
|
+
# tag_key: "String",
|
|
20506
|
+
# tag_value: "String",
|
|
20507
|
+
# },
|
|
20508
|
+
# },
|
|
20509
|
+
# },
|
|
20510
|
+
# search_criteria: {
|
|
20511
|
+
# or_conditions: [
|
|
20512
|
+
# {
|
|
20513
|
+
# # recursive WorkspaceSearchCriteria
|
|
20514
|
+
# },
|
|
20515
|
+
# ],
|
|
20516
|
+
# and_conditions: [
|
|
20517
|
+
# {
|
|
20518
|
+
# # recursive WorkspaceSearchCriteria
|
|
20519
|
+
# },
|
|
20520
|
+
# ],
|
|
20521
|
+
# string_condition: {
|
|
20522
|
+
# field_name: "String",
|
|
20523
|
+
# value: "String",
|
|
20524
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
|
20525
|
+
# },
|
|
20526
|
+
# },
|
|
20527
|
+
# })
|
|
20528
|
+
#
|
|
20529
|
+
# @example Response structure
|
|
20530
|
+
#
|
|
20531
|
+
# resp.next_token #=> String
|
|
20532
|
+
# resp.workspaces #=> Array
|
|
20533
|
+
# resp.workspaces[0].id #=> String
|
|
20534
|
+
# resp.workspaces[0].name #=> String
|
|
20535
|
+
# resp.workspaces[0].visibility #=> String, one of "ALL", "ASSIGNED", "NONE"
|
|
20536
|
+
# resp.workspaces[0].description #=> String
|
|
20537
|
+
# resp.workspaces[0].title #=> String
|
|
20538
|
+
# resp.workspaces[0].arn #=> String
|
|
20539
|
+
# resp.workspaces[0].created_at #=> Time
|
|
20540
|
+
# resp.workspaces[0].tags #=> Hash
|
|
20541
|
+
# resp.workspaces[0].tags["TagKey"] #=> String
|
|
20542
|
+
# resp.approximate_total_count #=> Integer
|
|
20543
|
+
#
|
|
20544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchWorkspaces AWS API Documentation
|
|
20545
|
+
#
|
|
20546
|
+
# @overload search_workspaces(params = {})
|
|
20547
|
+
# @param [Hash] params ({})
|
|
20548
|
+
def search_workspaces(params = {}, options = {})
|
|
20549
|
+
req = build_request(:search_workspaces, params)
|
|
20550
|
+
req.send_request(options)
|
|
20551
|
+
end
|
|
20552
|
+
|
|
17762
20553
|
# Processes chat integration events from Amazon Web Services or external
|
|
17763
20554
|
# integrations to Amazon Connect. A chat integration event includes:
|
|
17764
20555
|
#
|
|
@@ -18137,6 +20928,9 @@ module Aws::Connect
|
|
|
18137
20928
|
# @option params [required, Types::ParticipantDetails] :participant_details
|
|
18138
20929
|
# Information identifying the participant.
|
|
18139
20930
|
#
|
|
20931
|
+
# @option params [Types::ParticipantConfiguration] :participant_configuration
|
|
20932
|
+
# The configuration of the participant.
|
|
20933
|
+
#
|
|
18140
20934
|
# @option params [Types::ChatMessage] :initial_message
|
|
18141
20935
|
# The initial message to be sent to the newly created chat.
|
|
18142
20936
|
#
|
|
@@ -18238,6 +21032,9 @@ module Aws::Connect
|
|
|
18238
21032
|
# participant_details: { # required
|
|
18239
21033
|
# display_name: "DisplayName", # required
|
|
18240
21034
|
# },
|
|
21035
|
+
# participant_configuration: {
|
|
21036
|
+
# response_mode: "INCREMENTAL", # accepts INCREMENTAL, COMPLETE
|
|
21037
|
+
# },
|
|
18241
21038
|
# initial_message: {
|
|
18242
21039
|
# content_type: "ChatContentType", # required
|
|
18243
21040
|
# content: "ChatContent", # required
|
|
@@ -18366,6 +21163,48 @@ module Aws::Connect
|
|
|
18366
21163
|
req.send_request(options)
|
|
18367
21164
|
end
|
|
18368
21165
|
|
|
21166
|
+
# Enables in-flight message processing for an ongoing chat session.
|
|
21167
|
+
# Message processing will stay active for the rest of the chat, even if
|
|
21168
|
+
# an individual contact segment ends.
|
|
21169
|
+
#
|
|
21170
|
+
# @option params [String] :instance_id
|
|
21171
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
21172
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
21173
|
+
#
|
|
21174
|
+
#
|
|
21175
|
+
#
|
|
21176
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
21177
|
+
#
|
|
21178
|
+
# @option params [String] :contact_id
|
|
21179
|
+
# The identifier of the contact.
|
|
21180
|
+
#
|
|
21181
|
+
# @option params [String] :processor_arn
|
|
21182
|
+
# The Amazon Resource Name (ARN) of the Lambda processor. You can find
|
|
21183
|
+
# the Amazon Resource Name of the lambda in the lambda console.
|
|
21184
|
+
#
|
|
21185
|
+
# @option params [String] :failure_mode
|
|
21186
|
+
# The desired behavior for failed message processing.
|
|
21187
|
+
#
|
|
21188
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
21189
|
+
#
|
|
21190
|
+
# @example Request syntax with placeholder values
|
|
21191
|
+
#
|
|
21192
|
+
# resp = client.start_contact_media_processing({
|
|
21193
|
+
# instance_id: "InstanceId",
|
|
21194
|
+
# contact_id: "ContactId",
|
|
21195
|
+
# processor_arn: "ARN",
|
|
21196
|
+
# failure_mode: "DELIVER_UNPROCESSED_MESSAGE", # accepts DELIVER_UNPROCESSED_MESSAGE, DO_NOT_DELIVER_UNPROCESSED_MESSAGE
|
|
21197
|
+
# })
|
|
21198
|
+
#
|
|
21199
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactMediaProcessing AWS API Documentation
|
|
21200
|
+
#
|
|
21201
|
+
# @overload start_contact_media_processing(params = {})
|
|
21202
|
+
# @param [Hash] params ({})
|
|
21203
|
+
def start_contact_media_processing(params = {}, options = {})
|
|
21204
|
+
req = build_request(:start_contact_media_processing, params)
|
|
21205
|
+
req.send_request(options)
|
|
21206
|
+
end
|
|
21207
|
+
|
|
18369
21208
|
# Starts recording the contact:
|
|
18370
21209
|
#
|
|
18371
21210
|
# * If the API is called *before* the agent joins the call, recording
|
|
@@ -18623,7 +21462,7 @@ module Aws::Connect
|
|
|
18623
21462
|
# references: {
|
|
18624
21463
|
# "ReferenceKey" => {
|
|
18625
21464
|
# value: "ReferenceValue",
|
|
18626
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
21465
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
18627
21466
|
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
|
18628
21467
|
# arn: "ReferenceArn",
|
|
18629
21468
|
# status_reason: "ReferenceStatusReason",
|
|
@@ -19132,7 +21971,7 @@ module Aws::Connect
|
|
|
19132
21971
|
# references: {
|
|
19133
21972
|
# "ReferenceKey" => {
|
|
19134
21973
|
# value: "ReferenceValue",
|
|
19135
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
21974
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
19136
21975
|
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
|
19137
21976
|
# arn: "ReferenceArn",
|
|
19138
21977
|
# status_reason: "ReferenceStatusReason",
|
|
@@ -19416,7 +22255,7 @@ module Aws::Connect
|
|
|
19416
22255
|
# references: {
|
|
19417
22256
|
# "ReferenceKey" => {
|
|
19418
22257
|
# value: "ReferenceValue",
|
|
19419
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
22258
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
19420
22259
|
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
|
19421
22260
|
# arn: "ReferenceArn",
|
|
19422
22261
|
# status_reason: "ReferenceStatusReason",
|
|
@@ -19561,7 +22400,7 @@ module Aws::Connect
|
|
|
19561
22400
|
# references: {
|
|
19562
22401
|
# "ReferenceKey" => {
|
|
19563
22402
|
# value: "ReferenceValue",
|
|
19564
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
22403
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
19565
22404
|
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
|
19566
22405
|
# arn: "ReferenceArn",
|
|
19567
22406
|
# status_reason: "ReferenceStatusReason",
|
|
@@ -19632,26 +22471,57 @@ module Aws::Connect
|
|
|
19632
22471
|
#
|
|
19633
22472
|
#
|
|
19634
22473
|
#
|
|
19635
|
-
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
|
|
22474
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
|
|
22475
|
+
#
|
|
22476
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
22477
|
+
#
|
|
22478
|
+
# @example Request syntax with placeholder values
|
|
22479
|
+
#
|
|
22480
|
+
# resp = client.stop_contact({
|
|
22481
|
+
# contact_id: "ContactId", # required
|
|
22482
|
+
# instance_id: "InstanceId", # required
|
|
22483
|
+
# disconnect_reason: {
|
|
22484
|
+
# code: "DisconnectReasonCode",
|
|
22485
|
+
# },
|
|
22486
|
+
# })
|
|
22487
|
+
#
|
|
22488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact AWS API Documentation
|
|
22489
|
+
#
|
|
22490
|
+
# @overload stop_contact(params = {})
|
|
22491
|
+
# @param [Hash] params ({})
|
|
22492
|
+
def stop_contact(params = {}, options = {})
|
|
22493
|
+
req = build_request(:stop_contact, params)
|
|
22494
|
+
req.send_request(options)
|
|
22495
|
+
end
|
|
22496
|
+
|
|
22497
|
+
# Stops in-flight message processing for an ongoing chat session.
|
|
22498
|
+
#
|
|
22499
|
+
# @option params [String] :instance_id
|
|
22500
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
22501
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
22502
|
+
#
|
|
22503
|
+
#
|
|
22504
|
+
#
|
|
22505
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
22506
|
+
#
|
|
22507
|
+
# @option params [String] :contact_id
|
|
22508
|
+
# The identifier of the contact.
|
|
19636
22509
|
#
|
|
19637
22510
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
19638
22511
|
#
|
|
19639
22512
|
# @example Request syntax with placeholder values
|
|
19640
22513
|
#
|
|
19641
|
-
# resp = client.
|
|
19642
|
-
#
|
|
19643
|
-
#
|
|
19644
|
-
# disconnect_reason: {
|
|
19645
|
-
# code: "DisconnectReasonCode",
|
|
19646
|
-
# },
|
|
22514
|
+
# resp = client.stop_contact_media_processing({
|
|
22515
|
+
# instance_id: "InstanceId",
|
|
22516
|
+
# contact_id: "ContactId",
|
|
19647
22517
|
# })
|
|
19648
22518
|
#
|
|
19649
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
|
22519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactMediaProcessing AWS API Documentation
|
|
19650
22520
|
#
|
|
19651
|
-
# @overload
|
|
22521
|
+
# @overload stop_contact_media_processing(params = {})
|
|
19652
22522
|
# @param [Hash] params ({})
|
|
19653
|
-
def
|
|
19654
|
-
req = build_request(:
|
|
22523
|
+
def stop_contact_media_processing(params = {}, options = {})
|
|
22524
|
+
req = build_request(:stop_contact_media_processing, params)
|
|
19655
22525
|
req.send_request(options)
|
|
19656
22526
|
end
|
|
19657
22527
|
|
|
@@ -19789,6 +22659,8 @@ module Aws::Connect
|
|
|
19789
22659
|
# value: {
|
|
19790
22660
|
# string_value: "EvaluationAnswerDataStringValue",
|
|
19791
22661
|
# numeric_value: 1.0,
|
|
22662
|
+
# string_values: ["EvaluationAnswerDataStringValue"],
|
|
22663
|
+
# date_time_value: "ISO8601Datetime",
|
|
19792
22664
|
# not_applicable: false,
|
|
19793
22665
|
# },
|
|
19794
22666
|
# },
|
|
@@ -20355,7 +23227,7 @@ module Aws::Connect
|
|
|
20355
23227
|
# references: {
|
|
20356
23228
|
# "ReferenceKey" => {
|
|
20357
23229
|
# value: "ReferenceValue",
|
|
20358
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
23230
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
20359
23231
|
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
|
20360
23232
|
# arn: "ReferenceArn",
|
|
20361
23233
|
# status_reason: "ReferenceStatusReason",
|
|
@@ -20525,6 +23397,8 @@ module Aws::Connect
|
|
|
20525
23397
|
# value: {
|
|
20526
23398
|
# string_value: "EvaluationAnswerDataStringValue",
|
|
20527
23399
|
# numeric_value: 1.0,
|
|
23400
|
+
# string_values: ["EvaluationAnswerDataStringValue"],
|
|
23401
|
+
# date_time_value: "ISO8601Datetime",
|
|
20528
23402
|
# not_applicable: false,
|
|
20529
23403
|
# },
|
|
20530
23404
|
# },
|
|
@@ -20873,7 +23747,7 @@ module Aws::Connect
|
|
|
20873
23747
|
#
|
|
20874
23748
|
# @option params [Types::RoutingCriteriaInput] :routing_criteria
|
|
20875
23749
|
# Updates the routing criteria on the contact. These properties can be
|
|
20876
|
-
# used to change how a
|
|
23750
|
+
# used to change how a
|
|
20877
23751
|
#
|
|
20878
23752
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
20879
23753
|
#
|
|
@@ -20984,6 +23858,231 @@ module Aws::Connect
|
|
|
20984
23858
|
req.send_request(options)
|
|
20985
23859
|
end
|
|
20986
23860
|
|
|
23861
|
+
# Updates all properties for an attribute using all properties from
|
|
23862
|
+
# CreateDataTableAttribute. There are no other granular update
|
|
23863
|
+
# endpoints. It does not act as a patch operation - all properties must
|
|
23864
|
+
# be provided. System managed attributes are not mutable by customers.
|
|
23865
|
+
# Changing an attribute's validation does not invalidate existing
|
|
23866
|
+
# values since validation only runs when values are created or updated.
|
|
23867
|
+
#
|
|
23868
|
+
# @option params [required, String] :instance_id
|
|
23869
|
+
# The unique identifier for the Amazon Connect instance.
|
|
23870
|
+
#
|
|
23871
|
+
# @option params [required, String] :data_table_id
|
|
23872
|
+
# The unique identifier for the data table. Must also accept the table
|
|
23873
|
+
# ARN with or without a version alias.
|
|
23874
|
+
#
|
|
23875
|
+
# @option params [required, String] :attribute_name
|
|
23876
|
+
# The current name of the attribute to update. Used as an identifier
|
|
23877
|
+
# since attribute names can be changed.
|
|
23878
|
+
#
|
|
23879
|
+
# @option params [required, String] :name
|
|
23880
|
+
# The new name for the attribute. Must conform to Connect human readable
|
|
23881
|
+
# string specification and be unique within the data table.
|
|
23882
|
+
#
|
|
23883
|
+
# @option params [required, String] :value_type
|
|
23884
|
+
# The updated value type for the attribute. When changing value types,
|
|
23885
|
+
# existing values are not deleted but may return default values if
|
|
23886
|
+
# incompatible.
|
|
23887
|
+
#
|
|
23888
|
+
# @option params [String] :description
|
|
23889
|
+
# The updated description for the attribute.
|
|
23890
|
+
#
|
|
23891
|
+
# @option params [Boolean] :primary
|
|
23892
|
+
# Whether the attribute should be treated as a primary key. Converting
|
|
23893
|
+
# to primary attribute requires existing values to maintain uniqueness.
|
|
23894
|
+
#
|
|
23895
|
+
# @option params [Types::Validation] :validation
|
|
23896
|
+
# The updated validation rules for the attribute. Changes do not affect
|
|
23897
|
+
# existing values until they are modified.
|
|
23898
|
+
#
|
|
23899
|
+
# @return [Types::UpdateDataTableAttributeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
23900
|
+
#
|
|
23901
|
+
# * {Types::UpdateDataTableAttributeResponse#name #name} => String
|
|
23902
|
+
# * {Types::UpdateDataTableAttributeResponse#lock_version #lock_version} => Types::DataTableLockVersion
|
|
23903
|
+
#
|
|
23904
|
+
# @example Request syntax with placeholder values
|
|
23905
|
+
#
|
|
23906
|
+
# resp = client.update_data_table_attribute({
|
|
23907
|
+
# instance_id: "InstanceId", # required
|
|
23908
|
+
# data_table_id: "DataTableId", # required
|
|
23909
|
+
# attribute_name: "DataTableName", # required
|
|
23910
|
+
# name: "DataTableName", # required
|
|
23911
|
+
# value_type: "TEXT", # required, accepts TEXT, NUMBER, BOOLEAN, TEXT_LIST, NUMBER_LIST
|
|
23912
|
+
# description: "DataTableDescription",
|
|
23913
|
+
# primary: false,
|
|
23914
|
+
# validation: {
|
|
23915
|
+
# min_length: 1,
|
|
23916
|
+
# max_length: 1,
|
|
23917
|
+
# min_values: 1,
|
|
23918
|
+
# max_values: 1,
|
|
23919
|
+
# ignore_case: false,
|
|
23920
|
+
# minimum: 1.0,
|
|
23921
|
+
# maximum: 1.0,
|
|
23922
|
+
# exclusive_minimum: 1.0,
|
|
23923
|
+
# exclusive_maximum: 1.0,
|
|
23924
|
+
# multiple_of: 1.0,
|
|
23925
|
+
# enum: {
|
|
23926
|
+
# strict: false,
|
|
23927
|
+
# values: ["String"],
|
|
23928
|
+
# },
|
|
23929
|
+
# },
|
|
23930
|
+
# })
|
|
23931
|
+
#
|
|
23932
|
+
# @example Response structure
|
|
23933
|
+
#
|
|
23934
|
+
# resp.name #=> String
|
|
23935
|
+
# resp.lock_version.data_table #=> String
|
|
23936
|
+
# resp.lock_version.attribute #=> String
|
|
23937
|
+
# resp.lock_version.primary_values #=> String
|
|
23938
|
+
# resp.lock_version.value #=> String
|
|
23939
|
+
#
|
|
23940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateDataTableAttribute AWS API Documentation
|
|
23941
|
+
#
|
|
23942
|
+
# @overload update_data_table_attribute(params = {})
|
|
23943
|
+
# @param [Hash] params ({})
|
|
23944
|
+
def update_data_table_attribute(params = {}, options = {})
|
|
23945
|
+
req = build_request(:update_data_table_attribute, params)
|
|
23946
|
+
req.send_request(options)
|
|
23947
|
+
end
|
|
23948
|
+
|
|
23949
|
+
# Updates the metadata properties of a data table. Accepts all fields
|
|
23950
|
+
# similar to CreateDataTable, except for fields and tags. There are no
|
|
23951
|
+
# other granular update endpoints. It does not act as a patch operation
|
|
23952
|
+
# - all properties must be provided or defaults will be used. Fields
|
|
23953
|
+
# follow the same requirements as CreateDataTable.
|
|
23954
|
+
#
|
|
23955
|
+
# @option params [required, String] :instance_id
|
|
23956
|
+
# The unique identifier for the Amazon Connect instance.
|
|
23957
|
+
#
|
|
23958
|
+
# @option params [required, String] :data_table_id
|
|
23959
|
+
# The unique identifier for the data table. Must also accept the table
|
|
23960
|
+
# ARN with or without a version alias. If the version is provided as
|
|
23961
|
+
# part of the identifier or ARN, the version must be $LATEST. Providing
|
|
23962
|
+
# any other alias fails with an error.
|
|
23963
|
+
#
|
|
23964
|
+
# @option params [required, String] :name
|
|
23965
|
+
# The updated name for the data table. Must conform to Connect human
|
|
23966
|
+
# readable string specification and have 1-127 characters. Must be
|
|
23967
|
+
# unique for the instance using case-insensitive comparison.
|
|
23968
|
+
#
|
|
23969
|
+
# @option params [String] :description
|
|
23970
|
+
# The updated description for the data table. Must conform to Connect
|
|
23971
|
+
# human readable string specification and have 0-250 characters.
|
|
23972
|
+
#
|
|
23973
|
+
# @option params [required, String] :value_lock_level
|
|
23974
|
+
# The updated value lock level for the data table. One of DATA\_TABLE,
|
|
23975
|
+
# PRIMARY\_VALUE, ATTRIBUTE, VALUE, and NONE.
|
|
23976
|
+
#
|
|
23977
|
+
# @option params [required, String] :time_zone
|
|
23978
|
+
# The updated IANA timezone identifier to use when resolving time based
|
|
23979
|
+
# dynamic values.
|
|
23980
|
+
#
|
|
23981
|
+
# @return [Types::UpdateDataTableMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
23982
|
+
#
|
|
23983
|
+
# * {Types::UpdateDataTableMetadataResponse#lock_version #lock_version} => Types::DataTableLockVersion
|
|
23984
|
+
#
|
|
23985
|
+
# @example Request syntax with placeholder values
|
|
23986
|
+
#
|
|
23987
|
+
# resp = client.update_data_table_metadata({
|
|
23988
|
+
# instance_id: "InstanceId", # required
|
|
23989
|
+
# data_table_id: "DataTableId", # required
|
|
23990
|
+
# name: "DataTableName", # required
|
|
23991
|
+
# description: "DataTableDescription",
|
|
23992
|
+
# value_lock_level: "NONE", # required, accepts NONE, DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE
|
|
23993
|
+
# time_zone: "TimeZone", # required
|
|
23994
|
+
# })
|
|
23995
|
+
#
|
|
23996
|
+
# @example Response structure
|
|
23997
|
+
#
|
|
23998
|
+
# resp.lock_version.data_table #=> String
|
|
23999
|
+
# resp.lock_version.attribute #=> String
|
|
24000
|
+
# resp.lock_version.primary_values #=> String
|
|
24001
|
+
# resp.lock_version.value #=> String
|
|
24002
|
+
#
|
|
24003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateDataTableMetadata AWS API Documentation
|
|
24004
|
+
#
|
|
24005
|
+
# @overload update_data_table_metadata(params = {})
|
|
24006
|
+
# @param [Hash] params ({})
|
|
24007
|
+
def update_data_table_metadata(params = {}, options = {})
|
|
24008
|
+
req = build_request(:update_data_table_metadata, params)
|
|
24009
|
+
req.send_request(options)
|
|
24010
|
+
end
|
|
24011
|
+
|
|
24012
|
+
# Updates the primary values for a record. This operation affects all
|
|
24013
|
+
# existing values that are currently associated to the record and its
|
|
24014
|
+
# primary values. Users that have restrictions on attributes and/or
|
|
24015
|
+
# primary values are not authorized to use this endpoint. The
|
|
24016
|
+
# combination of new primary values must be unique within the table.
|
|
24017
|
+
#
|
|
24018
|
+
# @option params [required, String] :instance_id
|
|
24019
|
+
# The unique identifier for the Amazon Connect instance.
|
|
24020
|
+
#
|
|
24021
|
+
# @option params [required, String] :data_table_id
|
|
24022
|
+
# The unique identifier for the data table. Must also accept the table
|
|
24023
|
+
# ARN with or without a version alias. If the version is provided as
|
|
24024
|
+
# part of the identifier or ARN, the version must be one of the two
|
|
24025
|
+
# available system managed aliases, $SAVED or $LATEST.
|
|
24026
|
+
#
|
|
24027
|
+
# @option params [required, Array<Types::PrimaryValue>] :primary_values
|
|
24028
|
+
# The current primary values for the record. Required and must include
|
|
24029
|
+
# values for all primary attributes. Fails if the table has primary
|
|
24030
|
+
# attributes and some primary values are omitted.
|
|
24031
|
+
#
|
|
24032
|
+
# @option params [required, Array<Types::PrimaryValue>] :new_primary_values
|
|
24033
|
+
# The new primary values for the record. Required and must include
|
|
24034
|
+
# values for all primary attributes. The combination must be unique
|
|
24035
|
+
# within the table.
|
|
24036
|
+
#
|
|
24037
|
+
# @option params [required, Types::DataTableLockVersion] :lock_version
|
|
24038
|
+
# The lock version information required for optimistic locking to
|
|
24039
|
+
# prevent concurrent modifications.
|
|
24040
|
+
#
|
|
24041
|
+
# @return [Types::UpdateDataTablePrimaryValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
24042
|
+
#
|
|
24043
|
+
# * {Types::UpdateDataTablePrimaryValuesResponse#lock_version #lock_version} => Types::DataTableLockVersion
|
|
24044
|
+
#
|
|
24045
|
+
# @example Request syntax with placeholder values
|
|
24046
|
+
#
|
|
24047
|
+
# resp = client.update_data_table_primary_values({
|
|
24048
|
+
# instance_id: "InstanceId", # required
|
|
24049
|
+
# data_table_id: "DataTableId", # required
|
|
24050
|
+
# primary_values: [ # required
|
|
24051
|
+
# {
|
|
24052
|
+
# attribute_name: "DataTableName", # required
|
|
24053
|
+
# value: "String", # required
|
|
24054
|
+
# },
|
|
24055
|
+
# ],
|
|
24056
|
+
# new_primary_values: [ # required
|
|
24057
|
+
# {
|
|
24058
|
+
# attribute_name: "DataTableName", # required
|
|
24059
|
+
# value: "String", # required
|
|
24060
|
+
# },
|
|
24061
|
+
# ],
|
|
24062
|
+
# lock_version: { # required
|
|
24063
|
+
# data_table: "String",
|
|
24064
|
+
# attribute: "String",
|
|
24065
|
+
# primary_values: "String",
|
|
24066
|
+
# value: "String",
|
|
24067
|
+
# },
|
|
24068
|
+
# })
|
|
24069
|
+
#
|
|
24070
|
+
# @example Response structure
|
|
24071
|
+
#
|
|
24072
|
+
# resp.lock_version.data_table #=> String
|
|
24073
|
+
# resp.lock_version.attribute #=> String
|
|
24074
|
+
# resp.lock_version.primary_values #=> String
|
|
24075
|
+
# resp.lock_version.value #=> String
|
|
24076
|
+
#
|
|
24077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateDataTablePrimaryValues AWS API Documentation
|
|
24078
|
+
#
|
|
24079
|
+
# @overload update_data_table_primary_values(params = {})
|
|
24080
|
+
# @param [Hash] params ({})
|
|
24081
|
+
def update_data_table_primary_values(params = {}, options = {})
|
|
24082
|
+
req = build_request(:update_data_table_primary_values, params)
|
|
24083
|
+
req.send_request(options)
|
|
24084
|
+
end
|
|
24085
|
+
|
|
20987
24086
|
# Updates an email address metadata. For more information about email
|
|
20988
24087
|
# addresses, see [Create email addresses][1] in the Amazon Connect
|
|
20989
24088
|
# Administrator Guide.
|
|
@@ -21089,6 +24188,10 @@ module Aws::Connect
|
|
|
21089
24188
|
# @option params [Types::EvaluationFormAutoEvaluationConfiguration] :auto_evaluation_configuration
|
|
21090
24189
|
# Whether automated evaluations are enabled.
|
|
21091
24190
|
#
|
|
24191
|
+
# @option params [Boolean] :as_draft
|
|
24192
|
+
# A boolean flag indicating whether to update evaluation form to draft
|
|
24193
|
+
# state.
|
|
24194
|
+
#
|
|
21092
24195
|
# @option params [String] :client_token
|
|
21093
24196
|
# A unique, case-sensitive identifier that you provide to ensure the
|
|
21094
24197
|
# idempotency of the request. If not provided, the Amazon Web Services
|
|
@@ -21102,6 +24205,12 @@ module Aws::Connect
|
|
|
21102
24205
|
#
|
|
21103
24206
|
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
21104
24207
|
#
|
|
24208
|
+
# @option params [Types::EvaluationFormTargetConfiguration] :target_configuration
|
|
24209
|
+
# Configuration that specifies the target for the evaluation form.
|
|
24210
|
+
#
|
|
24211
|
+
# @option params [Types::EvaluationFormLanguageConfiguration] :language_configuration
|
|
24212
|
+
# Configuration for language settings of the evaluation form.
|
|
24213
|
+
#
|
|
21105
24214
|
# @return [Types::UpdateEvaluationFormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
21106
24215
|
#
|
|
21107
24216
|
# * {Types::UpdateEvaluationFormResponse#evaluation_form_id #evaluation_form_id} => String
|
|
@@ -21133,7 +24242,7 @@ module Aws::Connect
|
|
|
21133
24242
|
# instructions: "EvaluationFormQuestionInstructions",
|
|
21134
24243
|
# ref_id: "ReferenceId", # required
|
|
21135
24244
|
# not_applicable_enabled: false,
|
|
21136
|
-
# question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC
|
|
24245
|
+
# question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC, MULTISELECT, DATETIME
|
|
21137
24246
|
# question_type_properties: {
|
|
21138
24247
|
# numeric: {
|
|
21139
24248
|
# min_value: 1, # required
|
|
@@ -21151,7 +24260,7 @@ module Aws::Connect
|
|
|
21151
24260
|
# ],
|
|
21152
24261
|
# automation: {
|
|
21153
24262
|
# property_value: {
|
|
21154
|
-
# label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts OVERALL_CUSTOMER_SENTIMENT_SCORE, OVERALL_AGENT_SENTIMENT_SCORE, 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
|
|
24263
|
+
# label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts 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
|
|
21155
24264
|
# },
|
|
21156
24265
|
# answer_source: {
|
|
21157
24266
|
# source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
|
|
@@ -21194,6 +24303,30 @@ module Aws::Connect
|
|
|
21194
24303
|
# },
|
|
21195
24304
|
# },
|
|
21196
24305
|
# },
|
|
24306
|
+
# multi_select: {
|
|
24307
|
+
# options: [ # required
|
|
24308
|
+
# {
|
|
24309
|
+
# ref_id: "ReferenceId", # required
|
|
24310
|
+
# text: "EvaluationFormMultiSelectQuestionOptionText", # required
|
|
24311
|
+
# },
|
|
24312
|
+
# ],
|
|
24313
|
+
# display_as: "DROPDOWN", # accepts DROPDOWN, CHECKBOX
|
|
24314
|
+
# automation: {
|
|
24315
|
+
# options: [
|
|
24316
|
+
# {
|
|
24317
|
+
# rule_category: {
|
|
24318
|
+
# category: "MultiSelectQuestionRuleCategoryAutomationLabel", # required
|
|
24319
|
+
# condition: "PRESENT", # required, accepts PRESENT, NOT_PRESENT
|
|
24320
|
+
# option_ref_ids: ["ReferenceId"], # required
|
|
24321
|
+
# },
|
|
24322
|
+
# },
|
|
24323
|
+
# ],
|
|
24324
|
+
# default_option_ref_ids: ["ReferenceId"],
|
|
24325
|
+
# answer_source: {
|
|
24326
|
+
# source_type: "CONTACT_LENS_DATA", # required, accepts CONTACT_LENS_DATA, GEN_AI
|
|
24327
|
+
# },
|
|
24328
|
+
# },
|
|
24329
|
+
# },
|
|
21197
24330
|
# },
|
|
21198
24331
|
# enablement: {
|
|
21199
24332
|
# condition: { # required
|
|
@@ -21210,7 +24343,7 @@ module Aws::Connect
|
|
|
21210
24343
|
# ref_id: "ReferenceId",
|
|
21211
24344
|
# },
|
|
21212
24345
|
# ],
|
|
21213
|
-
# comparator: "IN", # required, accepts IN, NOT_IN
|
|
24346
|
+
# comparator: "IN", # required, accepts IN, NOT_IN, ALL_IN, EXACT
|
|
21214
24347
|
# },
|
|
21215
24348
|
# condition: {
|
|
21216
24349
|
# # recursive EvaluationFormItemEnablementCondition
|
|
@@ -21233,7 +24366,14 @@ module Aws::Connect
|
|
|
21233
24366
|
# auto_evaluation_configuration: {
|
|
21234
24367
|
# enabled: false, # required
|
|
21235
24368
|
# },
|
|
24369
|
+
# as_draft: false,
|
|
21236
24370
|
# client_token: "ClientToken",
|
|
24371
|
+
# target_configuration: {
|
|
24372
|
+
# contact_interaction_type: "AGENT", # required, accepts AGENT, AUTOMATED
|
|
24373
|
+
# },
|
|
24374
|
+
# language_configuration: {
|
|
24375
|
+
# form_language: "de-DE", # accepts de-DE, en-US, es-ES, fr-FR, it-IT, pt-BR
|
|
24376
|
+
# },
|
|
21237
24377
|
# })
|
|
21238
24378
|
#
|
|
21239
24379
|
# @example Response structure
|
|
@@ -21395,6 +24535,13 @@ module Aws::Connect
|
|
|
21395
24535
|
#
|
|
21396
24536
|
# </note>
|
|
21397
24537
|
#
|
|
24538
|
+
# <note markdown="1"> If you set the attribute type as `MESSAGE_STREAMING`, you need to
|
|
24539
|
+
# update the Lex bot alias resource based policy to include the
|
|
24540
|
+
# `lex:RecognizeMessageAsync` action for the connect instance ARN
|
|
24541
|
+
# resource.
|
|
24542
|
+
#
|
|
24543
|
+
# </note>
|
|
24544
|
+
#
|
|
21398
24545
|
# @option params [required, String] :value
|
|
21399
24546
|
# The value for the attribute. Maximum character limit is 100.
|
|
21400
24547
|
#
|
|
@@ -21417,7 +24564,7 @@ module Aws::Connect
|
|
|
21417
24564
|
#
|
|
21418
24565
|
# resp = client.update_instance_attribute({
|
|
21419
24566
|
# instance_id: "InstanceId", # required
|
|
21420
|
-
# attribute_type: "INBOUND_CALLS", # required, accepts 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
|
|
24567
|
+
# attribute_type: "INBOUND_CALLS", # required, accepts 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
|
|
21421
24568
|
# value: "InstanceAttributeValue", # required
|
|
21422
24569
|
# client_token: "ClientToken",
|
|
21423
24570
|
# })
|
|
@@ -22175,7 +25322,7 @@ module Aws::Connect
|
|
|
22175
25322
|
# instance_id: "InstanceId", # required
|
|
22176
25323
|
# quick_connect_id: "QuickConnectId", # required
|
|
22177
25324
|
# quick_connect_config: { # required
|
|
22178
|
-
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER
|
|
25325
|
+
# quick_connect_type: "USER", # required, accepts USER, QUEUE, PHONE_NUMBER, FLOW
|
|
22179
25326
|
# user_config: {
|
|
22180
25327
|
# user_id: "UserId", # required
|
|
22181
25328
|
# contact_flow_id: "ContactFlowId", # required
|
|
@@ -22187,6 +25334,9 @@ module Aws::Connect
|
|
|
22187
25334
|
# phone_config: {
|
|
22188
25335
|
# phone_number: "PhoneNumber", # required
|
|
22189
25336
|
# },
|
|
25337
|
+
# flow_config: {
|
|
25338
|
+
# contact_flow_id: "ContactFlowId", # required
|
|
25339
|
+
# },
|
|
22190
25340
|
# },
|
|
22191
25341
|
# })
|
|
22192
25342
|
#
|
|
@@ -22501,7 +25651,7 @@ module Aws::Connect
|
|
|
22501
25651
|
# references: {
|
|
22502
25652
|
# "ReferenceKey" => {
|
|
22503
25653
|
# value: "ReferenceValue",
|
|
22504
|
-
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE
|
|
25654
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, CONTACT_ANALYSIS, NUMBER, STRING, DATE, EMAIL, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT
|
|
22505
25655
|
# status: "AVAILABLE", # accepts AVAILABLE, DELETED, APPROVED, REJECTED, PROCESSING, FAILED
|
|
22506
25656
|
# arn: "ReferenceArn",
|
|
22507
25657
|
# status_reason: "ReferenceStatusReason",
|
|
@@ -22651,6 +25801,13 @@ module Aws::Connect
|
|
|
22651
25801
|
# The identifier of the hierarchy group that a security profile uses to
|
|
22652
25802
|
# restrict access to resources in Amazon Connect.
|
|
22653
25803
|
#
|
|
25804
|
+
# @option params [Array<Types::FlowModule>] :allowed_flow_modules
|
|
25805
|
+
# A list of Flow Modules an AI Agent can invoke as a tool
|
|
25806
|
+
#
|
|
25807
|
+
# @option params [Types::GranularAccessControlConfiguration] :granular_access_control_configuration
|
|
25808
|
+
# The granular access control configuration for the security profile,
|
|
25809
|
+
# including data table permissions.
|
|
25810
|
+
#
|
|
22654
25811
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
22655
25812
|
#
|
|
22656
25813
|
# @example Request syntax with placeholder values
|
|
@@ -22668,10 +25825,30 @@ module Aws::Connect
|
|
|
22668
25825
|
# {
|
|
22669
25826
|
# namespace: "Namespace",
|
|
22670
25827
|
# application_permissions: ["Permission"],
|
|
25828
|
+
# type: "MCP", # accepts MCP, THIRD_PARTY_APPLICATION
|
|
22671
25829
|
# },
|
|
22672
25830
|
# ],
|
|
22673
25831
|
# hierarchy_restricted_resources: ["HierarchyRestrictedResourceName"],
|
|
22674
25832
|
# allowed_access_control_hierarchy_group_id: "HierarchyGroupId",
|
|
25833
|
+
# allowed_flow_modules: [
|
|
25834
|
+
# {
|
|
25835
|
+
# type: "MCP", # accepts MCP
|
|
25836
|
+
# flow_module_id: "FlowModuleId",
|
|
25837
|
+
# },
|
|
25838
|
+
# ],
|
|
25839
|
+
# granular_access_control_configuration: {
|
|
25840
|
+
# data_table_access_control_configuration: {
|
|
25841
|
+
# primary_attribute_access_control_configuration: {
|
|
25842
|
+
# primary_attribute_values: [
|
|
25843
|
+
# {
|
|
25844
|
+
# access_type: "ALLOW", # accepts ALLOW
|
|
25845
|
+
# attribute_name: "PrimaryAttributeContextKeyName",
|
|
25846
|
+
# values: ["IAMRestrictedPrimaryValue"],
|
|
25847
|
+
# },
|
|
25848
|
+
# ],
|
|
25849
|
+
# },
|
|
25850
|
+
# },
|
|
25851
|
+
# },
|
|
22675
25852
|
# })
|
|
22676
25853
|
#
|
|
22677
25854
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateSecurityProfile AWS API Documentation
|
|
@@ -23348,6 +26525,256 @@ module Aws::Connect
|
|
|
23348
26525
|
req.send_request(options)
|
|
23349
26526
|
end
|
|
23350
26527
|
|
|
26528
|
+
# Updates the metadata of a workspace, such as its name and description.
|
|
26529
|
+
#
|
|
26530
|
+
# @option params [required, String] :instance_id
|
|
26531
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
26532
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
26533
|
+
#
|
|
26534
|
+
#
|
|
26535
|
+
#
|
|
26536
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
26537
|
+
#
|
|
26538
|
+
# @option params [required, String] :workspace_id
|
|
26539
|
+
# The identifier of the workspace.
|
|
26540
|
+
#
|
|
26541
|
+
# @option params [String] :name
|
|
26542
|
+
# The name of the workspace.
|
|
26543
|
+
#
|
|
26544
|
+
# @option params [String] :description
|
|
26545
|
+
# The description of the workspace.
|
|
26546
|
+
#
|
|
26547
|
+
# @option params [String] :title
|
|
26548
|
+
# The title displayed for the workspace.
|
|
26549
|
+
#
|
|
26550
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
26551
|
+
#
|
|
26552
|
+
# @example Request syntax with placeholder values
|
|
26553
|
+
#
|
|
26554
|
+
# resp = client.update_workspace_metadata({
|
|
26555
|
+
# instance_id: "InstanceId", # required
|
|
26556
|
+
# workspace_id: "WorkspaceId", # required
|
|
26557
|
+
# name: "WorkspaceName",
|
|
26558
|
+
# description: "WorkspaceDescription",
|
|
26559
|
+
# title: "WorkspaceTitle",
|
|
26560
|
+
# })
|
|
26561
|
+
#
|
|
26562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateWorkspaceMetadata AWS API Documentation
|
|
26563
|
+
#
|
|
26564
|
+
# @overload update_workspace_metadata(params = {})
|
|
26565
|
+
# @param [Hash] params ({})
|
|
26566
|
+
def update_workspace_metadata(params = {}, options = {})
|
|
26567
|
+
req = build_request(:update_workspace_metadata, params)
|
|
26568
|
+
req.send_request(options)
|
|
26569
|
+
end
|
|
26570
|
+
|
|
26571
|
+
# Updates the configuration of a page in a workspace, including the
|
|
26572
|
+
# associated view and input data.
|
|
26573
|
+
#
|
|
26574
|
+
# @option params [required, String] :instance_id
|
|
26575
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
26576
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
26577
|
+
#
|
|
26578
|
+
#
|
|
26579
|
+
#
|
|
26580
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
26581
|
+
#
|
|
26582
|
+
# @option params [required, String] :workspace_id
|
|
26583
|
+
# The identifier of the workspace.
|
|
26584
|
+
#
|
|
26585
|
+
# @option params [required, String] :page
|
|
26586
|
+
# The current page identifier.
|
|
26587
|
+
#
|
|
26588
|
+
# @option params [String] :new_page
|
|
26589
|
+
# The new page identifier, if changing the page name.
|
|
26590
|
+
#
|
|
26591
|
+
# @option params [String] :resource_arn
|
|
26592
|
+
# The Amazon Resource Name (ARN) of the view to associate with the page.
|
|
26593
|
+
#
|
|
26594
|
+
# @option params [String] :slug
|
|
26595
|
+
# The URL-friendly identifier for the page.
|
|
26596
|
+
#
|
|
26597
|
+
# @option params [String] :input_data
|
|
26598
|
+
# A JSON string containing input parameters for the view.
|
|
26599
|
+
#
|
|
26600
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
26601
|
+
#
|
|
26602
|
+
# @example Request syntax with placeholder values
|
|
26603
|
+
#
|
|
26604
|
+
# resp = client.update_workspace_page({
|
|
26605
|
+
# instance_id: "InstanceId", # required
|
|
26606
|
+
# workspace_id: "WorkspaceId", # required
|
|
26607
|
+
# page: "Page", # required
|
|
26608
|
+
# new_page: "Page",
|
|
26609
|
+
# resource_arn: "ARN",
|
|
26610
|
+
# slug: "Slug",
|
|
26611
|
+
# input_data: "InputData",
|
|
26612
|
+
# })
|
|
26613
|
+
#
|
|
26614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateWorkspacePage AWS API Documentation
|
|
26615
|
+
#
|
|
26616
|
+
# @overload update_workspace_page(params = {})
|
|
26617
|
+
# @param [Hash] params ({})
|
|
26618
|
+
def update_workspace_page(params = {}, options = {})
|
|
26619
|
+
req = build_request(:update_workspace_page, params)
|
|
26620
|
+
req.send_request(options)
|
|
26621
|
+
end
|
|
26622
|
+
|
|
26623
|
+
# Updates the theme configuration for a workspace, including colors and
|
|
26624
|
+
# styling.
|
|
26625
|
+
#
|
|
26626
|
+
# @option params [required, String] :instance_id
|
|
26627
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
26628
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
26629
|
+
#
|
|
26630
|
+
#
|
|
26631
|
+
#
|
|
26632
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
26633
|
+
#
|
|
26634
|
+
# @option params [required, String] :workspace_id
|
|
26635
|
+
# The identifier of the workspace.
|
|
26636
|
+
#
|
|
26637
|
+
# @option params [Types::WorkspaceTheme] :theme
|
|
26638
|
+
# The theme configuration, including color schemes and visual styles.
|
|
26639
|
+
#
|
|
26640
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
26641
|
+
#
|
|
26642
|
+
# @example Request syntax with placeholder values
|
|
26643
|
+
#
|
|
26644
|
+
# resp = client.update_workspace_theme({
|
|
26645
|
+
# instance_id: "InstanceId", # required
|
|
26646
|
+
# workspace_id: "WorkspaceId", # required
|
|
26647
|
+
# theme: {
|
|
26648
|
+
# light: {
|
|
26649
|
+
# palette: {
|
|
26650
|
+
# header: {
|
|
26651
|
+
# background: "ThemeString",
|
|
26652
|
+
# text: "ThemeString",
|
|
26653
|
+
# text_hover: "ThemeString",
|
|
26654
|
+
# invert_actions_colors: false,
|
|
26655
|
+
# },
|
|
26656
|
+
# navigation: {
|
|
26657
|
+
# background: "ThemeString",
|
|
26658
|
+
# text_background_hover: "ThemeString",
|
|
26659
|
+
# text_background_active: "ThemeString",
|
|
26660
|
+
# text: "ThemeString",
|
|
26661
|
+
# text_hover: "ThemeString",
|
|
26662
|
+
# text_active: "ThemeString",
|
|
26663
|
+
# invert_actions_colors: false,
|
|
26664
|
+
# },
|
|
26665
|
+
# canvas: {
|
|
26666
|
+
# container_background: "ThemeString",
|
|
26667
|
+
# page_background: "ThemeString",
|
|
26668
|
+
# active_background: "ThemeString",
|
|
26669
|
+
# },
|
|
26670
|
+
# primary: {
|
|
26671
|
+
# default: "ThemeString",
|
|
26672
|
+
# active: "ThemeString",
|
|
26673
|
+
# contrast_text: "ThemeString",
|
|
26674
|
+
# },
|
|
26675
|
+
# },
|
|
26676
|
+
# images: {
|
|
26677
|
+
# logo: {
|
|
26678
|
+
# default: "ThemeImageLink",
|
|
26679
|
+
# favicon: "ThemeImageLink",
|
|
26680
|
+
# },
|
|
26681
|
+
# },
|
|
26682
|
+
# typography: {
|
|
26683
|
+
# font_family: {
|
|
26684
|
+
# default: "Arial", # accepts Arial, Courier New, Georgia, Times New Roman, Trebuchet, Verdana
|
|
26685
|
+
# },
|
|
26686
|
+
# },
|
|
26687
|
+
# },
|
|
26688
|
+
# dark: {
|
|
26689
|
+
# palette: {
|
|
26690
|
+
# header: {
|
|
26691
|
+
# background: "ThemeString",
|
|
26692
|
+
# text: "ThemeString",
|
|
26693
|
+
# text_hover: "ThemeString",
|
|
26694
|
+
# invert_actions_colors: false,
|
|
26695
|
+
# },
|
|
26696
|
+
# navigation: {
|
|
26697
|
+
# background: "ThemeString",
|
|
26698
|
+
# text_background_hover: "ThemeString",
|
|
26699
|
+
# text_background_active: "ThemeString",
|
|
26700
|
+
# text: "ThemeString",
|
|
26701
|
+
# text_hover: "ThemeString",
|
|
26702
|
+
# text_active: "ThemeString",
|
|
26703
|
+
# invert_actions_colors: false,
|
|
26704
|
+
# },
|
|
26705
|
+
# canvas: {
|
|
26706
|
+
# container_background: "ThemeString",
|
|
26707
|
+
# page_background: "ThemeString",
|
|
26708
|
+
# active_background: "ThemeString",
|
|
26709
|
+
# },
|
|
26710
|
+
# primary: {
|
|
26711
|
+
# default: "ThemeString",
|
|
26712
|
+
# active: "ThemeString",
|
|
26713
|
+
# contrast_text: "ThemeString",
|
|
26714
|
+
# },
|
|
26715
|
+
# },
|
|
26716
|
+
# images: {
|
|
26717
|
+
# logo: {
|
|
26718
|
+
# default: "ThemeImageLink",
|
|
26719
|
+
# favicon: "ThemeImageLink",
|
|
26720
|
+
# },
|
|
26721
|
+
# },
|
|
26722
|
+
# typography: {
|
|
26723
|
+
# font_family: {
|
|
26724
|
+
# default: "Arial", # accepts Arial, Courier New, Georgia, Times New Roman, Trebuchet, Verdana
|
|
26725
|
+
# },
|
|
26726
|
+
# },
|
|
26727
|
+
# },
|
|
26728
|
+
# },
|
|
26729
|
+
# })
|
|
26730
|
+
#
|
|
26731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateWorkspaceTheme AWS API Documentation
|
|
26732
|
+
#
|
|
26733
|
+
# @overload update_workspace_theme(params = {})
|
|
26734
|
+
# @param [Hash] params ({})
|
|
26735
|
+
def update_workspace_theme(params = {}, options = {})
|
|
26736
|
+
req = build_request(:update_workspace_theme, params)
|
|
26737
|
+
req.send_request(options)
|
|
26738
|
+
end
|
|
26739
|
+
|
|
26740
|
+
# Updates the visibility setting of a workspace, controlling whether it
|
|
26741
|
+
# is available to all users, assigned users only, or none.
|
|
26742
|
+
#
|
|
26743
|
+
# @option params [required, String] :instance_id
|
|
26744
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
26745
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
26746
|
+
#
|
|
26747
|
+
#
|
|
26748
|
+
#
|
|
26749
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
26750
|
+
#
|
|
26751
|
+
# @option params [required, String] :workspace_id
|
|
26752
|
+
# The identifier of the workspace.
|
|
26753
|
+
#
|
|
26754
|
+
# @option params [required, String] :visibility
|
|
26755
|
+
# The visibility setting for the workspace. Valid values are: `ALL`
|
|
26756
|
+
# (available to all users), `ASSIGNED` (available only to assigned users
|
|
26757
|
+
# and routing profiles), and `NONE` (not visible to any users).
|
|
26758
|
+
#
|
|
26759
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
26760
|
+
#
|
|
26761
|
+
# @example Request syntax with placeholder values
|
|
26762
|
+
#
|
|
26763
|
+
# resp = client.update_workspace_visibility({
|
|
26764
|
+
# instance_id: "InstanceId", # required
|
|
26765
|
+
# workspace_id: "WorkspaceId", # required
|
|
26766
|
+
# visibility: "ALL", # required, accepts ALL, ASSIGNED, NONE
|
|
26767
|
+
# })
|
|
26768
|
+
#
|
|
26769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateWorkspaceVisibility AWS API Documentation
|
|
26770
|
+
#
|
|
26771
|
+
# @overload update_workspace_visibility(params = {})
|
|
26772
|
+
# @param [Hash] params ({})
|
|
26773
|
+
def update_workspace_visibility(params = {}, options = {})
|
|
26774
|
+
req = build_request(:update_workspace_visibility, params)
|
|
26775
|
+
req.send_request(options)
|
|
26776
|
+
end
|
|
26777
|
+
|
|
23351
26778
|
# @!endgroup
|
|
23352
26779
|
|
|
23353
26780
|
# @param params ({})
|
|
@@ -23366,7 +26793,7 @@ module Aws::Connect
|
|
|
23366
26793
|
tracer: tracer
|
|
23367
26794
|
)
|
|
23368
26795
|
context[:gem_name] = 'aws-sdk-connect'
|
|
23369
|
-
context[:gem_version] = '1.
|
|
26796
|
+
context[:gem_version] = '1.227.0'
|
|
23370
26797
|
Seahorse::Client::Request.new(handlers, context)
|
|
23371
26798
|
end
|
|
23372
26799
|
|