github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/appintegrations/2020-07-29/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<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>", 4 "operations": { 5 "CreateDataIntegration": "<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>", 6 "CreateEventIntegration": "<p>Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.</p>", 7 "DeleteDataIntegration": "<p>Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role. </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>", 8 "DeleteEventIntegration": "<p>Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.</p>", 9 "GetDataIntegration": "<p>Returns information about the 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>", 10 "GetEventIntegration": "<p>Returns information about the event integration.</p>", 11 "ListDataIntegrationAssociations": "<p>Returns a paginated list of DataIntegration associations in the account.</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>", 12 "ListDataIntegrations": "<p>Returns a paginated list of DataIntegrations in the account.</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>", 13 "ListEventIntegrationAssociations": "<p>Returns a paginated list of event integration associations in the account. </p>", 14 "ListEventIntegrations": "<p>Returns a paginated list of event integrations in the account.</p>", 15 "ListTagsForResource": "<p>Lists the tags for the specified resource.</p>", 16 "TagResource": "<p>Adds the specified tags to the specified resource.</p>", 17 "UntagResource": "<p>Removes the specified tags from the specified resource.</p>", 18 "UpdateDataIntegration": "<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>", 19 "UpdateEventIntegration": "<p>Updates the description of an event integration.</p>" 20 }, 21 "shapes": { 22 "AccessDeniedException": { 23 "base": "<p>You do not have sufficient access to perform this action.</p>", 24 "refs": { 25 } 26 }, 27 "Arn": { 28 "base": null, 29 "refs": { 30 "CreateDataIntegrationResponse$Arn": "<p>The Amazon Resource Name (ARN)</p>", 31 "CreateEventIntegrationResponse$EventIntegrationArn": "<p>The Amazon Resource Name (ARN) of the event integration. </p>", 32 "DataIntegrationAssociationSummary$DataIntegrationAssociationArn": "<p>The Amazon Resource Name (ARN) of the DataIntegration association.</p>", 33 "DataIntegrationAssociationSummary$DataIntegrationArn": "<p>The Amazon Resource Name (ARN)of the DataIntegration.</p>", 34 "DataIntegrationSummary$Arn": "<p>The Amazon Resource Name (ARN) of the DataIntegration.</p>", 35 "EventIntegration$EventIntegrationArn": "<p>The Amazon Resource Name (ARN) of the event integration.</p>", 36 "EventIntegrationAssociation$EventIntegrationAssociationArn": "<p>The Amazon Resource Name (ARN) for the event integration association.</p>", 37 "GetDataIntegrationResponse$Arn": "<p>The Amazon Resource Name (ARN) for the DataIntegration.</p>", 38 "GetEventIntegrationResponse$EventIntegrationArn": "<p>The Amazon Resource Name (ARN) for the event integration.</p>", 39 "ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource. </p>", 40 "TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>", 41 "UntagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>" 42 } 43 }, 44 "ClientAssociationMetadata": { 45 "base": null, 46 "refs": { 47 "EventIntegrationAssociation$ClientAssociationMetadata": "<p>The metadata associated with the client.</p>" 48 } 49 }, 50 "ClientId": { 51 "base": null, 52 "refs": { 53 "DataIntegrationAssociationSummary$ClientId": "<p>The identifier for teh client that is associated with the DataIntegration association.</p>", 54 "EventIntegrationAssociation$ClientId": "<p>The identifier for the client that is associated with the event integration.</p>" 55 } 56 }, 57 "CreateDataIntegrationRequest": { 58 "base": null, 59 "refs": { 60 } 61 }, 62 "CreateDataIntegrationResponse": { 63 "base": null, 64 "refs": { 65 } 66 }, 67 "CreateEventIntegrationRequest": { 68 "base": null, 69 "refs": { 70 } 71 }, 72 "CreateEventIntegrationResponse": { 73 "base": null, 74 "refs": { 75 } 76 }, 77 "DataIntegrationAssociationSummary": { 78 "base": "<p>Summary information about the DataIntegration association.</p>", 79 "refs": { 80 "DataIntegrationAssociationsList$member": null 81 } 82 }, 83 "DataIntegrationAssociationsList": { 84 "base": null, 85 "refs": { 86 "ListDataIntegrationAssociationsResponse$DataIntegrationAssociations": "<p>The Amazon Resource Name (ARN) and unique ID of the DataIntegration association.</p>" 87 } 88 }, 89 "DataIntegrationSummary": { 90 "base": "<p>Summary information about the DataIntegration.</p>", 91 "refs": { 92 "DataIntegrationsList$member": null 93 } 94 }, 95 "DataIntegrationsList": { 96 "base": null, 97 "refs": { 98 "ListDataIntegrationsResponse$DataIntegrations": "<p>The DataIntegrations associated with this account.</p>" 99 } 100 }, 101 "DeleteDataIntegrationRequest": { 102 "base": null, 103 "refs": { 104 } 105 }, 106 "DeleteDataIntegrationResponse": { 107 "base": null, 108 "refs": { 109 } 110 }, 111 "DeleteEventIntegrationRequest": { 112 "base": null, 113 "refs": { 114 } 115 }, 116 "DeleteEventIntegrationResponse": { 117 "base": null, 118 "refs": { 119 } 120 }, 121 "Description": { 122 "base": null, 123 "refs": { 124 "CreateDataIntegrationRequest$Description": "<p>A description of the DataIntegration.</p>", 125 "CreateDataIntegrationResponse$Description": "<p>A description of the DataIntegration.</p>", 126 "CreateEventIntegrationRequest$Description": "<p>The description of the event integration.</p>", 127 "EventIntegration$Description": "<p>The event integration description.</p>", 128 "GetDataIntegrationResponse$Description": "<p>The KMS key for the DataIntegration.</p>", 129 "GetEventIntegrationResponse$Description": "<p>The description of the event integration.</p>", 130 "UpdateDataIntegrationRequest$Description": "<p>A description of the DataIntegration.</p>", 131 "UpdateEventIntegrationRequest$Description": "<p>The description of the event inegration.</p>" 132 } 133 }, 134 "DuplicateResourceException": { 135 "base": "<p>A resource with the specified name already exists.</p>", 136 "refs": { 137 } 138 }, 139 "EventBridgeBus": { 140 "base": null, 141 "refs": { 142 "CreateEventIntegrationRequest$EventBridgeBus": "<p>The EventBridge bus.</p>", 143 "EventIntegration$EventBridgeBus": "<p>The Amazon EventBridge bus for the event integration.</p>", 144 "GetEventIntegrationResponse$EventBridgeBus": "<p>The EventBridge bus.</p>" 145 } 146 }, 147 "EventBridgeRuleName": { 148 "base": null, 149 "refs": { 150 "EventIntegrationAssociation$EventBridgeRuleName": "<p>The name of the EventBridge rule.</p>" 151 } 152 }, 153 "EventFilter": { 154 "base": "<p>The event filter.</p>", 155 "refs": { 156 "CreateEventIntegrationRequest$EventFilter": "<p>The event filter.</p>", 157 "EventIntegration$EventFilter": "<p>The event integration filter.</p>", 158 "GetEventIntegrationResponse$EventFilter": "<p>The event filter.</p>" 159 } 160 }, 161 "EventIntegration": { 162 "base": "<p>The event integration.</p>", 163 "refs": { 164 "EventIntegrationsList$member": null 165 } 166 }, 167 "EventIntegrationAssociation": { 168 "base": "<p>The event integration association.</p>", 169 "refs": { 170 "EventIntegrationAssociationsList$member": null 171 } 172 }, 173 "EventIntegrationAssociationsList": { 174 "base": null, 175 "refs": { 176 "ListEventIntegrationAssociationsResponse$EventIntegrationAssociations": "<p>The event integration associations.</p>" 177 } 178 }, 179 "EventIntegrationsList": { 180 "base": null, 181 "refs": { 182 "ListEventIntegrationsResponse$EventIntegrations": "<p>The event integrations.</p>" 183 } 184 }, 185 "GetDataIntegrationRequest": { 186 "base": null, 187 "refs": { 188 } 189 }, 190 "GetDataIntegrationResponse": { 191 "base": null, 192 "refs": { 193 } 194 }, 195 "GetEventIntegrationRequest": { 196 "base": null, 197 "refs": { 198 } 199 }, 200 "GetEventIntegrationResponse": { 201 "base": null, 202 "refs": { 203 } 204 }, 205 "IdempotencyToken": { 206 "base": null, 207 "refs": { 208 "CreateDataIntegrationRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 209 "CreateDataIntegrationResponse$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>", 210 "CreateEventIntegrationRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>" 211 } 212 }, 213 "Identifier": { 214 "base": null, 215 "refs": { 216 "DeleteDataIntegrationRequest$DataIntegrationIdentifier": "<p>A unique identifier for the DataIntegration.</p>", 217 "GetDataIntegrationRequest$Identifier": "<p>A unique identifier.</p>", 218 "ListDataIntegrationAssociationsRequest$DataIntegrationIdentifier": "<p>A unique identifier for the DataIntegration.</p>", 219 "UpdateDataIntegrationRequest$Identifier": "<p>A unique identifier for the DataIntegration.</p>" 220 } 221 }, 222 "InternalServiceError": { 223 "base": "<p>Request processing failed due to an error or failure with the service.</p>", 224 "refs": { 225 } 226 }, 227 "InvalidRequestException": { 228 "base": "<p>The request is not valid. </p>", 229 "refs": { 230 } 231 }, 232 "ListDataIntegrationAssociationsRequest": { 233 "base": null, 234 "refs": { 235 } 236 }, 237 "ListDataIntegrationAssociationsResponse": { 238 "base": null, 239 "refs": { 240 } 241 }, 242 "ListDataIntegrationsRequest": { 243 "base": null, 244 "refs": { 245 } 246 }, 247 "ListDataIntegrationsResponse": { 248 "base": null, 249 "refs": { 250 } 251 }, 252 "ListEventIntegrationAssociationsRequest": { 253 "base": null, 254 "refs": { 255 } 256 }, 257 "ListEventIntegrationAssociationsResponse": { 258 "base": null, 259 "refs": { 260 } 261 }, 262 "ListEventIntegrationsRequest": { 263 "base": null, 264 "refs": { 265 } 266 }, 267 "ListEventIntegrationsResponse": { 268 "base": null, 269 "refs": { 270 } 271 }, 272 "ListTagsForResourceRequest": { 273 "base": null, 274 "refs": { 275 } 276 }, 277 "ListTagsForResourceResponse": { 278 "base": null, 279 "refs": { 280 } 281 }, 282 "MaxResults": { 283 "base": null, 284 "refs": { 285 "ListDataIntegrationAssociationsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 286 "ListDataIntegrationsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 287 "ListEventIntegrationAssociationsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>", 288 "ListEventIntegrationsRequest$MaxResults": "<p>The maximum number of results to return per page.</p>" 289 } 290 }, 291 "Message": { 292 "base": null, 293 "refs": { 294 "AccessDeniedException$Message": null, 295 "DuplicateResourceException$Message": null, 296 "InternalServiceError$Message": null, 297 "InvalidRequestException$Message": null, 298 "ResourceNotFoundException$Message": null, 299 "ResourceQuotaExceededException$Message": null, 300 "ThrottlingException$Message": null 301 } 302 }, 303 "Name": { 304 "base": null, 305 "refs": { 306 "CreateDataIntegrationRequest$Name": "<p>The name of the DataIntegration.</p>", 307 "CreateDataIntegrationResponse$Name": "<p>The name of the DataIntegration.</p>", 308 "CreateEventIntegrationRequest$Name": "<p>The name of the event integration.</p>", 309 "DataIntegrationSummary$Name": "<p>The name of the DataIntegration.</p>", 310 "DeleteEventIntegrationRequest$Name": "<p>The name of the event integration.</p>", 311 "EventIntegration$Name": "<p>The name of the event integration.</p>", 312 "EventIntegrationAssociation$EventIntegrationName": "<p>The name of the event integration.</p>", 313 "GetDataIntegrationResponse$Name": "<p>The name of the DataIntegration.</p>", 314 "GetEventIntegrationRequest$Name": "<p>The name of the event integration. </p>", 315 "GetEventIntegrationResponse$Name": "<p>The name of the event integration. </p>", 316 "ListEventIntegrationAssociationsRequest$EventIntegrationName": "<p>The name of the event integration. </p>", 317 "UpdateDataIntegrationRequest$Name": "<p>The name of the DataIntegration.</p>", 318 "UpdateEventIntegrationRequest$Name": "<p>The name of the event integration.</p>" 319 } 320 }, 321 "NextToken": { 322 "base": null, 323 "refs": { 324 "ListDataIntegrationAssociationsRequest$NextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>", 325 "ListDataIntegrationAssociationsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 326 "ListDataIntegrationsRequest$NextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>", 327 "ListDataIntegrationsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 328 "ListEventIntegrationAssociationsRequest$NextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>", 329 "ListEventIntegrationAssociationsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>", 330 "ListEventIntegrationsRequest$NextToken": "<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>", 331 "ListEventIntegrationsResponse$NextToken": "<p>If there are additional results, this is the token for the next set of results.</p>" 332 } 333 }, 334 "NonBlankString": { 335 "base": null, 336 "refs": { 337 "ClientAssociationMetadata$key": null, 338 "ClientAssociationMetadata$value": null, 339 "CreateDataIntegrationRequest$KmsKey": "<p>The KMS key for the DataIntegration.</p>", 340 "CreateDataIntegrationRequest$SourceURI": "<p>The URI of the data source.</p>", 341 "CreateDataIntegrationResponse$KmsKey": "<p>The KMS key for the DataIntegration.</p>", 342 "CreateDataIntegrationResponse$SourceURI": "<p>The URI of the data source.</p>", 343 "DataIntegrationSummary$SourceURI": "<p>The URI of the data source.</p>", 344 "GetDataIntegrationResponse$KmsKey": "<p>The KMS key for the DataIntegration.</p>", 345 "GetDataIntegrationResponse$SourceURI": "<p>The URI of the data source.</p>", 346 "ScheduleConfiguration$FirstExecutionFrom": "<p>The start date for objects to import in the first flow run.</p>" 347 } 348 }, 349 "Object": { 350 "base": null, 351 "refs": { 352 "ScheduleConfiguration$Object": "<p>The name of the object to pull from the data source.</p>" 353 } 354 }, 355 "ResourceNotFoundException": { 356 "base": "<p>The specified resource was not found.</p>", 357 "refs": { 358 } 359 }, 360 "ResourceQuotaExceededException": { 361 "base": "<p>The allowed quota for the resource has been exceeded.</p>", 362 "refs": { 363 } 364 }, 365 "Schedule": { 366 "base": null, 367 "refs": { 368 "ScheduleConfiguration$ScheduleExpression": "<p>How often the data should be pulled from data source.</p>" 369 } 370 }, 371 "ScheduleConfiguration": { 372 "base": "<p>The name of the data and how often it should be pulled from the source.</p>", 373 "refs": { 374 "CreateDataIntegrationRequest$ScheduleConfig": "<p>The name of the data and how often it should be pulled from the source.</p>", 375 "CreateDataIntegrationResponse$ScheduleConfiguration": "<p>The name of the data and how often it should be pulled from the source.</p>", 376 "GetDataIntegrationResponse$ScheduleConfiguration": "<p>The name of the data and how often it should be pulled from the source.</p>" 377 } 378 }, 379 "Source": { 380 "base": null, 381 "refs": { 382 "EventFilter$Source": "<p>The source of the events.</p>" 383 } 384 }, 385 "TagKey": { 386 "base": null, 387 "refs": { 388 "TagKeyList$member": null, 389 "TagMap$key": null 390 } 391 }, 392 "TagKeyList": { 393 "base": null, 394 "refs": { 395 "UntagResourceRequest$tagKeys": "<p>The tag keys.</p>" 396 } 397 }, 398 "TagMap": { 399 "base": null, 400 "refs": { 401 "CreateDataIntegrationRequest$Tags": "<p>One or more tags.</p>", 402 "CreateDataIntegrationResponse$Tags": "<p>One or more tags.</p>", 403 "CreateEventIntegrationRequest$Tags": "<p>One or more tags.</p>", 404 "EventIntegration$Tags": "<p>The tags.</p>", 405 "GetDataIntegrationResponse$Tags": "<p>One or more tags.</p>", 406 "GetEventIntegrationResponse$Tags": "<p>One or more tags.</p>", 407 "ListTagsForResourceResponse$tags": "<p>Information about the tags.</p>", 408 "TagResourceRequest$tags": "<p>One or more tags. </p>" 409 } 410 }, 411 "TagResourceRequest": { 412 "base": null, 413 "refs": { 414 } 415 }, 416 "TagResourceResponse": { 417 "base": null, 418 "refs": { 419 } 420 }, 421 "TagValue": { 422 "base": null, 423 "refs": { 424 "TagMap$value": null 425 } 426 }, 427 "ThrottlingException": { 428 "base": "<p>The throttling limit has been exceeded.</p>", 429 "refs": { 430 } 431 }, 432 "UUID": { 433 "base": null, 434 "refs": { 435 "CreateDataIntegrationResponse$Id": "<p>A unique identifier.</p>", 436 "EventIntegrationAssociation$EventIntegrationAssociationId": "<p>The identifier for the event integration association.</p>", 437 "GetDataIntegrationResponse$Id": "<p>A unique identifier.</p>" 438 } 439 }, 440 "UntagResourceRequest": { 441 "base": null, 442 "refs": { 443 } 444 }, 445 "UntagResourceResponse": { 446 "base": null, 447 "refs": { 448 } 449 }, 450 "UpdateDataIntegrationRequest": { 451 "base": null, 452 "refs": { 453 } 454 }, 455 "UpdateDataIntegrationResponse": { 456 "base": null, 457 "refs": { 458 } 459 }, 460 "UpdateEventIntegrationRequest": { 461 "base": null, 462 "refs": { 463 } 464 }, 465 "UpdateEventIntegrationResponse": { 466 "base": null, 467 "refs": { 468 } 469 } 470 } 471 }