1{
2  "version":"2.0",
3  "metadata":{
4    "apiVersion":"2021-01-30",
5    "endpointPrefix":"connect-campaigns",
6    "jsonVersion":"1.1",
7    "protocol":"rest-json",
8    "serviceFullName":"AmazonConnectCampaignService",
9    "serviceId":"ConnectCampaigns",
10    "signatureVersion":"v4",
11    "signingName":"connect-campaigns",
12    "uid":"connectcampaigns-2021-01-30"
13  },
14  "operations":{
15    "CreateCampaign":{
16      "name":"CreateCampaign",
17      "http":{
18        "method":"PUT",
19        "requestUri":"/campaigns",
20        "responseCode":200
21      },
22      "input":{"shape":"CreateCampaignRequest"},
23      "output":{"shape":"CreateCampaignResponse"},
24      "errors":[
25        {"shape":"InternalServerException"},
26        {"shape":"ResourceNotFoundException"},
27        {"shape":"ValidationException"},
28        {"shape":"ConflictException"},
29        {"shape":"AccessDeniedException"},
30        {"shape":"ServiceQuotaExceededException"},
31        {"shape":"ThrottlingException"}
32      ],
33      "documentation":"<p>Creates a campaign for the specified Amazon Connect account. This API is idempotent.</p>",
34      "idempotent":true
35    },
36    "DeleteCampaign":{
37      "name":"DeleteCampaign",
38      "http":{
39        "method":"DELETE",
40        "requestUri":"/campaigns/{id}",
41        "responseCode":200
42      },
43      "input":{"shape":"DeleteCampaignRequest"},
44      "errors":[
45        {"shape":"InternalServerException"},
46        {"shape":"ResourceNotFoundException"},
47        {"shape":"ValidationException"},
48        {"shape":"AccessDeniedException"}
49      ],
50      "documentation":"<p>Deletes a campaign from the specified Amazon Connect account.</p>",
51      "idempotent":true
52    },
53    "DeleteConnectInstanceConfig":{
54      "name":"DeleteConnectInstanceConfig",
55      "http":{
56        "method":"DELETE",
57        "requestUri":"/connect-instance/{connectInstanceId}/config",
58        "responseCode":200
59      },
60      "input":{"shape":"DeleteConnectInstanceConfigRequest"},
61      "errors":[
62        {"shape":"InternalServerException"},
63        {"shape":"ResourceNotFoundException"},
64        {"shape":"ValidationException"},
65        {"shape":"AccessDeniedException"},
66        {"shape":"InvalidStateException"},
67        {"shape":"ThrottlingException"}
68      ],
69      "documentation":"<p>Deletes a connect instance config from the specified AWS account.</p>",
70      "idempotent":true
71    },
72    "DeleteInstanceOnboardingJob":{
73      "name":"DeleteInstanceOnboardingJob",
74      "http":{
75        "method":"DELETE",
76        "requestUri":"/connect-instance/{connectInstanceId}/onboarding",
77        "responseCode":200
78      },
79      "input":{"shape":"DeleteInstanceOnboardingJobRequest"},
80      "errors":[
81        {"shape":"InternalServerException"},
82        {"shape":"ResourceNotFoundException"},
83        {"shape":"ValidationException"},
84        {"shape":"AccessDeniedException"},
85        {"shape":"InvalidStateException"}
86      ],
87      "documentation":"<p>Delete the Connect Campaigns onboarding job for the specified Amazon Connect instance.</p>",
88      "idempotent":true
89    },
90    "DescribeCampaign":{
91      "name":"DescribeCampaign",
92      "http":{
93        "method":"GET",
94        "requestUri":"/campaigns/{id}",
95        "responseCode":200
96      },
97      "input":{"shape":"DescribeCampaignRequest"},
98      "output":{"shape":"DescribeCampaignResponse"},
99      "errors":[
100        {"shape":"InternalServerException"},
101        {"shape":"ResourceNotFoundException"},
102        {"shape":"ValidationException"},
103        {"shape":"AccessDeniedException"}
104      ],
105      "documentation":"<p>Describes the specific campaign.</p>"
106    },
107    "GetCampaignState":{
108      "name":"GetCampaignState",
109      "http":{
110        "method":"GET",
111        "requestUri":"/campaigns/{id}/state",
112        "responseCode":200
113      },
114      "input":{"shape":"GetCampaignStateRequest"},
115      "output":{"shape":"GetCampaignStateResponse"},
116      "errors":[
117        {"shape":"InternalServerException"},
118        {"shape":"ResourceNotFoundException"},
119        {"shape":"ValidationException"},
120        {"shape":"AccessDeniedException"},
121        {"shape":"ThrottlingException"}
122      ],
123      "documentation":"<p>Get state of a campaign for the specified Amazon Connect account.</p>"
124    },
125    "GetCampaignStateBatch":{
126      "name":"GetCampaignStateBatch",
127      "http":{
128        "method":"POST",
129        "requestUri":"/campaigns-state",
130        "responseCode":200
131      },
132      "input":{"shape":"GetCampaignStateBatchRequest"},
133      "output":{"shape":"GetCampaignStateBatchResponse"},
134      "errors":[
135        {"shape":"InternalServerException"},
136        {"shape":"ValidationException"},
137        {"shape":"AccessDeniedException"},
138        {"shape":"ThrottlingException"}
139      ],
140      "documentation":"<p>Get state of campaigns for the specified Amazon Connect account.</p>"
141    },
142    "GetConnectInstanceConfig":{
143      "name":"GetConnectInstanceConfig",
144      "http":{
145        "method":"GET",
146        "requestUri":"/connect-instance/{connectInstanceId}/config",
147        "responseCode":200
148      },
149      "input":{"shape":"GetConnectInstanceConfigRequest"},
150      "output":{"shape":"GetConnectInstanceConfigResponse"},
151      "errors":[
152        {"shape":"InternalServerException"},
153        {"shape":"ResourceNotFoundException"},
154        {"shape":"ValidationException"},
155        {"shape":"AccessDeniedException"}
156      ],
157      "documentation":"<p>Get the specific Connect instance config.</p>"
158    },
159    "GetInstanceOnboardingJobStatus":{
160      "name":"GetInstanceOnboardingJobStatus",
161      "http":{
162        "method":"GET",
163        "requestUri":"/connect-instance/{connectInstanceId}/onboarding",
164        "responseCode":200
165      },
166      "input":{"shape":"GetInstanceOnboardingJobStatusRequest"},
167      "output":{"shape":"GetInstanceOnboardingJobStatusResponse"},
168      "errors":[
169        {"shape":"InternalServerException"},
170        {"shape":"ResourceNotFoundException"},
171        {"shape":"ValidationException"},
172        {"shape":"AccessDeniedException"}
173      ],
174      "documentation":"<p>Get the specific instance onboarding job status.</p>"
175    },
176    "ListCampaigns":{
177      "name":"ListCampaigns",
178      "http":{
179        "method":"POST",
180        "requestUri":"/campaigns-summary",
181        "responseCode":200
182      },
183      "input":{"shape":"ListCampaignsRequest"},
184      "output":{"shape":"ListCampaignsResponse"},
185      "errors":[
186        {"shape":"InternalServerException"},
187        {"shape":"ValidationException"},
188        {"shape":"AccessDeniedException"}
189      ],
190      "documentation":"<p>Provides summary information about the campaigns under the specified Amazon Connect account.</p>"
191    },
192    "ListTagsForResource":{
193      "name":"ListTagsForResource",
194      "http":{
195        "method":"GET",
196        "requestUri":"/tags/{arn}",
197        "responseCode":200
198      },
199      "input":{"shape":"ListTagsForResourceRequest"},
200      "output":{"shape":"ListTagsForResourceResponse"},
201      "errors":[
202        {"shape":"InternalServerException"},
203        {"shape":"ResourceNotFoundException"},
204        {"shape":"ValidationException"},
205        {"shape":"AccessDeniedException"},
206        {"shape":"ThrottlingException"}
207      ],
208      "documentation":"<p>List tags for a resource.</p>",
209      "idempotent":true
210    },
211    "PauseCampaign":{
212      "name":"PauseCampaign",
213      "http":{
214        "method":"POST",
215        "requestUri":"/campaigns/{id}/pause",
216        "responseCode":200
217      },
218      "input":{"shape":"PauseCampaignRequest"},
219      "errors":[
220        {"shape":"InternalServerException"},
221        {"shape":"ResourceNotFoundException"},
222        {"shape":"ValidationException"},
223        {"shape":"ConflictException"},
224        {"shape":"InvalidCampaignStateException"},
225        {"shape":"AccessDeniedException"},
226        {"shape":"ThrottlingException"}
227      ],
228      "documentation":"<p>Pauses a campaign for the specified Amazon Connect account.</p>"
229    },
230    "PutDialRequestBatch":{
231      "name":"PutDialRequestBatch",
232      "http":{
233        "method":"PUT",
234        "requestUri":"/campaigns/{id}/dial-requests",
235        "responseCode":200
236      },
237      "input":{"shape":"PutDialRequestBatchRequest"},
238      "output":{"shape":"PutDialRequestBatchResponse"},
239      "errors":[
240        {"shape":"InternalServerException"},
241        {"shape":"ResourceNotFoundException"},
242        {"shape":"ValidationException"},
243        {"shape":"ConflictException"},
244        {"shape":"InvalidCampaignStateException"},
245        {"shape":"AccessDeniedException"},
246        {"shape":"ThrottlingException"}
247      ],
248      "documentation":"<p>Creates dials requests for the specified campaign Amazon Connect account. This API is idempotent.</p>",
249      "idempotent":true
250    },
251    "ResumeCampaign":{
252      "name":"ResumeCampaign",
253      "http":{
254        "method":"POST",
255        "requestUri":"/campaigns/{id}/resume",
256        "responseCode":200
257      },
258      "input":{"shape":"ResumeCampaignRequest"},
259      "errors":[
260        {"shape":"InternalServerException"},
261        {"shape":"ResourceNotFoundException"},
262        {"shape":"ValidationException"},
263        {"shape":"ConflictException"},
264        {"shape":"InvalidCampaignStateException"},
265        {"shape":"AccessDeniedException"},
266        {"shape":"ThrottlingException"}
267      ],
268      "documentation":"<p>Stops a campaign for the specified Amazon Connect account.</p>"
269    },
270    "StartCampaign":{
271      "name":"StartCampaign",
272      "http":{
273        "method":"POST",
274        "requestUri":"/campaigns/{id}/start",
275        "responseCode":200
276      },
277      "input":{"shape":"StartCampaignRequest"},
278      "errors":[
279        {"shape":"InternalServerException"},
280        {"shape":"ResourceNotFoundException"},
281        {"shape":"ValidationException"},
282        {"shape":"ConflictException"},
283        {"shape":"InvalidCampaignStateException"},
284        {"shape":"AccessDeniedException"},
285        {"shape":"ThrottlingException"}
286      ],
287      "documentation":"<p>Starts a campaign for the specified Amazon Connect account.</p>"
288    },
289    "StartInstanceOnboardingJob":{
290      "name":"StartInstanceOnboardingJob",
291      "http":{
292        "method":"PUT",
293        "requestUri":"/connect-instance/{connectInstanceId}/onboarding",
294        "responseCode":200
295      },
296      "input":{"shape":"StartInstanceOnboardingJobRequest"},
297      "output":{"shape":"StartInstanceOnboardingJobResponse"},
298      "errors":[
299        {"shape":"InternalServerException"},
300        {"shape":"ResourceNotFoundException"},
301        {"shape":"ValidationException"},
302        {"shape":"ConflictException"},
303        {"shape":"AccessDeniedException"},
304        {"shape":"ThrottlingException"}
305      ],
306      "documentation":"<p>Onboard the specific Amazon Connect instance to Connect Campaigns.</p>",
307      "idempotent":true
308    },
309    "StopCampaign":{
310      "name":"StopCampaign",
311      "http":{
312        "method":"POST",
313        "requestUri":"/campaigns/{id}/stop",
314        "responseCode":200
315      },
316      "input":{"shape":"StopCampaignRequest"},
317      "errors":[
318        {"shape":"InternalServerException"},
319        {"shape":"ResourceNotFoundException"},
320        {"shape":"ValidationException"},
321        {"shape":"ConflictException"},
322        {"shape":"InvalidCampaignStateException"},
323        {"shape":"AccessDeniedException"},
324        {"shape":"ThrottlingException"}
325      ],
326      "documentation":"<p>Stops a campaign for the specified Amazon Connect account.</p>"
327    },
328    "TagResource":{
329      "name":"TagResource",
330      "http":{
331        "method":"POST",
332        "requestUri":"/tags/{arn}",
333        "responseCode":200
334      },
335      "input":{"shape":"TagResourceRequest"},
336      "errors":[
337        {"shape":"InternalServerException"},
338        {"shape":"ResourceNotFoundException"},
339        {"shape":"ValidationException"},
340        {"shape":"AccessDeniedException"},
341        {"shape":"ThrottlingException"}
342      ],
343      "documentation":"<p>Tag a resource.</p>",
344      "idempotent":true
345    },
346    "UntagResource":{
347      "name":"UntagResource",
348      "http":{
349        "method":"DELETE",
350        "requestUri":"/tags/{arn}",
351        "responseCode":200
352      },
353      "input":{"shape":"UntagResourceRequest"},
354      "errors":[
355        {"shape":"InternalServerException"},
356        {"shape":"ResourceNotFoundException"},
357        {"shape":"ValidationException"},
358        {"shape":"AccessDeniedException"},
359        {"shape":"ThrottlingException"}
360      ],
361      "documentation":"<p>Untag a resource.</p>",
362      "idempotent":true
363    },
364    "UpdateCampaignDialerConfig":{
365      "name":"UpdateCampaignDialerConfig",
366      "http":{
367        "method":"POST",
368        "requestUri":"/campaigns/{id}/dialer-config",
369        "responseCode":200
370      },
371      "input":{"shape":"UpdateCampaignDialerConfigRequest"},
372      "errors":[
373        {"shape":"InternalServerException"},
374        {"shape":"ResourceNotFoundException"},
375        {"shape":"ValidationException"},
376        {"shape":"ConflictException"},
377        {"shape":"AccessDeniedException"}
378      ],
379      "documentation":"<p>Updates the dialer config of a campaign. This API is idempotent.</p>",
380      "idempotent":true
381    },
382    "UpdateCampaignName":{
383      "name":"UpdateCampaignName",
384      "http":{
385        "method":"POST",
386        "requestUri":"/campaigns/{id}/name",
387        "responseCode":200
388      },
389      "input":{"shape":"UpdateCampaignNameRequest"},
390      "errors":[
391        {"shape":"InternalServerException"},
392        {"shape":"ResourceNotFoundException"},
393        {"shape":"ValidationException"},
394        {"shape":"ConflictException"},
395        {"shape":"AccessDeniedException"}
396      ],
397      "documentation":"<p>Updates the name of a campaign. This API is idempotent.</p>",
398      "idempotent":true
399    },
400    "UpdateCampaignOutboundCallConfig":{
401      "name":"UpdateCampaignOutboundCallConfig",
402      "http":{
403        "method":"POST",
404        "requestUri":"/campaigns/{id}/outbound-call-config",
405        "responseCode":200
406      },
407      "input":{"shape":"UpdateCampaignOutboundCallConfigRequest"},
408      "errors":[
409        {"shape":"InternalServerException"},
410        {"shape":"ResourceNotFoundException"},
411        {"shape":"ValidationException"},
412        {"shape":"ConflictException"},
413        {"shape":"AccessDeniedException"},
414        {"shape":"ThrottlingException"}
415      ],
416      "documentation":"<p>Updates the outbound call config of a campaign. This API is idempotent.</p>",
417      "idempotent":true
418    }
419  },
420  "shapes":{
421    "AccessDeniedException":{
422      "type":"structure",
423      "required":["message"],
424      "members":{
425        "message":{"shape":"String"},
426        "xAmzErrorType":{
427          "shape":"XAmazonErrorType",
428          "location":"header",
429          "locationName":"x-amzn-ErrorType"
430        }
431      },
432      "documentation":"<p>You do not have sufficient access to perform this action.</p>",
433      "error":{
434        "httpStatusCode":403,
435        "senderFault":true
436      },
437      "exception":true
438    },
439    "AgentlessDialerConfig":{
440      "type":"structure",
441      "members":{
442        "dialingCapacity":{"shape":"DialingCapacity"}
443      },
444      "documentation":"<p>Agentless Dialer config</p>"
445    },
446    "AnswerMachineDetectionConfig":{
447      "type":"structure",
448      "required":["enableAnswerMachineDetection"],
449      "members":{
450        "enableAnswerMachineDetection":{
451          "shape":"Boolean",
452          "documentation":"<p>Enable or disable answering machine detection</p>"
453        }
454      },
455      "documentation":"<p>Answering Machine Detection config</p>"
456    },
457    "Arn":{
458      "type":"string",
459      "documentation":"<p>Arn</p>",
460      "max":500,
461      "min":20,
462      "pattern":"arn:.*"
463    },
464    "AttributeName":{
465      "type":"string",
466      "documentation":"<p>The key of the attribute. Attribute keys can include only alphanumeric, dash, and underscore characters.</p>",
467      "max":32767,
468      "min":0,
469      "pattern":"[a-zA-Z0-9\\-_]+"
470    },
471    "AttributeValue":{
472      "type":"string",
473      "documentation":"<p>The value of the attribute.</p>",
474      "max":32767,
475      "min":0,
476      "pattern":".*"
477    },
478    "Attributes":{
479      "type":"map",
480      "key":{"shape":"AttributeName"},
481      "value":{"shape":"AttributeValue"},
482      "documentation":"<p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</p>",
483      "sensitive":true
484    },
485    "BandwidthAllocation":{
486      "type":"double",
487      "documentation":"<p>The bandwidth allocation of a queue resource.</p>",
488      "box":true,
489      "max":1,
490      "min":0
491    },
492    "Boolean":{
493      "type":"boolean",
494      "box":true
495    },
496    "Campaign":{
497      "type":"structure",
498      "required":[
499        "id",
500        "arn",
501        "name",
502        "connectInstanceId",
503        "dialerConfig",
504        "outboundCallConfig"
505      ],
506      "members":{
507        "id":{"shape":"CampaignId"},
508        "arn":{"shape":"CampaignArn"},
509        "name":{"shape":"CampaignName"},
510        "connectInstanceId":{"shape":"InstanceId"},
511        "dialerConfig":{"shape":"DialerConfig"},
512        "outboundCallConfig":{"shape":"OutboundCallConfig"},
513        "tags":{"shape":"TagMap"}
514      },
515      "documentation":"<p>An Amazon Connect campaign.</p>"
516    },
517    "CampaignArn":{
518      "type":"string",
519      "documentation":"<p>The resource name of an Amazon Connect campaign.</p>",
520      "max":500,
521      "min":20
522    },
523    "CampaignFilters":{
524      "type":"structure",
525      "members":{
526        "instanceIdFilter":{"shape":"InstanceIdFilter"}
527      },
528      "documentation":"<p>Filter model by type</p>"
529    },
530    "CampaignId":{
531      "type":"string",
532      "documentation":"<p>Identifier representing a Campaign</p>",
533      "max":256,
534      "min":0,
535      "pattern":"[\\S]*"
536    },
537    "CampaignName":{
538      "type":"string",
539      "documentation":"<p>The name of an Amazon Connect Campaign name.</p>",
540      "max":127,
541      "min":1
542    },
543    "CampaignState":{
544      "type":"string",
545      "documentation":"<p>State of a campaign</p>",
546      "enum":[
547        "Initialized",
548        "Running",
549        "Paused",
550        "Stopped",
551        "Failed"
552      ]
553    },
554    "CampaignSummary":{
555      "type":"structure",
556      "required":[
557        "id",
558        "arn",
559        "name",
560        "connectInstanceId"
561      ],
562      "members":{
563        "id":{"shape":"CampaignId"},
564        "arn":{"shape":"CampaignArn"},
565        "name":{"shape":"CampaignName"},
566        "connectInstanceId":{"shape":"InstanceId"}
567      },
568      "documentation":"<p>An Amazon Connect campaign summary.</p>"
569    },
570    "CampaignSummaryList":{
571      "type":"list",
572      "member":{"shape":"CampaignSummary"},
573      "documentation":"<p>A list of Amazon Connect campaigns.</p>"
574    },
575    "ClientToken":{
576      "type":"string",
577      "documentation":"<p>Client provided parameter used for idempotency. Its value must be unique for each request.</p>",
578      "max":200,
579      "min":0,
580      "pattern":"[a-zA-Z0-9_\\-.]*"
581    },
582    "ConflictException":{
583      "type":"structure",
584      "required":["message"],
585      "members":{
586        "message":{"shape":"String"},
587        "xAmzErrorType":{
588          "shape":"XAmazonErrorType",
589          "location":"header",
590          "locationName":"x-amzn-ErrorType"
591        }
592      },
593      "documentation":"<p>The request could not be processed because of conflict in the current state of the resource.</p>",
594      "error":{
595        "httpStatusCode":409,
596        "senderFault":true
597      },
598      "exception":true
599    },
600    "ContactFlowId":{
601      "type":"string",
602      "documentation":"<p>The identifier of the contact flow for the outbound call.</p>",
603      "max":500,
604      "min":0
605    },
606    "CreateCampaignRequest":{
607      "type":"structure",
608      "required":[
609        "name",
610        "connectInstanceId",
611        "dialerConfig",
612        "outboundCallConfig"
613      ],
614      "members":{
615        "name":{"shape":"CampaignName"},
616        "connectInstanceId":{"shape":"InstanceId"},
617        "dialerConfig":{"shape":"DialerConfig"},
618        "outboundCallConfig":{"shape":"OutboundCallConfig"},
619        "tags":{"shape":"TagMap"}
620      },
621      "documentation":"<p>The request for Create Campaign API.</p>"
622    },
623    "CreateCampaignResponse":{
624      "type":"structure",
625      "members":{
626        "id":{"shape":"CampaignId"},
627        "arn":{"shape":"CampaignArn"},
628        "tags":{"shape":"TagMap"}
629      },
630      "documentation":"<p>The response for Create Campaign API</p>"
631    },
632    "DeleteCampaignRequest":{
633      "type":"structure",
634      "required":["id"],
635      "members":{
636        "id":{
637          "shape":"CampaignId",
638          "location":"uri",
639          "locationName":"id"
640        }
641      },
642      "documentation":"<p>DeleteCampaignRequest</p>"
643    },
644    "DeleteConnectInstanceConfigRequest":{
645      "type":"structure",
646      "required":["connectInstanceId"],
647      "members":{
648        "connectInstanceId":{
649          "shape":"InstanceId",
650          "location":"uri",
651          "locationName":"connectInstanceId"
652        }
653      },
654      "documentation":"<p>DeleteCampaignRequest</p>"
655    },
656    "DeleteInstanceOnboardingJobRequest":{
657      "type":"structure",
658      "required":["connectInstanceId"],
659      "members":{
660        "connectInstanceId":{
661          "shape":"InstanceId",
662          "location":"uri",
663          "locationName":"connectInstanceId"
664        }
665      },
666      "documentation":"<p>The request for DeleteInstanceOnboardingJob API.</p>"
667    },
668    "DescribeCampaignRequest":{
669      "type":"structure",
670      "required":["id"],
671      "members":{
672        "id":{
673          "shape":"CampaignId",
674          "location":"uri",
675          "locationName":"id"
676        }
677      },
678      "documentation":"<p>DescribeCampaignRequests</p>"
679    },
680    "DescribeCampaignResponse":{
681      "type":"structure",
682      "members":{
683        "campaign":{"shape":"Campaign"}
684      },
685      "documentation":"<p>DescribeCampaignResponse</p>"
686    },
687    "DestinationPhoneNumber":{
688      "type":"string",
689      "documentation":"<p>The phone number of the customer, in E.164 format.</p>",
690      "max":20,
691      "min":0,
692      "pattern":"[\\d\\-+]*",
693      "sensitive":true
694    },
695    "DialRequest":{
696      "type":"structure",
697      "required":[
698        "clientToken",
699        "phoneNumber",
700        "expirationTime",
701        "attributes"
702      ],
703      "members":{
704        "clientToken":{"shape":"ClientToken"},
705        "phoneNumber":{"shape":"DestinationPhoneNumber"},
706        "expirationTime":{"shape":"TimeStamp"},
707        "attributes":{"shape":"Attributes"}
708      },
709      "documentation":"<p>A dial request for a campaign.</p>"
710    },
711    "DialRequestId":{
712      "type":"string",
713      "documentation":"<p>Identifier representing a Dial request</p>",
714      "max":256,
715      "min":0,
716      "pattern":"[a-zA-Z0-9_\\-.]*"
717    },
718    "DialRequestList":{
719      "type":"list",
720      "member":{"shape":"DialRequest"},
721      "documentation":"<p>A list of dial requests.</p>",
722      "max":25,
723      "min":1
724    },
725    "DialerConfig":{
726      "type":"structure",
727      "members":{
728        "progressiveDialerConfig":{"shape":"ProgressiveDialerConfig"},
729        "predictiveDialerConfig":{"shape":"PredictiveDialerConfig"},
730        "agentlessDialerConfig":{"shape":"AgentlessDialerConfig"}
731      },
732      "documentation":"<p>The possible types of dialer config parameters</p>",
733      "union":true
734    },
735    "DialingCapacity":{
736      "type":"double",
737      "documentation":"<p>Allocates dialing capacity for this campaign between multiple active campaigns</p>",
738      "box":true,
739      "max":1,
740      "min":0.01
741    },
742    "Enabled":{
743      "type":"boolean",
744      "documentation":"<p>Boolean to indicate if custom encryption has been enabled.</p>"
745    },
746    "EncryptionConfig":{
747      "type":"structure",
748      "required":["enabled"],
749      "members":{
750        "enabled":{"shape":"Enabled"},
751        "encryptionType":{"shape":"EncryptionType"},
752        "keyArn":{"shape":"EncryptionKey"}
753      },
754      "documentation":"<p>Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported</p>"
755    },
756    "EncryptionKey":{
757      "type":"string",
758      "documentation":"<p>KMS key id/arn for encryption config.</p>",
759      "max":500,
760      "min":0
761    },
762    "EncryptionType":{
763      "type":"string",
764      "documentation":"<p>Server-side encryption type.</p>",
765      "enum":["KMS"]
766    },
767    "FailedCampaignStateResponse":{
768      "type":"structure",
769      "members":{
770        "campaignId":{"shape":"CampaignId"},
771        "failureCode":{"shape":"GetCampaignStateBatchFailureCode"}
772      },
773      "documentation":"<p>Failed response of campaign state</p>"
774    },
775    "FailedCampaignStateResponseList":{
776      "type":"list",
777      "member":{"shape":"FailedCampaignStateResponse"},
778      "documentation":"<p>List of failed requests of campaign state</p>",
779      "max":25,
780      "min":0
781    },
782    "FailedRequest":{
783      "type":"structure",
784      "members":{
785        "clientToken":{"shape":"ClientToken"},
786        "id":{"shape":"DialRequestId"},
787        "failureCode":{"shape":"FailureCode"}
788      },
789      "documentation":"<p>A failed request identified by the unique client token.</p>"
790    },
791    "FailedRequestList":{
792      "type":"list",
793      "member":{"shape":"FailedRequest"},
794      "documentation":"<p>A list of failed requests.</p>",
795      "max":25,
796      "min":0
797    },
798    "FailureCode":{
799      "type":"string",
800      "documentation":"<p>A predefined code indicating the error that caused the failure.</p>",
801      "enum":[
802        "InvalidInput",
803        "RequestThrottled",
804        "UnknownError"
805      ]
806    },
807    "GetCampaignStateBatchFailureCode":{
808      "type":"string",
809      "documentation":"<p>A predefined code indicating the error that caused the failure in getting state of campaigns</p>",
810      "enum":[
811        "ResourceNotFound",
812        "UnknownError"
813      ]
814    },
815    "GetCampaignStateBatchRequest":{
816      "type":"structure",
817      "required":["campaignIds"],
818      "members":{
819        "campaignIds":{"shape":"GetCampaignStateBatchRequestCampaignIdsList"}
820      },
821      "documentation":"<p>GetCampaignStateBatchRequest</p>"
822    },
823    "GetCampaignStateBatchRequestCampaignIdsList":{
824      "type":"list",
825      "member":{"shape":"CampaignId"},
826      "documentation":"<p>List of CampaignId</p>",
827      "max":25,
828      "min":1
829    },
830    "GetCampaignStateBatchResponse":{
831      "type":"structure",
832      "members":{
833        "successfulRequests":{"shape":"SuccessfulCampaignStateResponseList"},
834        "failedRequests":{"shape":"FailedCampaignStateResponseList"}
835      },
836      "documentation":"<p>GetCampaignStateBatchResponse</p>"
837    },
838    "GetCampaignStateRequest":{
839      "type":"structure",
840      "required":["id"],
841      "members":{
842        "id":{
843          "shape":"CampaignId",
844          "location":"uri",
845          "locationName":"id"
846        }
847      },
848      "documentation":"<p>GetCampaignStateRequest</p>"
849    },
850    "GetCampaignStateResponse":{
851      "type":"structure",
852      "members":{
853        "state":{"shape":"CampaignState"}
854      },
855      "documentation":"<p>GetCampaignStateResponse</p>"
856    },
857    "GetConnectInstanceConfigRequest":{
858      "type":"structure",
859      "required":["connectInstanceId"],
860      "members":{
861        "connectInstanceId":{
862          "shape":"InstanceId",
863          "location":"uri",
864          "locationName":"connectInstanceId"
865        }
866      },
867      "documentation":"<p>GetConnectInstanceConfigRequest</p>"
868    },
869    "GetConnectInstanceConfigResponse":{
870      "type":"structure",
871      "members":{
872        "connectInstanceConfig":{"shape":"InstanceConfig"}
873      },
874      "documentation":"<p>GetConnectInstanceConfigResponse</p>"
875    },
876    "GetInstanceOnboardingJobStatusRequest":{
877      "type":"structure",
878      "required":["connectInstanceId"],
879      "members":{
880        "connectInstanceId":{
881          "shape":"InstanceId",
882          "location":"uri",
883          "locationName":"connectInstanceId"
884        }
885      },
886      "documentation":"<p>GetInstanceOnboardingJobStatusRequest</p>"
887    },
888    "GetInstanceOnboardingJobStatusResponse":{
889      "type":"structure",
890      "members":{
891        "connectInstanceOnboardingJobStatus":{"shape":"InstanceOnboardingJobStatus"}
892      },
893      "documentation":"<p>GetInstanceOnboardingJobStatusResponse</p>"
894    },
895    "InstanceConfig":{
896      "type":"structure",
897      "required":[
898        "connectInstanceId",
899        "serviceLinkedRoleArn",
900        "encryptionConfig"
901      ],
902      "members":{
903        "connectInstanceId":{"shape":"InstanceId"},
904        "serviceLinkedRoleArn":{"shape":"ServiceLinkedRoleArn"},
905        "encryptionConfig":{"shape":"EncryptionConfig"}
906      },
907      "documentation":"<p>Instance config object</p>"
908    },
909    "InstanceId":{
910      "type":"string",
911      "documentation":"<p>Amazon Connect Instance Id</p>",
912      "max":256,
913      "min":0,
914      "pattern":"[a-zA-Z0-9_\\-.]*"
915    },
916    "InstanceIdFilter":{
917      "type":"structure",
918      "required":[
919        "value",
920        "operator"
921      ],
922      "members":{
923        "value":{"shape":"InstanceId"},
924        "operator":{"shape":"InstanceIdFilterOperator"}
925      },
926      "documentation":"<p>Connect instance identifier filter</p>"
927    },
928    "InstanceIdFilterOperator":{
929      "type":"string",
930      "documentation":"<p>Operators for Connect instance identifier filter</p>",
931      "enum":["Eq"]
932    },
933    "InstanceOnboardingJobFailureCode":{
934      "type":"string",
935      "documentation":"<p>Enumeration of the possible failure codes for instance onboarding job</p>",
936      "enum":[
937        "EVENT_BRIDGE_ACCESS_DENIED",
938        "EVENT_BRIDGE_MANAGED_RULE_LIMIT_EXCEEDED",
939        "IAM_ACCESS_DENIED",
940        "KMS_ACCESS_DENIED",
941        "KMS_KEY_NOT_FOUND",
942        "INTERNAL_FAILURE"
943      ]
944    },
945    "InstanceOnboardingJobStatus":{
946      "type":"structure",
947      "required":[
948        "connectInstanceId",
949        "status"
950      ],
951      "members":{
952        "connectInstanceId":{"shape":"InstanceId"},
953        "status":{"shape":"InstanceOnboardingJobStatusCode"},
954        "failureCode":{"shape":"InstanceOnboardingJobFailureCode"}
955      },
956      "documentation":"<p>Instance onboarding job status object</p>"
957    },
958    "InstanceOnboardingJobStatusCode":{
959      "type":"string",
960      "documentation":"<p>Enumeration of the possible states for instance onboarding job</p>",
961      "enum":[
962        "IN_PROGRESS",
963        "SUCCEEDED",
964        "FAILED"
965      ]
966    },
967    "InternalServerException":{
968      "type":"structure",
969      "required":["message"],
970      "members":{
971        "message":{"shape":"String"},
972        "xAmzErrorType":{
973          "shape":"XAmazonErrorType",
974          "location":"header",
975          "locationName":"x-amzn-ErrorType"
976        }
977      },
978      "documentation":"<p>Request processing failed because of an error or failure with the service.</p>",
979      "error":{"httpStatusCode":500},
980      "exception":true,
981      "fault":true,
982      "retryable":{"throttling":false}
983    },
984    "InvalidCampaignStateException":{
985      "type":"structure",
986      "required":[
987        "state",
988        "message"
989      ],
990      "members":{
991        "state":{"shape":"CampaignState"},
992        "message":{"shape":"String"},
993        "xAmzErrorType":{
994          "shape":"XAmazonErrorType",
995          "location":"header",
996          "locationName":"x-amzn-ErrorType"
997        }
998      },
999      "documentation":"<p>The request could not be processed because of conflict in the current state of the campaign.</p>",
1000      "error":{
1001        "httpStatusCode":409,
1002        "senderFault":true
1003      },
1004      "exception":true
1005    },
1006    "InvalidStateException":{
1007      "type":"structure",
1008      "required":["message"],
1009      "members":{
1010        "message":{"shape":"String"},
1011        "xAmzErrorType":{
1012          "shape":"XAmazonErrorType",
1013          "location":"header",
1014          "locationName":"x-amzn-ErrorType"
1015        }
1016      },
1017      "documentation":"<p>The request could not be processed because of conflict in the current state.</p>",
1018      "error":{
1019        "httpStatusCode":409,
1020        "senderFault":true
1021      },
1022      "exception":true
1023    },
1024    "ListCampaignsRequest":{
1025      "type":"structure",
1026      "members":{
1027        "maxResults":{"shape":"MaxResults"},
1028        "nextToken":{"shape":"NextToken"},
1029        "filters":{"shape":"CampaignFilters"}
1030      },
1031      "documentation":"<p>ListCampaignsRequest</p>"
1032    },
1033    "ListCampaignsResponse":{
1034      "type":"structure",
1035      "members":{
1036        "nextToken":{"shape":"NextToken"},
1037        "campaignSummaryList":{"shape":"CampaignSummaryList"}
1038      },
1039      "documentation":"<p>ListCampaignsResponse</p>"
1040    },
1041    "ListTagsForResourceRequest":{
1042      "type":"structure",
1043      "required":["arn"],
1044      "members":{
1045        "arn":{
1046          "shape":"Arn",
1047          "location":"uri",
1048          "locationName":"arn"
1049        }
1050      },
1051      "documentation":"<p>ListTagsForResource</p>"
1052    },
1053    "ListTagsForResourceResponse":{
1054      "type":"structure",
1055      "members":{
1056        "tags":{"shape":"TagMap"}
1057      },
1058      "documentation":"<p>ListTagsForResponse</p>"
1059    },
1060    "MaxResults":{
1061      "type":"integer",
1062      "documentation":"<p>The maximum number of results to return per page.</p>",
1063      "box":true,
1064      "max":50,
1065      "min":1
1066    },
1067    "NextToken":{
1068      "type":"string",
1069      "documentation":"<p>The token for the next set of results.</p>",
1070      "max":1000,
1071      "min":0
1072    },
1073    "OutboundCallConfig":{
1074      "type":"structure",
1075      "required":["connectContactFlowId"],
1076      "members":{
1077        "connectContactFlowId":{"shape":"ContactFlowId"},
1078        "connectSourcePhoneNumber":{"shape":"SourcePhoneNumber"},
1079        "connectQueueId":{"shape":"QueueId"},
1080        "answerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"}
1081      },
1082      "documentation":"<p>The configuration used for outbound calls.</p>"
1083    },
1084    "PauseCampaignRequest":{
1085      "type":"structure",
1086      "required":["id"],
1087      "members":{
1088        "id":{
1089          "shape":"CampaignId",
1090          "location":"uri",
1091          "locationName":"id"
1092        }
1093      },
1094      "documentation":"<p>PauseCampaignRequest</p>"
1095    },
1096    "PredictiveDialerConfig":{
1097      "type":"structure",
1098      "required":["bandwidthAllocation"],
1099      "members":{
1100        "bandwidthAllocation":{"shape":"BandwidthAllocation"},
1101        "dialingCapacity":{"shape":"DialingCapacity"}
1102      },
1103      "documentation":"<p>Predictive Dialer config</p>"
1104    },
1105    "ProgressiveDialerConfig":{
1106      "type":"structure",
1107      "required":["bandwidthAllocation"],
1108      "members":{
1109        "bandwidthAllocation":{"shape":"BandwidthAllocation"},
1110        "dialingCapacity":{"shape":"DialingCapacity"}
1111      },
1112      "documentation":"<p>Progressive Dialer config</p>"
1113    },
1114    "PutDialRequestBatchRequest":{
1115      "type":"structure",
1116      "required":[
1117        "id",
1118        "dialRequests"
1119      ],
1120      "members":{
1121        "id":{
1122          "shape":"CampaignId",
1123          "location":"uri",
1124          "locationName":"id"
1125        },
1126        "dialRequests":{"shape":"DialRequestList"}
1127      },
1128      "documentation":"<p>PutDialRequestBatchRequest</p>"
1129    },
1130    "PutDialRequestBatchResponse":{
1131      "type":"structure",
1132      "members":{
1133        "successfulRequests":{"shape":"SuccessfulRequestList"},
1134        "failedRequests":{"shape":"FailedRequestList"}
1135      },
1136      "documentation":"<p>PutDialRequestBatchResponse</p>"
1137    },
1138    "QueueId":{
1139      "type":"string",
1140      "documentation":"<p>The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.</p>",
1141      "max":500,
1142      "min":0
1143    },
1144    "ResourceNotFoundException":{
1145      "type":"structure",
1146      "required":["message"],
1147      "members":{
1148        "message":{"shape":"String"},
1149        "xAmzErrorType":{
1150          "shape":"XAmazonErrorType",
1151          "location":"header",
1152          "locationName":"x-amzn-ErrorType"
1153        }
1154      },
1155      "documentation":"<p>The specified resource was not found.</p>",
1156      "error":{
1157        "httpStatusCode":404,
1158        "senderFault":true
1159      },
1160      "exception":true
1161    },
1162    "ResumeCampaignRequest":{
1163      "type":"structure",
1164      "required":["id"],
1165      "members":{
1166        "id":{
1167          "shape":"CampaignId",
1168          "location":"uri",
1169          "locationName":"id"
1170        }
1171      },
1172      "documentation":"<p>ResumeCampaignRequest</p>"
1173    },
1174    "ServiceLinkedRoleArn":{
1175      "type":"string",
1176      "documentation":"<p>Service linked role arn</p>",
1177      "max":256,
1178      "min":0
1179    },
1180    "ServiceQuotaExceededException":{
1181      "type":"structure",
1182      "required":["message"],
1183      "members":{
1184        "message":{"shape":"String"},
1185        "xAmzErrorType":{
1186          "shape":"XAmazonErrorType",
1187          "location":"header",
1188          "locationName":"x-amzn-ErrorType"
1189        }
1190      },
1191      "documentation":"<p>Request would cause a service quota to be exceeded.</p>",
1192      "error":{
1193        "httpStatusCode":402,
1194        "senderFault":true
1195      },
1196      "exception":true
1197    },
1198    "SourcePhoneNumber":{
1199      "type":"string",
1200      "documentation":"<p>The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.</p>",
1201      "max":100,
1202      "min":0
1203    },
1204    "StartCampaignRequest":{
1205      "type":"structure",
1206      "required":["id"],
1207      "members":{
1208        "id":{
1209          "shape":"CampaignId",
1210          "location":"uri",
1211          "locationName":"id"
1212        }
1213      },
1214      "documentation":"<p>StartCampaignRequest</p>"
1215    },
1216    "StartInstanceOnboardingJobRequest":{
1217      "type":"structure",
1218      "required":[
1219        "connectInstanceId",
1220        "encryptionConfig"
1221      ],
1222      "members":{
1223        "connectInstanceId":{
1224          "shape":"InstanceId",
1225          "location":"uri",
1226          "locationName":"connectInstanceId"
1227        },
1228        "encryptionConfig":{"shape":"EncryptionConfig"}
1229      },
1230      "documentation":"<p>The request for StartInstanceOnboardingJob API.</p>"
1231    },
1232    "StartInstanceOnboardingJobResponse":{
1233      "type":"structure",
1234      "members":{
1235        "connectInstanceOnboardingJobStatus":{"shape":"InstanceOnboardingJobStatus"}
1236      },
1237      "documentation":"<p>The response for StartInstanceOnboardingJob API.</p>"
1238    },
1239    "StopCampaignRequest":{
1240      "type":"structure",
1241      "required":["id"],
1242      "members":{
1243        "id":{
1244          "shape":"CampaignId",
1245          "location":"uri",
1246          "locationName":"id"
1247        }
1248      },
1249      "documentation":"<p>StopCampaignRequest</p>"
1250    },
1251    "String":{"type":"string"},
1252    "SuccessfulCampaignStateResponse":{
1253      "type":"structure",
1254      "members":{
1255        "campaignId":{"shape":"CampaignId"},
1256        "state":{"shape":"CampaignState"}
1257      },
1258      "documentation":"<p>Successful response of campaign state</p>"
1259    },
1260    "SuccessfulCampaignStateResponseList":{
1261      "type":"list",
1262      "member":{"shape":"SuccessfulCampaignStateResponse"},
1263      "documentation":"<p>List of successful response of campaign state</p>",
1264      "max":25,
1265      "min":0
1266    },
1267    "SuccessfulRequest":{
1268      "type":"structure",
1269      "members":{
1270        "clientToken":{"shape":"ClientToken"},
1271        "id":{"shape":"DialRequestId"}
1272      },
1273      "documentation":"<p>A successful request identified by the unique client token.</p>"
1274    },
1275    "SuccessfulRequestList":{
1276      "type":"list",
1277      "member":{"shape":"SuccessfulRequest"},
1278      "documentation":"<p>A list of successful requests identified by the unique client token.</p>",
1279      "max":25,
1280      "min":0
1281    },
1282    "TagKey":{
1283      "type":"string",
1284      "documentation":"<p>Tag key.</p>",
1285      "max":128,
1286      "min":1,
1287      "pattern":"(?!aws:)[a-zA-Z+-=._:/]+"
1288    },
1289    "TagKeyList":{
1290      "type":"list",
1291      "member":{"shape":"TagKey"},
1292      "documentation":"<p>List of tag keys.</p>",
1293      "max":50,
1294      "min":0
1295    },
1296    "TagMap":{
1297      "type":"map",
1298      "key":{"shape":"TagKey"},
1299      "value":{"shape":"TagValue"},
1300      "documentation":"<p>Tag map with key and value.</p>"
1301    },
1302    "TagResourceRequest":{
1303      "type":"structure",
1304      "required":[
1305        "arn",
1306        "tags"
1307      ],
1308      "members":{
1309        "arn":{
1310          "shape":"Arn",
1311          "location":"uri",
1312          "locationName":"arn"
1313        },
1314        "tags":{"shape":"TagMap"}
1315      },
1316      "documentation":"<p>TagResourceRequest</p>"
1317    },
1318    "TagValue":{
1319      "type":"string",
1320      "documentation":"<p>Tag value.</p>",
1321      "max":256,
1322      "min":0
1323    },
1324    "ThrottlingException":{
1325      "type":"structure",
1326      "required":["message"],
1327      "members":{
1328        "message":{"shape":"String"},
1329        "xAmzErrorType":{
1330          "shape":"XAmazonErrorType",
1331          "location":"header",
1332          "locationName":"x-amzn-ErrorType"
1333        }
1334      },
1335      "documentation":"<p>The request was denied due to request throttling.</p>",
1336      "error":{
1337        "httpStatusCode":429,
1338        "senderFault":true
1339      },
1340      "exception":true,
1341      "retryable":{"throttling":false}
1342    },
1343    "TimeStamp":{
1344      "type":"timestamp",
1345      "documentation":"<p>Timestamp with no UTC offset or timezone</p>",
1346      "timestampFormat":"iso8601"
1347    },
1348    "UntagResourceRequest":{
1349      "type":"structure",
1350      "required":[
1351        "arn",
1352        "tagKeys"
1353      ],
1354      "members":{
1355        "arn":{
1356          "shape":"Arn",
1357          "location":"uri",
1358          "locationName":"arn"
1359        },
1360        "tagKeys":{
1361          "shape":"TagKeyList",
1362          "location":"querystring",
1363          "locationName":"tagKeys"
1364        }
1365      },
1366      "documentation":"<p>UntagResourceRequest</p>"
1367    },
1368    "UpdateCampaignDialerConfigRequest":{
1369      "type":"structure",
1370      "required":[
1371        "id",
1372        "dialerConfig"
1373      ],
1374      "members":{
1375        "id":{
1376          "shape":"CampaignId",
1377          "location":"uri",
1378          "locationName":"id"
1379        },
1380        "dialerConfig":{"shape":"DialerConfig"}
1381      },
1382      "documentation":"<p>UpdateCampaignDialerConfigRequest</p>"
1383    },
1384    "UpdateCampaignNameRequest":{
1385      "type":"structure",
1386      "required":[
1387        "id",
1388        "name"
1389      ],
1390      "members":{
1391        "id":{
1392          "shape":"CampaignId",
1393          "location":"uri",
1394          "locationName":"id"
1395        },
1396        "name":{"shape":"CampaignName"}
1397      },
1398      "documentation":"<p>UpdateCampaignNameRequest</p>"
1399    },
1400    "UpdateCampaignOutboundCallConfigRequest":{
1401      "type":"structure",
1402      "required":["id"],
1403      "members":{
1404        "id":{
1405          "shape":"CampaignId",
1406          "location":"uri",
1407          "locationName":"id"
1408        },
1409        "connectContactFlowId":{"shape":"ContactFlowId"},
1410        "connectSourcePhoneNumber":{"shape":"SourcePhoneNumber"},
1411        "answerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"}
1412      },
1413      "documentation":"<p>UpdateCampaignOutboundCallConfigRequest</p>"
1414    },
1415    "ValidationException":{
1416      "type":"structure",
1417      "required":["message"],
1418      "members":{
1419        "message":{"shape":"String"},
1420        "xAmzErrorType":{
1421          "shape":"XAmazonErrorType",
1422          "location":"header",
1423          "locationName":"x-amzn-ErrorType"
1424        }
1425      },
1426      "documentation":"<p>The input fails to satisfy the constraints specified by an AWS service.</p>",
1427      "error":{
1428        "httpStatusCode":400,
1429        "senderFault":true
1430      },
1431      "exception":true
1432    },
1433    "XAmazonErrorType":{
1434      "type":"string",
1435      "documentation":"<p>A header that defines the error encountered while processing the request.</p>"
1436    }
1437  },
1438  "documentation":"<p>Provide APIs to create and manage Amazon Connect Campaigns.</p>"
1439}
1440