Amazon Connect
API Reference
API Version 2017-08-08
Amazon Connect: API Reference
Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.
Table of Contents
Welcome ... 1
Actions ... 2
AssociateApprovedOrigin ... 6
Request Syntax ... 6
URI Request Parameters ... 6
Request Body ... 6
Response Syntax ... 6
Response Elements ... 6
Errors ... 6
See Also ... 7
AssociateBot ... 8
Request Syntax ... 8
URI Request Parameters ... 8
Request Body ... 8
Response Syntax ... 8
Response Elements ... 9
Errors ... 9
See Also ... 9
AssociateDefaultVocabulary ... 11
Request Syntax ... 11
URI Request Parameters ... 11
Request Body ... 11
Response Syntax ... 11
Response Elements ... 12
Errors ... 12
See Also ... 12
AssociateInstanceStorageConfig ... 13
Request Syntax ... 13
URI Request Parameters ... 13
Request Body ... 14
Response Syntax ... 14
Response Elements ... 14
Errors ... 14
See Also ... 15
AssociateLambdaFunction ... 16
Request Syntax ... 16
URI Request Parameters ... 16
Request Body ... 16
Response Syntax ... 16
Response Elements ... 16
Errors ... 17
See Also ... 17
AssociateLexBot ... 18
Request Syntax ... 18
URI Request Parameters ... 18
Request Body ... 18
Response Syntax ... 18
Response Elements ... 18
Errors ... 19
See Also ... 19
AssociateQueueQuickConnects ... 20
Request Syntax ... 20
URI Request Parameters ... 20
Request Body ... 20
Response Syntax ... 20
Response Elements ... 20
Errors ... 21
See Also ... 21
AssociateRoutingProfileQueues ... 22
Request Syntax ... 22
URI Request Parameters ... 22
Request Body ... 22
Response Syntax ... 23
Response Elements ... 23
Errors ... 23
See Also ... 23
AssociateSecurityKey ... 25
Request Syntax ... 25
URI Request Parameters ... 25
Request Body ... 25
Response Syntax ... 25
Response Elements ... 25
Errors ... 26
See Also ... 26
CreateAgentStatus ... 28
Request Syntax ... 28
URI Request Parameters ... 28
Request Body ... 28
Response Syntax ... 29
Response Elements ... 29
Errors ... 30
See Also ... 30
CreateContactFlow ... 32
Request Syntax ... 32
URI Request Parameters ... 32
Request Body ... 32
Response Syntax ... 33
Response Elements ... 33
Errors ... 34
See Also ... 34
CreateContactFlowModule ... 36
Request Syntax ... 36
URI Request Parameters ... 36
Request Body ... 36
Response Syntax ... 37
Response Elements ... 37
Errors ... 38
See Also ... 39
CreateHoursOfOperation ... 40
Request Syntax ... 40
URI Request Parameters ... 40
Request Body ... 40
Response Syntax ... 41
Response Elements ... 41
Errors ... 42
See Also ... 42
CreateInstance ... 44
Request Syntax ... 44
URI Request Parameters ... 44
Request Body ... 44
Response Syntax ... 45
Response Elements ... 45
Errors ... 46
See Also ... 46
CreateIntegrationAssociation ... 47
Request Syntax ... 47
URI Request Parameters ... 47
Request Body ... 47
Response Syntax ... 48
Response Elements ... 48
Errors ... 49
See Also ... 49
CreateQueue ... 51
Request Syntax ... 51
URI Request Parameters ... 51
Request Body ... 51
Response Syntax ... 52
Response Elements ... 53
Errors ... 53
See Also ... 54
CreateQuickConnect ... 55
Request Syntax ... 55
URI Request Parameters ... 55
Request Body ... 55
Response Syntax ... 56
Response Elements ... 56
Errors ... 57
See Also ... 57
CreateRoutingProfile ... 58
Request Syntax ... 58
URI Request Parameters ... 58
Request Body ... 58
Response Syntax ... 59
Response Elements ... 60
Errors ... 60
See Also ... 61
CreateSecurityProfile ... 62
Request Syntax ... 62
URI Request Parameters ... 62
Request Body ... 62
Response Syntax ... 63
Response Elements ... 63
Errors ... 63
See Also ... 64
CreateUseCase ... 65
Request Syntax ... 65
URI Request Parameters ... 65
Request Body ... 65
Response Syntax ... 66
Response Elements ... 66
Errors ... 66
See Also ... 67
CreateUser ... 68
Request Syntax ... 68
URI Request Parameters ... 68
Request Body ... 68
Response Syntax ... 70
Response Elements ... 70
Errors ... 70
See Also ... 71
CreateUserHierarchyGroup ... 72
Request Syntax ... 72
URI Request Parameters ... 72
Request Body ... 72
Response Syntax ... 73
Response Elements ... 73
Errors ... 73
See Also ... 74
CreateVocabulary ... 75
Request Syntax ... 75
URI Request Parameters ... 75
Request Body ... 75
Response Syntax ... 76
Response Elements ... 76
Errors ... 77
See Also ... 78
DeleteContactFlow ... 79
Request Syntax ... 79
URI Request Parameters ... 79
Request Body ... 79
Response Syntax ... 79
Response Elements ... 79
Errors ... 79
See Also ... 80
DeleteContactFlowModule ... 81
Request Syntax ... 81
URI Request Parameters ... 81
Request Body ... 81
Response Syntax ... 81
Response Elements ... 81
Errors ... 81
See Also ... 82
DeleteHoursOfOperation ... 83
Request Syntax ... 83
URI Request Parameters ... 83
Request Body ... 83
Response Syntax ... 83
Response Elements ... 83
Errors ... 83
See Also ... 84
DeleteInstance ... 85
Request Syntax ... 85
URI Request Parameters ... 85
Request Body ... 85
Response Syntax ... 85
Response Elements ... 85
Errors ... 85
See Also ... 86
DeleteIntegrationAssociation ... 87
Request Syntax ... 87
URI Request Parameters ... 87
Request Body ... 87
Response Syntax ... 87
Response Elements ... 87
Errors ... 87
See Also ... 88
DeleteQuickConnect ... 89
Request Syntax ... 89
URI Request Parameters ... 89
Request Body ... 89
Response Syntax ... 89
Response Elements ... 89
Errors ... 89
See Also ... 90
DeleteSecurityProfile ... 91
Request Syntax ... 91
URI Request Parameters ... 91
Request Body ... 91
Response Syntax ... 91
Response Elements ... 91
Errors ... 91
See Also ... 92
DeleteUseCase ... 93
Request Syntax ... 93
URI Request Parameters ... 93
Request Body ... 93
Response Syntax ... 93
Response Elements ... 93
Errors ... 93
See Also ... 94
DeleteUser ... 95
Request Syntax ... 95
URI Request Parameters ... 95
Request Body ... 95
Response Syntax ... 95
Response Elements ... 95
Errors ... 95
See Also ... 96
DeleteUserHierarchyGroup ... 97
Request Syntax ... 97
URI Request Parameters ... 97
Request Body ... 97
Response Syntax ... 97
Response Elements ... 97
Errors ... 97
See Also ... 98
DeleteVocabulary ... 99
Request Syntax ... 99
URI Request Parameters ... 99
Request Body ... 99
Response Syntax ... 99
Response Elements ... 99
Errors ... 100
See Also ... 100
DescribeAgentStatus ... 102
Request Syntax ... 102
URI Request Parameters ... 102
Request Body ... 102
Response Syntax ... 102
Response Elements ... 102
Errors ... 103
See Also ... 103
DescribeContact ... 104
Request Syntax ... 104
URI Request Parameters ... 104
Request Body ... 104
Response Syntax ... 104
Response Elements ... 105
Errors ... 105
See Also ... 105
DescribeContactFlow ... 107
Request Syntax ... 107
URI Request Parameters ... 107
Request Body ... 107
Response Syntax ... 107
Response Elements ... 107
Errors ... 108
See Also ... 108
DescribeContactFlowModule ... 110
Request Syntax ... 110
URI Request Parameters ... 110
Request Body ... 110
Response Syntax ... 110
Response Elements ... 110
Errors ... 111
See Also ... 111
DescribeHoursOfOperation ... 113
Request Syntax ... 113
URI Request Parameters ... 113
Request Body ... 113
Response Syntax ... 113
Response Elements ... 114
Errors ... 114
See Also ... 114
DescribeInstance ... 116
Request Syntax ... 116
URI Request Parameters ... 116
Request Body ... 116
Response Syntax ... 116
Response Elements ... 117
Errors ... 117
See Also ... 117
DescribeInstanceAttribute ... 118
Request Syntax ... 118
URI Request Parameters ... 118
Request Body ... 118
Response Syntax ... 118
Response Elements ... 118
Errors ... 119
See Also ... 119
DescribeInstanceStorageConfig ... 120
Request Syntax ... 120
URI Request Parameters ... 120
Request Body ... 120
Response Syntax ... 120
Response Elements ... 121
Errors ... 121
See Also ... 122
DescribeQueue ... 123
Request Syntax ... 123
URI Request Parameters ... 123
Request Body ... 123
Response Syntax ... 123
Response Elements ... 124
Errors ... 124
See Also ... 124
DescribeQuickConnect ... 126
Request Syntax ... 126
URI Request Parameters ... 126
Request Body ... 126
Response Syntax ... 126
Response Elements ... 127
Errors ... 127
See Also ... 127
DescribeRoutingProfile ... 129
Request Syntax ... 129
URI Request Parameters ... 129
Request Body ... 129
Response Syntax ... 129
Response Elements ... 130
Errors ... 130
See Also ... 130
DescribeSecurityProfile ... 132
Request Syntax ... 132
URI Request Parameters ... 132
Request Body ... 132
Response Syntax ... 132
Response Elements ... 132
Errors ... 133
See Also ... 133
DescribeUser ... 134
Request Syntax ... 134
URI Request Parameters ... 134
Request Body ... 134
Response Syntax ... 134
Response Elements ... 135
Errors ... 135
See Also ... 135
DescribeUserHierarchyGroup ... 137
Request Syntax ... 137
URI Request Parameters ... 137
Request Body ... 137
Response Syntax ... 137
Response Elements ... 138
Errors ... 138
See Also ... 139
DescribeUserHierarchyStructure ... 140
Request Syntax ... 140
URI Request Parameters ... 140
Request Body ... 140
Response Syntax ... 140
Response Elements ... 141
Errors ... 141
See Also ... 141
DescribeVocabulary ... 143
Request Syntax ... 143
URI Request Parameters ... 143
Request Body ... 143
Response Syntax ... 143
Response Elements ... 144
Errors ... 144
See Also ... 144
DisassociateApprovedOrigin ... 146
Request Syntax ... 146
URI Request Parameters ... 146
Request Body ... 146
Response Syntax ... 146
Response Elements ... 146
Errors ... 146
See Also ... 147
DisassociateBot ... 148
Request Syntax ... 148
URI Request Parameters ... 148
Request Body ... 148
Response Syntax ... 149
Response Elements ... 149
Errors ... 149
See Also ... 149
DisassociateInstanceStorageConfig ... 150
Request Syntax ... 150
URI Request Parameters ... 150
Request Body ... 150
Response Syntax ... 150
Response Elements ... 150
Errors ... 151
See Also ... 151
DisassociateLambdaFunction ... 152
Request Syntax ... 152
URI Request Parameters ... 152
Request Body ... 152
Response Syntax ... 152
Response Elements ... 152
Errors ... 152
See Also ... 153
DisassociateLexBot ... 154
Request Syntax ... 154
URI Request Parameters ... 154
Request Body ... 154
Response Syntax ... 154
Response Elements ... 154
Errors ... 154
See Also ... 155
DisassociateQueueQuickConnects ... 156
Request Syntax ... 156
URI Request Parameters ... 156
Request Body ... 156
Response Syntax ... 156
Response Elements ... 156
Errors ... 157
See Also ... 157
DisassociateRoutingProfileQueues ... 158
Request Syntax ... 158
URI Request Parameters ... 158
Request Body ... 158
Response Syntax ... 158
Response Elements ... 159
Errors ... 159
See Also ... 159
DisassociateSecurityKey ... 160
Request Syntax ... 160
URI Request Parameters ... 160
Request Body ... 160
Response Syntax ... 160
Response Elements ... 160
Errors ... 160
See Also ... 161
GetContactAttributes ... 162
Request Syntax ... 162
URI Request Parameters ... 162
Request Body ... 162
Response Syntax ... 162
Response Elements ... 162
Errors ... 163
See Also ... 163
GetCurrentMetricData ... 164
Request Syntax ... 164
URI Request Parameters ... 164
Request Body ... 164
Response Syntax ... 167
Response Elements ... 167
Errors ... 167
Examples ... 168
See Also ... 169
GetFederationToken ... 171
Request Syntax ... 171
URI Request Parameters ... 171
Request Body ... 171
Response Syntax ... 171
Response Elements ... 171
Errors ... 172
See Also ... 172
GetMetricData ... 173
Request Syntax ... 173
URI Request Parameters ... 173
Request Body ... 173
Response Syntax ... 177
Response Elements ... 177
Errors ... 178
Examples ... 178
See Also ... 180
ListAgentStatuses ... 182
Request Syntax ... 182
URI Request Parameters ... 182
Request Body ... 182
Response Syntax ... 182
Response Elements ... 183
Errors ... 183
See Also ... 183
ListApprovedOrigins ... 185
Request Syntax ... 185
URI Request Parameters ... 185
Request Body ... 185
Response Syntax ... 185
Response Elements ... 185
Errors ... 186
See Also ... 186
ListBots ... 188
Request Syntax ... 188
URI Request Parameters ... 188
Request Body ... 188
Response Syntax ... 188
Response Elements ... 189
Errors ... 189
See Also ... 189
ListContactFlowModules ... 191
Request Syntax ... 191
URI Request Parameters ... 191
Request Body ... 191
Response Syntax ... 191
Response Elements ... 192
Errors ... 192
See Also ... 193
ListContactFlows ... 194
Request Syntax ... 194
URI Request Parameters ... 194
Request Body ... 194
Response Syntax ... 194
Response Elements ... 195
Errors ... 195
See Also ... 196
ListContactReferences ... 197
Request Syntax ... 197
URI Request Parameters ... 197
Request Body ... 197
Response Syntax ... 197
Response Elements ... 198
Errors ... 198
See Also ... 199
ListDefaultVocabularies ... 200
Request Syntax ... 200
URI Request Parameters ... 200
Request Body ... 200
Response Syntax ... 201
Response Elements ... 201
Errors ... 201
See Also ... 202
ListHoursOfOperations ... 203
Request Syntax ... 203
URI Request Parameters ... 203
Request Body ... 203
Response Syntax ... 203
Response Elements ... 204
Errors ... 204
See Also ... 204
ListInstanceAttributes ... 206
Request Syntax ... 206
URI Request Parameters ... 206
Request Body ... 206
Response Syntax ... 206
Response Elements ... 206
Errors ... 207
See Also ... 207
ListInstances ... 209
Request Syntax ... 209
URI Request Parameters ... 209
Request Body ... 209
Response Syntax ... 209
Response Elements ... 209
Errors ... 210
See Also ... 210
ListInstanceStorageConfigs ... 211
Request Syntax ... 211
URI Request Parameters ... 211
Request Body ... 211
Response Syntax ... 211
Response Elements ... 212
Errors ... 212
See Also ... 213
ListIntegrationAssociations ... 214
Request Syntax ... 214
URI Request Parameters ... 214
Request Body ... 214
Response Syntax ... 214
Response Elements ... 215
Errors ... 215
See Also ... 215
ListLambdaFunctions ... 217
Request Syntax ... 217
URI Request Parameters ... 217
Request Body ... 217
Response Syntax ... 217
Response Elements ... 217
Errors ... 218
See Also ... 218
ListLexBots ... 220
Request Syntax ... 220
URI Request Parameters ... 220
Request Body ... 220
Response Syntax ... 220
Response Elements ... 220
Errors ... 221
See Also ... 221
ListPhoneNumbers ... 223
Request Syntax ... 223
URI Request Parameters ... 223
Request Body ... 224
Response Syntax ... 224
Response Elements ... 224
Errors ... 224
See Also ... 225
ListPrompts ... 226
Request Syntax ... 226
URI Request Parameters ... 226
Request Body ... 226
Response Syntax ... 226
Response Elements ... 226
Errors ... 227
See Also ... 227
ListQueueQuickConnects ... 229
Request Syntax ... 229
URI Request Parameters ... 229
Request Body ... 229
Response Syntax ... 229
Response Elements ... 230
Errors ... 230
See Also ... 230
ListQueues ... 232
Request Syntax ... 232
URI Request Parameters ... 232
Request Body ... 232
Response Syntax ... 232
Response Elements ... 233
Errors ... 233
See Also ... 234
ListQuickConnects ... 235
Request Syntax ... 235
URI Request Parameters ... 235
Request Body ... 235
Response Syntax ... 235
Response Elements ... 236
Errors ... 236
See Also ... 236
ListRoutingProfileQueues ... 238
Request Syntax ... 238
URI Request Parameters ... 238
Request Body ... 238
Response Syntax ... 238
Response Elements ... 239
Errors ... 239
See Also ... 239
ListRoutingProfiles ... 241
Request Syntax ... 241
URI Request Parameters ... 241
Request Body ... 241
Response Syntax ... 241
Response Elements ... 242
Errors ... 242
See Also ... 242
ListSecurityKeys ... 244
Request Syntax ... 244
URI Request Parameters ... 244
Request Body ... 244
Response Syntax ... 244
Response Elements ... 244
Errors ... 245
See Also ... 245
ListSecurityProfilePermissions ... 247
Request Syntax ... 247
URI Request Parameters ... 247
Request Body ... 247
Response Syntax ... 247
Response Elements ... 248
Errors ... 248
See Also ... 248
ListSecurityProfiles ... 250
Request Syntax ... 250
URI Request Parameters ... 250
Request Body ... 250
Response Syntax ... 250
Response Elements ... 251
Errors ... 251
See Also ... 251
ListTagsForResource ... 253
Request Syntax ... 253
URI Request Parameters ... 253
Request Body ... 253
Response Syntax ... 253
Response Elements ... 253
Errors ... 254
See Also ... 254
ListUseCases ... 255
Request Syntax ... 255
URI Request Parameters ... 255
Request Body ... 255
Response Syntax ... 255
Response Elements ... 256
Errors ... 256
See Also ... 256
ListUserHierarchyGroups ... 258
Request Syntax ... 258
URI Request Parameters ... 258
Request Body ... 258
Response Syntax ... 258
Response Elements ... 259
Errors ... 259
See Also ... 259
ListUsers ... 261
Request Syntax ... 261
URI Request Parameters ... 261
Request Body ... 261
Response Syntax ... 261
Response Elements ... 261
Errors ... 262
See Also ... 262
ResumeContactRecording ... 264
Request Syntax ... 264
URI Request Parameters ... 264
Request Body ... 264
Response Syntax ... 265
Response Elements ... 265
Errors ... 265
See Also ... 265
SearchVocabularies ... 266
Request Syntax ... 266
URI Request Parameters ... 266
Request Body ... 266
Response Syntax ... 267
Response Elements ... 267
Errors ... 268
See Also ... 268
StartChatContact ... 269
Request Syntax ... 269
URI Request Parameters ... 269
Request Body ... 269
Response Syntax ... 271
Response Elements ... 271
Errors ... 271
See Also ... 272
StartContactRecording ... 273
Request Syntax ... 273
URI Request Parameters ... 273
Request Body ... 273
Response Syntax ... 274
Response Elements ... 274
Errors ... 274
See Also ... 274
StartContactStreaming ... 276
Request Syntax ... 276
URI Request Parameters ... 276
Request Body ... 276
Response Syntax ... 277
Response Elements ... 277
Errors ... 277
See Also ... 278
StartOutboundVoiceContact ... 279
Request Syntax ... 279
URI Request Parameters ... 279
Request Body ... 279
Response Syntax ... 281
Response Elements ... 281
Errors ... 282
See Also ... 282
StartTaskContact ... 283
Request Syntax ... 283
URI Request Parameters ... 283
Request Body ... 283
Response Syntax ... 285
Response Elements ... 285
Errors ... 285
See Also ... 286
StopContact ... 287
Request Syntax ... 287
URI Request Parameters ... 287
Request Body ... 287
Response Syntax ... 287
Response Elements ... 288
Errors ... 288
See Also ... 288
StopContactRecording ... 289
Request Syntax ... 289
URI Request Parameters ... 289
Request Body ... 289
Response Syntax ... 290
Response Elements ... 290
Errors ... 290
See Also ... 290
StopContactStreaming ... 291
Request Syntax ... 291
URI Request Parameters ... 291
Request Body ... 291
Response Syntax ... 292
Response Elements ... 292
Errors ... 292
See Also ... 292
SuspendContactRecording ... 293
Request Syntax ... 293
URI Request Parameters ... 293
Request Body ... 293
Response Syntax ... 294
Response Elements ... 294
Errors ... 294
See Also ... 294
TagResource ... 295
Request Syntax ... 295
URI Request Parameters ... 295
Request Body ... 295
Response Syntax ... 295
Response Elements ... 296
Errors ... 296
See Also ... 296
UntagResource ... 297
Request Syntax ... 297
URI Request Parameters ... 297
Request Body ... 297
Response Syntax ... 297
Response Elements ... 297
Errors ... 297
See Also ... 298
UpdateAgentStatus ... 299
Request Syntax ... 299
URI Request Parameters ... 299
Request Body ... 299
Response Syntax ... 300
Response Elements ... 300
Errors ... 300
See Also ... 301
UpdateContact ... 302
Request Syntax ... 302
URI Request Parameters ... 302
Request Body ... 302
Response Syntax ... 303
Response Elements ... 303
Errors ... 303
See Also ... 304
UpdateContactAttributes ... 305
Request Syntax ... 305
URI Request Parameters ... 305
Request Body ... 305
Response Syntax ... 306
Response Elements ... 306
Errors ... 306
See Also ... 307
UpdateContactFlowContent ... 308
Request Syntax ... 308
URI Request Parameters ... 308
Request Body ... 308
Response Syntax ... 308
Response Elements ... 308
Errors ... 309
See Also ... 309
UpdateContactFlowMetadata ... 310
Request Syntax ... 310
URI Request Parameters ... 310
Request Body ... 310
Response Syntax ... 311
Response Elements ... 311
Errors ... 311
See Also ... 311
UpdateContactFlowModuleContent ... 313
Request Syntax ... 313
URI Request Parameters ... 313
Request Body ... 313
Response Syntax ... 313
Response Elements ... 313
Errors ... 314
See Also ... 314
UpdateContactFlowModuleMetadata ... 315
Request Syntax ... 315
URI Request Parameters ... 315
Request Body ... 315
Response Syntax ... 316
Response Elements ... 316
Errors ... 316
See Also ... 317
UpdateContactFlowName ... 318
Request Syntax ... 318
URI Request Parameters ... 318
Request Body ... 318
Response Syntax ... 319
Response Elements ... 319
Errors ... 319
See Also ... 319
UpdateContactSchedule ... 321
Request Syntax ... 321
URI Request Parameters ... 321
Request Body ... 321
Response Syntax ... 321
Response Elements ... 322
Errors ... 322
See Also ... 322
UpdateHoursOfOperation ... 323
Request Syntax ... 323
URI Request Parameters ... 323
Request Body ... 323
Response Syntax ... 324
Response Elements ... 324
Errors ... 324
See Also ... 325
UpdateInstanceAttribute ... 326
Request Syntax ... 326
URI Request Parameters ... 326
Request Body ... 326
Response Syntax ... 327
Response Elements ... 327
Errors ... 327
See Also ... 327
UpdateInstanceStorageConfig ... 329
Request Syntax ... 329
URI Request Parameters ... 329
Request Body ... 330
Response Syntax ... 330
Response Elements ... 330
Errors ... 330
See Also ... 331
UpdateQueueHoursOfOperation ... 332
Request Syntax ... 332
URI Request Parameters ... 332
Request Body ... 332
Response Syntax ... 332
Response Elements ... 332
Errors ... 333
See Also ... 333
UpdateQueueMaxContacts ... 334
Request Syntax ... 334
URI Request Parameters ... 334
Request Body ... 334
Response Syntax ... 334
Response Elements ... 334
Errors ... 335
See Also ... 335
UpdateQueueName ... 336
Request Syntax ... 336
URI Request Parameters ... 336
Request Body ... 336
Response Syntax ... 337
Response Elements ... 337
Errors ... 337
See Also ... 337
UpdateQueueOutboundCallerConfig ... 339
Request Syntax ... 339
URI Request Parameters ... 339
Request Body ... 339
Response Syntax ... 339
Response Elements ... 340
Errors ... 340
See Also ... 340
UpdateQueueStatus ... 341
Request Syntax ... 341
URI Request Parameters ... 341
Request Body ... 341
Response Syntax ... 341
Response Elements ... 341
Errors ... 342
See Also ... 342
UpdateQuickConnectConfig ... 343
Request Syntax ... 343
URI Request Parameters ... 343
Request Body ... 343
Response Syntax ... 344
Response Elements ... 344
Errors ... 344
See Also ... 344
UpdateQuickConnectName ... 346
Request Syntax ... 346
URI Request Parameters ... 346
Request Body ... 346
Response Syntax ... 347
Response Elements ... 347
Errors ... 347
See Also ... 347
UpdateRoutingProfileConcurrency ... 349
Request Syntax ... 349
URI Request Parameters ... 349
Request Body ... 349
Response Syntax ... 349
Response Elements ... 350
Errors ... 350
See Also ... 350
UpdateRoutingProfileDefaultOutboundQueue ... 351
Request Syntax ... 351
URI Request Parameters ... 351
Request Body ... 351
Response Syntax ... 351
Response Elements ... 351
Errors ... 352
See Also ... 352
UpdateRoutingProfileName ... 353
Request Syntax ... 353
URI Request Parameters ... 353
Request Body ... 353
Response Syntax ... 354
Response Elements ... 354
Errors ... 354
See Also ... 354
UpdateRoutingProfileQueues ... 356
Request Syntax ... 356
URI Request Parameters ... 356
Request Body ... 356
Response Syntax ... 357
Response Elements ... 357
Errors ... 357
See Also ... 357
UpdateSecurityProfile ... 359
Request Syntax ... 359
URI Request Parameters ... 359
Request Body ... 359
Response Syntax ... 360
Response Elements ... 360
Errors ... 360
See Also ... 360
UpdateUserHierarchy ... 362
Request Syntax ... 362
URI Request Parameters ... 362
Request Body ... 362
Response Syntax ... 362
Response Elements ... 362
Errors ... 363
See Also ... 363
UpdateUserHierarchyGroupName ... 364
Request Syntax ... 364
URI Request Parameters ... 364
Request Body ... 364
Response Syntax ... 364
Response Elements ... 364
Errors ... 365
See Also ... 365
UpdateUserHierarchyStructure ... 366
Request Syntax ... 366
URI Request Parameters ... 366
Request Body ... 366
Response Syntax ... 367
Response Elements ... 367
Errors ... 367
See Also ... 367
UpdateUserIdentityInfo ... 369
Request Syntax ... 369
URI Request Parameters ... 369
Request Body ... 369
Response Syntax ... 370
Response Elements ... 370
Errors ... 370
See Also ... 370
UpdateUserPhoneConfig ... 372
Request Syntax ... 372
URI Request Parameters ... 372
Request Body ... 372
Response Syntax ... 372
Response Elements ... 373
Errors ... 373
See Also ... 373
UpdateUserRoutingProfile ... 374
Request Syntax ... 374
URI Request Parameters ... 374
Request Body ... 374
Response Syntax ... 374
Response Elements ... 374
Errors ... 375
See Also ... 375
UpdateUserSecurityProfiles ... 376
Request Syntax ... 376
URI Request Parameters ... 376
Request Body ... 376
Response Syntax ... 376
Response Elements ... 376
Errors ... 377
See Also ... 377
Data Types ... 378
AgentInfo ... 381
Contents ... 381
See Also ... 381
AgentStatus ... 382 Contents ... 382 See Also ... 383 AgentStatusSummary ... 384 Contents ... 384 See Also ... 384 AnswerMachineDetectionConfig ... 385 Contents ... 385 See Also ... 385 AttachmentReference ... 386 Contents ... 386 See Also ... 386 Attribute ... 387 Contents ... 387 See Also ... 387 ChatMessage ... 388 Contents ... 388 See Also ... 388 ChatStreamingConfiguration ... 389 Contents ... 389 See Also ... 389 Contact ... 390 Contents ... 390 See Also ... 392 ContactFlow ... 393 Contents ... 393 See Also ... 394 ContactFlowModule ... 395 Contents ... 395 See Also ... 396 ContactFlowModuleSummary ... 397 Contents ... 397 See Also ... 397 ContactFlowSummary ... 398 Contents ... 398 See Also ... 398 Credentials ... 400 Contents ... 400 See Also ... 400 CurrentMetric ... 401 Contents ... 401 See Also ... 401 CurrentMetricData ... 402 Contents ... 402 See Also ... 402 CurrentMetricResult ... 403 Contents ... 403 See Also ... 403 DefaultVocabulary ... 404 Contents ... 404 See Also ... 404 Dimensions ... 406 Contents ... 406 See Also ... 406 EncryptionConfig ... 407 Contents ... 407 See Also ... 407
Filters ... 408 Contents ... 408 See Also ... 408 HierarchyGroup ... 409 Contents ... 409 See Also ... 410 HierarchyGroupSummary ... 411 Contents ... 411 See Also ... 411 HierarchyLevel ... 412 Contents ... 412 See Also ... 412 HierarchyLevelUpdate ... 413 Contents ... 413 See Also ... 413 HierarchyPath ... 414 Contents ... 414 See Also ... 414 HierarchyStructure ... 415 Contents ... 415 See Also ... 415 HierarchyStructureUpdate ... 416 Contents ... 416 See Also ... 416 HistoricalMetric ... 417 Contents ... 417 See Also ... 417 HistoricalMetricData ... 419 Contents ... 419 See Also ... 419 HistoricalMetricResult ... 420 Contents ... 420 See Also ... 420 HoursOfOperation ... 421 Contents ... 421 See Also ... 422 HoursOfOperationConfig ... 423 Contents ... 423 See Also ... 423 HoursOfOperationSummary ... 424 Contents ... 424 See Also ... 424 HoursOfOperationTimeSlice ... 425 Contents ... 425 See Also ... 425 Instance ... 426 Contents ... 426 See Also ... 427 InstanceStatusReason ... 428 Contents ... 428 See Also ... 428 InstanceStorageConfig ... 429 Contents ... 429 See Also ... 429 InstanceSummary ... 431 Contents ... 431 See Also ... 432
IntegrationAssociationSummary ... 433 Contents ... 433 See Also ... 434 KinesisFirehoseConfig ... 435 Contents ... 435 See Also ... 435 KinesisStreamConfig ... 436 Contents ... 436 See Also ... 436 KinesisVideoStreamConfig ... 437 Contents ... 437 See Also ... 437 LexBot ... 438 Contents ... 438 See Also ... 438 LexBotConfig ... 439 Contents ... 439 See Also ... 439 LexV2Bot ... 440 Contents ... 440 See Also ... 440 MediaConcurrency ... 441 Contents ... 441 See Also ... 441 OutboundCallerConfig ... 442 Contents ... 442 See Also ... 442 ParticipantDetails ... 443 Contents ... 443 See Also ... 443 PhoneNumberQuickConnectConfig ... 444 Contents ... 444 See Also ... 444 PhoneNumberSummary ... 445 Contents ... 445 See Also ... 446 ProblemDetail ... 447 Contents ... 447 See Also ... 447 PromptSummary ... 448 Contents ... 448 See Also ... 448 Queue ... 449 Contents ... 449 See Also ... 450 QueueInfo ... 451 Contents ... 451 See Also ... 451 QueueQuickConnectConfig ... 452 Contents ... 452 See Also ... 452 QueueReference ... 453 Contents ... 453 See Also ... 453 QueueSummary ... 454 Contents ... 454 See Also ... 454
QuickConnect ... 455 Contents ... 455 See Also ... 456 QuickConnectConfig ... 457 Contents ... 457 See Also ... 457 QuickConnectSummary ... 458 Contents ... 458 See Also ... 458 Reference ... 459 Contents ... 459 See Also ... 459 ReferenceSummary ... 460 Contents ... 460 See Also ... 460 RoutingProfile ... 461 Contents ... 461 See Also ... 462 RoutingProfileQueueConfig ... 463 Contents ... 463 See Also ... 463 RoutingProfileQueueConfigSummary ... 464 Contents ... 464 See Also ... 465 RoutingProfileQueueReference ... 466 Contents ... 466 See Also ... 466 RoutingProfileSummary ... 467 Contents ... 467 See Also ... 467 S3Config ... 468 Contents ... 468 See Also ... 468 SecurityKey ... 469 Contents ... 469 See Also ... 469 SecurityProfile ... 470 Contents ... 470 See Also ... 471 SecurityProfileSummary ... 472 Contents ... 472 See Also ... 472 Threshold ... 473 Contents ... 473 See Also ... 473 UrlReference ... 474 Contents ... 474 See Also ... 474 UseCase ... 475 Contents ... 475 See Also ... 475 User ... 476 Contents ... 476 See Also ... 477 UserIdentityInfo ... 478 Contents ... 478 See Also ... 478
UserPhoneConfig ... 479 Contents ... 479 See Also ... 479 UserQuickConnectConfig ... 480 Contents ... 480 See Also ... 480 UserSummary ... 481 Contents ... 481 See Also ... 481 Vocabulary ... 482 Contents ... 482 See Also ... 483 VocabularySummary ... 484 Contents ... 484 See Also ... 485 VoiceRecordingConfiguration ... 486 Contents ... 486 See Also ... 486 Common Parameters ... 487 Common Errors ... 489
Welcome
Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing.
You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an AWS service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
NoteWorking with contact flows? Check out the Amazon Connect Flow language.
This document was last published on March 6, 2022.
Actions
The following actions are supported:
• AssociateApprovedOrigin (p. 6)
• AssociateBot (p. 8)
• AssociateDefaultVocabulary (p. 11)
• AssociateInstanceStorageConfig (p. 13)
• AssociateLambdaFunction (p. 16)
• AssociateLexBot (p. 18)
• AssociateQueueQuickConnects (p. 20)
• AssociateRoutingProfileQueues (p. 22)
• AssociateSecurityKey (p. 25)
• CreateAgentStatus (p. 28)
• CreateContactFlow (p. 32)
• CreateContactFlowModule (p. 36)
• CreateHoursOfOperation (p. 40)
• CreateInstance (p. 44)
• CreateIntegrationAssociation (p. 47)
• CreateQueue (p. 51)
• CreateQuickConnect (p. 55)
• CreateRoutingProfile (p. 58)
• CreateSecurityProfile (p. 62)
• CreateUseCase (p. 65)
• CreateUser (p. 68)
• CreateUserHierarchyGroup (p. 72)
• CreateVocabulary (p. 75)
• DeleteContactFlow (p. 79)
• DeleteContactFlowModule (p. 81)
• DeleteHoursOfOperation (p. 83)
• DeleteInstance (p. 85)
• DeleteIntegrationAssociation (p. 87)
• DeleteQuickConnect (p. 89)
• DeleteSecurityProfile (p. 91)
• DeleteUseCase (p. 93)
• DeleteUser (p. 95)
• DeleteUserHierarchyGroup (p. 97)
• DeleteVocabulary (p. 99)
• DescribeAgentStatus (p. 102)
• DescribeContact (p. 104)
• DescribeContactFlow (p. 107)
• DescribeContactFlowModule (p. 110)
• DescribeHoursOfOperation (p. 113)
• DescribeInstance (p. 116)
• DescribeInstanceAttribute (p. 118)
• DescribeInstanceStorageConfig (p. 120)
• DescribeQueue (p. 123)
• DescribeQuickConnect (p. 126)
• DescribeRoutingProfile (p. 129)
• DescribeSecurityProfile (p. 132)
• DescribeUser (p. 134)
• DescribeUserHierarchyGroup (p. 137)
• DescribeUserHierarchyStructure (p. 140)
• DescribeVocabulary (p. 143)
• DisassociateApprovedOrigin (p. 146)
• DisassociateBot (p. 148)
• DisassociateInstanceStorageConfig (p. 150)
• DisassociateLambdaFunction (p. 152)
• DisassociateLexBot (p. 154)
• DisassociateQueueQuickConnects (p. 156)
• DisassociateRoutingProfileQueues (p. 158)
• DisassociateSecurityKey (p. 160)
• GetContactAttributes (p. 162)
• GetCurrentMetricData (p. 164)
• GetFederationToken (p. 171)
• GetMetricData (p. 173)
• ListAgentStatuses (p. 182)
• ListApprovedOrigins (p. 185)
• ListBots (p. 188)
• ListContactFlowModules (p. 191)
• ListContactFlows (p. 194)
• ListContactReferences (p. 197)
• ListDefaultVocabularies (p. 200)
• ListHoursOfOperations (p. 203)
• ListInstanceAttributes (p. 206)
• ListInstances (p. 209)
• ListInstanceStorageConfigs (p. 211)
• ListIntegrationAssociations (p. 214)
• ListLambdaFunctions (p. 217)
• ListLexBots (p. 220)
• ListPhoneNumbers (p. 223)
• ListPrompts (p. 226)
• ListQueueQuickConnects (p. 229)
• ListQueues (p. 232)
• ListQuickConnects (p. 235)
• ListRoutingProfileQueues (p. 238)
• ListRoutingProfiles (p. 241)
• ListSecurityKeys (p. 244)
• ListSecurityProfilePermissions (p. 247)
• ListSecurityProfiles (p. 250)
• ListTagsForResource (p. 253)
• ListUseCases (p. 255)
• ListUserHierarchyGroups (p. 258)
• ListUsers (p. 261)
• ResumeContactRecording (p. 264)
• SearchVocabularies (p. 266)
• StartChatContact (p. 269)
• StartContactRecording (p. 273)
• StartContactStreaming (p. 276)
• StartOutboundVoiceContact (p. 279)
• StartTaskContact (p. 283)
• StopContact (p. 287)
• StopContactRecording (p. 289)
• StopContactStreaming (p. 291)
• SuspendContactRecording (p. 293)
• TagResource (p. 295)
• UntagResource (p. 297)
• UpdateAgentStatus (p. 299)
• UpdateContact (p. 302)
• UpdateContactAttributes (p. 305)
• UpdateContactFlowContent (p. 308)
• UpdateContactFlowMetadata (p. 310)
• UpdateContactFlowModuleContent (p. 313)
• UpdateContactFlowModuleMetadata (p. 315)
• UpdateContactFlowName (p. 318)
• UpdateContactSchedule (p. 321)
• UpdateHoursOfOperation (p. 323)
• UpdateInstanceAttribute (p. 326)
• UpdateInstanceStorageConfig (p. 329)
• UpdateQueueHoursOfOperation (p. 332)
• UpdateQueueMaxContacts (p. 334)
• UpdateQueueName (p. 336)
• UpdateQueueOutboundCallerConfig (p. 339)
• UpdateQueueStatus (p. 341)
• UpdateQuickConnectConfig (p. 343)
• UpdateQuickConnectName (p. 346)
• UpdateRoutingProfileConcurrency (p. 349)
• UpdateRoutingProfileDefaultOutboundQueue (p. 351)
• UpdateRoutingProfileName (p. 353)
• UpdateRoutingProfileQueues (p. 356)
• UpdateSecurityProfile (p. 359)
• UpdateUserHierarchy (p. 362)
• UpdateUserHierarchyGroupName (p. 364)
• UpdateUserHierarchyStructure (p. 366)
• UpdateUserIdentityInfo (p. 369)
• UpdateUserPhoneConfig (p. 372)
• UpdateUserRoutingProfile (p. 374)
• UpdateUserSecurityProfiles (p. 376)
AssociateApprovedOrigin
AssociateApprovedOrigin
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
Request Syntax
PUT /instance/InstanceId/approved-origin HTTP/1.1 Content-type: application/json
{ "Origin": "string"
}
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 6)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
Origin (p. 6)
The domain to add to your allow list.
Type: String
Length Constraints: Maximum length of 267.
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
See Also
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceConflictException
A resource already has that name.
HTTP Status Code: 409 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ServiceQuotaExceededException
The service quota has been exceeded.
HTTP Status Code: 402 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AssociateBot
AssociateBot
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.
Request Syntax
PUT /instance/InstanceId/bot HTTP/1.1 Content-type: application/json { "LexBot": {
"LexRegion": "string", "Name": "string"
},
"LexV2Bot": {
"AliasArn": "string"
}}
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 8)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
LexBot (p. 8)
Configuration information of an Amazon Lex bot.
Type: LexBot (p. 438) object Required: No
LexV2Bot (p. 8)
The Amazon Lex V2 bot to associate with the instance.
Type: LexV2Bot (p. 440) object Required: No
Response Syntax
HTTP/1.1 200
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 LimitExceededException
The allowed limit for the resource has been exceeded.
HTTP Status Code: 429 ResourceConflictException
A resource already has that name.
HTTP Status Code: 409 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ServiceQuotaExceededException
The service quota has been exceeded.
HTTP Status Code: 402 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
See Also
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AssociateDefaultVocabulary
AssociateDefaultVocabulary
Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
Request Syntax
PUT /default-vocabulary/InstanceId/LanguageCode HTTP/1.1 Content-type: application/json
{
"VocabularyId": "string"
}
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 11)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes LanguageCode (p. 11)
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
Valid Values: ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko- KR | pt-BR | pt-PT | zh-CN
Required: Yes
Request Body
The request accepts the following data in JSON format.
VocabularyId (p. 11)
The identifier of the custom vocabulary. If this is empty, the default is set to none.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
AccessDeniedException
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403 InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AssociateInstanceStorageConfig
AssociateInstanceStorageConfig
This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage
configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
Request Syntax
PUT /instance/InstanceId/storage-config HTTP/1.1 Content-type: application/json
{ "ResourceType": "string", "StorageConfig": {
"AssociationId": "string", "KinesisFirehoseConfig": { "FirehoseArn": "string"
},
"KinesisStreamConfig": { "StreamArn": "string"
},
"KinesisVideoStreamConfig": { "EncryptionConfig": {
"EncryptionType": "string", "KeyId": "string"
},
"Prefix": "string",
"RetentionPeriodHours": number },
"S3Config": {
"BucketName": "string", "BucketPrefix": "string", "EncryptionConfig": {
"EncryptionType": "string", "KeyId": "string"
} },
"StorageType": "string"
} }
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 13)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
Request Body
The request accepts the following data in JSON format.
ResourceType (p. 13) A valid resource type.
Type: String
Valid Values: CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS
Required: Yes StorageConfig (p. 13)
A valid storage type.
Type: InstanceStorageConfig (p. 429) object Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "AssociationId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
AssociationId (p. 14)
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
See Also
InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceConflictException
A resource already has that name.
HTTP Status Code: 409 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AssociateLambdaFunction
AssociateLambdaFunction
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
Request Syntax
PUT /instance/InstanceId/lambda-function HTTP/1.1 Content-type: application/json
{
"FunctionArn": "string"
}
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 16)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
FunctionArn (p. 16)
The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceConflictException
A resource already has that name.
HTTP Status Code: 409 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ServiceQuotaExceededException
The service quota has been exceeded.
HTTP Status Code: 402 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AssociateLexBot
AssociateLexBot
This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.
Request Syntax
PUT /instance/InstanceId/lex-bot HTTP/1.1 Content-type: application/json
{ "LexBot": {
"LexRegion": "string", "Name": "string"
} }
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 18)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
LexBot (p. 18)
The Amazon Lex bot to associate with the instance.
Type: LexBot (p. 438) object Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceConflictException
A resource already has that name.
HTTP Status Code: 409 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ServiceQuotaExceededException
The service quota has been exceeded.
HTTP Status Code: 402 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AssociateQueueQuickConnects
AssociateQueueQuickConnects
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
Request Syntax
POST /queues/InstanceId/QueueId/associate-quick-connects HTTP/1.1 Content-type: application/json
{ "QuickConnectIds": [ "string" ] }
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 20)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes QueueId (p. 20)
The identifier for the queue.
Required: Yes
Request Body
The request accepts the following data in JSON format.
QuickConnectIds (p. 20)
The quick connects to associate with this queue.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 LimitExceededException
The allowed limit for the resource has been exceeded.
HTTP Status Code: 429 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
AssociateRoutingProfileQueues
AssociateRoutingProfileQueues
Associates a set of queues with a routing profile.
Request Syntax
POST /routing-profiles/InstanceId/RoutingProfileId/associate-queues HTTP/1.1 Content-type: application/json
{
"QueueConfigs": [ {
"Delay": number, "Priority": number, "QueueReference": { "Channel": "string", "QueueId": "string"
} } ] }
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 22)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes RoutingProfileId (p. 22)
The identifier of the routing profile.
Required: Yes
Request Body
The request accepts the following data in JSON format.
QueueConfigs (p. 22)
The queues to associate with this routing profile.
Type: Array of RoutingProfileQueueConfig (p. 463) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
Response Syntax
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
See Also
AssociateSecurityKey
AssociateSecurityKey
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
Request Syntax
PUT /instance/InstanceId/security-key HTTP/1.1 Content-type: application/json
{
"Key": "string"
}
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 25)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
Key (p. 25)
A valid security key in PEM format.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "AssociationId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
Errors
The following data is returned in JSON format by the service.
AssociationId (p. 25)
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 489).
InternalServiceException
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500 InvalidParameterException
One or more of the specified parameters are not valid.
HTTP Status Code: 400 InvalidRequestException
The request is not valid.
HTTP Status Code: 400 ResourceConflictException
A resource already has that name.
HTTP Status Code: 409 ResourceNotFoundException
The specified resource was not found.
HTTP Status Code: 404 ServiceQuotaExceededException
The service quota has been exceeded.
HTTP Status Code: 402 ThrottlingException
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
See Also
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateAgentStatus
CreateAgentStatus
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
Request Syntax
PUT /agent-status/InstanceId HTTP/1.1 Content-type: application/json {
"Description": "string", "DisplayOrder": number, "Name": "string", "State": "string", "Tags": {
"string" : "string"
} }
URI Request Parameters
The request uses the following URI parameters.
InstanceId (p. 28)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
Description (p. 28)
The description of the status.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Required: No DisplayOrder (p. 28)
The display order of the status.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
