aws-sdk-connect 1.134.0 → 1.136.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ce6fdd94a84dd02f31c43ba3dc9306abce8ccfcff6502d199db6bb651f74a752
4
- data.tar.gz: 3ff5eba413b29c6f08c1c262f204b2146c223a2dc9fd9f6db355e711fba19ae8
3
+ metadata.gz: ec9fe11c1bd800473d36f4c9c13cf18626ae44a232d805366a3ae9ff4157f3fa
4
+ data.tar.gz: 336b4c3219526f2bf1096fb38dba5fe0b11b64881d273b9aae17ee185a1b398f
5
5
  SHA512:
6
- metadata.gz: d8ab1d3ca621875c98780cfdf0e509a2e62f55d7243728368c8e08ac4870f688b7873bae980e788ecca6ed2c4f73d5538bcb56babac8a9f083b1f5a2de665d7d
7
- data.tar.gz: 2f8b4105d238ea93efe9fae7dba69227dd5565e5e392739c4bc355430e0a41e1a30e3dfd169d4822ae7762e6ce77dc72172a2783fb0de0cb898860d49b2adcd8
6
+ metadata.gz: ba23af8c4c408b11168cdcb6b11a00a0563834e6858c0983a9aa96093b568b0bfe8348f8fbab038a72ecd6565f9f58266c9c825d29056d521e753e5f9102769c
7
+ data.tar.gz: c818da384bbf75fd3a1a7359ff079e47795643c7688a0f193252df17babb81a1e7dbba49d5fa338aaefb0bed9c3f5b91fe704afc2c272156a78b03cbd108141a
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.136.0 (2023-11-08)
5
+ ------------------
6
+
7
+ * Feature - This release clarifies in our public documentation that InstanceId is a requirement for SearchUsers API requests.
8
+
9
+ 1.135.0 (2023-11-06)
10
+ ------------------
11
+
12
+ * Feature - Added new API that allows Amazon Connect Outbound Campaigns to create contacts in Amazon Connect when ingesting your dial requests.
13
+
4
14
  1.134.0 (2023-11-03)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.134.0
1
+ 1.136.0
@@ -963,6 +963,98 @@ module Aws::Connect
963
963
  req.send_request(options)
964
964
  end
965
965
 
966
+ # <note markdown="1"> Only the Amazon Connect outbound campaigns service principal is
967
+ # allowed to assume a role in your account and call this API.
968
+ #
969
+ # </note>
970
+ #
971
+ # Allows you to create a batch of contacts in Amazon Connect. The
972
+ # outbound campaigns capability ingests dial requests via the
973
+ # [PutDialRequestBatch][1] API. It then uses BatchPutContact to create
974
+ # contacts corresponding to those dial requests. If agents are
975
+ # available, the dial requests are dialed out, which results in a voice
976
+ # call. The resulting voice call uses the same contactId that was
977
+ # created by BatchPutContact.
978
+ #
979
+ #
980
+ #
981
+ # [1]: https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html
982
+ #
983
+ # @option params [String] :client_token
984
+ # A unique, case-sensitive identifier that you provide to ensure the
985
+ # idempotency of the request. If not provided, the Amazon Web Services
986
+ # SDK populates this field. For more information about idempotency, see
987
+ # [Making retries safe with idempotent APIs][1].
988
+ #
989
+ # **A suitable default value is auto-generated.** You should normally
990
+ # not need to pass this option.**
991
+ #
992
+ #
993
+ #
994
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
995
+ #
996
+ # @option params [required, String] :instance_id
997
+ # The identifier of the Amazon Connect instance. You can [find the
998
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
999
+ #
1000
+ #
1001
+ #
1002
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
1003
+ #
1004
+ # @option params [required, Array<Types::ContactDataRequest>] :contact_data_request_list
1005
+ # List of individual contact requests.
1006
+ #
1007
+ # @return [Types::BatchPutContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1008
+ #
1009
+ # * {Types::BatchPutContactResponse#successful_request_list #successful_request_list} => Array&lt;Types::SuccessfulRequest&gt;
1010
+ # * {Types::BatchPutContactResponse#failed_request_list #failed_request_list} => Array&lt;Types::FailedRequest&gt;
1011
+ #
1012
+ # @example Request syntax with placeholder values
1013
+ #
1014
+ # resp = client.batch_put_contact({
1015
+ # client_token: "ClientToken",
1016
+ # instance_id: "InstanceId", # required
1017
+ # contact_data_request_list: [ # required
1018
+ # {
1019
+ # system_endpoint: {
1020
+ # type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW
1021
+ # address: "EndpointAddress",
1022
+ # },
1023
+ # customer_endpoint: {
1024
+ # type: "TELEPHONE_NUMBER", # accepts TELEPHONE_NUMBER, VOIP, CONTACT_FLOW
1025
+ # address: "EndpointAddress",
1026
+ # },
1027
+ # request_identifier: "RequestIdentifier",
1028
+ # queue_id: "QueueId",
1029
+ # attributes: {
1030
+ # "AttributeName" => "AttributeValue",
1031
+ # },
1032
+ # campaign: {
1033
+ # campaign_id: "CampaignId",
1034
+ # },
1035
+ # },
1036
+ # ],
1037
+ # })
1038
+ #
1039
+ # @example Response structure
1040
+ #
1041
+ # resp.successful_request_list #=> Array
1042
+ # resp.successful_request_list[0].request_identifier #=> String
1043
+ # resp.successful_request_list[0].contact_id #=> String
1044
+ # resp.failed_request_list #=> Array
1045
+ # resp.failed_request_list[0].request_identifier #=> String
1046
+ # resp.failed_request_list[0].failure_reason_code #=> String, one of "INVALID_ATTRIBUTE_KEY", "INVALID_CUSTOMER_ENDPOINT", "INVALID_SYSTEM_ENDPOINT", "INVALID_QUEUE", "MISSING_CAMPAIGN", "MISSING_CUSTOMER_ENDPOINT", "MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT", "REQUEST_THROTTLED", "IDEMPOTENCY_EXCEPTION", "INTERNAL_ERROR"
1047
+ # resp.failed_request_list[0].failure_reason_message #=> String
1048
+ #
1049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchPutContact AWS API Documentation
1050
+ #
1051
+ # @overload batch_put_contact(params = {})
1052
+ # @param [Hash] params ({})
1053
+ def batch_put_contact(params = {}, options = {})
1054
+ req = build_request(:batch_put_contact, params)
1055
+ req.send_request(options)
1056
+ end
1057
+
966
1058
  # Claims an available phone number to your Amazon Connect instance or
967
1059
  # traffic distribution group. You can call this API only in the same
968
1060
  # Amazon Web Services Region where the Amazon Connect instance or
@@ -10554,7 +10646,7 @@ module Aws::Connect
10554
10646
  #
10555
10647
  # </note>
10556
10648
  #
10557
- # @option params [String] :instance_id
10649
+ # @option params [required, String] :instance_id
10558
10650
  # The identifier of the Amazon Connect instance. You can [find the
10559
10651
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
10560
10652
  #
@@ -10599,7 +10691,7 @@ module Aws::Connect
10599
10691
  # @example Request syntax with placeholder values
10600
10692
  #
10601
10693
  # resp = client.search_users({
10602
- # instance_id: "InstanceId",
10694
+ # instance_id: "InstanceId", # required
10603
10695
  # next_token: "NextToken2500",
10604
10696
  # max_results: 1,
10605
10697
  # search_filter: {
@@ -11464,6 +11556,10 @@ module Aws::Connect
11464
11556
  #
11465
11557
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
11466
11558
  #
11559
+ # @option params [Types::DisconnectReason] :disconnect_reason
11560
+ # The reason a contact can be disconnected. Only Amazon Connect outbound
11561
+ # campaigns can provide this field.
11562
+ #
11467
11563
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
11468
11564
  #
11469
11565
  # @example Request syntax with placeholder values
@@ -11471,6 +11567,9 @@ module Aws::Connect
11471
11567
  # resp = client.stop_contact({
11472
11568
  # contact_id: "ContactId", # required
11473
11569
  # instance_id: "InstanceId", # required
11570
+ # disconnect_reason: {
11571
+ # code: "DisconnectReasonCode",
11572
+ # },
11474
11573
  # })
11475
11574
  #
11476
11575
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContact AWS API Documentation
@@ -14203,7 +14302,7 @@ module Aws::Connect
14203
14302
  params: params,
14204
14303
  config: config)
14205
14304
  context[:gem_name] = 'aws-sdk-connect'
14206
- context[:gem_version] = '1.134.0'
14305
+ context[:gem_version] = '1.136.0'
14207
14306
  Seahorse::Client::Request.new(handlers, context)
14208
14307
  end
14209
14308
 
@@ -79,11 +79,14 @@ module Aws::Connect
79
79
  AwsRegion = Shapes::StringShape.new(name: 'AwsRegion')
80
80
  BatchGetFlowAssociationRequest = Shapes::StructureShape.new(name: 'BatchGetFlowAssociationRequest')
81
81
  BatchGetFlowAssociationResponse = Shapes::StructureShape.new(name: 'BatchGetFlowAssociationResponse')
82
+ BatchPutContactRequest = Shapes::StructureShape.new(name: 'BatchPutContactRequest')
83
+ BatchPutContactResponse = Shapes::StructureShape.new(name: 'BatchPutContactResponse')
82
84
  BehaviorType = Shapes::StringShape.new(name: 'BehaviorType')
83
85
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
84
86
  BotName = Shapes::StringShape.new(name: 'BotName')
85
87
  BoxedBoolean = Shapes::BooleanShape.new(name: 'BoxedBoolean')
86
88
  BucketName = Shapes::StringShape.new(name: 'BucketName')
89
+ Campaign = Shapes::StructureShape.new(name: 'Campaign')
87
90
  CampaignId = Shapes::StringShape.new(name: 'CampaignId')
88
91
  Channel = Shapes::StringShape.new(name: 'Channel')
89
92
  ChannelToCountMap = Shapes::MapShape.new(name: 'ChannelToCountMap')
@@ -103,6 +106,8 @@ module Aws::Connect
103
106
  Comparison = Shapes::StringShape.new(name: 'Comparison')
104
107
  Concurrency = Shapes::IntegerShape.new(name: 'Concurrency')
105
108
  Contact = Shapes::StructureShape.new(name: 'Contact')
109
+ ContactDataRequest = Shapes::StructureShape.new(name: 'ContactDataRequest')
110
+ ContactDataRequestList = Shapes::ListShape.new(name: 'ContactDataRequestList')
106
111
  ContactFilter = Shapes::StructureShape.new(name: 'ContactFilter')
107
112
  ContactFlow = Shapes::StructureShape.new(name: 'ContactFlow')
108
113
  ContactFlowContent = Shapes::StringShape.new(name: 'ContactFlowContent')
@@ -292,6 +297,8 @@ module Aws::Connect
292
297
  DisassociateSecurityKeyRequest = Shapes::StructureShape.new(name: 'DisassociateSecurityKeyRequest')
293
298
  DisassociateTrafficDistributionGroupUserRequest = Shapes::StructureShape.new(name: 'DisassociateTrafficDistributionGroupUserRequest')
294
299
  DisassociateTrafficDistributionGroupUserResponse = Shapes::StructureShape.new(name: 'DisassociateTrafficDistributionGroupUserResponse')
300
+ DisconnectReason = Shapes::StructureShape.new(name: 'DisconnectReason')
301
+ DisconnectReasonCode = Shapes::StringShape.new(name: 'DisconnectReasonCode')
295
302
  DismissUserContactRequest = Shapes::StructureShape.new(name: 'DismissUserContactRequest')
296
303
  DismissUserContactResponse = Shapes::StructureShape.new(name: 'DismissUserContactResponse')
297
304
  DisplayName = Shapes::StringShape.new(name: 'DisplayName')
@@ -302,6 +309,9 @@ module Aws::Connect
302
309
  EmailReference = Shapes::StructureShape.new(name: 'EmailReference')
303
310
  EncryptionConfig = Shapes::StructureShape.new(name: 'EncryptionConfig')
304
311
  EncryptionType = Shapes::StringShape.new(name: 'EncryptionType')
312
+ Endpoint = Shapes::StructureShape.new(name: 'Endpoint')
313
+ EndpointAddress = Shapes::StringShape.new(name: 'EndpointAddress')
314
+ EndpointType = Shapes::StringShape.new(name: 'EndpointType')
305
315
  Evaluation = Shapes::StructureShape.new(name: 'Evaluation')
306
316
  EvaluationAnswerData = Shapes::UnionShape.new(name: 'EvaluationAnswerData')
307
317
  EvaluationAnswerDataNumericValue = Shapes::FloatShape.new(name: 'EvaluationAnswerDataNumericValue')
@@ -359,6 +369,9 @@ module Aws::Connect
359
369
  EventBridgeActionDefinition = Shapes::StructureShape.new(name: 'EventBridgeActionDefinition')
360
370
  EventBridgeActionName = Shapes::StringShape.new(name: 'EventBridgeActionName')
361
371
  EventSourceName = Shapes::StringShape.new(name: 'EventSourceName')
372
+ FailedRequest = Shapes::StructureShape.new(name: 'FailedRequest')
373
+ FailedRequestList = Shapes::ListShape.new(name: 'FailedRequestList')
374
+ FailureReasonCode = Shapes::StringShape.new(name: 'FailureReasonCode')
362
375
  FilterV2 = Shapes::StructureShape.new(name: 'FilterV2')
363
376
  FilterValueList = Shapes::ListShape.new(name: 'FilterValueList')
364
377
  Filters = Shapes::StructureShape.new(name: 'Filters')
@@ -701,6 +714,7 @@ module Aws::Connect
701
714
  ReleasePhoneNumberRequest = Shapes::StructureShape.new(name: 'ReleasePhoneNumberRequest')
702
715
  ReplicateInstanceRequest = Shapes::StructureShape.new(name: 'ReplicateInstanceRequest')
703
716
  ReplicateInstanceResponse = Shapes::StructureShape.new(name: 'ReplicateInstanceResponse')
717
+ RequestIdentifier = Shapes::StringShape.new(name: 'RequestIdentifier')
704
718
  RequiredFieldInfo = Shapes::StructureShape.new(name: 'RequiredFieldInfo')
705
719
  RequiredTaskTemplateFields = Shapes::ListShape.new(name: 'RequiredTaskTemplateFields')
706
720
  ResourceArnOrId = Shapes::StringShape.new(name: 'ResourceArnOrId')
@@ -824,6 +838,8 @@ module Aws::Connect
824
838
  Subject = Shapes::StringShape.new(name: 'Subject')
825
839
  SubmitContactEvaluationRequest = Shapes::StructureShape.new(name: 'SubmitContactEvaluationRequest')
826
840
  SubmitContactEvaluationResponse = Shapes::StructureShape.new(name: 'SubmitContactEvaluationResponse')
841
+ SuccessfulRequest = Shapes::StructureShape.new(name: 'SuccessfulRequest')
842
+ SuccessfulRequestList = Shapes::ListShape.new(name: 'SuccessfulRequestList')
827
843
  SupportedMessagingContentType = Shapes::StringShape.new(name: 'SupportedMessagingContentType')
828
844
  SupportedMessagingContentTypes = Shapes::ListShape.new(name: 'SupportedMessagingContentTypes')
829
845
  SuspendContactRecordingRequest = Shapes::StructureShape.new(name: 'SuspendContactRecordingRequest')
@@ -1197,6 +1213,18 @@ module Aws::Connect
1197
1213
  BatchGetFlowAssociationResponse.add_member(:flow_association_summary_list, Shapes::ShapeRef.new(shape: FlowAssociationSummaryList, location_name: "FlowAssociationSummaryList"))
1198
1214
  BatchGetFlowAssociationResponse.struct_class = Types::BatchGetFlowAssociationResponse
1199
1215
 
1216
+ BatchPutContactRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
1217
+ BatchPutContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
1218
+ BatchPutContactRequest.add_member(:contact_data_request_list, Shapes::ShapeRef.new(shape: ContactDataRequestList, required: true, location_name: "ContactDataRequestList"))
1219
+ BatchPutContactRequest.struct_class = Types::BatchPutContactRequest
1220
+
1221
+ BatchPutContactResponse.add_member(:successful_request_list, Shapes::ShapeRef.new(shape: SuccessfulRequestList, location_name: "SuccessfulRequestList"))
1222
+ BatchPutContactResponse.add_member(:failed_request_list, Shapes::ShapeRef.new(shape: FailedRequestList, location_name: "FailedRequestList"))
1223
+ BatchPutContactResponse.struct_class = Types::BatchPutContactResponse
1224
+
1225
+ Campaign.add_member(:campaign_id, Shapes::ShapeRef.new(shape: CampaignId, location_name: "CampaignId"))
1226
+ Campaign.struct_class = Types::Campaign
1227
+
1200
1228
  ChannelToCountMap.key = Shapes::ShapeRef.new(shape: Channel)
1201
1229
  ChannelToCountMap.value = Shapes::ShapeRef.new(shape: IntegerCount)
1202
1230
 
@@ -1254,6 +1282,16 @@ module Aws::Connect
1254
1282
  Contact.add_member(:wisdom_info, Shapes::ShapeRef.new(shape: WisdomInfo, location_name: "WisdomInfo"))
1255
1283
  Contact.struct_class = Types::Contact
1256
1284
 
1285
+ ContactDataRequest.add_member(:system_endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "SystemEndpoint"))
1286
+ ContactDataRequest.add_member(:customer_endpoint, Shapes::ShapeRef.new(shape: Endpoint, location_name: "CustomerEndpoint"))
1287
+ ContactDataRequest.add_member(:request_identifier, Shapes::ShapeRef.new(shape: RequestIdentifier, location_name: "RequestIdentifier"))
1288
+ ContactDataRequest.add_member(:queue_id, Shapes::ShapeRef.new(shape: QueueId, location_name: "QueueId"))
1289
+ ContactDataRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: Attributes, location_name: "Attributes"))
1290
+ ContactDataRequest.add_member(:campaign, Shapes::ShapeRef.new(shape: Campaign, location_name: "Campaign"))
1291
+ ContactDataRequest.struct_class = Types::ContactDataRequest
1292
+
1293
+ ContactDataRequestList.member = Shapes::ShapeRef.new(shape: ContactDataRequest)
1294
+
1257
1295
  ContactFilter.add_member(:contact_states, Shapes::ShapeRef.new(shape: ContactStates, location_name: "ContactStates"))
1258
1296
  ContactFilter.struct_class = Types::ContactFilter
1259
1297
 
@@ -1966,6 +2004,9 @@ module Aws::Connect
1966
2004
 
1967
2005
  DisassociateTrafficDistributionGroupUserResponse.struct_class = Types::DisassociateTrafficDistributionGroupUserResponse
1968
2006
 
2007
+ DisconnectReason.add_member(:code, Shapes::ShapeRef.new(shape: DisconnectReasonCode, location_name: "Code"))
2008
+ DisconnectReason.struct_class = Types::DisconnectReason
2009
+
1969
2010
  DismissUserContactRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, required: true, location: "uri", location_name: "UserId"))
1970
2011
  DismissUserContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "uri", location_name: "InstanceId"))
1971
2012
  DismissUserContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
@@ -1990,6 +2031,10 @@ module Aws::Connect
1990
2031
  EncryptionConfig.add_member(:key_id, Shapes::ShapeRef.new(shape: KeyId, required: true, location_name: "KeyId"))
1991
2032
  EncryptionConfig.struct_class = Types::EncryptionConfig
1992
2033
 
2034
+ Endpoint.add_member(:type, Shapes::ShapeRef.new(shape: EndpointType, location_name: "Type"))
2035
+ Endpoint.add_member(:address, Shapes::ShapeRef.new(shape: EndpointAddress, location_name: "Address"))
2036
+ Endpoint.struct_class = Types::Endpoint
2037
+
1993
2038
  Evaluation.add_member(:evaluation_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "EvaluationId"))
1994
2039
  Evaluation.add_member(:evaluation_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "EvaluationArn"))
1995
2040
  Evaluation.add_member(:metadata, Shapes::ShapeRef.new(shape: EvaluationMetadata, required: true, location_name: "Metadata"))
@@ -2197,6 +2242,13 @@ module Aws::Connect
2197
2242
  EventBridgeActionDefinition.add_member(:name, Shapes::ShapeRef.new(shape: EventBridgeActionName, required: true, location_name: "Name"))
2198
2243
  EventBridgeActionDefinition.struct_class = Types::EventBridgeActionDefinition
2199
2244
 
2245
+ FailedRequest.add_member(:request_identifier, Shapes::ShapeRef.new(shape: RequestIdentifier, location_name: "RequestIdentifier"))
2246
+ FailedRequest.add_member(:failure_reason_code, Shapes::ShapeRef.new(shape: FailureReasonCode, location_name: "FailureReasonCode"))
2247
+ FailedRequest.add_member(:failure_reason_message, Shapes::ShapeRef.new(shape: String, location_name: "FailureReasonMessage"))
2248
+ FailedRequest.struct_class = Types::FailedRequest
2249
+
2250
+ FailedRequestList.member = Shapes::ShapeRef.new(shape: FailedRequest)
2251
+
2200
2252
  FilterV2.add_member(:filter_key, Shapes::ShapeRef.new(shape: ResourceArnOrId, location_name: "FilterKey"))
2201
2253
  FilterV2.add_member(:filter_values, Shapes::ShapeRef.new(shape: FilterValueList, location_name: "FilterValues"))
2202
2254
  FilterV2.struct_class = Types::FilterV2
@@ -3517,7 +3569,7 @@ module Aws::Connect
3517
3569
  SearchSecurityProfilesResponse.add_member(:approximate_total_count, Shapes::ShapeRef.new(shape: ApproximateTotalCount, location_name: "ApproximateTotalCount"))
3518
3570
  SearchSecurityProfilesResponse.struct_class = Types::SearchSecurityProfilesResponse
3519
3571
 
3520
- SearchUsersRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, location_name: "InstanceId"))
3572
+ SearchUsersRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
3521
3573
  SearchUsersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken2500, location_name: "NextToken"))
3522
3574
  SearchUsersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResult100, location_name: "MaxResults", metadata: {"box"=>true}))
3523
3575
  SearchUsersRequest.add_member(:search_filter, Shapes::ShapeRef.new(shape: UserSearchFilter, location_name: "SearchFilter"))
@@ -3703,6 +3755,7 @@ module Aws::Connect
3703
3755
 
3704
3756
  StopContactRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, required: true, location_name: "ContactId"))
3705
3757
  StopContactRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
3758
+ StopContactRequest.add_member(:disconnect_reason, Shapes::ShapeRef.new(shape: DisconnectReason, location_name: "DisconnectReason"))
3706
3759
  StopContactRequest.struct_class = Types::StopContactRequest
3707
3760
 
3708
3761
  StopContactResponse.struct_class = Types::StopContactResponse
@@ -3733,6 +3786,12 @@ module Aws::Connect
3733
3786
  SubmitContactEvaluationResponse.add_member(:evaluation_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "EvaluationArn"))
3734
3787
  SubmitContactEvaluationResponse.struct_class = Types::SubmitContactEvaluationResponse
3735
3788
 
3789
+ SuccessfulRequest.add_member(:request_identifier, Shapes::ShapeRef.new(shape: RequestIdentifier, location_name: "RequestIdentifier"))
3790
+ SuccessfulRequest.add_member(:contact_id, Shapes::ShapeRef.new(shape: ContactId, location_name: "ContactId"))
3791
+ SuccessfulRequest.struct_class = Types::SuccessfulRequest
3792
+
3793
+ SuccessfulRequestList.member = Shapes::ShapeRef.new(shape: SuccessfulRequest)
3794
+
3736
3795
  SupportedMessagingContentTypes.member = Shapes::ShapeRef.new(shape: SupportedMessagingContentType)
3737
3796
 
3738
3797
  SuspendContactRecordingRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
@@ -4588,6 +4647,20 @@ module Aws::Connect
4588
4647
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
4589
4648
  end)
4590
4649
 
4650
+ api.add_operation(:batch_put_contact, Seahorse::Model::Operation.new.tap do |o|
4651
+ o.name = "BatchPutContact"
4652
+ o.http_method = "PUT"
4653
+ o.http_request_uri = "/contact/batch/{InstanceId}"
4654
+ o.input = Shapes::ShapeRef.new(shape: BatchPutContactRequest)
4655
+ o.output = Shapes::ShapeRef.new(shape: BatchPutContactResponse)
4656
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
4657
+ o.errors << Shapes::ShapeRef.new(shape: InternalServiceException)
4658
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
4659
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
4660
+ o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
4661
+ o.errors << Shapes::ShapeRef.new(shape: IdempotencyException)
4662
+ end)
4663
+
4591
4664
  api.add_operation(:claim_phone_number, Seahorse::Model::Operation.new.tap do |o|
4592
4665
  o.name = "ClaimPhoneNumber"
4593
4666
  o.http_method = "POST"
@@ -194,6 +194,20 @@ module Aws::Connect
194
194
  end
195
195
  end
196
196
 
197
+ class BatchPutContact
198
+ def self.build(context)
199
+ unless context.config.regional_endpoint
200
+ endpoint = context.config.endpoint.to_s
201
+ end
202
+ Aws::Connect::EndpointParameters.new(
203
+ region: context.config.region,
204
+ use_dual_stack: context.config.use_dualstack_endpoint,
205
+ use_fips: context.config.use_fips_endpoint,
206
+ endpoint: endpoint,
207
+ )
208
+ end
209
+ end
210
+
197
211
  class ClaimPhoneNumber
198
212
  def self.build(context)
199
213
  unless context.config.regional_endpoint
@@ -82,6 +82,8 @@ module Aws::Connect
82
82
  Aws::Connect::Endpoints::AssociateTrafficDistributionGroupUser.build(context)
83
83
  when :batch_get_flow_association
84
84
  Aws::Connect::Endpoints::BatchGetFlowAssociation.build(context)
85
+ when :batch_put_contact
86
+ Aws::Connect::Endpoints::BatchPutContact.build(context)
85
87
  when :claim_phone_number
86
88
  Aws::Connect::Endpoints::ClaimPhoneNumber.build(context)
87
89
  when :create_agent_status
@@ -788,6 +788,74 @@ module Aws::Connect
788
788
  include Aws::Structure
789
789
  end
790
790
 
791
+ # @!attribute [rw] client_token
792
+ # A unique, case-sensitive identifier that you provide to ensure the
793
+ # idempotency of the request. If not provided, the Amazon Web Services
794
+ # SDK populates this field. For more information about idempotency,
795
+ # see [Making retries safe with idempotent APIs][1].
796
+ #
797
+ # **A suitable default value is auto-generated.** You should normally
798
+ # not need to pass this option.
799
+ #
800
+ #
801
+ #
802
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
803
+ # @return [String]
804
+ #
805
+ # @!attribute [rw] instance_id
806
+ # The identifier of the Amazon Connect instance. You can [find the
807
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
808
+ #
809
+ #
810
+ #
811
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
812
+ # @return [String]
813
+ #
814
+ # @!attribute [rw] contact_data_request_list
815
+ # List of individual contact requests.
816
+ # @return [Array<Types::ContactDataRequest>]
817
+ #
818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchPutContactRequest AWS API Documentation
819
+ #
820
+ class BatchPutContactRequest < Struct.new(
821
+ :client_token,
822
+ :instance_id,
823
+ :contact_data_request_list)
824
+ SENSITIVE = []
825
+ include Aws::Structure
826
+ end
827
+
828
+ # @!attribute [rw] successful_request_list
829
+ # List of requests for which contact was successfully created.
830
+ # @return [Array<Types::SuccessfulRequest>]
831
+ #
832
+ # @!attribute [rw] failed_request_list
833
+ # List of requests for which contact creation failed.
834
+ # @return [Array<Types::FailedRequest>]
835
+ #
836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchPutContactResponse AWS API Documentation
837
+ #
838
+ class BatchPutContactResponse < Struct.new(
839
+ :successful_request_list,
840
+ :failed_request_list)
841
+ SENSITIVE = []
842
+ include Aws::Structure
843
+ end
844
+
845
+ # Information associated with a campaign.
846
+ #
847
+ # @!attribute [rw] campaign_id
848
+ # A unique identifier for a campaign.
849
+ # @return [String]
850
+ #
851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Campaign AWS API Documentation
852
+ #
853
+ class Campaign < Struct.new(
854
+ :campaign_id)
855
+ SENSITIVE = []
856
+ include Aws::Structure
857
+ end
858
+
791
859
  # A chat message.
792
860
  #
793
861
  # @!attribute [rw] content_type
@@ -1138,6 +1206,47 @@ module Aws::Connect
1138
1206
  include Aws::Structure
1139
1207
  end
1140
1208
 
1209
+ # Request object with information to create a contact.
1210
+ #
1211
+ # @!attribute [rw] system_endpoint
1212
+ # Endpoint associated with the Amazon Connect instance from which
1213
+ # outbound contact will be initiated for the campaign.
1214
+ # @return [Types::Endpoint]
1215
+ #
1216
+ # @!attribute [rw] customer_endpoint
1217
+ # Endpoint of the customer for which contact will be initiated.
1218
+ # @return [Types::Endpoint]
1219
+ #
1220
+ # @!attribute [rw] request_identifier
1221
+ # Identifier to uniquely identify individual requests in the batch.
1222
+ # @return [String]
1223
+ #
1224
+ # @!attribute [rw] queue_id
1225
+ # The identifier of the queue associated with the Amazon Connect
1226
+ # instance in which contacts that are created will be queued.
1227
+ # @return [String]
1228
+ #
1229
+ # @!attribute [rw] attributes
1230
+ # List of attributes to be stored in a contact.
1231
+ # @return [Hash<String,String>]
1232
+ #
1233
+ # @!attribute [rw] campaign
1234
+ # Structure to store information associated with a campaign.
1235
+ # @return [Types::Campaign]
1236
+ #
1237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactDataRequest AWS API Documentation
1238
+ #
1239
+ class ContactDataRequest < Struct.new(
1240
+ :system_endpoint,
1241
+ :customer_endpoint,
1242
+ :request_identifier,
1243
+ :queue_id,
1244
+ :attributes,
1245
+ :campaign)
1246
+ SENSITIVE = []
1247
+ include Aws::Structure
1248
+ end
1249
+
1141
1250
  # Filters user data based on the contact information that is associated
1142
1251
  # to the users. It contains a list of [contact states][1].
1143
1252
  #
@@ -4874,6 +4983,21 @@ module Aws::Connect
4874
4983
  #
4875
4984
  class DisassociateTrafficDistributionGroupUserResponse < Aws::EmptyStructure; end
4876
4985
 
4986
+ # Contains details about why a contact was disconnected. Only Amazon
4987
+ # Connect outbound campaigns can provide this field.
4988
+ #
4989
+ # @!attribute [rw] code
4990
+ # A code that indicates how the contact was terminated.
4991
+ # @return [String]
4992
+ #
4993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisconnectReason AWS API Documentation
4994
+ #
4995
+ class DisconnectReason < Struct.new(
4996
+ :code)
4997
+ SENSITIVE = []
4998
+ include Aws::Structure
4999
+ end
5000
+
4877
5001
  # @!attribute [rw] user_id
4878
5002
  # The identifier of the user account.
4879
5003
  # @return [String]
@@ -4985,6 +5109,25 @@ module Aws::Connect
4985
5109
  include Aws::Structure
4986
5110
  end
4987
5111
 
5112
+ # Information about the endpoint.
5113
+ #
5114
+ # @!attribute [rw] type
5115
+ # Type of the endpoint.
5116
+ # @return [String]
5117
+ #
5118
+ # @!attribute [rw] address
5119
+ # Address of the endpoint.
5120
+ # @return [String]
5121
+ #
5122
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Endpoint AWS API Documentation
5123
+ #
5124
+ class Endpoint < Struct.new(
5125
+ :type,
5126
+ :address)
5127
+ SENSITIVE = []
5128
+ include Aws::Structure
5129
+ end
5130
+
4988
5131
  # Information about a contact evaluation.
4989
5132
  #
4990
5133
  # @!attribute [rw] evaluation_id
@@ -5860,6 +6003,31 @@ module Aws::Connect
5860
6003
  include Aws::Structure
5861
6004
  end
5862
6005
 
6006
+ # Request for which contact failed to be generated.
6007
+ #
6008
+ # @!attribute [rw] request_identifier
6009
+ # Request identifier provided in the API call in the
6010
+ # ContactDataRequest to create a contact.
6011
+ # @return [String]
6012
+ #
6013
+ # @!attribute [rw] failure_reason_code
6014
+ # Reason code for the failure.
6015
+ # @return [String]
6016
+ #
6017
+ # @!attribute [rw] failure_reason_message
6018
+ # Why the request to create a contact failed.
6019
+ # @return [String]
6020
+ #
6021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/FailedRequest AWS API Documentation
6022
+ #
6023
+ class FailedRequest < Struct.new(
6024
+ :request_identifier,
6025
+ :failure_reason_code,
6026
+ :failure_reason_message)
6027
+ SENSITIVE = []
6028
+ include Aws::Structure
6029
+ end
6030
+
5863
6031
  # Contains the filter to apply when retrieving metrics with the
5864
6032
  # [GetMetricDataV2][1] API.
5865
6033
  #
@@ -14334,11 +14502,17 @@ module Aws::Connect
14334
14502
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
14335
14503
  # @return [String]
14336
14504
  #
14505
+ # @!attribute [rw] disconnect_reason
14506
+ # The reason a contact can be disconnected. Only Amazon Connect
14507
+ # outbound campaigns can provide this field.
14508
+ # @return [Types::DisconnectReason]
14509
+ #
14337
14510
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRequest AWS API Documentation
14338
14511
  #
14339
14512
  class StopContactRequest < Struct.new(
14340
14513
  :contact_id,
14341
- :instance_id)
14514
+ :instance_id,
14515
+ :disconnect_reason)
14342
14516
  SENSITIVE = []
14343
14517
  include Aws::Structure
14344
14518
  end
@@ -14474,6 +14648,26 @@ module Aws::Connect
14474
14648
  include Aws::Structure
14475
14649
  end
14476
14650
 
14651
+ # Request for which contact was successfully created.
14652
+ #
14653
+ # @!attribute [rw] request_identifier
14654
+ # Request identifier provided in the API call in the
14655
+ # ContactDataRequest to create a contact.
14656
+ # @return [String]
14657
+ #
14658
+ # @!attribute [rw] contact_id
14659
+ # The contactId of the contact that was created successfully.
14660
+ # @return [String]
14661
+ #
14662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SuccessfulRequest AWS API Documentation
14663
+ #
14664
+ class SuccessfulRequest < Struct.new(
14665
+ :request_identifier,
14666
+ :contact_id)
14667
+ SENSITIVE = []
14668
+ include Aws::Structure
14669
+ end
14670
+
14477
14671
  # @!attribute [rw] instance_id
14478
14672
  # The identifier of the Amazon Connect instance. You can [find the
14479
14673
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-connect/customizations'
52
52
  # @!group service
53
53
  module Aws::Connect
54
54
 
55
- GEM_VERSION = '1.134.0'
55
+ GEM_VERSION = '1.136.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-connect
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.134.0
4
+ version: 1.136.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-03 00:00:00.000000000 Z
11
+ date: 2023-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core