|
359 | 359 | "documentation":"<p>Creates outbound requests for the specified campaign Amazon Connect account. This API is idempotent.</p>",
|
360 | 360 | "idempotent":true
|
361 | 361 | },
|
| 362 | + "PutProfileOutboundRequestBatch":{ |
| 363 | + "name":"PutProfileOutboundRequestBatch", |
| 364 | + "http":{ |
| 365 | + "method":"PUT", |
| 366 | + "requestUri":"/v2/campaigns/{id}/profile-outbound-requests", |
| 367 | + "responseCode":200 |
| 368 | + }, |
| 369 | + "input":{"shape":"PutProfileOutboundRequestBatchRequest"}, |
| 370 | + "output":{"shape":"PutProfileOutboundRequestBatchResponse"}, |
| 371 | + "errors":[ |
| 372 | + {"shape":"InternalServerException"}, |
| 373 | + {"shape":"ResourceNotFoundException"}, |
| 374 | + {"shape":"ValidationException"}, |
| 375 | + {"shape":"ConflictException"}, |
| 376 | + {"shape":"InvalidCampaignStateException"}, |
| 377 | + {"shape":"AccessDeniedException"}, |
| 378 | + {"shape":"ThrottlingException"} |
| 379 | + ], |
| 380 | + "documentation":"<p>Takes in a list of profile outbound requests to be placed as part of an outbound campaign. This API is idempotent.</p>", |
| 381 | + "idempotent":true |
| 382 | + }, |
362 | 383 | "ResumeCampaign":{
|
363 | 384 | "name":"ResumeCampaign",
|
364 | 385 | "http":{
|
|
1251 | 1272 | "documentation":"<p>Server-side encryption type.</p>",
|
1252 | 1273 | "enum":["KMS"]
|
1253 | 1274 | },
|
| 1275 | + "EventTrigger":{ |
| 1276 | + "type":"structure", |
| 1277 | + "members":{ |
| 1278 | + "customerProfilesDomainArn":{"shape":"Arn"} |
| 1279 | + }, |
| 1280 | + "documentation":"<p>Event trigger of the campaign</p>" |
| 1281 | + }, |
1254 | 1282 | "EventType":{
|
1255 | 1283 | "type":"string",
|
1256 | 1284 | "documentation":"<p>Enumeration of Customer Profiles event type</p>",
|
|
1276 | 1304 | "max":25,
|
1277 | 1305 | "min":0
|
1278 | 1306 | },
|
| 1307 | + "FailedProfileOutboundRequest":{ |
| 1308 | + "type":"structure", |
| 1309 | + "members":{ |
| 1310 | + "clientToken":{"shape":"ClientToken"}, |
| 1311 | + "id":{"shape":"ProfileOutboundRequestId"}, |
| 1312 | + "failureCode":{"shape":"ProfileOutboundRequestFailureCode"} |
| 1313 | + }, |
| 1314 | + "documentation":"<p>Failure details for a profile outbound request</p>" |
| 1315 | + }, |
| 1316 | + "FailedProfileOutboundRequestList":{ |
| 1317 | + "type":"list", |
| 1318 | + "member":{"shape":"FailedProfileOutboundRequest"}, |
| 1319 | + "documentation":"<p>List of failed profile outbound requests</p>", |
| 1320 | + "max":20, |
| 1321 | + "min":0 |
| 1322 | + }, |
1279 | 1323 | "FailedRequest":{
|
1280 | 1324 | "type":"structure",
|
1281 | 1325 | "members":{
|
|
1729 | 1773 | },
|
1730 | 1774 | "documentation":"<p>Predictive config</p>"
|
1731 | 1775 | },
|
| 1776 | + "ProfileId":{ |
| 1777 | + "type":"string", |
| 1778 | + "documentation":"<p>Identifier of the customer profile</p>", |
| 1779 | + "pattern":"[a-f0-9]{32}" |
| 1780 | + }, |
| 1781 | + "ProfileOutboundRequest":{ |
| 1782 | + "type":"structure", |
| 1783 | + "required":[ |
| 1784 | + "clientToken", |
| 1785 | + "profileId" |
| 1786 | + ], |
| 1787 | + "members":{ |
| 1788 | + "clientToken":{"shape":"ClientToken"}, |
| 1789 | + "profileId":{"shape":"ProfileId"}, |
| 1790 | + "expirationTime":{"shape":"TimeStamp"} |
| 1791 | + }, |
| 1792 | + "documentation":"<p>Information about a profile outbound request</p>" |
| 1793 | + }, |
| 1794 | + "ProfileOutboundRequestFailureCode":{ |
| 1795 | + "type":"string", |
| 1796 | + "documentation":"<p>Predefined code indicating the error that caused the failure</p>", |
| 1797 | + "enum":[ |
| 1798 | + "UnknownError", |
| 1799 | + "ResourceNotFound", |
| 1800 | + "Conflict", |
| 1801 | + "RequestThrottled", |
| 1802 | + "InvalidInput" |
| 1803 | + ] |
| 1804 | + }, |
| 1805 | + "ProfileOutboundRequestId":{ |
| 1806 | + "type":"string", |
| 1807 | + "documentation":"<p>Identifier of the profile outbound request</p>", |
| 1808 | + "max":256, |
| 1809 | + "min":0, |
| 1810 | + "pattern":"[a-zA-Z0-9_\\-.]*" |
| 1811 | + }, |
| 1812 | + "ProfileOutboundRequestList":{ |
| 1813 | + "type":"list", |
| 1814 | + "member":{"shape":"ProfileOutboundRequest"}, |
| 1815 | + "documentation":"<p>List of profile outbound requests</p>", |
| 1816 | + "max":20, |
| 1817 | + "min":1 |
| 1818 | + }, |
1732 | 1819 | "ProgressiveConfig":{
|
1733 | 1820 | "type":"structure",
|
1734 | 1821 | "required":["bandwidthAllocation"],
|
|
1777 | 1864 | },
|
1778 | 1865 | "documentation":"<p>The response for PutOutboundRequestBatch API.</p>"
|
1779 | 1866 | },
|
| 1867 | + "PutProfileOutboundRequestBatchRequest":{ |
| 1868 | + "type":"structure", |
| 1869 | + "required":[ |
| 1870 | + "id", |
| 1871 | + "profileOutboundRequests" |
| 1872 | + ], |
| 1873 | + "members":{ |
| 1874 | + "id":{ |
| 1875 | + "shape":"CampaignId", |
| 1876 | + "location":"uri", |
| 1877 | + "locationName":"id" |
| 1878 | + }, |
| 1879 | + "profileOutboundRequests":{"shape":"ProfileOutboundRequestList"} |
| 1880 | + }, |
| 1881 | + "documentation":"<p>The request for PutProfileOutboundRequestBatch API</p>" |
| 1882 | + }, |
| 1883 | + "PutProfileOutboundRequestBatchResponse":{ |
| 1884 | + "type":"structure", |
| 1885 | + "members":{ |
| 1886 | + "successfulRequests":{"shape":"SuccessfulProfileOutboundRequestList"}, |
| 1887 | + "failedRequests":{"shape":"FailedProfileOutboundRequestList"} |
| 1888 | + }, |
| 1889 | + "documentation":"<p>The response for PutProfileOutboundRequestBatch API</p>" |
| 1890 | + }, |
1780 | 1891 | "QConnectIntegrationConfig":{
|
1781 | 1892 | "type":"structure",
|
1782 | 1893 | "required":["knowledgeBaseArn"],
|
|
1956 | 2067 | "Source":{
|
1957 | 2068 | "type":"structure",
|
1958 | 2069 | "members":{
|
1959 |
| - "customerProfilesSegmentArn":{"shape":"Arn"} |
| 2070 | + "customerProfilesSegmentArn":{"shape":"Arn"}, |
| 2071 | + "eventTrigger":{"shape":"EventTrigger"} |
1960 | 2072 | },
|
1961 | 2073 | "documentation":"<p>Source of the campaign</p>",
|
1962 | 2074 | "union":true
|
|
2030 | 2142 | "max":25,
|
2031 | 2143 | "min":0
|
2032 | 2144 | },
|
| 2145 | + "SuccessfulProfileOutboundRequest":{ |
| 2146 | + "type":"structure", |
| 2147 | + "members":{ |
| 2148 | + "clientToken":{"shape":"ClientToken"}, |
| 2149 | + "id":{"shape":"ProfileOutboundRequestId"} |
| 2150 | + }, |
| 2151 | + "documentation":"<p>Success details for a profile outbound request</p>" |
| 2152 | + }, |
| 2153 | + "SuccessfulProfileOutboundRequestList":{ |
| 2154 | + "type":"list", |
| 2155 | + "member":{"shape":"SuccessfulProfileOutboundRequest"}, |
| 2156 | + "documentation":"<p>List of successful profile outbound requests</p>", |
| 2157 | + "max":20, |
| 2158 | + "min":0 |
| 2159 | + }, |
2033 | 2160 | "SuccessfulRequest":{
|
2034 | 2161 | "type":"structure",
|
2035 | 2162 | "members":{
|
|
0 commit comments