aws-sdk-connectcampaignsv2 1.0.0 → 1.1.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-connectcampaignsv2/client.rb +54 -1
- data/lib/aws-sdk-connectcampaignsv2/client_api.rb +60 -0
- data/lib/aws-sdk-connectcampaignsv2/types.rb +128 -0
- data/lib/aws-sdk-connectcampaignsv2.rb +1 -1
- data/sig/client.rbs +26 -2
- data/sig/types.rbs +40 -0
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e46b2403530cda4eef6c6f8afe0f820f31914f011edac69d9f0d6fd7f853ba07
|
4
|
+
data.tar.gz: a35c8793f559a3517388f738c6cdb0c8faf0e57412acca9a9a562209ddd33f70
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ebcdfb3dfb25bc80b5b2b11e00ba7860fe696647f9191a7156d4b23262fe03cca4d9c040b493dbad57b563a4876ad50cf72afd7e55dfe1b4790df52b24b58f90
|
7
|
+
data.tar.gz: 36c549cc1bea29f954cfb1561b37102e5d1975acd22a437ea6e8178d4f7729d4fa0764ce8a4fe6b40a82df273bfca8e172131406e99e71566ce32c6ca34f8417
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.1.0
|
@@ -537,6 +537,9 @@ module Aws::ConnectCampaignsV2
|
|
537
537
|
# },
|
538
538
|
# source: {
|
539
539
|
# customer_profiles_segment_arn: "Arn",
|
540
|
+
# event_trigger: {
|
541
|
+
# customer_profiles_domain_arn: "Arn",
|
542
|
+
# },
|
540
543
|
# },
|
541
544
|
# connect_campaign_flow_arn: "Arn",
|
542
545
|
# schedule: {
|
@@ -868,6 +871,7 @@ module Aws::ConnectCampaignsV2
|
|
868
871
|
# resp.campaign.channel_subtype_config.email.default_outbound_config.source_email_address_display_name #=> String
|
869
872
|
# resp.campaign.channel_subtype_config.email.default_outbound_config.wisdom_template_arn #=> String
|
870
873
|
# resp.campaign.source.customer_profiles_segment_arn #=> String
|
874
|
+
# resp.campaign.source.event_trigger.customer_profiles_domain_arn #=> String
|
871
875
|
# resp.campaign.connect_campaign_flow_arn #=> String
|
872
876
|
# resp.campaign.schedule.start_time #=> Time
|
873
877
|
# resp.campaign.schedule.end_time #=> Time
|
@@ -1302,6 +1306,52 @@ module Aws::ConnectCampaignsV2
|
|
1302
1306
|
req.send_request(options)
|
1303
1307
|
end
|
1304
1308
|
|
1309
|
+
# Takes in a list of profile outbound requests to be placed as part of
|
1310
|
+
# an outbound campaign. This API is idempotent.
|
1311
|
+
#
|
1312
|
+
# @option params [required, String] :id
|
1313
|
+
# Identifier representing a Campaign
|
1314
|
+
#
|
1315
|
+
# @option params [required, Array<Types::ProfileOutboundRequest>] :profile_outbound_requests
|
1316
|
+
# List of profile outbound requests
|
1317
|
+
#
|
1318
|
+
# @return [Types::PutProfileOutboundRequestBatchResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1319
|
+
#
|
1320
|
+
# * {Types::PutProfileOutboundRequestBatchResponse#successful_requests #successful_requests} => Array<Types::SuccessfulProfileOutboundRequest>
|
1321
|
+
# * {Types::PutProfileOutboundRequestBatchResponse#failed_requests #failed_requests} => Array<Types::FailedProfileOutboundRequest>
|
1322
|
+
#
|
1323
|
+
# @example Request syntax with placeholder values
|
1324
|
+
#
|
1325
|
+
# resp = client.put_profile_outbound_request_batch({
|
1326
|
+
# id: "CampaignId", # required
|
1327
|
+
# profile_outbound_requests: [ # required
|
1328
|
+
# {
|
1329
|
+
# client_token: "ClientToken", # required
|
1330
|
+
# profile_id: "ProfileId", # required
|
1331
|
+
# expiration_time: Time.now,
|
1332
|
+
# },
|
1333
|
+
# ],
|
1334
|
+
# })
|
1335
|
+
#
|
1336
|
+
# @example Response structure
|
1337
|
+
#
|
1338
|
+
# resp.successful_requests #=> Array
|
1339
|
+
# resp.successful_requests[0].client_token #=> String
|
1340
|
+
# resp.successful_requests[0].id #=> String
|
1341
|
+
# resp.failed_requests #=> Array
|
1342
|
+
# resp.failed_requests[0].client_token #=> String
|
1343
|
+
# resp.failed_requests[0].id #=> String
|
1344
|
+
# resp.failed_requests[0].failure_code #=> String, one of "UnknownError", "ResourceNotFound", "Conflict", "RequestThrottled", "InvalidInput"
|
1345
|
+
#
|
1346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch AWS API Documentation
|
1347
|
+
#
|
1348
|
+
# @overload put_profile_outbound_request_batch(params = {})
|
1349
|
+
# @param [Hash] params ({})
|
1350
|
+
def put_profile_outbound_request_batch(params = {}, options = {})
|
1351
|
+
req = build_request(:put_profile_outbound_request_batch, params)
|
1352
|
+
req.send_request(options)
|
1353
|
+
end
|
1354
|
+
|
1305
1355
|
# Stops a campaign for the specified Amazon Connect account.
|
1306
1356
|
#
|
1307
1357
|
# @option params [required, String] :id
|
@@ -1767,6 +1817,9 @@ module Aws::ConnectCampaignsV2
|
|
1767
1817
|
# id: "CampaignId", # required
|
1768
1818
|
# source: { # required
|
1769
1819
|
# customer_profiles_segment_arn: "Arn",
|
1820
|
+
# event_trigger: {
|
1821
|
+
# customer_profiles_domain_arn: "Arn",
|
1822
|
+
# },
|
1770
1823
|
# },
|
1771
1824
|
# })
|
1772
1825
|
#
|
@@ -1797,7 +1850,7 @@ module Aws::ConnectCampaignsV2
|
|
1797
1850
|
tracer: tracer
|
1798
1851
|
)
|
1799
1852
|
context[:gem_name] = 'aws-sdk-connectcampaignsv2'
|
1800
|
-
context[:gem_version] = '1.
|
1853
|
+
context[:gem_version] = '1.1.0'
|
1801
1854
|
Seahorse::Client::Request.new(handlers, context)
|
1802
1855
|
end
|
1803
1856
|
|
@@ -78,9 +78,12 @@ module Aws::ConnectCampaignsV2
|
|
78
78
|
EncryptionConfig = Shapes::StructureShape.new(name: 'EncryptionConfig')
|
79
79
|
EncryptionKey = Shapes::StringShape.new(name: 'EncryptionKey')
|
80
80
|
EncryptionType = Shapes::StringShape.new(name: 'EncryptionType')
|
81
|
+
EventTrigger = Shapes::StructureShape.new(name: 'EventTrigger')
|
81
82
|
EventType = Shapes::StringShape.new(name: 'EventType')
|
82
83
|
FailedCampaignStateResponse = Shapes::StructureShape.new(name: 'FailedCampaignStateResponse')
|
83
84
|
FailedCampaignStateResponseList = Shapes::ListShape.new(name: 'FailedCampaignStateResponseList')
|
85
|
+
FailedProfileOutboundRequest = Shapes::StructureShape.new(name: 'FailedProfileOutboundRequest')
|
86
|
+
FailedProfileOutboundRequestList = Shapes::ListShape.new(name: 'FailedProfileOutboundRequestList')
|
84
87
|
FailedRequest = Shapes::StructureShape.new(name: 'FailedRequest')
|
85
88
|
FailedRequestList = Shapes::ListShape.new(name: 'FailedRequestList')
|
86
89
|
FailureCode = Shapes::StringShape.new(name: 'FailureCode')
|
@@ -129,10 +132,17 @@ module Aws::ConnectCampaignsV2
|
|
129
132
|
OutboundRequestList = Shapes::ListShape.new(name: 'OutboundRequestList')
|
130
133
|
PauseCampaignRequest = Shapes::StructureShape.new(name: 'PauseCampaignRequest')
|
131
134
|
PredictiveConfig = Shapes::StructureShape.new(name: 'PredictiveConfig')
|
135
|
+
ProfileId = Shapes::StringShape.new(name: 'ProfileId')
|
136
|
+
ProfileOutboundRequest = Shapes::StructureShape.new(name: 'ProfileOutboundRequest')
|
137
|
+
ProfileOutboundRequestFailureCode = Shapes::StringShape.new(name: 'ProfileOutboundRequestFailureCode')
|
138
|
+
ProfileOutboundRequestId = Shapes::StringShape.new(name: 'ProfileOutboundRequestId')
|
139
|
+
ProfileOutboundRequestList = Shapes::ListShape.new(name: 'ProfileOutboundRequestList')
|
132
140
|
ProgressiveConfig = Shapes::StructureShape.new(name: 'ProgressiveConfig')
|
133
141
|
PutConnectInstanceIntegrationRequest = Shapes::StructureShape.new(name: 'PutConnectInstanceIntegrationRequest')
|
134
142
|
PutOutboundRequestBatchRequest = Shapes::StructureShape.new(name: 'PutOutboundRequestBatchRequest')
|
135
143
|
PutOutboundRequestBatchResponse = Shapes::StructureShape.new(name: 'PutOutboundRequestBatchResponse')
|
144
|
+
PutProfileOutboundRequestBatchRequest = Shapes::StructureShape.new(name: 'PutProfileOutboundRequestBatchRequest')
|
145
|
+
PutProfileOutboundRequestBatchResponse = Shapes::StructureShape.new(name: 'PutProfileOutboundRequestBatchResponse')
|
136
146
|
QConnectIntegrationConfig = Shapes::StructureShape.new(name: 'QConnectIntegrationConfig')
|
137
147
|
QConnectIntegrationIdentifier = Shapes::StructureShape.new(name: 'QConnectIntegrationIdentifier')
|
138
148
|
QConnectIntegrationSummary = Shapes::StructureShape.new(name: 'QConnectIntegrationSummary')
|
@@ -159,6 +169,8 @@ module Aws::ConnectCampaignsV2
|
|
159
169
|
String = Shapes::StringShape.new(name: 'String')
|
160
170
|
SuccessfulCampaignStateResponse = Shapes::StructureShape.new(name: 'SuccessfulCampaignStateResponse')
|
161
171
|
SuccessfulCampaignStateResponseList = Shapes::ListShape.new(name: 'SuccessfulCampaignStateResponseList')
|
172
|
+
SuccessfulProfileOutboundRequest = Shapes::StructureShape.new(name: 'SuccessfulProfileOutboundRequest')
|
173
|
+
SuccessfulProfileOutboundRequestList = Shapes::ListShape.new(name: 'SuccessfulProfileOutboundRequestList')
|
162
174
|
SuccessfulRequest = Shapes::StructureShape.new(name: 'SuccessfulRequest')
|
163
175
|
SuccessfulRequestList = Shapes::ListShape.new(name: 'SuccessfulRequestList')
|
164
176
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
@@ -359,12 +371,22 @@ module Aws::ConnectCampaignsV2
|
|
359
371
|
EncryptionConfig.add_member(:key_arn, Shapes::ShapeRef.new(shape: EncryptionKey, location_name: "keyArn"))
|
360
372
|
EncryptionConfig.struct_class = Types::EncryptionConfig
|
361
373
|
|
374
|
+
EventTrigger.add_member(:customer_profiles_domain_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "customerProfilesDomainArn"))
|
375
|
+
EventTrigger.struct_class = Types::EventTrigger
|
376
|
+
|
362
377
|
FailedCampaignStateResponse.add_member(:campaign_id, Shapes::ShapeRef.new(shape: CampaignId, location_name: "campaignId"))
|
363
378
|
FailedCampaignStateResponse.add_member(:failure_code, Shapes::ShapeRef.new(shape: GetCampaignStateBatchFailureCode, location_name: "failureCode"))
|
364
379
|
FailedCampaignStateResponse.struct_class = Types::FailedCampaignStateResponse
|
365
380
|
|
366
381
|
FailedCampaignStateResponseList.member = Shapes::ShapeRef.new(shape: FailedCampaignStateResponse)
|
367
382
|
|
383
|
+
FailedProfileOutboundRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken"))
|
384
|
+
FailedProfileOutboundRequest.add_member(:id, Shapes::ShapeRef.new(shape: ProfileOutboundRequestId, location_name: "id"))
|
385
|
+
FailedProfileOutboundRequest.add_member(:failure_code, Shapes::ShapeRef.new(shape: ProfileOutboundRequestFailureCode, location_name: "failureCode"))
|
386
|
+
FailedProfileOutboundRequest.struct_class = Types::FailedProfileOutboundRequest
|
387
|
+
|
388
|
+
FailedProfileOutboundRequestList.member = Shapes::ShapeRef.new(shape: FailedProfileOutboundRequest)
|
389
|
+
|
368
390
|
FailedRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken"))
|
369
391
|
FailedRequest.add_member(:id, Shapes::ShapeRef.new(shape: DialRequestId, location_name: "id"))
|
370
392
|
FailedRequest.add_member(:failure_code, Shapes::ShapeRef.new(shape: FailureCode, location_name: "failureCode"))
|
@@ -504,6 +526,13 @@ module Aws::ConnectCampaignsV2
|
|
504
526
|
PredictiveConfig.add_member(:bandwidth_allocation, Shapes::ShapeRef.new(shape: BandwidthAllocation, required: true, location_name: "bandwidthAllocation"))
|
505
527
|
PredictiveConfig.struct_class = Types::PredictiveConfig
|
506
528
|
|
529
|
+
ProfileOutboundRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, required: true, location_name: "clientToken"))
|
530
|
+
ProfileOutboundRequest.add_member(:profile_id, Shapes::ShapeRef.new(shape: ProfileId, required: true, location_name: "profileId"))
|
531
|
+
ProfileOutboundRequest.add_member(:expiration_time, Shapes::ShapeRef.new(shape: TimeStamp, location_name: "expirationTime"))
|
532
|
+
ProfileOutboundRequest.struct_class = Types::ProfileOutboundRequest
|
533
|
+
|
534
|
+
ProfileOutboundRequestList.member = Shapes::ShapeRef.new(shape: ProfileOutboundRequest)
|
535
|
+
|
507
536
|
ProgressiveConfig.add_member(:bandwidth_allocation, Shapes::ShapeRef.new(shape: BandwidthAllocation, required: true, location_name: "bandwidthAllocation"))
|
508
537
|
ProgressiveConfig.struct_class = Types::ProgressiveConfig
|
509
538
|
|
@@ -519,6 +548,14 @@ module Aws::ConnectCampaignsV2
|
|
519
548
|
PutOutboundRequestBatchResponse.add_member(:failed_requests, Shapes::ShapeRef.new(shape: FailedRequestList, location_name: "failedRequests"))
|
520
549
|
PutOutboundRequestBatchResponse.struct_class = Types::PutOutboundRequestBatchResponse
|
521
550
|
|
551
|
+
PutProfileOutboundRequestBatchRequest.add_member(:id, Shapes::ShapeRef.new(shape: CampaignId, required: true, location: "uri", location_name: "id"))
|
552
|
+
PutProfileOutboundRequestBatchRequest.add_member(:profile_outbound_requests, Shapes::ShapeRef.new(shape: ProfileOutboundRequestList, required: true, location_name: "profileOutboundRequests"))
|
553
|
+
PutProfileOutboundRequestBatchRequest.struct_class = Types::PutProfileOutboundRequestBatchRequest
|
554
|
+
|
555
|
+
PutProfileOutboundRequestBatchResponse.add_member(:successful_requests, Shapes::ShapeRef.new(shape: SuccessfulProfileOutboundRequestList, location_name: "successfulRequests"))
|
556
|
+
PutProfileOutboundRequestBatchResponse.add_member(:failed_requests, Shapes::ShapeRef.new(shape: FailedProfileOutboundRequestList, location_name: "failedRequests"))
|
557
|
+
PutProfileOutboundRequestBatchResponse.struct_class = Types::PutProfileOutboundRequestBatchResponse
|
558
|
+
|
522
559
|
QConnectIntegrationConfig.add_member(:knowledge_base_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "knowledgeBaseArn"))
|
523
560
|
QConnectIntegrationConfig.struct_class = Types::QConnectIntegrationConfig
|
524
561
|
|
@@ -579,8 +616,10 @@ module Aws::ConnectCampaignsV2
|
|
579
616
|
SmsOutboundMode.struct_class = Types::SmsOutboundMode
|
580
617
|
|
581
618
|
Source.add_member(:customer_profiles_segment_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "customerProfilesSegmentArn"))
|
619
|
+
Source.add_member(:event_trigger, Shapes::ShapeRef.new(shape: EventTrigger, location_name: "eventTrigger"))
|
582
620
|
Source.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
583
621
|
Source.add_member_subclass(:customer_profiles_segment_arn, Types::Source::CustomerProfilesSegmentArn)
|
622
|
+
Source.add_member_subclass(:event_trigger, Types::Source::EventTrigger)
|
584
623
|
Source.add_member_subclass(:unknown, Types::Source::Unknown)
|
585
624
|
Source.struct_class = Types::Source
|
586
625
|
|
@@ -603,6 +642,12 @@ module Aws::ConnectCampaignsV2
|
|
603
642
|
|
604
643
|
SuccessfulCampaignStateResponseList.member = Shapes::ShapeRef.new(shape: SuccessfulCampaignStateResponse)
|
605
644
|
|
645
|
+
SuccessfulProfileOutboundRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken"))
|
646
|
+
SuccessfulProfileOutboundRequest.add_member(:id, Shapes::ShapeRef.new(shape: ProfileOutboundRequestId, location_name: "id"))
|
647
|
+
SuccessfulProfileOutboundRequest.struct_class = Types::SuccessfulProfileOutboundRequest
|
648
|
+
|
649
|
+
SuccessfulProfileOutboundRequestList.member = Shapes::ShapeRef.new(shape: SuccessfulProfileOutboundRequest)
|
650
|
+
|
606
651
|
SuccessfulRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken"))
|
607
652
|
SuccessfulRequest.add_member(:id, Shapes::ShapeRef.new(shape: DialRequestId, location_name: "id"))
|
608
653
|
SuccessfulRequest.struct_class = Types::SuccessfulRequest
|
@@ -977,6 +1022,21 @@ module Aws::ConnectCampaignsV2
|
|
977
1022
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
978
1023
|
end)
|
979
1024
|
|
1025
|
+
api.add_operation(:put_profile_outbound_request_batch, Seahorse::Model::Operation.new.tap do |o|
|
1026
|
+
o.name = "PutProfileOutboundRequestBatch"
|
1027
|
+
o.http_method = "PUT"
|
1028
|
+
o.http_request_uri = "/v2/campaigns/{id}/profile-outbound-requests"
|
1029
|
+
o.input = Shapes::ShapeRef.new(shape: PutProfileOutboundRequestBatchRequest)
|
1030
|
+
o.output = Shapes::ShapeRef.new(shape: PutProfileOutboundRequestBatchResponse)
|
1031
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
1032
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1033
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
1034
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
1035
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidCampaignStateException)
|
1036
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1037
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1038
|
+
end)
|
1039
|
+
|
980
1040
|
api.add_operation(:resume_campaign, Seahorse::Model::Operation.new.tap do |o|
|
981
1041
|
o.name = "ResumeCampaign"
|
982
1042
|
o.http_method = "POST"
|
@@ -758,6 +758,20 @@ module Aws::ConnectCampaignsV2
|
|
758
758
|
include Aws::Structure
|
759
759
|
end
|
760
760
|
|
761
|
+
# Event trigger of the campaign
|
762
|
+
#
|
763
|
+
# @!attribute [rw] customer_profiles_domain_arn
|
764
|
+
# Amazon Resource Names(ARN)
|
765
|
+
# @return [String]
|
766
|
+
#
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/EventTrigger AWS API Documentation
|
768
|
+
#
|
769
|
+
class EventTrigger < Struct.new(
|
770
|
+
:customer_profiles_domain_arn)
|
771
|
+
SENSITIVE = []
|
772
|
+
include Aws::Structure
|
773
|
+
end
|
774
|
+
|
761
775
|
# Failed response of campaign state
|
762
776
|
#
|
763
777
|
# @!attribute [rw] campaign_id
|
@@ -778,6 +792,31 @@ module Aws::ConnectCampaignsV2
|
|
778
792
|
include Aws::Structure
|
779
793
|
end
|
780
794
|
|
795
|
+
# Failure details for a profile outbound request
|
796
|
+
#
|
797
|
+
# @!attribute [rw] client_token
|
798
|
+
# Client provided parameter used for idempotency. Its value must be
|
799
|
+
# unique for each request.
|
800
|
+
# @return [String]
|
801
|
+
#
|
802
|
+
# @!attribute [rw] id
|
803
|
+
# Identifier of the profile outbound request
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @!attribute [rw] failure_code
|
807
|
+
# Predefined code indicating the error that caused the failure
|
808
|
+
# @return [String]
|
809
|
+
#
|
810
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/FailedProfileOutboundRequest AWS API Documentation
|
811
|
+
#
|
812
|
+
class FailedProfileOutboundRequest < Struct.new(
|
813
|
+
:client_token,
|
814
|
+
:id,
|
815
|
+
:failure_code)
|
816
|
+
SENSITIVE = []
|
817
|
+
include Aws::Structure
|
818
|
+
end
|
819
|
+
|
781
820
|
# A failed request identified by the unique client token.
|
782
821
|
#
|
783
822
|
# @!attribute [rw] client_token
|
@@ -1346,6 +1385,31 @@ module Aws::ConnectCampaignsV2
|
|
1346
1385
|
include Aws::Structure
|
1347
1386
|
end
|
1348
1387
|
|
1388
|
+
# Information about a profile outbound request
|
1389
|
+
#
|
1390
|
+
# @!attribute [rw] client_token
|
1391
|
+
# Client provided parameter used for idempotency. Its value must be
|
1392
|
+
# unique for each request.
|
1393
|
+
# @return [String]
|
1394
|
+
#
|
1395
|
+
# @!attribute [rw] profile_id
|
1396
|
+
# Identifier of the customer profile
|
1397
|
+
# @return [String]
|
1398
|
+
#
|
1399
|
+
# @!attribute [rw] expiration_time
|
1400
|
+
# Timestamp with no UTC offset or timezone
|
1401
|
+
# @return [Time]
|
1402
|
+
#
|
1403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/ProfileOutboundRequest AWS API Documentation
|
1404
|
+
#
|
1405
|
+
class ProfileOutboundRequest < Struct.new(
|
1406
|
+
:client_token,
|
1407
|
+
:profile_id,
|
1408
|
+
:expiration_time)
|
1409
|
+
SENSITIVE = []
|
1410
|
+
include Aws::Structure
|
1411
|
+
end
|
1412
|
+
|
1349
1413
|
# Progressive config
|
1350
1414
|
#
|
1351
1415
|
# @!attribute [rw] bandwidth_allocation
|
@@ -1417,6 +1481,44 @@ module Aws::ConnectCampaignsV2
|
|
1417
1481
|
include Aws::Structure
|
1418
1482
|
end
|
1419
1483
|
|
1484
|
+
# The request for PutProfileOutboundRequestBatch API
|
1485
|
+
#
|
1486
|
+
# @!attribute [rw] id
|
1487
|
+
# Identifier representing a Campaign
|
1488
|
+
# @return [String]
|
1489
|
+
#
|
1490
|
+
# @!attribute [rw] profile_outbound_requests
|
1491
|
+
# List of profile outbound requests
|
1492
|
+
# @return [Array<Types::ProfileOutboundRequest>]
|
1493
|
+
#
|
1494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatchRequest AWS API Documentation
|
1495
|
+
#
|
1496
|
+
class PutProfileOutboundRequestBatchRequest < Struct.new(
|
1497
|
+
:id,
|
1498
|
+
:profile_outbound_requests)
|
1499
|
+
SENSITIVE = []
|
1500
|
+
include Aws::Structure
|
1501
|
+
end
|
1502
|
+
|
1503
|
+
# The response for PutProfileOutboundRequestBatch API
|
1504
|
+
#
|
1505
|
+
# @!attribute [rw] successful_requests
|
1506
|
+
# List of successful profile outbound requests
|
1507
|
+
# @return [Array<Types::SuccessfulProfileOutboundRequest>]
|
1508
|
+
#
|
1509
|
+
# @!attribute [rw] failed_requests
|
1510
|
+
# List of failed profile outbound requests
|
1511
|
+
# @return [Array<Types::FailedProfileOutboundRequest>]
|
1512
|
+
#
|
1513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatchResponse AWS API Documentation
|
1514
|
+
#
|
1515
|
+
class PutProfileOutboundRequestBatchResponse < Struct.new(
|
1516
|
+
:successful_requests,
|
1517
|
+
:failed_requests)
|
1518
|
+
SENSITIVE = []
|
1519
|
+
include Aws::Structure
|
1520
|
+
end
|
1521
|
+
|
1420
1522
|
# Q Connect integration config
|
1421
1523
|
#
|
1422
1524
|
# @!attribute [rw] knowledge_base_arn
|
@@ -1690,16 +1792,22 @@ module Aws::ConnectCampaignsV2
|
|
1690
1792
|
# Amazon Resource Names(ARN)
|
1691
1793
|
# @return [String]
|
1692
1794
|
#
|
1795
|
+
# @!attribute [rw] event_trigger
|
1796
|
+
# Event trigger of the campaign
|
1797
|
+
# @return [Types::EventTrigger]
|
1798
|
+
#
|
1693
1799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/Source AWS API Documentation
|
1694
1800
|
#
|
1695
1801
|
class Source < Struct.new(
|
1696
1802
|
:customer_profiles_segment_arn,
|
1803
|
+
:event_trigger,
|
1697
1804
|
:unknown)
|
1698
1805
|
SENSITIVE = []
|
1699
1806
|
include Aws::Structure
|
1700
1807
|
include Aws::Structure::Union
|
1701
1808
|
|
1702
1809
|
class CustomerProfilesSegmentArn < Source; end
|
1810
|
+
class EventTrigger < Source; end
|
1703
1811
|
class Unknown < Source; end
|
1704
1812
|
end
|
1705
1813
|
|
@@ -1786,6 +1894,26 @@ module Aws::ConnectCampaignsV2
|
|
1786
1894
|
include Aws::Structure
|
1787
1895
|
end
|
1788
1896
|
|
1897
|
+
# Success details for a profile outbound request
|
1898
|
+
#
|
1899
|
+
# @!attribute [rw] client_token
|
1900
|
+
# Client provided parameter used for idempotency. Its value must be
|
1901
|
+
# unique for each request.
|
1902
|
+
# @return [String]
|
1903
|
+
#
|
1904
|
+
# @!attribute [rw] id
|
1905
|
+
# Identifier of the profile outbound request
|
1906
|
+
# @return [String]
|
1907
|
+
#
|
1908
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connectcampaignsv2-2024-04-23/SuccessfulProfileOutboundRequest AWS API Documentation
|
1909
|
+
#
|
1910
|
+
class SuccessfulProfileOutboundRequest < Struct.new(
|
1911
|
+
:client_token,
|
1912
|
+
:id)
|
1913
|
+
SENSITIVE = []
|
1914
|
+
include Aws::Structure
|
1915
|
+
end
|
1916
|
+
|
1789
1917
|
# A successful request identified by the unique client token.
|
1790
1918
|
#
|
1791
1919
|
# @!attribute [rw] client_token
|
data/sig/client.rbs
CHANGED
@@ -133,7 +133,10 @@ module Aws
|
|
133
133
|
}?
|
134
134
|
},
|
135
135
|
?source: {
|
136
|
-
customer_profiles_segment_arn: ::String
|
136
|
+
customer_profiles_segment_arn: ::String?,
|
137
|
+
event_trigger: {
|
138
|
+
customer_profiles_domain_arn: ::String?
|
139
|
+
}?
|
137
140
|
},
|
138
141
|
?connect_campaign_flow_arn: ::String,
|
139
142
|
?schedule: {
|
@@ -426,6 +429,24 @@ module Aws
|
|
426
429
|
) -> _PutOutboundRequestBatchResponseSuccess
|
427
430
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutOutboundRequestBatchResponseSuccess
|
428
431
|
|
432
|
+
interface _PutProfileOutboundRequestBatchResponseSuccess
|
433
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutProfileOutboundRequestBatchResponse]
|
434
|
+
def successful_requests: () -> ::Array[Types::SuccessfulProfileOutboundRequest]
|
435
|
+
def failed_requests: () -> ::Array[Types::FailedProfileOutboundRequest]
|
436
|
+
end
|
437
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#put_profile_outbound_request_batch-instance_method
|
438
|
+
def put_profile_outbound_request_batch: (
|
439
|
+
id: ::String,
|
440
|
+
profile_outbound_requests: Array[
|
441
|
+
{
|
442
|
+
client_token: ::String,
|
443
|
+
profile_id: ::String,
|
444
|
+
expiration_time: ::Time?
|
445
|
+
},
|
446
|
+
]
|
447
|
+
) -> _PutProfileOutboundRequestBatchResponseSuccess
|
448
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutProfileOutboundRequestBatchResponseSuccess
|
449
|
+
|
429
450
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ConnectCampaignsV2/Client.html#resume_campaign-instance_method
|
430
451
|
def resume_campaign: (
|
431
452
|
id: ::String
|
@@ -641,7 +662,10 @@ module Aws
|
|
641
662
|
def update_campaign_source: (
|
642
663
|
id: ::String,
|
643
664
|
source: {
|
644
|
-
customer_profiles_segment_arn: ::String
|
665
|
+
customer_profiles_segment_arn: ::String?,
|
666
|
+
event_trigger: {
|
667
|
+
customer_profiles_domain_arn: ::String?
|
668
|
+
}?
|
645
669
|
}
|
646
670
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
647
671
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
data/sig/types.rbs
CHANGED
@@ -242,12 +242,24 @@ module Aws::ConnectCampaignsV2
|
|
242
242
|
SENSITIVE: []
|
243
243
|
end
|
244
244
|
|
245
|
+
class EventTrigger
|
246
|
+
attr_accessor customer_profiles_domain_arn: ::String
|
247
|
+
SENSITIVE: []
|
248
|
+
end
|
249
|
+
|
245
250
|
class FailedCampaignStateResponse
|
246
251
|
attr_accessor campaign_id: ::String
|
247
252
|
attr_accessor failure_code: ("ResourceNotFound" | "UnknownError")
|
248
253
|
SENSITIVE: []
|
249
254
|
end
|
250
255
|
|
256
|
+
class FailedProfileOutboundRequest
|
257
|
+
attr_accessor client_token: ::String
|
258
|
+
attr_accessor id: ::String
|
259
|
+
attr_accessor failure_code: ("UnknownError" | "ResourceNotFound" | "Conflict" | "RequestThrottled" | "InvalidInput")
|
260
|
+
SENSITIVE: []
|
261
|
+
end
|
262
|
+
|
251
263
|
class FailedRequest
|
252
264
|
attr_accessor client_token: ::String
|
253
265
|
attr_accessor id: ::String
|
@@ -447,6 +459,13 @@ module Aws::ConnectCampaignsV2
|
|
447
459
|
SENSITIVE: []
|
448
460
|
end
|
449
461
|
|
462
|
+
class ProfileOutboundRequest
|
463
|
+
attr_accessor client_token: ::String
|
464
|
+
attr_accessor profile_id: ::String
|
465
|
+
attr_accessor expiration_time: ::Time
|
466
|
+
SENSITIVE: []
|
467
|
+
end
|
468
|
+
|
450
469
|
class ProgressiveConfig
|
451
470
|
attr_accessor bandwidth_allocation: ::Float
|
452
471
|
SENSITIVE: []
|
@@ -470,6 +489,18 @@ module Aws::ConnectCampaignsV2
|
|
470
489
|
SENSITIVE: []
|
471
490
|
end
|
472
491
|
|
492
|
+
class PutProfileOutboundRequestBatchRequest
|
493
|
+
attr_accessor id: ::String
|
494
|
+
attr_accessor profile_outbound_requests: ::Array[Types::ProfileOutboundRequest]
|
495
|
+
SENSITIVE: []
|
496
|
+
end
|
497
|
+
|
498
|
+
class PutProfileOutboundRequestBatchResponse
|
499
|
+
attr_accessor successful_requests: ::Array[Types::SuccessfulProfileOutboundRequest]
|
500
|
+
attr_accessor failed_requests: ::Array[Types::FailedProfileOutboundRequest]
|
501
|
+
SENSITIVE: []
|
502
|
+
end
|
503
|
+
|
473
504
|
class QConnectIntegrationConfig
|
474
505
|
attr_accessor knowledge_base_arn: ::String
|
475
506
|
SENSITIVE: []
|
@@ -561,11 +592,14 @@ module Aws::ConnectCampaignsV2
|
|
561
592
|
|
562
593
|
class Source
|
563
594
|
attr_accessor customer_profiles_segment_arn: ::String
|
595
|
+
attr_accessor event_trigger: Types::EventTrigger
|
564
596
|
attr_accessor unknown: untyped
|
565
597
|
SENSITIVE: []
|
566
598
|
|
567
599
|
class CustomerProfilesSegmentArn < Source
|
568
600
|
end
|
601
|
+
class EventTrigger < Source
|
602
|
+
end
|
569
603
|
class Unknown < Source
|
570
604
|
end
|
571
605
|
end
|
@@ -597,6 +631,12 @@ module Aws::ConnectCampaignsV2
|
|
597
631
|
SENSITIVE: []
|
598
632
|
end
|
599
633
|
|
634
|
+
class SuccessfulProfileOutboundRequest
|
635
|
+
attr_accessor client_token: ::String
|
636
|
+
attr_accessor id: ::String
|
637
|
+
SENSITIVE: []
|
638
|
+
end
|
639
|
+
|
600
640
|
class SuccessfulRequest
|
601
641
|
attr_accessor client_token: ::String
|
602
642
|
attr_accessor id: ::String
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-connectcampaignsv2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.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: 2024-
|
11
|
+
date: 2024-12-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|