aws-sdk-connect 1.214.0 → 1.216.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +227 -47
- data/lib/aws-sdk-connect/client_api.rb +37 -1
- data/lib/aws-sdk-connect/types.rb +164 -19
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +45 -11
- data/sig/types.rbs +30 -3
- metadata +1 -1
@@ -43,6 +43,7 @@ module Aws::Connect
|
|
43
43
|
AgentStatus = Shapes::StructureShape.new(name: 'AgentStatus')
|
44
44
|
AgentStatusDescription = Shapes::StringShape.new(name: 'AgentStatusDescription')
|
45
45
|
AgentStatusId = Shapes::StringShape.new(name: 'AgentStatusId')
|
46
|
+
AgentStatusIdentifier = Shapes::StructureShape.new(name: 'AgentStatusIdentifier')
|
46
47
|
AgentStatusList = Shapes::ListShape.new(name: 'AgentStatusList')
|
47
48
|
AgentStatusName = Shapes::StringShape.new(name: 'AgentStatusName')
|
48
49
|
AgentStatusOrderNumber = Shapes::IntegerShape.new(name: 'AgentStatusOrderNumber')
|
@@ -55,6 +56,7 @@ module Aws::Connect
|
|
55
56
|
AgentStatusSummaryList = Shapes::ListShape.new(name: 'AgentStatusSummaryList')
|
56
57
|
AgentStatusType = Shapes::StringShape.new(name: 'AgentStatusType')
|
57
58
|
AgentStatusTypes = Shapes::ListShape.new(name: 'AgentStatusTypes')
|
59
|
+
AgentStatuses = Shapes::ListShape.new(name: 'AgentStatuses')
|
58
60
|
AgentUsername = Shapes::StringShape.new(name: 'AgentUsername')
|
59
61
|
AgentsCriteria = Shapes::StructureShape.new(name: 'AgentsCriteria')
|
60
62
|
AgentsMinOneMaxHundred = Shapes::ListShape.new(name: 'AgentsMinOneMaxHundred')
|
@@ -507,6 +509,7 @@ module Aws::Connect
|
|
507
509
|
EmailRecipientsList = Shapes::ListShape.new(name: 'EmailRecipientsList')
|
508
510
|
EmailReference = Shapes::StructureShape.new(name: 'EmailReference')
|
509
511
|
EmptyFieldValue = Shapes::StructureShape.new(name: 'EmptyFieldValue')
|
512
|
+
EnableValueValidationOnAssociation = Shapes::BooleanShape.new(name: 'EnableValueValidationOnAssociation')
|
510
513
|
EncryptionConfig = Shapes::StructureShape.new(name: 'EncryptionConfig')
|
511
514
|
EncryptionType = Shapes::StringShape.new(name: 'EncryptionType')
|
512
515
|
EndAssociatedTasksActionDefinition = Shapes::StructureShape.new(name: 'EndAssociatedTasksActionDefinition')
|
@@ -706,6 +709,7 @@ module Aws::Connect
|
|
706
709
|
Index = Shapes::IntegerShape.new(name: 'Index')
|
707
710
|
InitiateAs = Shapes::StringShape.new(name: 'InitiateAs')
|
708
711
|
InitiationMethodList = Shapes::ListShape.new(name: 'InitiationMethodList')
|
712
|
+
InputPredefinedAttributeConfiguration = Shapes::StructureShape.new(name: 'InputPredefinedAttributeConfiguration')
|
709
713
|
Instance = Shapes::StructureShape.new(name: 'Instance')
|
710
714
|
InstanceArn = Shapes::StringShape.new(name: 'InstanceArn')
|
711
715
|
InstanceAttributeType = Shapes::StringShape.new(name: 'InstanceAttributeType')
|
@@ -738,6 +742,7 @@ module Aws::Connect
|
|
738
742
|
InvisibleTaskTemplateFields = Shapes::ListShape.new(name: 'InvisibleTaskTemplateFields')
|
739
743
|
IpCidr = Shapes::StringShape.new(name: 'IpCidr')
|
740
744
|
IpCidrList = Shapes::ListShape.new(name: 'IpCidrList')
|
745
|
+
IsReadOnly = Shapes::BooleanShape.new(name: 'IsReadOnly')
|
741
746
|
IvrRecordingTrack = Shapes::StringShape.new(name: 'IvrRecordingTrack')
|
742
747
|
JoinToken = Shapes::StringShape.new(name: 'JoinToken')
|
743
748
|
KeyId = Shapes::StringShape.new(name: 'KeyId')
|
@@ -979,7 +984,10 @@ module Aws::Connect
|
|
979
984
|
PotentialDisconnectIssue = Shapes::StringShape.new(name: 'PotentialDisconnectIssue')
|
980
985
|
PreSignedAttachmentUrl = Shapes::StringShape.new(name: 'PreSignedAttachmentUrl')
|
981
986
|
PredefinedAttribute = Shapes::StructureShape.new(name: 'PredefinedAttribute')
|
987
|
+
PredefinedAttributeConfiguration = Shapes::StructureShape.new(name: 'PredefinedAttributeConfiguration')
|
982
988
|
PredefinedAttributeName = Shapes::StringShape.new(name: 'PredefinedAttributeName')
|
989
|
+
PredefinedAttributePurposeName = Shapes::StringShape.new(name: 'PredefinedAttributePurposeName')
|
990
|
+
PredefinedAttributePurposeNameList = Shapes::ListShape.new(name: 'PredefinedAttributePurposeNameList')
|
983
991
|
PredefinedAttributeSearchConditionList = Shapes::ListShape.new(name: 'PredefinedAttributeSearchConditionList')
|
984
992
|
PredefinedAttributeSearchCriteria = Shapes::StructureShape.new(name: 'PredefinedAttributeSearchCriteria')
|
985
993
|
PredefinedAttributeSearchSummaryList = Shapes::ListShape.new(name: 'PredefinedAttributeSearchSummaryList')
|
@@ -1251,6 +1259,7 @@ module Aws::Connect
|
|
1251
1259
|
SegmentAttributeName = Shapes::StringShape.new(name: 'SegmentAttributeName')
|
1252
1260
|
SegmentAttributeValue = Shapes::StructureShape.new(name: 'SegmentAttributeValue')
|
1253
1261
|
SegmentAttributeValueInteger = Shapes::IntegerShape.new(name: 'SegmentAttributeValueInteger')
|
1262
|
+
SegmentAttributeValueList = Shapes::ListShape.new(name: 'SegmentAttributeValueList')
|
1254
1263
|
SegmentAttributeValueMap = Shapes::MapShape.new(name: 'SegmentAttributeValueMap')
|
1255
1264
|
SegmentAttributeValueString = Shapes::StringShape.new(name: 'SegmentAttributeValueString')
|
1256
1265
|
SegmentAttributes = Shapes::MapShape.new(name: 'SegmentAttributes')
|
@@ -1646,6 +1655,10 @@ module Aws::Connect
|
|
1646
1655
|
AgentStatus.add_member(:last_modified_region, Shapes::ShapeRef.new(shape: RegionName, location_name: "LastModifiedRegion"))
|
1647
1656
|
AgentStatus.struct_class = Types::AgentStatus
|
1648
1657
|
|
1658
|
+
AgentStatusIdentifier.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
1659
|
+
AgentStatusIdentifier.add_member(:id, Shapes::ShapeRef.new(shape: AgentStatusId, location_name: "Id"))
|
1660
|
+
AgentStatusIdentifier.struct_class = Types::AgentStatusIdentifier
|
1661
|
+
|
1649
1662
|
AgentStatusList.member = Shapes::ShapeRef.new(shape: AgentStatus)
|
1650
1663
|
|
1651
1664
|
AgentStatusReference.add_member(:status_start_timestamp, Shapes::ShapeRef.new(shape: Timestamp, location_name: "StatusStartTimestamp"))
|
@@ -1675,6 +1688,8 @@ module Aws::Connect
|
|
1675
1688
|
|
1676
1689
|
AgentStatusTypes.member = Shapes::ShapeRef.new(shape: AgentStatusType)
|
1677
1690
|
|
1691
|
+
AgentStatuses.member = Shapes::ShapeRef.new(shape: AgentStatusId)
|
1692
|
+
|
1678
1693
|
AgentsCriteria.add_member(:agent_ids, Shapes::ShapeRef.new(shape: AgentIds, location_name: "AgentIds"))
|
1679
1694
|
AgentsCriteria.struct_class = Types::AgentsCriteria
|
1680
1695
|
|
@@ -2478,7 +2493,9 @@ module Aws::Connect
|
|
2478
2493
|
|
2479
2494
|
CreatePredefinedAttributeRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
2480
2495
|
CreatePredefinedAttributeRequest.add_member(:name, Shapes::ShapeRef.new(shape: PredefinedAttributeName, required: true, location_name: "Name"))
|
2481
|
-
CreatePredefinedAttributeRequest.add_member(:values, Shapes::ShapeRef.new(shape: PredefinedAttributeValues,
|
2496
|
+
CreatePredefinedAttributeRequest.add_member(:values, Shapes::ShapeRef.new(shape: PredefinedAttributeValues, location_name: "Values"))
|
2497
|
+
CreatePredefinedAttributeRequest.add_member(:purposes, Shapes::ShapeRef.new(shape: PredefinedAttributePurposeNameList, location_name: "Purposes"))
|
2498
|
+
CreatePredefinedAttributeRequest.add_member(:attribute_configuration, Shapes::ShapeRef.new(shape: InputPredefinedAttributeConfiguration, location_name: "AttributeConfiguration"))
|
2482
2499
|
CreatePredefinedAttributeRequest.struct_class = Types::CreatePredefinedAttributeRequest
|
2483
2500
|
|
2484
2501
|
CreatePromptRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
@@ -3098,6 +3115,7 @@ module Aws::Connect
|
|
3098
3115
|
Dimensions.add_member(:channel, Shapes::ShapeRef.new(shape: Channel, location_name: "Channel"))
|
3099
3116
|
Dimensions.add_member(:routing_profile, Shapes::ShapeRef.new(shape: RoutingProfileReference, location_name: "RoutingProfile"))
|
3100
3117
|
Dimensions.add_member(:routing_step_expression, Shapes::ShapeRef.new(shape: RoutingExpression, location_name: "RoutingStepExpression"))
|
3118
|
+
Dimensions.add_member(:agent_status, Shapes::ShapeRef.new(shape: AgentStatusIdentifier, location_name: "AgentStatus"))
|
3101
3119
|
Dimensions.struct_class = Types::Dimensions
|
3102
3120
|
|
3103
3121
|
DimensionsV2Map.key = Shapes::ShapeRef.new(shape: DimensionsV2Key)
|
@@ -3527,6 +3545,7 @@ module Aws::Connect
|
|
3527
3545
|
Filters.add_member(:channels, Shapes::ShapeRef.new(shape: Channels, location_name: "Channels"))
|
3528
3546
|
Filters.add_member(:routing_profiles, Shapes::ShapeRef.new(shape: RoutingProfiles, location_name: "RoutingProfiles"))
|
3529
3547
|
Filters.add_member(:routing_step_expressions, Shapes::ShapeRef.new(shape: RoutingExpressions, location_name: "RoutingStepExpressions"))
|
3548
|
+
Filters.add_member(:agent_statuses, Shapes::ShapeRef.new(shape: AgentStatuses, location_name: "AgentStatuses"))
|
3530
3549
|
Filters.struct_class = Types::Filters
|
3531
3550
|
|
3532
3551
|
FiltersV2List.member = Shapes::ShapeRef.new(shape: FilterV2)
|
@@ -3900,6 +3919,9 @@ module Aws::Connect
|
|
3900
3919
|
|
3901
3920
|
InitiationMethodList.member = Shapes::ShapeRef.new(shape: ContactInitiationMethod)
|
3902
3921
|
|
3922
|
+
InputPredefinedAttributeConfiguration.add_member(:enable_value_validation_on_association, Shapes::ShapeRef.new(shape: EnableValueValidationOnAssociation, location_name: "EnableValueValidationOnAssociation"))
|
3923
|
+
InputPredefinedAttributeConfiguration.struct_class = Types::InputPredefinedAttributeConfiguration
|
3924
|
+
|
3903
3925
|
Instance.add_member(:id, Shapes::ShapeRef.new(shape: InstanceId, location_name: "Id"))
|
3904
3926
|
Instance.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, location_name: "Arn"))
|
3905
3927
|
Instance.add_member(:identity_management_type, Shapes::ShapeRef.new(shape: DirectoryType, location_name: "IdentityManagementType"))
|
@@ -4736,10 +4758,18 @@ module Aws::Connect
|
|
4736
4758
|
|
4737
4759
|
PredefinedAttribute.add_member(:name, Shapes::ShapeRef.new(shape: PredefinedAttributeName, location_name: "Name"))
|
4738
4760
|
PredefinedAttribute.add_member(:values, Shapes::ShapeRef.new(shape: PredefinedAttributeValues, location_name: "Values"))
|
4761
|
+
PredefinedAttribute.add_member(:purposes, Shapes::ShapeRef.new(shape: PredefinedAttributePurposeNameList, location_name: "Purposes"))
|
4762
|
+
PredefinedAttribute.add_member(:attribute_configuration, Shapes::ShapeRef.new(shape: PredefinedAttributeConfiguration, location_name: "AttributeConfiguration"))
|
4739
4763
|
PredefinedAttribute.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModifiedTime"))
|
4740
4764
|
PredefinedAttribute.add_member(:last_modified_region, Shapes::ShapeRef.new(shape: RegionName, location_name: "LastModifiedRegion"))
|
4741
4765
|
PredefinedAttribute.struct_class = Types::PredefinedAttribute
|
4742
4766
|
|
4767
|
+
PredefinedAttributeConfiguration.add_member(:enable_value_validation_on_association, Shapes::ShapeRef.new(shape: EnableValueValidationOnAssociation, location_name: "EnableValueValidationOnAssociation"))
|
4768
|
+
PredefinedAttributeConfiguration.add_member(:is_read_only, Shapes::ShapeRef.new(shape: IsReadOnly, location_name: "IsReadOnly"))
|
4769
|
+
PredefinedAttributeConfiguration.struct_class = Types::PredefinedAttributeConfiguration
|
4770
|
+
|
4771
|
+
PredefinedAttributePurposeNameList.member = Shapes::ShapeRef.new(shape: PredefinedAttributePurposeName)
|
4772
|
+
|
4743
4773
|
PredefinedAttributeSearchConditionList.member = Shapes::ShapeRef.new(shape: PredefinedAttributeSearchCriteria)
|
4744
4774
|
|
4745
4775
|
PredefinedAttributeSearchCriteria.add_member(:or_conditions, Shapes::ShapeRef.new(shape: PredefinedAttributeSearchConditionList, location_name: "OrConditions"))
|
@@ -5594,8 +5624,12 @@ module Aws::Connect
|
|
5594
5624
|
SegmentAttributeValue.add_member(:value_string, Shapes::ShapeRef.new(shape: SegmentAttributeValueString, location_name: "ValueString"))
|
5595
5625
|
SegmentAttributeValue.add_member(:value_map, Shapes::ShapeRef.new(shape: SegmentAttributeValueMap, location_name: "ValueMap"))
|
5596
5626
|
SegmentAttributeValue.add_member(:value_integer, Shapes::ShapeRef.new(shape: SegmentAttributeValueInteger, location_name: "ValueInteger"))
|
5627
|
+
SegmentAttributeValue.add_member(:value_list, Shapes::ShapeRef.new(shape: SegmentAttributeValueList, location_name: "ValueList"))
|
5628
|
+
SegmentAttributeValue.add_member(:value_arn, Shapes::ShapeRef.new(shape: SegmentAttributeValueString, location_name: "ValueArn"))
|
5597
5629
|
SegmentAttributeValue.struct_class = Types::SegmentAttributeValue
|
5598
5630
|
|
5631
|
+
SegmentAttributeValueList.member = Shapes::ShapeRef.new(shape: SegmentAttributeValue)
|
5632
|
+
|
5599
5633
|
SegmentAttributeValueMap.key = Shapes::ShapeRef.new(shape: SegmentAttributeName)
|
5600
5634
|
SegmentAttributeValueMap.value = Shapes::ShapeRef.new(shape: SegmentAttributeValue)
|
5601
5635
|
|
@@ -6290,6 +6324,8 @@ module Aws::Connect
|
|
6290
6324
|
UpdatePredefinedAttributeRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
6291
6325
|
UpdatePredefinedAttributeRequest.add_member(:name, Shapes::ShapeRef.new(shape: PredefinedAttributeName, required: true, location: "uri", location_name: "Name"))
|
6292
6326
|
UpdatePredefinedAttributeRequest.add_member(:values, Shapes::ShapeRef.new(shape: PredefinedAttributeValues, location_name: "Values"))
|
6327
|
+
UpdatePredefinedAttributeRequest.add_member(:purposes, Shapes::ShapeRef.new(shape: PredefinedAttributePurposeNameList, location_name: "Purposes"))
|
6328
|
+
UpdatePredefinedAttributeRequest.add_member(:attribute_configuration, Shapes::ShapeRef.new(shape: InputPredefinedAttributeConfiguration, location_name: "AttributeConfiguration"))
|
6293
6329
|
UpdatePredefinedAttributeRequest.struct_class = Types::UpdatePredefinedAttributeRequest
|
6294
6330
|
|
6295
6331
|
UpdatePromptRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
|
@@ -389,6 +389,25 @@ module Aws::Connect
|
|
389
389
|
include Aws::Structure
|
390
390
|
end
|
391
391
|
|
392
|
+
# Information about the agent status assigned to the user.
|
393
|
+
#
|
394
|
+
# @!attribute [rw] arn
|
395
|
+
# The Amazon Resource Name (ARN) of the agent status.
|
396
|
+
# @return [String]
|
397
|
+
#
|
398
|
+
# @!attribute [rw] id
|
399
|
+
# The identifier of the agent status.
|
400
|
+
# @return [String]
|
401
|
+
#
|
402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentStatusIdentifier AWS API Documentation
|
403
|
+
#
|
404
|
+
class AgentStatusIdentifier < Struct.new(
|
405
|
+
:arn,
|
406
|
+
:id)
|
407
|
+
SENSITIVE = []
|
408
|
+
include Aws::Structure
|
409
|
+
end
|
410
|
+
|
392
411
|
# Information about the agent's status.
|
393
412
|
#
|
394
413
|
# @!attribute [rw] status_start_timestamp
|
@@ -1564,8 +1583,8 @@ module Aws::Connect
|
|
1564
1583
|
end
|
1565
1584
|
|
1566
1585
|
# This API is in preview release for Amazon Connect and is subject to
|
1567
|
-
# change. To request access to this API, contact Amazon Web
|
1568
|
-
#
|
1586
|
+
# change. To request access to this API, contact Amazon Web Services
|
1587
|
+
# Support.
|
1569
1588
|
#
|
1570
1589
|
# Information about an authentication profile. An authentication profile
|
1571
1590
|
# is a resource that stores the authentication settings for users in
|
@@ -1678,8 +1697,8 @@ module Aws::Connect
|
|
1678
1697
|
end
|
1679
1698
|
|
1680
1699
|
# This API is in preview release for Amazon Connect and is subject to
|
1681
|
-
# change. To request access to this API, contact Amazon Web
|
1682
|
-
#
|
1700
|
+
# change. To request access to this API, contact Amazon Web Services
|
1701
|
+
# Support.
|
1683
1702
|
#
|
1684
1703
|
# A summary of a given authentication profile.
|
1685
1704
|
#
|
@@ -3551,7 +3570,7 @@ module Aws::Connect
|
|
3551
3570
|
:disconnect_timestamp,
|
3552
3571
|
:scheduled_timestamp,
|
3553
3572
|
:segment_attributes)
|
3554
|
-
SENSITIVE = []
|
3573
|
+
SENSITIVE = [:segment_attributes]
|
3555
3574
|
include Aws::Structure
|
3556
3575
|
end
|
3557
3576
|
|
@@ -4783,12 +4802,27 @@ module Aws::Connect
|
|
4783
4802
|
# The values of the predefined attribute.
|
4784
4803
|
# @return [Types::PredefinedAttributeValues]
|
4785
4804
|
#
|
4805
|
+
# @!attribute [rw] purposes
|
4806
|
+
# Values that enable you to categorize your predefined attributes. You
|
4807
|
+
# can use them in custom UI elements across the Amazon Connect admin
|
4808
|
+
# website.
|
4809
|
+
# @return [Array<String>]
|
4810
|
+
#
|
4811
|
+
# @!attribute [rw] attribute_configuration
|
4812
|
+
# Custom metadata that is associated to predefined attributes to
|
4813
|
+
# control behavior in upstream services, such as controlling how a
|
4814
|
+
# predefined attribute should be displayed in the Amazon Connect admin
|
4815
|
+
# website.
|
4816
|
+
# @return [Types::InputPredefinedAttributeConfiguration]
|
4817
|
+
#
|
4786
4818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePredefinedAttributeRequest AWS API Documentation
|
4787
4819
|
#
|
4788
4820
|
class CreatePredefinedAttributeRequest < Struct.new(
|
4789
4821
|
:instance_id,
|
4790
4822
|
:name,
|
4791
|
-
:values
|
4823
|
+
:values,
|
4824
|
+
:purposes,
|
4825
|
+
:attribute_configuration)
|
4792
4826
|
SENSITIVE = []
|
4793
4827
|
include Aws::Structure
|
4794
4828
|
end
|
@@ -7936,13 +7970,18 @@ module Aws::Connect
|
|
7936
7970
|
# The expression of a step in a routing criteria.
|
7937
7971
|
# @return [String]
|
7938
7972
|
#
|
7973
|
+
# @!attribute [rw] agent_status
|
7974
|
+
# Information about the agent status assigned to the user.
|
7975
|
+
# @return [Types::AgentStatusIdentifier]
|
7976
|
+
#
|
7939
7977
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Dimensions AWS API Documentation
|
7940
7978
|
#
|
7941
7979
|
class Dimensions < Struct.new(
|
7942
7980
|
:queue,
|
7943
7981
|
:channel,
|
7944
7982
|
:routing_profile,
|
7945
|
-
:routing_step_expression
|
7983
|
+
:routing_step_expression,
|
7984
|
+
:agent_status)
|
7946
7985
|
SENSITIVE = []
|
7947
7986
|
include Aws::Structure
|
7948
7987
|
end
|
@@ -9868,13 +9907,18 @@ module Aws::Connect
|
|
9868
9907
|
# object of a step in a routing criteria.
|
9869
9908
|
# @return [Array<String>]
|
9870
9909
|
#
|
9910
|
+
# @!attribute [rw] agent_statuses
|
9911
|
+
# A list of up to 50 agent status IDs or ARNs.
|
9912
|
+
# @return [Array<String>]
|
9913
|
+
#
|
9871
9914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Filters AWS API Documentation
|
9872
9915
|
#
|
9873
9916
|
class Filters < Struct.new(
|
9874
9917
|
:queues,
|
9875
9918
|
:channels,
|
9876
9919
|
:routing_profiles,
|
9877
|
-
:routing_step_expressions
|
9920
|
+
:routing_step_expressions,
|
9921
|
+
:agent_statuses)
|
9878
9922
|
SENSITIVE = []
|
9879
9923
|
include Aws::Structure
|
9880
9924
|
end
|
@@ -10118,11 +10162,16 @@ module Aws::Connect
|
|
10118
10162
|
#
|
10119
10163
|
# * RoutingStepExpressions: 50
|
10120
10164
|
#
|
10165
|
+
# * AgentStatuses: 50
|
10166
|
+
#
|
10121
10167
|
# Metric data is retrieved only for the resources associated with the
|
10122
10168
|
# queues or routing profiles, and by any channels included in the
|
10123
10169
|
# filter. (You cannot filter by both queue AND routing profile.) You
|
10124
10170
|
# can include both resource IDs and resource ARNs in the same request.
|
10125
10171
|
#
|
10172
|
+
# When using `AgentStatuses` as filter make sure Queues is added as
|
10173
|
+
# primary filter.
|
10174
|
+
#
|
10126
10175
|
# When using the `RoutingStepExpression` filter, you need to pass
|
10127
10176
|
# exactly one `QueueId`. The filter is also case sensitive so when
|
10128
10177
|
# using the `RoutingStepExpression` filter, grouping by
|
@@ -10133,21 +10182,29 @@ module Aws::Connect
|
|
10133
10182
|
# @return [Types::Filters]
|
10134
10183
|
#
|
10135
10184
|
# @!attribute [rw] groupings
|
10136
|
-
#
|
10137
|
-
#
|
10138
|
-
#
|
10185
|
+
# Defines the level of aggregation for metrics data by a dimension(s).
|
10186
|
+
# Its similar to sorting items into buckets based on a common
|
10187
|
+
# characteristic, then counting or calculating something for each
|
10188
|
+
# bucket. For example, when grouped by `QUEUE`, the metrics returned
|
10189
|
+
# apply to each queue rather than aggregated for all queues.
|
10190
|
+
#
|
10191
|
+
# The grouping list is an ordered list, with the first item in the
|
10192
|
+
# list defined as the primary grouping. If no grouping is included in
|
10193
|
+
# the request, the aggregation happens at the instance-level.
|
10139
10194
|
#
|
10140
10195
|
# * If you group by `CHANNEL`, you should include a Channels filter.
|
10141
10196
|
# VOICE, CHAT, and TASK channels are supported.
|
10142
10197
|
#
|
10198
|
+
# * If you group by `AGENT_STATUS`, you must include the `QUEUE` as
|
10199
|
+
# the primary grouping and use queue filter. When you group by
|
10200
|
+
# `AGENT_STATUS`, the only metric available is the `AGENTS_ONLINE`
|
10201
|
+
# metric.
|
10202
|
+
#
|
10143
10203
|
# * If you group by `ROUTING_PROFILE`, you must include either a queue
|
10144
10204
|
# or routing profile filter. In addition, a routing profile filter
|
10145
10205
|
# is required for metrics `CONTACTS_SCHEDULED`, `CONTACTS_IN_QUEUE`,
|
10146
10206
|
# and ` OLDEST_CONTACT_AGE`.
|
10147
10207
|
#
|
10148
|
-
# * If no `Grouping` is included in the request, a summary of metrics
|
10149
|
-
# is returned.
|
10150
|
-
#
|
10151
10208
|
# * When using the `RoutingStepExpression` filter, group by
|
10152
10209
|
# `ROUTING_STEP_EXPRESSION` is required.
|
10153
10210
|
# @return [Array<String>]
|
@@ -14045,6 +14102,25 @@ module Aws::Connect
|
|
14045
14102
|
include Aws::Structure
|
14046
14103
|
end
|
14047
14104
|
|
14105
|
+
# Custom metadata that is associated to predefined attributes to control
|
14106
|
+
# behavior in upstream services, such as controlling how a predefined
|
14107
|
+
# attribute should be displayed in the Amazon Connect admin website.
|
14108
|
+
#
|
14109
|
+
# @!attribute [rw] enable_value_validation_on_association
|
14110
|
+
# When this parameter is set to true, Amazon Connect enforces strict
|
14111
|
+
# validation on the specific values, if the values are predefined in
|
14112
|
+
# attributes. The contact will store only valid and predefined values
|
14113
|
+
# for the predefined attribute key.
|
14114
|
+
# @return [Boolean]
|
14115
|
+
#
|
14116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/InputPredefinedAttributeConfiguration AWS API Documentation
|
14117
|
+
#
|
14118
|
+
class InputPredefinedAttributeConfiguration < Struct.new(
|
14119
|
+
:enable_value_validation_on_association)
|
14120
|
+
SENSITIVE = []
|
14121
|
+
include Aws::Structure
|
14122
|
+
end
|
14123
|
+
|
14048
14124
|
# The Amazon Connect instance.
|
14049
14125
|
#
|
14050
14126
|
# @!attribute [rw] id
|
@@ -18370,6 +18446,19 @@ module Aws::Connect
|
|
18370
18446
|
# The values of the predefined attribute.
|
18371
18447
|
# @return [Types::PredefinedAttributeValues]
|
18372
18448
|
#
|
18449
|
+
# @!attribute [rw] purposes
|
18450
|
+
# Values that enable you to categorize your predefined attributes. You
|
18451
|
+
# can use them in custom UI elements across the Amazon Connect admin
|
18452
|
+
# website.
|
18453
|
+
# @return [Array<String>]
|
18454
|
+
#
|
18455
|
+
# @!attribute [rw] attribute_configuration
|
18456
|
+
# Custom metadata that is associated to predefined attributes to
|
18457
|
+
# control behavior in upstream services, such as controlling how a
|
18458
|
+
# predefined attribute should be displayed in the Amazon Connect admin
|
18459
|
+
# website.
|
18460
|
+
# @return [Types::PredefinedAttributeConfiguration]
|
18461
|
+
#
|
18373
18462
|
# @!attribute [rw] last_modified_time
|
18374
18463
|
# Last modified time.
|
18375
18464
|
# @return [Time]
|
@@ -18383,12 +18472,39 @@ module Aws::Connect
|
|
18383
18472
|
class PredefinedAttribute < Struct.new(
|
18384
18473
|
:name,
|
18385
18474
|
:values,
|
18475
|
+
:purposes,
|
18476
|
+
:attribute_configuration,
|
18386
18477
|
:last_modified_time,
|
18387
18478
|
:last_modified_region)
|
18388
18479
|
SENSITIVE = []
|
18389
18480
|
include Aws::Structure
|
18390
18481
|
end
|
18391
18482
|
|
18483
|
+
# Custom metadata that is associated to predefined attributes to control
|
18484
|
+
# behavior in upstream services, such as controlling how a predefined
|
18485
|
+
# attribute should be displayed in the Amazon Connect admin website.
|
18486
|
+
#
|
18487
|
+
# @!attribute [rw] enable_value_validation_on_association
|
18488
|
+
# When this parameter is set to true, Amazon Connect enforces strict
|
18489
|
+
# validation on the specific values, if the values are predefined in
|
18490
|
+
# attributes. The contact will store only valid and predefined values
|
18491
|
+
# for teh predefined attribute key.
|
18492
|
+
# @return [Boolean]
|
18493
|
+
#
|
18494
|
+
# @!attribute [rw] is_read_only
|
18495
|
+
# A boolean flag used to indicate whether a predefined attribute
|
18496
|
+
# should be displayed in the Amazon Connect admin website.
|
18497
|
+
# @return [Boolean]
|
18498
|
+
#
|
18499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PredefinedAttributeConfiguration AWS API Documentation
|
18500
|
+
#
|
18501
|
+
class PredefinedAttributeConfiguration < Struct.new(
|
18502
|
+
:enable_value_validation_on_association,
|
18503
|
+
:is_read_only)
|
18504
|
+
SENSITIVE = []
|
18505
|
+
include Aws::Structure
|
18506
|
+
end
|
18507
|
+
|
18392
18508
|
# The search criteria to be used to return predefined attributes.
|
18393
18509
|
#
|
18394
18510
|
# @!attribute [rw] or_conditions
|
@@ -22411,12 +22527,25 @@ module Aws::Connect
|
|
22411
22527
|
# The value of a segment attribute.
|
22412
22528
|
# @return [Integer]
|
22413
22529
|
#
|
22530
|
+
# @!attribute [rw] value_list
|
22531
|
+
# The value of a segment attribute. This is only supported for
|
22532
|
+
# system-defined attributes, not for user-defined attributes.
|
22533
|
+
# @return [Array<Types::SegmentAttributeValue>]
|
22534
|
+
#
|
22535
|
+
# @!attribute [rw] value_arn
|
22536
|
+
# The value of a segment attribute that has to be a valid ARN. This is
|
22537
|
+
# only supported for system-defined attributes, not for user-defined
|
22538
|
+
# attributes.
|
22539
|
+
# @return [String]
|
22540
|
+
#
|
22414
22541
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SegmentAttributeValue AWS API Documentation
|
22415
22542
|
#
|
22416
22543
|
class SegmentAttributeValue < Struct.new(
|
22417
22544
|
:value_string,
|
22418
22545
|
:value_map,
|
22419
|
-
:value_integer
|
22546
|
+
:value_integer,
|
22547
|
+
:value_list,
|
22548
|
+
:value_arn)
|
22420
22549
|
SENSITIVE = []
|
22421
22550
|
include Aws::Structure
|
22422
22551
|
end
|
@@ -25582,8 +25711,9 @@ module Aws::Connect
|
|
25582
25711
|
# This field can be used to show channel subtype, such as
|
25583
25712
|
# `connect:Guide`.
|
25584
25713
|
#
|
25585
|
-
#
|
25586
|
-
# updated by using the
|
25714
|
+
# Contact Expiry, and user-defined attributes (String - String) that
|
25715
|
+
# are defined in predefined attributes, can be updated by using the
|
25716
|
+
# UpdateContact API.
|
25587
25717
|
# @return [Hash<String,Types::SegmentAttributeValue>]
|
25588
25718
|
#
|
25589
25719
|
# @!attribute [rw] queue_info
|
@@ -25993,7 +26123,7 @@ module Aws::Connect
|
|
25993
26123
|
# The type of attribute.
|
25994
26124
|
#
|
25995
26125
|
# <note markdown="1"> Only allowlisted customers can consume USE\_CUSTOM\_TTS\_VOICES. To
|
25996
|
-
# access this feature, contact Amazon Web
|
26126
|
+
# access this feature, contact Amazon Web Services Support for
|
25997
26127
|
# allowlisting.
|
25998
26128
|
#
|
25999
26129
|
# </note>
|
@@ -26286,12 +26416,27 @@ module Aws::Connect
|
|
26286
26416
|
# The values of the predefined attribute.
|
26287
26417
|
# @return [Types::PredefinedAttributeValues]
|
26288
26418
|
#
|
26419
|
+
# @!attribute [rw] purposes
|
26420
|
+
# Values that enable you to categorize your predefined attributes. You
|
26421
|
+
# can use them in custom UI elements across the Amazon Connect admin
|
26422
|
+
# website.
|
26423
|
+
# @return [Array<String>]
|
26424
|
+
#
|
26425
|
+
# @!attribute [rw] attribute_configuration
|
26426
|
+
# Custom metadata that is associated to predefined attributes to
|
26427
|
+
# control behavior in upstream services, such as controlling how a
|
26428
|
+
# predefined attribute should be displayed in the Amazon Connect admin
|
26429
|
+
# website.
|
26430
|
+
# @return [Types::InputPredefinedAttributeConfiguration]
|
26431
|
+
#
|
26289
26432
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePredefinedAttributeRequest AWS API Documentation
|
26290
26433
|
#
|
26291
26434
|
class UpdatePredefinedAttributeRequest < Struct.new(
|
26292
26435
|
:instance_id,
|
26293
26436
|
:name,
|
26294
|
-
:values
|
26437
|
+
:values,
|
26438
|
+
:purposes,
|
26439
|
+
:attribute_configuration)
|
26295
26440
|
SENSITIVE = []
|
26296
26441
|
include Aws::Structure
|
26297
26442
|
end
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -433,7 +433,11 @@ module Aws
|
|
433
433
|
?segment_attributes: Hash[::String, {
|
434
434
|
value_string: ::String?,
|
435
435
|
value_map: Hash[::String, untyped]?,
|
436
|
-
value_integer: ::Integer
|
436
|
+
value_integer: ::Integer?,
|
437
|
+
value_list: Array[
|
438
|
+
untyped,
|
439
|
+
]?,
|
440
|
+
value_arn: ::String?
|
437
441
|
}],
|
438
442
|
?previous_contact_id: ::String
|
439
443
|
) -> _CreateContactResponseSuccess
|
@@ -714,8 +718,12 @@ module Aws
|
|
714
718
|
def create_predefined_attribute: (
|
715
719
|
instance_id: ::String,
|
716
720
|
name: ::String,
|
717
|
-
values: {
|
721
|
+
?values: {
|
718
722
|
string_list: Array[::String]?
|
723
|
+
},
|
724
|
+
?purposes: Array[::String],
|
725
|
+
?attribute_configuration: {
|
726
|
+
enable_value_validation_on_association: bool?
|
719
727
|
}
|
720
728
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
721
729
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
@@ -1907,9 +1915,10 @@ module Aws
|
|
1907
1915
|
queues: Array[::String]?,
|
1908
1916
|
channels: Array[("VOICE" | "CHAT" | "TASK" | "EMAIL")]?,
|
1909
1917
|
routing_profiles: Array[::String]?,
|
1910
|
-
routing_step_expressions: Array[::String]
|
1918
|
+
routing_step_expressions: Array[::String]?,
|
1919
|
+
agent_statuses: Array[::String]?
|
1911
1920
|
},
|
1912
|
-
?groupings: Array[("QUEUE" | "CHANNEL" | "ROUTING_PROFILE" | "ROUTING_STEP_EXPRESSION")],
|
1921
|
+
?groupings: Array[("QUEUE" | "CHANNEL" | "ROUTING_PROFILE" | "ROUTING_STEP_EXPRESSION" | "AGENT_STATUS")],
|
1913
1922
|
current_metrics: Array[
|
1914
1923
|
{
|
1915
1924
|
name: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE")?,
|
@@ -2005,9 +2014,10 @@ module Aws
|
|
2005
2014
|
queues: Array[::String]?,
|
2006
2015
|
channels: Array[("VOICE" | "CHAT" | "TASK" | "EMAIL")]?,
|
2007
2016
|
routing_profiles: Array[::String]?,
|
2008
|
-
routing_step_expressions: Array[::String]
|
2017
|
+
routing_step_expressions: Array[::String]?,
|
2018
|
+
agent_statuses: Array[::String]?
|
2009
2019
|
},
|
2010
|
-
?groupings: Array[("QUEUE" | "CHANNEL" | "ROUTING_PROFILE" | "ROUTING_STEP_EXPRESSION")],
|
2020
|
+
?groupings: Array[("QUEUE" | "CHANNEL" | "ROUTING_PROFILE" | "ROUTING_STEP_EXPRESSION" | "AGENT_STATUS")],
|
2011
2021
|
historical_metrics: Array[
|
2012
2022
|
{
|
2013
2023
|
name: ("CONTACTS_QUEUED" | "CONTACTS_HANDLED" | "CONTACTS_ABANDONED" | "CONTACTS_CONSULTED" | "CONTACTS_AGENT_HUNG_UP_FIRST" | "CONTACTS_HANDLED_INCOMING" | "CONTACTS_HANDLED_OUTBOUND" | "CONTACTS_HOLD_ABANDONS" | "CONTACTS_TRANSFERRED_IN" | "CONTACTS_TRANSFERRED_OUT" | "CONTACTS_TRANSFERRED_IN_FROM_QUEUE" | "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE" | "CONTACTS_MISSED" | "CALLBACK_CONTACTS_HANDLED" | "API_CONTACTS_HANDLED" | "OCCUPANCY" | "HANDLE_TIME" | "AFTER_CONTACT_WORK_TIME" | "QUEUED_TIME" | "ABANDON_TIME" | "QUEUE_ANSWER_TIME" | "HOLD_TIME" | "INTERACTION_TIME" | "INTERACTION_AND_HOLD_TIME" | "SERVICE_LEVEL")?,
|
@@ -3894,7 +3904,11 @@ module Aws
|
|
3894
3904
|
?segment_attributes: Hash[::String, {
|
3895
3905
|
value_string: ::String?,
|
3896
3906
|
value_map: Hash[::String, untyped]?,
|
3897
|
-
value_integer: ::Integer
|
3907
|
+
value_integer: ::Integer?,
|
3908
|
+
value_list: Array[
|
3909
|
+
untyped,
|
3910
|
+
]?,
|
3911
|
+
value_arn: ::String?
|
3898
3912
|
}],
|
3899
3913
|
?customer_id: ::String
|
3900
3914
|
) -> _StartChatContactResponseSuccess
|
@@ -4000,7 +4014,11 @@ module Aws
|
|
4000
4014
|
?segment_attributes: Hash[::String, {
|
4001
4015
|
value_string: ::String?,
|
4002
4016
|
value_map: Hash[::String, untyped]?,
|
4003
|
-
value_integer: ::Integer
|
4017
|
+
value_integer: ::Integer?,
|
4018
|
+
value_list: Array[
|
4019
|
+
untyped,
|
4020
|
+
]?,
|
4021
|
+
value_arn: ::String?
|
4004
4022
|
}],
|
4005
4023
|
?client_token: ::String
|
4006
4024
|
) -> _StartEmailContactResponseSuccess
|
@@ -4024,7 +4042,11 @@ module Aws
|
|
4024
4042
|
segment_attributes: Hash[::String, {
|
4025
4043
|
value_string: ::String?,
|
4026
4044
|
value_map: Hash[::String, untyped]?,
|
4027
|
-
value_integer: ::Integer
|
4045
|
+
value_integer: ::Integer?,
|
4046
|
+
value_list: Array[
|
4047
|
+
untyped,
|
4048
|
+
]?,
|
4049
|
+
value_arn: ::String?
|
4028
4050
|
}],
|
4029
4051
|
?attributes: Hash[::String, ::String],
|
4030
4052
|
contact_flow_id: ::String,
|
@@ -4156,7 +4178,11 @@ module Aws
|
|
4156
4178
|
?segment_attributes: Hash[::String, {
|
4157
4179
|
value_string: ::String?,
|
4158
4180
|
value_map: Hash[::String, untyped]?,
|
4159
|
-
value_integer: ::Integer
|
4181
|
+
value_integer: ::Integer?,
|
4182
|
+
value_list: Array[
|
4183
|
+
untyped,
|
4184
|
+
]?,
|
4185
|
+
value_arn: ::String?
|
4160
4186
|
}]
|
4161
4187
|
) -> _StartTaskContactResponseSuccess
|
4162
4188
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartTaskContactResponseSuccess
|
@@ -4364,7 +4390,11 @@ module Aws
|
|
4364
4390
|
?segment_attributes: Hash[::String, {
|
4365
4391
|
value_string: ::String?,
|
4366
4392
|
value_map: Hash[::String, untyped]?,
|
4367
|
-
value_integer: ::Integer
|
4393
|
+
value_integer: ::Integer?,
|
4394
|
+
value_list: Array[
|
4395
|
+
untyped,
|
4396
|
+
]?,
|
4397
|
+
value_arn: ::String?
|
4368
4398
|
}],
|
4369
4399
|
?queue_info: {
|
4370
4400
|
id: ::String?
|
@@ -4801,6 +4831,10 @@ module Aws
|
|
4801
4831
|
name: ::String,
|
4802
4832
|
?values: {
|
4803
4833
|
string_list: Array[::String]?
|
4834
|
+
},
|
4835
|
+
?purposes: Array[::String],
|
4836
|
+
?attribute_configuration: {
|
4837
|
+
enable_value_validation_on_association: bool?
|
4804
4838
|
}
|
4805
4839
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
4806
4840
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|