Skip to content

Commit e70d59c

Browse files
author
AWS
committed
Amazon AppIntegrations Service Update: Updated CreateDataIntegration and CreateDataIntegrationAssociation API to support bulk data export from Amazon Connect Customer Profiles to the customer S3 bucket.
1 parent 6e9a245 commit e70d59c

File tree

2 files changed

+205
-13
lines changed

2 files changed

+205
-13
lines changed

‎.changes/next-release/feature-AmazonAppIntegrationsService-ce6cf1b.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon AppIntegrations Service",
4+
"contributor": "",
5+
"description": "Updated CreateDataIntegration and CreateDataIntegrationAssociation API to support bulk data export from Amazon Connect Customer Profiles to the customer S3 bucket."
6+
}

‎services/appintegrations/src/main/resources/codegen-resources/service-2.json

Lines changed: 199 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@
55
"endpointPrefix":"app-integrations",
66
"jsonVersion":"1.1",
77
"protocol":"rest-json",
8+
"protocols":["rest-json"],
89
"serviceFullName":"Amazon AppIntegrations Service",
910
"serviceId":"AppIntegrations",
1011
"signatureVersion":"v4",
1112
"signingName":"app-integrations",
12-
"uid":"appintegrations-2020-07-29"
13+
"uid":"appintegrations-2020-07-29",
14+
"auth":["aws.auth#sigv4"]
1315
},
1416
"operations":{
1517
"CreateApplication":{
@@ -29,7 +31,7 @@
2931
{"shape":"AccessDeniedException"},
3032
{"shape":"UnsupportedOperationException"}
3133
],
32-
"documentation":"<p>This API is in preview release and subject to change.</p> <p>Creates and persists an Application resource.</p>"
34+
"documentation":"<p>Creates and persists an Application resource.</p>"
3335
},
3436
"CreateDataIntegration":{
3537
"name":"CreateDataIntegration",
@@ -49,6 +51,24 @@
4951
],
5052
"documentation":"<p>Creates and persists a DataIntegration resource.</p> <note> <p>You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the <code>CreateDataIntegration</code> API.</p> </note>"
5153
},
54+
"CreateDataIntegrationAssociation":{
55+
"name":"CreateDataIntegrationAssociation",
56+
"http":{
57+
"method":"POST",
58+
"requestUri":"/dataIntegrations/{Identifier}/associations"
59+
},
60+
"input":{"shape":"CreateDataIntegrationAssociationRequest"},
61+
"output":{"shape":"CreateDataIntegrationAssociationResponse"},
62+
"errors":[
63+
{"shape":"InternalServiceError"},
64+
{"shape":"ResourceQuotaExceededException"},
65+
{"shape":"ThrottlingException"},
66+
{"shape":"ResourceNotFoundException"},
67+
{"shape":"InvalidRequestException"},
68+
{"shape":"AccessDeniedException"}
69+
],
70+
"documentation":"<p>Creates and persists a DataIntegrationAssociation resource.</p>"
71+
},
5272
"CreateEventIntegration":{
5373
"name":"CreateEventIntegration",
5474
"http":{
@@ -133,7 +153,7 @@
133153
{"shape":"InvalidRequestException"},
134154
{"shape":"AccessDeniedException"}
135155
],
136-
"documentation":"<p>This API is in preview release and subject to change.</p> <p>Get an Application resource.</p>"
156+
"documentation":"<p>Get an Application resource.</p>"
137157
},
138158
"GetDataIntegration":{
139159
"name":"GetDataIntegration",
@@ -200,7 +220,7 @@
200220
{"shape":"InvalidRequestException"},
201221
{"shape":"AccessDeniedException"}
202222
],
203-
"documentation":"<p>This API is in preview release and subject to change.</p> <p>Lists applications in the account.</p>"
223+
"documentation":"<p>Lists applications in the account.</p>"
204224
},
205225
"ListDataIntegrationAssociations":{
206226
"name":"ListDataIntegrationAssociations",
@@ -332,7 +352,7 @@
332352
{"shape":"AccessDeniedException"},
333353
{"shape":"UnsupportedOperationException"}
334354
],
335-
"documentation":"<p>This API is in preview release and subject to change.</p> <p>Updates and persists an Application resource.</p>"
355+
"documentation":"<p>Updates and persists an Application resource.</p>"
336356
},
337357
"UpdateDataIntegration":{
338358
"name":"UpdateDataIntegration",
@@ -351,6 +371,23 @@
351371
],
352372
"documentation":"<p>Updates the description of a DataIntegration.</p> <note> <p>You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html\">CreateDataIntegration</a> API.</p> </note>"
353373
},
374+
"UpdateDataIntegrationAssociation":{
375+
"name":"UpdateDataIntegrationAssociation",
376+
"http":{
377+
"method":"PATCH",
378+
"requestUri":"/dataIntegrations/{Identifier}/associations/{DataIntegrationAssociationIdentifier}"
379+
},
380+
"input":{"shape":"UpdateDataIntegrationAssociationRequest"},
381+
"output":{"shape":"UpdateDataIntegrationAssociationResponse"},
382+
"errors":[
383+
{"shape":"InternalServiceError"},
384+
{"shape":"ThrottlingException"},
385+
{"shape":"ResourceNotFoundException"},
386+
{"shape":"InvalidRequestException"},
387+
{"shape":"AccessDeniedException"}
388+
],
389+
"documentation":"<p>Updates and persists a DataIntegrationAssociation resource.</p> <note> <p> Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job. </p> </note>"
390+
},
354391
"UpdateEventIntegration":{
355392
"name":"UpdateEventIntegration",
356393
"http":{
@@ -560,12 +597,58 @@
560597
}
561598
}
562599
},
600+
"CreateDataIntegrationAssociationRequest":{
601+
"type":"structure",
602+
"required":["DataIntegrationIdentifier"],
603+
"members":{
604+
"DataIntegrationIdentifier":{
605+
"shape":"Identifier",
606+
"documentation":"<p>A unique identifier for the DataIntegration.</p>",
607+
"location":"uri",
608+
"locationName":"Identifier"
609+
},
610+
"ClientId":{
611+
"shape":"ClientId",
612+
"documentation":"<p>The identifier for the client that is associated with the DataIntegration association.</p>"
613+
},
614+
"ObjectConfiguration":{"shape":"ObjectConfiguration"},
615+
"DestinationURI":{
616+
"shape":"DestinationURI",
617+
"documentation":"<p>The URI of the data destination.</p>"
618+
},
619+
"ClientAssociationMetadata":{
620+
"shape":"ClientAssociationMetadata",
621+
"documentation":"<p>The mapping of metadata to be extracted from the data.</p>"
622+
},
623+
"ClientToken":{
624+
"shape":"IdempotencyToken",
625+
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href=\"https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/\">Making retries safe with idempotent APIs</a>.</p>",
626+
"idempotencyToken":true
627+
},
628+
"ExecutionConfiguration":{
629+
"shape":"ExecutionConfiguration",
630+
"documentation":"<p>The configuration for how the files should be pulled from the source.</p>"
631+
}
632+
}
633+
},
634+
"CreateDataIntegrationAssociationResponse":{
635+
"type":"structure",
636+
"members":{
637+
"DataIntegrationAssociationId":{
638+
"shape":"UUID",
639+
"documentation":"<p>A unique identifier. for the DataIntegrationAssociation.</p>"
640+
},
641+
"DataIntegrationArn":{
642+
"shape":"Arn",
643+
"documentation":"<p>The Amazon Resource Name (ARN) for the DataIntegration.</p>"
644+
}
645+
}
646+
},
563647
"CreateDataIntegrationRequest":{
564648
"type":"structure",
565649
"required":[
566650
"Name",
567-
"KmsKey",
568-
"SourceURI"
651+
"KmsKey"
569652
],
570653
"members":{
571654
"Name":{
@@ -578,7 +661,7 @@
578661
},
579662
"KmsKey":{
580663
"shape":"NonBlankString",
581-
"documentation":"<p>The KMS key for the DataIntegration.</p>"
664+
"documentation":"<p>The KMS key ARN for the DataIntegration.</p>"
582665
},
583666
"SourceURI":{
584667
"shape":"SourceURI",
@@ -628,7 +711,7 @@
628711
},
629712
"KmsKey":{
630713
"shape":"NonBlankString",
631-
"documentation":"<p>The KMS key for the DataIntegration.</p>"
714+
"documentation":"<p>The KMS key ARN for the DataIntegration.</p>"
632715
},
633716
"SourceURI":{
634717
"shape":"SourceURI",
@@ -714,7 +797,16 @@
714797
"ClientId":{
715798
"shape":"ClientId",
716799
"documentation":"<p>The identifier for the client that is associated with the DataIntegration association.</p>"
717-
}
800+
},
801+
"DestinationURI":{
802+
"shape":"DestinationURI",
803+
"documentation":"<p>The URI of the data destination.</p>"
804+
},
805+
"LastExecutionStatus":{
806+
"shape":"LastExecutionStatus",
807+
"documentation":"<p>The execution status of the last job.</p>"
808+
},
809+
"ExecutionConfiguration":{"shape":"ExecutionConfiguration"}
718810
},
719811
"documentation":"<p>Summary information about the DataIntegration association.</p>"
720812
},
@@ -805,6 +897,12 @@
805897
"min":0,
806898
"pattern":".*"
807899
},
900+
"DestinationURI":{
901+
"type":"string",
902+
"max":1000,
903+
"min":1,
904+
"pattern":"^(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+$)|(\\w+\\:\\/\\/[\\w.-]+[\\w/!@#+=.-]+[\\w/!@#+=.-]+[\\w/!@#+=.,-]+$)"
905+
},
808906
"DuplicateResourceException":{
809907
"type":"structure",
810908
"members":{
@@ -921,6 +1019,34 @@
9211019
"min":1,
9221020
"pattern":"^[a-zA-Z0-9\\/\\._\\-]+::[a-zA-Z0-9\\/\\._\\-]+(?:\\*)?$"
9231021
},
1022+
"ExecutionConfiguration":{
1023+
"type":"structure",
1024+
"required":["ExecutionMode"],
1025+
"members":{
1026+
"ExecutionMode":{
1027+
"shape":"ExecutionMode",
1028+
"documentation":"<p>The mode for data import/export execution.</p>"
1029+
},
1030+
"OnDemandConfiguration":{"shape":"OnDemandConfiguration"},
1031+
"ScheduleConfiguration":{"shape":"ScheduleConfiguration"}
1032+
},
1033+
"documentation":"<p>The configuration for how the files should be pulled from the source.</p>"
1034+
},
1035+
"ExecutionMode":{
1036+
"type":"string",
1037+
"enum":[
1038+
"ON_DEMAND",
1039+
"SCHEDULED"
1040+
]
1041+
},
1042+
"ExecutionStatus":{
1043+
"type":"string",
1044+
"enum":[
1045+
"COMPLETED",
1046+
"IN_PROGRESS",
1047+
"FAILED"
1048+
]
1049+
},
9241050
"ExternalUrlConfig":{
9251051
"type":"structure",
9261052
"required":["AccessUrl"],
@@ -1072,11 +1198,11 @@
10721198
},
10731199
"Description":{
10741200
"shape":"Description",
1075-
"documentation":"<p>The KMS key for the DataIntegration.</p>"
1201+
"documentation":"<p>The KMS key ARN for the DataIntegration.</p>"
10761202
},
10771203
"KmsKey":{
10781204
"shape":"NonBlankString",
1079-
"documentation":"<p>The KMS key for the DataIntegration.</p>"
1205+
"documentation":"<p>The KMS key ARN for the DataIntegration.</p>"
10801206
},
10811207
"SourceURI":{
10821208
"shape":"SourceURI",
@@ -1172,6 +1298,20 @@
11721298
"error":{"httpStatusCode":400},
11731299
"exception":true
11741300
},
1301+
"LastExecutionStatus":{
1302+
"type":"structure",
1303+
"members":{
1304+
"ExecutionStatus":{
1305+
"shape":"ExecutionStatus",
1306+
"documentation":"<p>The job status enum string.</p>"
1307+
},
1308+
"StatusMessage":{
1309+
"shape":"NonBlankString",
1310+
"documentation":"<p>The status message of a job.</p>"
1311+
}
1312+
},
1313+
"documentation":"<p>The execution status of the last job.</p>"
1314+
},
11751315
"ListApplicationAssociationsRequest":{
11761316
"type":"structure",
11771317
"required":["ApplicationId"],
@@ -1436,6 +1576,21 @@
14361576
"value":{"shape":"FieldsMap"},
14371577
"documentation":"<p>The configuration for what data should be pulled from the source.</p>"
14381578
},
1579+
"OnDemandConfiguration":{
1580+
"type":"structure",
1581+
"required":["StartTime"],
1582+
"members":{
1583+
"StartTime":{
1584+
"shape":"NonBlankString",
1585+
"documentation":"<p>The start time for data pull from the source as an Unix/epoch string in milliseconds</p>"
1586+
},
1587+
"EndTime":{
1588+
"shape":"NonBlankString",
1589+
"documentation":"<p>The end time for data pull from the source as an Unix/epoch string in milliseconds</p>"
1590+
}
1591+
},
1592+
"documentation":"<p>The start and end time for data pull from the source.</p>"
1593+
},
14391594
"Permission":{
14401595
"type":"string",
14411596
"documentation":"<p>The permission of an event or request that the application has access to.</p>",
@@ -1694,6 +1849,37 @@
16941849
"members":{
16951850
}
16961851
},
1852+
"UpdateDataIntegrationAssociationRequest":{
1853+
"type":"structure",
1854+
"required":[
1855+
"DataIntegrationIdentifier",
1856+
"DataIntegrationAssociationIdentifier",
1857+
"ExecutionConfiguration"
1858+
],
1859+
"members":{
1860+
"DataIntegrationIdentifier":{
1861+
"shape":"Identifier",
1862+
"documentation":"<p>A unique identifier for the DataIntegration.</p>",
1863+
"location":"uri",
1864+
"locationName":"Identifier"
1865+
},
1866+
"DataIntegrationAssociationIdentifier":{
1867+
"shape":"Identifier",
1868+
"documentation":"<p>A unique identifier. of the DataIntegrationAssociation resource</p>",
1869+
"location":"uri",
1870+
"locationName":"DataIntegrationAssociationIdentifier"
1871+
},
1872+
"ExecutionConfiguration":{
1873+
"shape":"ExecutionConfiguration",
1874+
"documentation":"<p>The configuration for how the files should be pulled from the source.</p>"
1875+
}
1876+
}
1877+
},
1878+
"UpdateDataIntegrationAssociationResponse":{
1879+
"type":"structure",
1880+
"members":{
1881+
}
1882+
},
16971883
"UpdateDataIntegrationRequest":{
16981884
"type":"structure",
16991885
"required":["Identifier"],
@@ -1741,5 +1927,5 @@
17411927
}
17421928
}
17431929
},
1744-
"documentation":"<p>The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.</p> <p>For information about how you can use external applications with Amazon Connect, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/crm.html\">Set up pre-built integrations</a> and <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-wisdom.html\">Deliver information to agents using Amazon Connect Wisdom</a> in the <i>Amazon Connect Administrator Guide</i>.</p>"
1930+
"documentation":"<ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_Operations_Amazon_AppIntegrations_Service.html\">Amazon AppIntegrations actions</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/APIReference/API_Types_Amazon_AppIntegrations_Service.html\">Amazon AppIntegrations data types</a> </p> </li> </ul> <p>The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.</p> <p>For information about how you can use external applications with Amazon Connect, see the following topics in the <i>Amazon Connect Administrator Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/3p-apps.html\">Third-party applications (3p apps) in the agent workspace</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html\">Use Amazon Q in Connect for generative AI–powered agent assistance in real-time</a> </p> </li> </ul>"
17451931
}

0 commit comments

Comments
 (0)