1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2021-04-20", 5 "endpointPrefix":"identity-chime", 6 "protocol":"rest-json", 7 "serviceFullName":"Amazon Chime SDK Identity", 8 "serviceId":"Chime SDK Identity", 9 "signatureVersion":"v4", 10 "signingName":"chime", 11 "uid":"chime-sdk-identity-2021-04-20" 12 }, 13 "operations":{ 14 "CreateAppInstance":{ 15 "name":"CreateAppInstance", 16 "http":{ 17 "method":"POST", 18 "requestUri":"/app-instances", 19 "responseCode":201 20 }, 21 "input":{"shape":"CreateAppInstanceRequest"}, 22 "output":{"shape":"CreateAppInstanceResponse"}, 23 "errors":[ 24 {"shape":"BadRequestException"}, 25 {"shape":"ConflictException"}, 26 {"shape":"ForbiddenException"}, 27 {"shape":"ResourceLimitExceededException"}, 28 {"shape":"ThrottledClientException"}, 29 {"shape":"UnauthorizedClientException"}, 30 {"shape":"ServiceUnavailableException"}, 31 {"shape":"ServiceFailureException"} 32 ], 33 "documentation":"<p>Creates an Amazon Chime SDK messaging <code>AppInstance</code> under an AWS account. Only SDK messaging customers use this API. <code>CreateAppInstance</code> supports idempotency behavior as described in the AWS API Standard.</p> <p>identity</p>" 34 }, 35 "CreateAppInstanceAdmin":{ 36 "name":"CreateAppInstanceAdmin", 37 "http":{ 38 "method":"POST", 39 "requestUri":"/app-instances/{appInstanceArn}/admins", 40 "responseCode":201 41 }, 42 "input":{"shape":"CreateAppInstanceAdminRequest"}, 43 "output":{"shape":"CreateAppInstanceAdminResponse"}, 44 "errors":[ 45 {"shape":"BadRequestException"}, 46 {"shape":"ConflictException"}, 47 {"shape":"ForbiddenException"}, 48 {"shape":"ResourceLimitExceededException"}, 49 {"shape":"ThrottledClientException"}, 50 {"shape":"UnauthorizedClientException"}, 51 {"shape":"ServiceUnavailableException"}, 52 {"shape":"ServiceFailureException"} 53 ], 54 "documentation":"<p>Promotes an <code>AppInstanceUser</code> or <code>AppInstanceBot</code> to an <code>AppInstanceAdmin</code>. The promoted entity can perform the following actions. </p> <ul> <li> <p> <code>ChannelModerator</code> actions across all channels in the <code>AppInstance</code>.</p> </li> <li> <p> <code>DeleteChannelMessage</code> actions.</p> </li> </ul> <p>Only an <code>AppInstanceUser</code> and <code>AppInstanceBot</code> can be promoted to an <code>AppInstanceAdmin</code> role.</p>" 55 }, 56 "CreateAppInstanceBot":{ 57 "name":"CreateAppInstanceBot", 58 "http":{ 59 "method":"POST", 60 "requestUri":"/app-instance-bots", 61 "responseCode":201 62 }, 63 "input":{"shape":"CreateAppInstanceBotRequest"}, 64 "output":{"shape":"CreateAppInstanceBotResponse"}, 65 "errors":[ 66 {"shape":"BadRequestException"}, 67 {"shape":"ConflictException"}, 68 {"shape":"ForbiddenException"}, 69 {"shape":"ResourceLimitExceededException"}, 70 {"shape":"ThrottledClientException"}, 71 {"shape":"UnauthorizedClientException"}, 72 {"shape":"ServiceUnavailableException"}, 73 {"shape":"ServiceFailureException"} 74 ], 75 "documentation":"<p>Creates a bot under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>Configuration</code> and <code>Name</code> for that bot.</p>" 76 }, 77 "CreateAppInstanceUser":{ 78 "name":"CreateAppInstanceUser", 79 "http":{ 80 "method":"POST", 81 "requestUri":"/app-instance-users", 82 "responseCode":201 83 }, 84 "input":{"shape":"CreateAppInstanceUserRequest"}, 85 "output":{"shape":"CreateAppInstanceUserResponse"}, 86 "errors":[ 87 {"shape":"BadRequestException"}, 88 {"shape":"ConflictException"}, 89 {"shape":"ForbiddenException"}, 90 {"shape":"ResourceLimitExceededException"}, 91 {"shape":"ThrottledClientException"}, 92 {"shape":"UnauthorizedClientException"}, 93 {"shape":"ServiceUnavailableException"}, 94 {"shape":"ServiceFailureException"} 95 ], 96 "documentation":"<p>Creates a user under an Amazon Chime <code>AppInstance</code>. The request consists of a unique <code>appInstanceUserId</code> and <code>Name</code> for that user.</p>" 97 }, 98 "DeleteAppInstance":{ 99 "name":"DeleteAppInstance", 100 "http":{ 101 "method":"DELETE", 102 "requestUri":"/app-instances/{appInstanceArn}", 103 "responseCode":204 104 }, 105 "input":{"shape":"DeleteAppInstanceRequest"}, 106 "errors":[ 107 {"shape":"BadRequestException"}, 108 {"shape":"ForbiddenException"}, 109 {"shape":"ResourceLimitExceededException"}, 110 {"shape":"ThrottledClientException"}, 111 {"shape":"UnauthorizedClientException"}, 112 {"shape":"ServiceUnavailableException"}, 113 {"shape":"ServiceFailureException"} 114 ], 115 "documentation":"<p>Deletes an <code>AppInstance</code> and all associated data asynchronously.</p>" 116 }, 117 "DeleteAppInstanceAdmin":{ 118 "name":"DeleteAppInstanceAdmin", 119 "http":{ 120 "method":"DELETE", 121 "requestUri":"/app-instances/{appInstanceArn}/admins/{appInstanceAdminArn}", 122 "responseCode":204 123 }, 124 "input":{"shape":"DeleteAppInstanceAdminRequest"}, 125 "errors":[ 126 {"shape":"BadRequestException"}, 127 {"shape":"ConflictException"}, 128 {"shape":"ForbiddenException"}, 129 {"shape":"ResourceLimitExceededException"}, 130 {"shape":"ThrottledClientException"}, 131 {"shape":"UnauthorizedClientException"}, 132 {"shape":"ServiceUnavailableException"}, 133 {"shape":"ServiceFailureException"} 134 ], 135 "documentation":"<p>Demotes an <code>AppInstanceAdmin</code> to an <code>AppInstanceUser</code> or <code>AppInstanceBot</code>. This action does not delete the user.</p>" 136 }, 137 "DeleteAppInstanceBot":{ 138 "name":"DeleteAppInstanceBot", 139 "http":{ 140 "method":"DELETE", 141 "requestUri":"/app-instance-bots/{appInstanceBotArn}", 142 "responseCode":204 143 }, 144 "input":{"shape":"DeleteAppInstanceBotRequest"}, 145 "errors":[ 146 {"shape":"BadRequestException"}, 147 {"shape":"ConflictException"}, 148 {"shape":"ForbiddenException"}, 149 {"shape":"ResourceLimitExceededException"}, 150 {"shape":"ThrottledClientException"}, 151 {"shape":"UnauthorizedClientException"}, 152 {"shape":"ServiceUnavailableException"}, 153 {"shape":"ServiceFailureException"} 154 ], 155 "documentation":"<p>Deletes an <code>AppInstanceBot</code>.</p>" 156 }, 157 "DeleteAppInstanceUser":{ 158 "name":"DeleteAppInstanceUser", 159 "http":{ 160 "method":"DELETE", 161 "requestUri":"/app-instance-users/{appInstanceUserArn}", 162 "responseCode":204 163 }, 164 "input":{"shape":"DeleteAppInstanceUserRequest"}, 165 "errors":[ 166 {"shape":"BadRequestException"}, 167 {"shape":"ConflictException"}, 168 {"shape":"ForbiddenException"}, 169 {"shape":"ResourceLimitExceededException"}, 170 {"shape":"ThrottledClientException"}, 171 {"shape":"UnauthorizedClientException"}, 172 {"shape":"ServiceUnavailableException"}, 173 {"shape":"ServiceFailureException"} 174 ], 175 "documentation":"<p>Deletes an <code>AppInstanceUser</code>.</p>" 176 }, 177 "DeregisterAppInstanceUserEndpoint":{ 178 "name":"DeregisterAppInstanceUserEndpoint", 179 "http":{ 180 "method":"DELETE", 181 "requestUri":"/app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}", 182 "responseCode":204 183 }, 184 "input":{"shape":"DeregisterAppInstanceUserEndpointRequest"}, 185 "errors":[ 186 {"shape":"BadRequestException"}, 187 {"shape":"ForbiddenException"}, 188 {"shape":"ThrottledClientException"}, 189 {"shape":"UnauthorizedClientException"}, 190 {"shape":"ServiceUnavailableException"}, 191 {"shape":"ServiceFailureException"} 192 ], 193 "documentation":"<p>Deregisters an <code>AppInstanceUserEndpoint</code>.</p>" 194 }, 195 "DescribeAppInstance":{ 196 "name":"DescribeAppInstance", 197 "http":{ 198 "method":"GET", 199 "requestUri":"/app-instances/{appInstanceArn}" 200 }, 201 "input":{"shape":"DescribeAppInstanceRequest"}, 202 "output":{"shape":"DescribeAppInstanceResponse"}, 203 "errors":[ 204 {"shape":"BadRequestException"}, 205 {"shape":"ForbiddenException"}, 206 {"shape":"ThrottledClientException"}, 207 {"shape":"UnauthorizedClientException"}, 208 {"shape":"ServiceUnavailableException"}, 209 {"shape":"ServiceFailureException"} 210 ], 211 "documentation":"<p>Returns the full details of an <code>AppInstance</code>.</p>" 212 }, 213 "DescribeAppInstanceAdmin":{ 214 "name":"DescribeAppInstanceAdmin", 215 "http":{ 216 "method":"GET", 217 "requestUri":"/app-instances/{appInstanceArn}/admins/{appInstanceAdminArn}", 218 "responseCode":200 219 }, 220 "input":{"shape":"DescribeAppInstanceAdminRequest"}, 221 "output":{"shape":"DescribeAppInstanceAdminResponse"}, 222 "errors":[ 223 {"shape":"BadRequestException"}, 224 {"shape":"ForbiddenException"}, 225 {"shape":"ThrottledClientException"}, 226 {"shape":"UnauthorizedClientException"}, 227 {"shape":"ServiceUnavailableException"}, 228 {"shape":"ServiceFailureException"} 229 ], 230 "documentation":"<p>Returns the full details of an <code>AppInstanceAdmin</code>.</p>" 231 }, 232 "DescribeAppInstanceBot":{ 233 "name":"DescribeAppInstanceBot", 234 "http":{ 235 "method":"GET", 236 "requestUri":"/app-instance-bots/{appInstanceBotArn}" 237 }, 238 "input":{"shape":"DescribeAppInstanceBotRequest"}, 239 "output":{"shape":"DescribeAppInstanceBotResponse"}, 240 "errors":[ 241 {"shape":"BadRequestException"}, 242 {"shape":"ForbiddenException"}, 243 {"shape":"ThrottledClientException"}, 244 {"shape":"UnauthorizedClientException"}, 245 {"shape":"NotFoundException"}, 246 {"shape":"ServiceUnavailableException"}, 247 {"shape":"ServiceFailureException"} 248 ], 249 "documentation":"<p>The <code>AppInstanceBot's</code> information.</p>" 250 }, 251 "DescribeAppInstanceUser":{ 252 "name":"DescribeAppInstanceUser", 253 "http":{ 254 "method":"GET", 255 "requestUri":"/app-instance-users/{appInstanceUserArn}" 256 }, 257 "input":{"shape":"DescribeAppInstanceUserRequest"}, 258 "output":{"shape":"DescribeAppInstanceUserResponse"}, 259 "errors":[ 260 {"shape":"BadRequestException"}, 261 {"shape":"ForbiddenException"}, 262 {"shape":"ThrottledClientException"}, 263 {"shape":"UnauthorizedClientException"}, 264 {"shape":"ServiceUnavailableException"}, 265 {"shape":"ServiceFailureException"} 266 ], 267 "documentation":"<p>Returns the full details of an <code>AppInstanceUser</code>.</p>" 268 }, 269 "DescribeAppInstanceUserEndpoint":{ 270 "name":"DescribeAppInstanceUserEndpoint", 271 "http":{ 272 "method":"GET", 273 "requestUri":"/app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}", 274 "responseCode":200 275 }, 276 "input":{"shape":"DescribeAppInstanceUserEndpointRequest"}, 277 "output":{"shape":"DescribeAppInstanceUserEndpointResponse"}, 278 "errors":[ 279 {"shape":"BadRequestException"}, 280 {"shape":"ForbiddenException"}, 281 {"shape":"ThrottledClientException"}, 282 {"shape":"UnauthorizedClientException"}, 283 {"shape":"ServiceUnavailableException"}, 284 {"shape":"ServiceFailureException"} 285 ], 286 "documentation":"<p>Returns the full details of an <code>AppInstanceUserEndpoint</code>.</p>" 287 }, 288 "GetAppInstanceRetentionSettings":{ 289 "name":"GetAppInstanceRetentionSettings", 290 "http":{ 291 "method":"GET", 292 "requestUri":"/app-instances/{appInstanceArn}/retention-settings", 293 "responseCode":200 294 }, 295 "input":{"shape":"GetAppInstanceRetentionSettingsRequest"}, 296 "output":{"shape":"GetAppInstanceRetentionSettingsResponse"}, 297 "errors":[ 298 {"shape":"BadRequestException"}, 299 {"shape":"ForbiddenException"}, 300 {"shape":"ThrottledClientException"}, 301 {"shape":"UnauthorizedClientException"}, 302 {"shape":"ServiceUnavailableException"}, 303 {"shape":"ServiceFailureException"} 304 ], 305 "documentation":"<p>Gets the retention settings for an <code>AppInstance</code>.</p>" 306 }, 307 "ListAppInstanceAdmins":{ 308 "name":"ListAppInstanceAdmins", 309 "http":{ 310 "method":"GET", 311 "requestUri":"/app-instances/{appInstanceArn}/admins", 312 "responseCode":200 313 }, 314 "input":{"shape":"ListAppInstanceAdminsRequest"}, 315 "output":{"shape":"ListAppInstanceAdminsResponse"}, 316 "errors":[ 317 {"shape":"BadRequestException"}, 318 {"shape":"ForbiddenException"}, 319 {"shape":"ResourceLimitExceededException"}, 320 {"shape":"ThrottledClientException"}, 321 {"shape":"UnauthorizedClientException"}, 322 {"shape":"ServiceUnavailableException"}, 323 {"shape":"ServiceFailureException"} 324 ], 325 "documentation":"<p>Returns a list of the administrators in the <code>AppInstance</code>.</p>" 326 }, 327 "ListAppInstanceBots":{ 328 "name":"ListAppInstanceBots", 329 "http":{ 330 "method":"GET", 331 "requestUri":"/app-instance-bots" 332 }, 333 "input":{"shape":"ListAppInstanceBotsRequest"}, 334 "output":{"shape":"ListAppInstanceBotsResponse"}, 335 "errors":[ 336 {"shape":"BadRequestException"}, 337 {"shape":"ForbiddenException"}, 338 {"shape":"ResourceLimitExceededException"}, 339 {"shape":"ThrottledClientException"}, 340 {"shape":"UnauthorizedClientException"}, 341 {"shape":"ServiceUnavailableException"}, 342 {"shape":"ServiceFailureException"} 343 ], 344 "documentation":"<p>Lists all <code>AppInstanceBots</code> created under a single <code>AppInstance</code>.</p>" 345 }, 346 "ListAppInstanceUserEndpoints":{ 347 "name":"ListAppInstanceUserEndpoints", 348 "http":{ 349 "method":"GET", 350 "requestUri":"/app-instance-users/{appInstanceUserArn}/endpoints", 351 "responseCode":200 352 }, 353 "input":{"shape":"ListAppInstanceUserEndpointsRequest"}, 354 "output":{"shape":"ListAppInstanceUserEndpointsResponse"}, 355 "errors":[ 356 {"shape":"BadRequestException"}, 357 {"shape":"ForbiddenException"}, 358 {"shape":"ThrottledClientException"}, 359 {"shape":"UnauthorizedClientException"}, 360 {"shape":"ServiceUnavailableException"}, 361 {"shape":"ServiceFailureException"} 362 ], 363 "documentation":"<p>Lists all the <code>AppInstanceUserEndpoints</code> created under a single <code>AppInstanceUser</code>.</p>" 364 }, 365 "ListAppInstanceUsers":{ 366 "name":"ListAppInstanceUsers", 367 "http":{ 368 "method":"GET", 369 "requestUri":"/app-instance-users" 370 }, 371 "input":{"shape":"ListAppInstanceUsersRequest"}, 372 "output":{"shape":"ListAppInstanceUsersResponse"}, 373 "errors":[ 374 {"shape":"BadRequestException"}, 375 {"shape":"ForbiddenException"}, 376 {"shape":"ThrottledClientException"}, 377 {"shape":"UnauthorizedClientException"}, 378 {"shape":"ServiceUnavailableException"}, 379 {"shape":"ServiceFailureException"} 380 ], 381 "documentation":"<p>List all <code>AppInstanceUsers</code> created under a single <code>AppInstance</code>.</p>" 382 }, 383 "ListAppInstances":{ 384 "name":"ListAppInstances", 385 "http":{ 386 "method":"GET", 387 "requestUri":"/app-instances" 388 }, 389 "input":{"shape":"ListAppInstancesRequest"}, 390 "output":{"shape":"ListAppInstancesResponse"}, 391 "errors":[ 392 {"shape":"BadRequestException"}, 393 {"shape":"ForbiddenException"}, 394 {"shape":"ThrottledClientException"}, 395 {"shape":"UnauthorizedClientException"}, 396 {"shape":"ServiceUnavailableException"}, 397 {"shape":"ServiceFailureException"} 398 ], 399 "documentation":"<p>Lists all Amazon Chime <code>AppInstance</code>s created under a single AWS account.</p>" 400 }, 401 "ListTagsForResource":{ 402 "name":"ListTagsForResource", 403 "http":{ 404 "method":"GET", 405 "requestUri":"/tags", 406 "responseCode":200 407 }, 408 "input":{"shape":"ListTagsForResourceRequest"}, 409 "output":{"shape":"ListTagsForResourceResponse"}, 410 "errors":[ 411 {"shape":"BadRequestException"}, 412 {"shape":"ForbiddenException"}, 413 {"shape":"UnauthorizedClientException"}, 414 {"shape":"ThrottledClientException"}, 415 {"shape":"ServiceUnavailableException"}, 416 {"shape":"ServiceFailureException"} 417 ], 418 "documentation":"<p>Lists the tags applied to an Amazon Chime SDK identity resource.</p>" 419 }, 420 "PutAppInstanceRetentionSettings":{ 421 "name":"PutAppInstanceRetentionSettings", 422 "http":{ 423 "method":"PUT", 424 "requestUri":"/app-instances/{appInstanceArn}/retention-settings", 425 "responseCode":200 426 }, 427 "input":{"shape":"PutAppInstanceRetentionSettingsRequest"}, 428 "output":{"shape":"PutAppInstanceRetentionSettingsResponse"}, 429 "errors":[ 430 {"shape":"BadRequestException"}, 431 {"shape":"ForbiddenException"}, 432 {"shape":"ThrottledClientException"}, 433 {"shape":"UnauthorizedClientException"}, 434 {"shape":"ServiceUnavailableException"}, 435 {"shape":"ServiceFailureException"} 436 ], 437 "documentation":"<p>Sets the amount of time in days that a given <code>AppInstance</code> retains data.</p>" 438 }, 439 "PutAppInstanceUserExpirationSettings":{ 440 "name":"PutAppInstanceUserExpirationSettings", 441 "http":{ 442 "method":"PUT", 443 "requestUri":"/app-instance-users/{appInstanceUserArn}/expiration-settings", 444 "responseCode":200 445 }, 446 "input":{"shape":"PutAppInstanceUserExpirationSettingsRequest"}, 447 "output":{"shape":"PutAppInstanceUserExpirationSettingsResponse"}, 448 "errors":[ 449 {"shape":"BadRequestException"}, 450 {"shape":"ConflictException"}, 451 {"shape":"ForbiddenException"}, 452 {"shape":"ThrottledClientException"}, 453 {"shape":"UnauthorizedClientException"}, 454 {"shape":"ServiceUnavailableException"}, 455 {"shape":"ServiceFailureException"} 456 ], 457 "documentation":"<p>Sets the number of days before the <code>AppInstanceUser</code> is automatically deleted.</p> <note> <p>A background process deletes expired <code>AppInstanceUsers</code> within 6 hours of expiration. Actual deletion times may vary.</p> <p>Expired <code>AppInstanceUsers</code> that have not yet been deleted appear as active, and you can update their expiration settings. The system honors the new settings.</p> </note>" 458 }, 459 "RegisterAppInstanceUserEndpoint":{ 460 "name":"RegisterAppInstanceUserEndpoint", 461 "http":{ 462 "method":"POST", 463 "requestUri":"/app-instance-users/{appInstanceUserArn}/endpoints", 464 "responseCode":201 465 }, 466 "input":{"shape":"RegisterAppInstanceUserEndpointRequest"}, 467 "output":{"shape":"RegisterAppInstanceUserEndpointResponse"}, 468 "errors":[ 469 {"shape":"BadRequestException"}, 470 {"shape":"ConflictException"}, 471 {"shape":"ForbiddenException"}, 472 {"shape":"ResourceLimitExceededException"}, 473 {"shape":"ThrottledClientException"}, 474 {"shape":"UnauthorizedClientException"}, 475 {"shape":"ServiceUnavailableException"}, 476 {"shape":"ServiceFailureException"} 477 ], 478 "documentation":"<p>Registers an endpoint under an Amazon Chime <code>AppInstanceUser</code>. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.</p>" 479 }, 480 "TagResource":{ 481 "name":"TagResource", 482 "http":{ 483 "method":"POST", 484 "requestUri":"/tags?operation=tag-resource", 485 "responseCode":204 486 }, 487 "input":{"shape":"TagResourceRequest"}, 488 "errors":[ 489 {"shape":"BadRequestException"}, 490 {"shape":"ForbiddenException"}, 491 {"shape":"UnauthorizedClientException"}, 492 {"shape":"ResourceLimitExceededException"}, 493 {"shape":"ThrottledClientException"}, 494 {"shape":"ServiceUnavailableException"}, 495 {"shape":"ServiceFailureException"} 496 ], 497 "documentation":"<p>Applies the specified tags to the specified Amazon Chime SDK identity resource.</p>" 498 }, 499 "UntagResource":{ 500 "name":"UntagResource", 501 "http":{ 502 "method":"POST", 503 "requestUri":"/tags?operation=untag-resource", 504 "responseCode":204 505 }, 506 "input":{"shape":"UntagResourceRequest"}, 507 "errors":[ 508 {"shape":"BadRequestException"}, 509 {"shape":"ForbiddenException"}, 510 {"shape":"UnauthorizedClientException"}, 511 {"shape":"ThrottledClientException"}, 512 {"shape":"ServiceUnavailableException"}, 513 {"shape":"ServiceFailureException"} 514 ], 515 "documentation":"<p>Removes the specified tags from the specified Amazon Chime SDK identity resource.</p>" 516 }, 517 "UpdateAppInstance":{ 518 "name":"UpdateAppInstance", 519 "http":{ 520 "method":"PUT", 521 "requestUri":"/app-instances/{appInstanceArn}", 522 "responseCode":200 523 }, 524 "input":{"shape":"UpdateAppInstanceRequest"}, 525 "output":{"shape":"UpdateAppInstanceResponse"}, 526 "errors":[ 527 {"shape":"BadRequestException"}, 528 {"shape":"ConflictException"}, 529 {"shape":"ForbiddenException"}, 530 {"shape":"ThrottledClientException"}, 531 {"shape":"UnauthorizedClientException"}, 532 {"shape":"ServiceUnavailableException"}, 533 {"shape":"ServiceFailureException"} 534 ], 535 "documentation":"<p>Updates <code>AppInstance</code> metadata.</p>" 536 }, 537 "UpdateAppInstanceBot":{ 538 "name":"UpdateAppInstanceBot", 539 "http":{ 540 "method":"PUT", 541 "requestUri":"/app-instance-bots/{appInstanceBotArn}", 542 "responseCode":200 543 }, 544 "input":{"shape":"UpdateAppInstanceBotRequest"}, 545 "output":{"shape":"UpdateAppInstanceBotResponse"}, 546 "errors":[ 547 {"shape":"BadRequestException"}, 548 {"shape":"ConflictException"}, 549 {"shape":"ForbiddenException"}, 550 {"shape":"ResourceLimitExceededException"}, 551 {"shape":"ThrottledClientException"}, 552 {"shape":"UnauthorizedClientException"}, 553 {"shape":"ServiceUnavailableException"}, 554 {"shape":"ServiceFailureException"} 555 ], 556 "documentation":"<p>Updates the name and metadata of an <code>AppInstanceBot</code>.</p>" 557 }, 558 "UpdateAppInstanceUser":{ 559 "name":"UpdateAppInstanceUser", 560 "http":{ 561 "method":"PUT", 562 "requestUri":"/app-instance-users/{appInstanceUserArn}", 563 "responseCode":200 564 }, 565 "input":{"shape":"UpdateAppInstanceUserRequest"}, 566 "output":{"shape":"UpdateAppInstanceUserResponse"}, 567 "errors":[ 568 {"shape":"BadRequestException"}, 569 {"shape":"ConflictException"}, 570 {"shape":"ForbiddenException"}, 571 {"shape":"ResourceLimitExceededException"}, 572 {"shape":"ThrottledClientException"}, 573 {"shape":"UnauthorizedClientException"}, 574 {"shape":"ServiceUnavailableException"}, 575 {"shape":"ServiceFailureException"} 576 ], 577 "documentation":"<p>Updates the details of an <code>AppInstanceUser</code>. You can update names and metadata.</p>" 578 }, 579 "UpdateAppInstanceUserEndpoint":{ 580 "name":"UpdateAppInstanceUserEndpoint", 581 "http":{ 582 "method":"PUT", 583 "requestUri":"/app-instance-users/{appInstanceUserArn}/endpoints/{endpointId}", 584 "responseCode":200 585 }, 586 "input":{"shape":"UpdateAppInstanceUserEndpointRequest"}, 587 "output":{"shape":"UpdateAppInstanceUserEndpointResponse"}, 588 "errors":[ 589 {"shape":"BadRequestException"}, 590 {"shape":"ConflictException"}, 591 {"shape":"ForbiddenException"}, 592 {"shape":"ThrottledClientException"}, 593 {"shape":"UnauthorizedClientException"}, 594 {"shape":"ServiceUnavailableException"}, 595 {"shape":"ServiceFailureException"} 596 ], 597 "documentation":"<p>Updates the details of an <code>AppInstanceUserEndpoint</code>. You can update the name and <code>AllowMessage</code> values.</p>" 598 } 599 }, 600 "shapes":{ 601 "AllowMessages":{ 602 "type":"string", 603 "enum":[ 604 "ALL", 605 "NONE" 606 ] 607 }, 608 "AppInstance":{ 609 "type":"structure", 610 "members":{ 611 "AppInstanceArn":{ 612 "shape":"ChimeArn", 613 "documentation":"<p>The ARN of the messaging instance.</p>" 614 }, 615 "Name":{ 616 "shape":"NonEmptyResourceName", 617 "documentation":"<p>The name of an <code>AppInstance</code>.</p>" 618 }, 619 "CreatedTimestamp":{ 620 "shape":"Timestamp", 621 "documentation":"<p>The time at which an <code>AppInstance</code> was created. In epoch milliseconds.</p>" 622 }, 623 "LastUpdatedTimestamp":{ 624 "shape":"Timestamp", 625 "documentation":"<p>The time an <code>AppInstance</code> was last updated. In epoch milliseconds.</p>" 626 }, 627 "Metadata":{ 628 "shape":"Metadata", 629 "documentation":"<p>The metadata of an <code>AppInstance</code>.</p>" 630 } 631 }, 632 "documentation":"<p>The details of an <code>AppInstance</code>, an instance of an Amazon Chime SDK messaging application.</p>" 633 }, 634 "AppInstanceAdmin":{ 635 "type":"structure", 636 "members":{ 637 "Admin":{ 638 "shape":"Identity", 639 "documentation":"<p>The <code>AppInstanceAdmin</code> data.</p>" 640 }, 641 "AppInstanceArn":{ 642 "shape":"ChimeArn", 643 "documentation":"<p>The ARN of the <code>AppInstance</code> for which the user is an administrator.</p>" 644 }, 645 "CreatedTimestamp":{ 646 "shape":"Timestamp", 647 "documentation":"<p>The time at which an administrator was created.</p>" 648 } 649 }, 650 "documentation":"<p>The name and ARN of the admin for the <code>AppInstance</code>.</p>" 651 }, 652 "AppInstanceAdminList":{ 653 "type":"list", 654 "member":{"shape":"AppInstanceAdminSummary"} 655 }, 656 "AppInstanceAdminSummary":{ 657 "type":"structure", 658 "members":{ 659 "Admin":{ 660 "shape":"Identity", 661 "documentation":"<p>The details of the <code>AppInstanceAdmin</code>.</p>" 662 } 663 }, 664 "documentation":"<p>Summary of the details of an <code>AppInstanceAdmin</code>.</p>" 665 }, 666 "AppInstanceBot":{ 667 "type":"structure", 668 "members":{ 669 "AppInstanceBotArn":{ 670 "shape":"ChimeArn", 671 "documentation":"<p>The ARN of the AppInstanceBot.</p>" 672 }, 673 "Name":{ 674 "shape":"ResourceName", 675 "documentation":"<p>The name of the AppInstanceBot.</p>" 676 }, 677 "Configuration":{ 678 "shape":"Configuration", 679 "documentation":"<p>The data processing instructions for an AppInstanceBot.</p>" 680 }, 681 "CreatedTimestamp":{ 682 "shape":"Timestamp", 683 "documentation":"<p>The time at which the <code>AppInstanceBot</code> was created.</p>" 684 }, 685 "LastUpdatedTimestamp":{ 686 "shape":"Timestamp", 687 "documentation":"<p>The time at which the <code>AppInstanceBot</code> was last updated.</p>" 688 }, 689 "Metadata":{ 690 "shape":"Metadata", 691 "documentation":"<p>The metadata for an AppInstanceBot.</p>" 692 } 693 }, 694 "documentation":"<p>An Amazon Lex V2 chat bot created under an <code>AppInstance</code>.</p>" 695 }, 696 "AppInstanceBotList":{ 697 "type":"list", 698 "member":{"shape":"AppInstanceBotSummary"} 699 }, 700 "AppInstanceBotSummary":{ 701 "type":"structure", 702 "members":{ 703 "AppInstanceBotArn":{ 704 "shape":"ChimeArn", 705 "documentation":"<p>The ARN of the AppInstanceBot.</p>" 706 }, 707 "Name":{ 708 "shape":"ResourceName", 709 "documentation":"<p>The name of the AppInstanceBox.</p>" 710 }, 711 "Metadata":{ 712 "shape":"Metadata", 713 "documentation":"<p>The metadata of the AppInstanceBot.</p>" 714 } 715 }, 716 "documentation":"<p>High-level information about an AppInstanceBot.</p>" 717 }, 718 "AppInstanceList":{ 719 "type":"list", 720 "member":{"shape":"AppInstanceSummary"} 721 }, 722 "AppInstanceRetentionSettings":{ 723 "type":"structure", 724 "members":{ 725 "ChannelRetentionSettings":{ 726 "shape":"ChannelRetentionSettings", 727 "documentation":"<p>The length of time in days to retain the messages in a channel.</p>" 728 } 729 }, 730 "documentation":"<p>The details of the data-retention settings for an <code>AppInstance</code>.</p>" 731 }, 732 "AppInstanceSummary":{ 733 "type":"structure", 734 "members":{ 735 "AppInstanceArn":{ 736 "shape":"ChimeArn", 737 "documentation":"<p>The <code>AppInstance</code> ARN.</p>" 738 }, 739 "Name":{ 740 "shape":"NonEmptyResourceName", 741 "documentation":"<p>The name of the <code>AppInstance</code>.</p>" 742 }, 743 "Metadata":{ 744 "shape":"Metadata", 745 "documentation":"<p>The metadata of the <code>AppInstance</code>.</p>" 746 } 747 }, 748 "documentation":"<p>Summary of the data for an <code>AppInstance</code>.</p>" 749 }, 750 "AppInstanceUser":{ 751 "type":"structure", 752 "members":{ 753 "AppInstanceUserArn":{ 754 "shape":"ChimeArn", 755 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>" 756 }, 757 "Name":{ 758 "shape":"UserName", 759 "documentation":"<p>The name of the <code>AppInstanceUser</code>.</p>" 760 }, 761 "Metadata":{ 762 "shape":"Metadata", 763 "documentation":"<p>The metadata of the <code>AppInstanceUser</code>.</p>" 764 }, 765 "CreatedTimestamp":{ 766 "shape":"Timestamp", 767 "documentation":"<p>The time at which the <code>AppInstanceUser</code> was created.</p>" 768 }, 769 "LastUpdatedTimestamp":{ 770 "shape":"Timestamp", 771 "documentation":"<p>The time at which the <code>AppInstanceUser</code> was last updated.</p>" 772 }, 773 "ExpirationSettings":{ 774 "shape":"ExpirationSettings", 775 "documentation":"<p>The interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>" 776 } 777 }, 778 "documentation":"<p>The details of an <code>AppInstanceUser</code>.</p>" 779 }, 780 "AppInstanceUserEndpoint":{ 781 "type":"structure", 782 "members":{ 783 "AppInstanceUserArn":{ 784 "shape":"ChimeArn", 785 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>" 786 }, 787 "EndpointId":{ 788 "shape":"String64", 789 "documentation":"<p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>" 790 }, 791 "Name":{ 792 "shape":"SensitiveString1600", 793 "documentation":"<p>The name of the <code>AppInstanceUserEndpoint</code>.</p>" 794 }, 795 "Type":{ 796 "shape":"AppInstanceUserEndpointType", 797 "documentation":"<p>The type of the <code>AppInstanceUserEndpoint</code>.</p>" 798 }, 799 "ResourceArn":{ 800 "shape":"ChimeArn", 801 "documentation":"<p>The ARN of the resource to which the endpoint belongs.</p>" 802 }, 803 "EndpointAttributes":{ 804 "shape":"EndpointAttributes", 805 "documentation":"<p>The attributes of an <code>Endpoint</code>.</p>" 806 }, 807 "CreatedTimestamp":{ 808 "shape":"Timestamp", 809 "documentation":"<p>The time at which an <code>AppInstanceUserEndpoint</code> was created.</p>" 810 }, 811 "LastUpdatedTimestamp":{ 812 "shape":"Timestamp", 813 "documentation":"<p>The time at which an <code>AppInstanceUserEndpoint</code> was last updated.</p>" 814 }, 815 "AllowMessages":{ 816 "shape":"AllowMessages", 817 "documentation":"<p>Boolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages. <code>NONE</code> indicates the endpoint will receive no messages.</p>" 818 }, 819 "EndpointState":{ 820 "shape":"EndpointState", 821 "documentation":"<p>A read-only field that represents the state of an <code>AppInstanceUserEndpoint</code>. Supported values:</p> <ul> <li> <p> <code>ACTIVE</code>: The <code>AppInstanceUserEndpoint</code> is active and able to receive messages. When <code>ACTIVE</code>, the <code>EndpointStatusReason</code> remains empty.</p> </li> <li> <p> <code>INACTIVE</code>: The <code>AppInstanceUserEndpoint</code> is inactive and can't receive message. When <code>INACTIVE</code>, the corresponding reason will be conveyed through <code>EndpointStatusReason</code>.</p> </li> <li> <p> <code>INVALID_DEVICE_TOKEN</code> indicates that an <code>AppInstanceUserEndpoint</code> is <code>INACTIVE</code> due to invalid device token</p> </li> <li> <p> <code>INVALID_PINPOINT_ARN</code> indicates that an <code>AppInstanceUserEndpoint</code> is <code>INACTIVE</code> due to an invalid pinpoint ARN that was input through the <code>ResourceArn</code> field.</p> </li> </ul>" 822 } 823 }, 824 "documentation":"<p>An endpoint under an Amazon Chime <code>AppInstanceUser</code> that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.</p>" 825 }, 826 "AppInstanceUserEndpointSummary":{ 827 "type":"structure", 828 "members":{ 829 "AppInstanceUserArn":{ 830 "shape":"ChimeArn", 831 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>" 832 }, 833 "EndpointId":{ 834 "shape":"String64", 835 "documentation":"<p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>" 836 }, 837 "Name":{ 838 "shape":"SensitiveString1600", 839 "documentation":"<p>The name of the <code>AppInstanceUserEndpoint</code>.</p>" 840 }, 841 "Type":{ 842 "shape":"AppInstanceUserEndpointType", 843 "documentation":"<p>The type of the <code>AppInstanceUserEndpoint</code>.</p>" 844 }, 845 "AllowMessages":{ 846 "shape":"AllowMessages", 847 "documentation":"<p>BBoolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages. <code>NONE</code> indicates the endpoint will receive no messages.</p>" 848 }, 849 "EndpointState":{ 850 "shape":"EndpointState", 851 "documentation":"<p>A read-only field that represent the state of an <code>AppInstanceUserEndpoint</code>.</p>" 852 } 853 }, 854 "documentation":"<p>Summary of the details of an <code>AppInstanceUserEndpoint</code>.</p>" 855 }, 856 "AppInstanceUserEndpointSummaryList":{ 857 "type":"list", 858 "member":{"shape":"AppInstanceUserEndpointSummary"} 859 }, 860 "AppInstanceUserEndpointType":{ 861 "type":"string", 862 "enum":[ 863 "APNS", 864 "APNS_SANDBOX", 865 "GCM" 866 ] 867 }, 868 "AppInstanceUserList":{ 869 "type":"list", 870 "member":{"shape":"AppInstanceUserSummary"} 871 }, 872 "AppInstanceUserSummary":{ 873 "type":"structure", 874 "members":{ 875 "AppInstanceUserArn":{ 876 "shape":"ChimeArn", 877 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>" 878 }, 879 "Name":{ 880 "shape":"UserName", 881 "documentation":"<p>The name of an <code>AppInstanceUser</code>.</p>" 882 }, 883 "Metadata":{ 884 "shape":"Metadata", 885 "documentation":"<p>The metadata of the <code>AppInstanceUser</code>.</p>" 886 } 887 }, 888 "documentation":"<p>Summary of the details of an <code>AppInstanceUser</code>.</p>" 889 }, 890 "BadRequestException":{ 891 "type":"structure", 892 "members":{ 893 "Code":{"shape":"ErrorCode"}, 894 "Message":{"shape":"String"} 895 }, 896 "documentation":"<p>The input parameters don't match the service's restrictions.</p>", 897 "error":{"httpStatusCode":400}, 898 "exception":true 899 }, 900 "ChannelRetentionSettings":{ 901 "type":"structure", 902 "members":{ 903 "RetentionDays":{ 904 "shape":"RetentionDays", 905 "documentation":"<p>The time in days to retain the messages in a channel.</p>" 906 } 907 }, 908 "documentation":"<p>The details of the retention settings for a channel.</p>" 909 }, 910 "ChimeArn":{ 911 "type":"string", 912 "max":1600, 913 "min":5, 914 "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" 915 }, 916 "ClientRequestToken":{ 917 "type":"string", 918 "max":64, 919 "min":2, 920 "pattern":"[-_a-zA-Z0-9]*" 921 }, 922 "Configuration":{ 923 "type":"structure", 924 "required":["Lex"], 925 "members":{ 926 "Lex":{ 927 "shape":"LexConfiguration", 928 "documentation":"<p>The configuration for an Amazon Lex V2 bot.</p>" 929 } 930 }, 931 "documentation":"<p>A structure that contains configuration data.</p>" 932 }, 933 "ConflictException":{ 934 "type":"structure", 935 "members":{ 936 "Code":{"shape":"ErrorCode"}, 937 "Message":{"shape":"String"} 938 }, 939 "documentation":"<p>The request could not be processed because of conflict in the current state of the resource.</p>", 940 "error":{"httpStatusCode":409}, 941 "exception":true 942 }, 943 "CreateAppInstanceAdminRequest":{ 944 "type":"structure", 945 "required":[ 946 "AppInstanceAdminArn", 947 "AppInstanceArn" 948 ], 949 "members":{ 950 "AppInstanceAdminArn":{ 951 "shape":"ChimeArn", 952 "documentation":"<p>The ARN of the administrator of the current <code>AppInstance</code>.</p>" 953 }, 954 "AppInstanceArn":{ 955 "shape":"ChimeArn", 956 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 957 "location":"uri", 958 "locationName":"appInstanceArn" 959 } 960 } 961 }, 962 "CreateAppInstanceAdminResponse":{ 963 "type":"structure", 964 "members":{ 965 "AppInstanceAdmin":{ 966 "shape":"Identity", 967 "documentation":"<p>The ARN and name of the administrator, the ARN of the <code>AppInstance</code>, and the created and last-updated timestamps. All timestamps use epoch milliseconds.</p>" 968 }, 969 "AppInstanceArn":{ 970 "shape":"ChimeArn", 971 "documentation":"<p>The ARN of the of the admin for the <code>AppInstance</code>.</p>" 972 } 973 } 974 }, 975 "CreateAppInstanceBotRequest":{ 976 "type":"structure", 977 "required":[ 978 "AppInstanceArn", 979 "ClientRequestToken", 980 "Configuration" 981 ], 982 "members":{ 983 "AppInstanceArn":{ 984 "shape":"ChimeArn", 985 "documentation":"<p>The ARN of the <code>AppInstance</code> request.</p>" 986 }, 987 "Name":{ 988 "shape":"ResourceName", 989 "documentation":"<p>The user's name.</p>" 990 }, 991 "Metadata":{ 992 "shape":"Metadata", 993 "documentation":"<p>The request metadata. Limited to a 1KB string in UTF-8.</p>" 994 }, 995 "ClientRequestToken":{ 996 "shape":"ClientRequestToken", 997 "documentation":"<p>The unique ID for the client making the request. Use different tokens for different <code>AppInstanceBots</code>.</p>", 998 "idempotencyToken":true 999 }, 1000 "Tags":{ 1001 "shape":"TagList", 1002 "documentation":"<p>The tags assigned to the <code>AppInstanceBot</code>.</p>" 1003 }, 1004 "Configuration":{ 1005 "shape":"Configuration", 1006 "documentation":"<p>Configuration information about the Amazon Lex V2 V2 bot.</p>" 1007 } 1008 } 1009 }, 1010 "CreateAppInstanceBotResponse":{ 1011 "type":"structure", 1012 "members":{ 1013 "AppInstanceBotArn":{ 1014 "shape":"ChimeArn", 1015 "documentation":"<p>The ARN of the <code>AppinstanceBot</code>.</p>" 1016 } 1017 } 1018 }, 1019 "CreateAppInstanceRequest":{ 1020 "type":"structure", 1021 "required":[ 1022 "Name", 1023 "ClientRequestToken" 1024 ], 1025 "members":{ 1026 "Name":{ 1027 "shape":"NonEmptyResourceName", 1028 "documentation":"<p>The name of the <code>AppInstance</code>.</p>" 1029 }, 1030 "Metadata":{ 1031 "shape":"Metadata", 1032 "documentation":"<p>The metadata of the <code>AppInstance</code>. Limited to a 1KB string in UTF-8.</p>" 1033 }, 1034 "ClientRequestToken":{ 1035 "shape":"ClientRequestToken", 1036 "documentation":"<p>The unique ID of the request. Use different tokens to create different <code>AppInstances</code>.</p>", 1037 "idempotencyToken":true 1038 }, 1039 "Tags":{ 1040 "shape":"TagList", 1041 "documentation":"<p>Tags assigned to the <code>AppInstance</code>.</p>" 1042 } 1043 } 1044 }, 1045 "CreateAppInstanceResponse":{ 1046 "type":"structure", 1047 "members":{ 1048 "AppInstanceArn":{ 1049 "shape":"ChimeArn", 1050 "documentation":"<p>The Amazon Resource Number (ARN) of the <code>AppInstance</code>.</p>" 1051 } 1052 } 1053 }, 1054 "CreateAppInstanceUserRequest":{ 1055 "type":"structure", 1056 "required":[ 1057 "AppInstanceArn", 1058 "AppInstanceUserId", 1059 "Name", 1060 "ClientRequestToken" 1061 ], 1062 "members":{ 1063 "AppInstanceArn":{ 1064 "shape":"ChimeArn", 1065 "documentation":"<p>The ARN of the <code>AppInstance</code> request.</p>" 1066 }, 1067 "AppInstanceUserId":{ 1068 "shape":"UserId", 1069 "documentation":"<p>The user ID of the <code>AppInstance</code>.</p>" 1070 }, 1071 "Name":{ 1072 "shape":"UserName", 1073 "documentation":"<p>The user's name.</p>" 1074 }, 1075 "Metadata":{ 1076 "shape":"Metadata", 1077 "documentation":"<p>The request's metadata. Limited to a 1KB string in UTF-8.</p>" 1078 }, 1079 "ClientRequestToken":{ 1080 "shape":"ClientRequestToken", 1081 "documentation":"<p>The unique ID of the request. Use different tokens to request additional <code>AppInstances</code>.</p>", 1082 "idempotencyToken":true 1083 }, 1084 "Tags":{ 1085 "shape":"TagList", 1086 "documentation":"<p>Tags assigned to the <code>AppInstanceUser</code>.</p>" 1087 }, 1088 "ExpirationSettings":{ 1089 "shape":"ExpirationSettings", 1090 "documentation":"<p>Settings that control the interval after which the <code>AppInstanceUser</code> is automatically deleted.</p>" 1091 } 1092 } 1093 }, 1094 "CreateAppInstanceUserResponse":{ 1095 "type":"structure", 1096 "members":{ 1097 "AppInstanceUserArn":{ 1098 "shape":"ChimeArn", 1099 "documentation":"<p>The user's ARN.</p>" 1100 } 1101 } 1102 }, 1103 "DeleteAppInstanceAdminRequest":{ 1104 "type":"structure", 1105 "required":[ 1106 "AppInstanceAdminArn", 1107 "AppInstanceArn" 1108 ], 1109 "members":{ 1110 "AppInstanceAdminArn":{ 1111 "shape":"ChimeArn", 1112 "documentation":"<p>The ARN of the <code>AppInstance</code>'s administrator.</p>", 1113 "location":"uri", 1114 "locationName":"appInstanceAdminArn" 1115 }, 1116 "AppInstanceArn":{ 1117 "shape":"ChimeArn", 1118 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1119 "location":"uri", 1120 "locationName":"appInstanceArn" 1121 } 1122 } 1123 }, 1124 "DeleteAppInstanceBotRequest":{ 1125 "type":"structure", 1126 "required":["AppInstanceBotArn"], 1127 "members":{ 1128 "AppInstanceBotArn":{ 1129 "shape":"ChimeArn", 1130 "documentation":"<p>The ARN of the <code>AppInstanceBot</code> being deleted.</p>", 1131 "location":"uri", 1132 "locationName":"appInstanceBotArn" 1133 } 1134 } 1135 }, 1136 "DeleteAppInstanceRequest":{ 1137 "type":"structure", 1138 "required":["AppInstanceArn"], 1139 "members":{ 1140 "AppInstanceArn":{ 1141 "shape":"ChimeArn", 1142 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1143 "location":"uri", 1144 "locationName":"appInstanceArn" 1145 } 1146 } 1147 }, 1148 "DeleteAppInstanceUserRequest":{ 1149 "type":"structure", 1150 "required":["AppInstanceUserArn"], 1151 "members":{ 1152 "AppInstanceUserArn":{ 1153 "shape":"ChimeArn", 1154 "documentation":"<p>The ARN of the user request being deleted.</p>", 1155 "location":"uri", 1156 "locationName":"appInstanceUserArn" 1157 } 1158 } 1159 }, 1160 "DeregisterAppInstanceUserEndpointRequest":{ 1161 "type":"structure", 1162 "required":[ 1163 "AppInstanceUserArn", 1164 "EndpointId" 1165 ], 1166 "members":{ 1167 "AppInstanceUserArn":{ 1168 "shape":"ChimeArn", 1169 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>", 1170 "location":"uri", 1171 "locationName":"appInstanceUserArn" 1172 }, 1173 "EndpointId":{ 1174 "shape":"String64", 1175 "documentation":"<p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>", 1176 "location":"uri", 1177 "locationName":"endpointId" 1178 } 1179 } 1180 }, 1181 "DescribeAppInstanceAdminRequest":{ 1182 "type":"structure", 1183 "required":[ 1184 "AppInstanceAdminArn", 1185 "AppInstanceArn" 1186 ], 1187 "members":{ 1188 "AppInstanceAdminArn":{ 1189 "shape":"ChimeArn", 1190 "documentation":"<p>The ARN of the <code>AppInstanceAdmin</code>.</p>", 1191 "location":"uri", 1192 "locationName":"appInstanceAdminArn" 1193 }, 1194 "AppInstanceArn":{ 1195 "shape":"ChimeArn", 1196 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1197 "location":"uri", 1198 "locationName":"appInstanceArn" 1199 } 1200 } 1201 }, 1202 "DescribeAppInstanceAdminResponse":{ 1203 "type":"structure", 1204 "members":{ 1205 "AppInstanceAdmin":{ 1206 "shape":"AppInstanceAdmin", 1207 "documentation":"<p>The ARN and name of the <code>AppInstanceUser</code>, the ARN of the <code>AppInstance</code>, and the created and last-updated timestamps. All timestamps use epoch milliseconds.</p>" 1208 } 1209 } 1210 }, 1211 "DescribeAppInstanceBotRequest":{ 1212 "type":"structure", 1213 "required":["AppInstanceBotArn"], 1214 "members":{ 1215 "AppInstanceBotArn":{ 1216 "shape":"ChimeArn", 1217 "documentation":"<p>The ARN of the <code>AppInstanceBot</code>.</p>", 1218 "location":"uri", 1219 "locationName":"appInstanceBotArn" 1220 } 1221 } 1222 }, 1223 "DescribeAppInstanceBotResponse":{ 1224 "type":"structure", 1225 "members":{ 1226 "AppInstanceBot":{ 1227 "shape":"AppInstanceBot", 1228 "documentation":"<p>The detials of the <code>AppInstanceBot</code>.</p>" 1229 } 1230 } 1231 }, 1232 "DescribeAppInstanceRequest":{ 1233 "type":"structure", 1234 "required":["AppInstanceArn"], 1235 "members":{ 1236 "AppInstanceArn":{ 1237 "shape":"ChimeArn", 1238 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1239 "location":"uri", 1240 "locationName":"appInstanceArn" 1241 } 1242 } 1243 }, 1244 "DescribeAppInstanceResponse":{ 1245 "type":"structure", 1246 "members":{ 1247 "AppInstance":{ 1248 "shape":"AppInstance", 1249 "documentation":"<p>The ARN, metadata, created and last-updated timestamps, and the name of the <code>AppInstance</code>. All timestamps use epoch milliseconds.</p>" 1250 } 1251 } 1252 }, 1253 "DescribeAppInstanceUserEndpointRequest":{ 1254 "type":"structure", 1255 "required":[ 1256 "AppInstanceUserArn", 1257 "EndpointId" 1258 ], 1259 "members":{ 1260 "AppInstanceUserArn":{ 1261 "shape":"String1600", 1262 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>", 1263 "location":"uri", 1264 "locationName":"appInstanceUserArn" 1265 }, 1266 "EndpointId":{ 1267 "shape":"String64", 1268 "documentation":"<p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>", 1269 "location":"uri", 1270 "locationName":"endpointId" 1271 } 1272 } 1273 }, 1274 "DescribeAppInstanceUserEndpointResponse":{ 1275 "type":"structure", 1276 "members":{ 1277 "AppInstanceUserEndpoint":{ 1278 "shape":"AppInstanceUserEndpoint", 1279 "documentation":"<p>The full details of an <code>AppInstanceUserEndpoint</code>: the <code>AppInstanceUserArn</code>, ID, name, type, resource ARN, attributes, allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.</p>" 1280 } 1281 } 1282 }, 1283 "DescribeAppInstanceUserRequest":{ 1284 "type":"structure", 1285 "required":["AppInstanceUserArn"], 1286 "members":{ 1287 "AppInstanceUserArn":{ 1288 "shape":"ChimeArn", 1289 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>", 1290 "location":"uri", 1291 "locationName":"appInstanceUserArn" 1292 } 1293 } 1294 }, 1295 "DescribeAppInstanceUserResponse":{ 1296 "type":"structure", 1297 "members":{ 1298 "AppInstanceUser":{ 1299 "shape":"AppInstanceUser", 1300 "documentation":"<p>The name of the <code>AppInstanceUser</code>.</p>" 1301 } 1302 } 1303 }, 1304 "EndpointAttributes":{ 1305 "type":"structure", 1306 "required":["DeviceToken"], 1307 "members":{ 1308 "DeviceToken":{ 1309 "shape":"NonEmptySensitiveString1600", 1310 "documentation":"<p>The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.</p>" 1311 }, 1312 "VoipDeviceToken":{ 1313 "shape":"NonEmptySensitiveString1600", 1314 "documentation":"<p>The VOIP device token for the APNS and APNS_SANDBOX endpoint types.</p>" 1315 } 1316 }, 1317 "documentation":"<p>The attributes of an <code>Endpoint</code>.</p>" 1318 }, 1319 "EndpointState":{ 1320 "type":"structure", 1321 "required":["Status"], 1322 "members":{ 1323 "Status":{ 1324 "shape":"EndpointStatus", 1325 "documentation":"<p>Enum that indicates the Status of an <code>AppInstanceUserEndpoint</code>.</p>" 1326 }, 1327 "StatusReason":{ 1328 "shape":"EndpointStatusReason", 1329 "documentation":"<p>The reason for the <code>EndpointStatus</code>.</p>" 1330 } 1331 }, 1332 "documentation":"<p>A read-only field that represents the state of an <code>AppInstanceUserEndpoint</code>. Supported values:</p> <ul> <li> <p> <code>ACTIVE</code>: The <code>AppInstanceUserEndpoint</code> is active and able to receive messages. When <code>ACTIVE</code>, the <code>EndpointStatusReason</code> remains empty.</p> </li> <li> <p> <code>INACTIVE</code>: The <code>AppInstanceUserEndpoint</code> is inactive and can't receive message. When INACTIVE, the corresponding reason will be conveyed through EndpointStatusReason.</p> </li> <li> <p> <code>INVALID_DEVICE_TOKEN</code> indicates that an <code>AppInstanceUserEndpoint</code> is <code>INACTIVE</code> due to invalid device token</p> </li> <li> <p> <code>INVALID_PINPOINT_ARN</code> indicates that an <code>AppInstanceUserEndpoint</code> is <code>INACTIVE</code> due to an invalid pinpoint ARN that was input through the <code>ResourceArn</code> field.</p> </li> </ul>" 1333 }, 1334 "EndpointStatus":{ 1335 "type":"string", 1336 "enum":[ 1337 "ACTIVE", 1338 "INACTIVE" 1339 ] 1340 }, 1341 "EndpointStatusReason":{ 1342 "type":"string", 1343 "enum":[ 1344 "INVALID_DEVICE_TOKEN", 1345 "INVALID_PINPOINT_ARN" 1346 ] 1347 }, 1348 "ErrorCode":{ 1349 "type":"string", 1350 "enum":[ 1351 "BadRequest", 1352 "Conflict", 1353 "Forbidden", 1354 "NotFound", 1355 "PreconditionFailed", 1356 "ResourceLimitExceeded", 1357 "ServiceFailure", 1358 "AccessDenied", 1359 "ServiceUnavailable", 1360 "Throttled", 1361 "Throttling", 1362 "Unauthorized", 1363 "Unprocessable", 1364 "VoiceConnectorGroupAssociationsExist", 1365 "PhoneNumberAssociationsExist" 1366 ] 1367 }, 1368 "ExpirationCriterion":{ 1369 "type":"string", 1370 "enum":["CREATED_TIMESTAMP"] 1371 }, 1372 "ExpirationDays":{ 1373 "type":"integer", 1374 "max":5475, 1375 "min":1 1376 }, 1377 "ExpirationSettings":{ 1378 "type":"structure", 1379 "required":[ 1380 "ExpirationDays", 1381 "ExpirationCriterion" 1382 ], 1383 "members":{ 1384 "ExpirationDays":{ 1385 "shape":"ExpirationDays", 1386 "documentation":"<p>The period in days after which an <code>AppInstanceUser</code> will be automatically deleted.</p>" 1387 }, 1388 "ExpirationCriterion":{ 1389 "shape":"ExpirationCriterion", 1390 "documentation":"<p>Specifies the conditions under which an <code>AppInstanceUser</code> will expire.</p>" 1391 } 1392 }, 1393 "documentation":"<p>Determines the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>" 1394 }, 1395 "ForbiddenException":{ 1396 "type":"structure", 1397 "members":{ 1398 "Code":{"shape":"ErrorCode"}, 1399 "Message":{"shape":"String"} 1400 }, 1401 "documentation":"<p>The client is permanently forbidden from making the request.</p>", 1402 "error":{"httpStatusCode":403}, 1403 "exception":true 1404 }, 1405 "GetAppInstanceRetentionSettingsRequest":{ 1406 "type":"structure", 1407 "required":["AppInstanceArn"], 1408 "members":{ 1409 "AppInstanceArn":{ 1410 "shape":"ChimeArn", 1411 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1412 "location":"uri", 1413 "locationName":"appInstanceArn" 1414 } 1415 } 1416 }, 1417 "GetAppInstanceRetentionSettingsResponse":{ 1418 "type":"structure", 1419 "members":{ 1420 "AppInstanceRetentionSettings":{ 1421 "shape":"AppInstanceRetentionSettings", 1422 "documentation":"<p>The retention settings for the <code>AppInstance</code>.</p>" 1423 }, 1424 "InitiateDeletionTimestamp":{ 1425 "shape":"Timestamp", 1426 "documentation":"<p>The timestamp representing the time at which the specified items are retained, in Epoch Seconds.</p>" 1427 } 1428 } 1429 }, 1430 "Identity":{ 1431 "type":"structure", 1432 "members":{ 1433 "Arn":{ 1434 "shape":"ChimeArn", 1435 "documentation":"<p>The ARN in an Identity.</p>" 1436 }, 1437 "Name":{ 1438 "shape":"ResourceName", 1439 "documentation":"<p>The name in an Identity.</p>" 1440 } 1441 }, 1442 "documentation":"<p>The details of a user or bot.</p>" 1443 }, 1444 "InvokedBy":{ 1445 "type":"structure", 1446 "required":[ 1447 "StandardMessages", 1448 "TargetedMessages" 1449 ], 1450 "members":{ 1451 "StandardMessages":{ 1452 "shape":"StandardMessages", 1453 "documentation":"<p>Sets standard messages as the bot trigger. For standard messages:</p> <ul> <li> <p> <code>ALL</code>: The bot processes all standard messages.</p> </li> <li> <p> <code>AUTO</code>: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.</p> </li> <li> <p> <code>MENTIONS</code>: The bot processes all standard messages that have a message attribute with <code>CHIME.mentions</code> and a value of the bot ARN.</p> </li> <li> <p> <code>NONE</code>: The bot processes no standard messages.</p> </li> </ul>" 1454 }, 1455 "TargetedMessages":{ 1456 "shape":"TargetedMessages", 1457 "documentation":"<p>Sets targeted messages as the bot trigger. For targeted messages:</p> <ul> <li> <p> <code>ALL</code>: The bot processes all <code>TargetedMessages</code> sent to it. The bot then responds with a targeted message back to the sender. </p> </li> <li> <p> <code>NONE</code>: The bot processes no targeted messages.</p> </li> </ul>" 1458 } 1459 }, 1460 "documentation":"<p>Specifies the type of message that triggers a bot.</p>" 1461 }, 1462 "LexBotAliasArn":{ 1463 "type":"string", 1464 "max":2048, 1465 "min":15, 1466 "pattern":"arn:aws:lex:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:bot-alias/[A-Z0-9]{10}/[A-Z0-9]{10}" 1467 }, 1468 "LexConfiguration":{ 1469 "type":"structure", 1470 "required":[ 1471 "LexBotAliasArn", 1472 "LocaleId" 1473 ], 1474 "members":{ 1475 "RespondsTo":{ 1476 "shape":"RespondsTo", 1477 "documentation":"<important> <p> <b>Deprecated</b>. Use <code>InvokedBy</code> instead.</p> </important> <p>Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.</p>" 1478 }, 1479 "InvokedBy":{ 1480 "shape":"InvokedBy", 1481 "documentation":"<p>Specifies the type of message that triggers a bot.</p>" 1482 }, 1483 "LexBotAliasArn":{ 1484 "shape":"LexBotAliasArn", 1485 "documentation":"<p>The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: <code>arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS</code> </p>" 1486 }, 1487 "LocaleId":{ 1488 "shape":"String", 1489 "documentation":"<p>Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html\">Supported languages</a> in the <i>Amazon Lex V2 Developer Guide</i>.</p>" 1490 }, 1491 "WelcomeIntent":{ 1492 "shape":"LexIntentName", 1493 "documentation":"<p>The name of the welcome intent configured in the Amazon Lex V2 bot.</p>" 1494 } 1495 }, 1496 "documentation":"<p>The configuration for an Amazon Lex V2 bot.</p>" 1497 }, 1498 "LexIntentName":{ 1499 "type":"string", 1500 "max":100, 1501 "min":1, 1502 "pattern":"^([A-Za-z]_?)+$" 1503 }, 1504 "ListAppInstanceAdminsRequest":{ 1505 "type":"structure", 1506 "required":["AppInstanceArn"], 1507 "members":{ 1508 "AppInstanceArn":{ 1509 "shape":"ChimeArn", 1510 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1511 "location":"uri", 1512 "locationName":"appInstanceArn" 1513 }, 1514 "MaxResults":{ 1515 "shape":"MaxResults", 1516 "documentation":"<p>The maximum number of administrators that you want to return.</p>", 1517 "location":"querystring", 1518 "locationName":"max-results" 1519 }, 1520 "NextToken":{ 1521 "shape":"NextToken", 1522 "documentation":"<p>The token returned from previous API requests until the number of administrators is reached.</p>", 1523 "location":"querystring", 1524 "locationName":"next-token" 1525 } 1526 } 1527 }, 1528 "ListAppInstanceAdminsResponse":{ 1529 "type":"structure", 1530 "members":{ 1531 "AppInstanceArn":{ 1532 "shape":"ChimeArn", 1533 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>" 1534 }, 1535 "AppInstanceAdmins":{ 1536 "shape":"AppInstanceAdminList", 1537 "documentation":"<p>The information for each administrator.</p>" 1538 }, 1539 "NextToken":{ 1540 "shape":"NextToken", 1541 "documentation":"<p>The token returned from previous API requests until the number of administrators is reached.</p>" 1542 } 1543 } 1544 }, 1545 "ListAppInstanceBotsRequest":{ 1546 "type":"structure", 1547 "required":["AppInstanceArn"], 1548 "members":{ 1549 "AppInstanceArn":{ 1550 "shape":"ChimeArn", 1551 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1552 "location":"querystring", 1553 "locationName":"app-instance-arn" 1554 }, 1555 "MaxResults":{ 1556 "shape":"MaxResults", 1557 "documentation":"<p>The maximum number of requests to return.</p>", 1558 "location":"querystring", 1559 "locationName":"max-results" 1560 }, 1561 "NextToken":{ 1562 "shape":"NextToken", 1563 "documentation":"<p>The token passed by previous API calls until all requested bots are returned.</p>", 1564 "location":"querystring", 1565 "locationName":"next-token" 1566 } 1567 } 1568 }, 1569 "ListAppInstanceBotsResponse":{ 1570 "type":"structure", 1571 "members":{ 1572 "AppInstanceArn":{ 1573 "shape":"ChimeArn", 1574 "documentation":"<p>The ARN of the AppInstance.</p>" 1575 }, 1576 "AppInstanceBots":{ 1577 "shape":"AppInstanceBotList", 1578 "documentation":"<p>The information for each requested <code>AppInstanceBot</code>.</p>" 1579 }, 1580 "NextToken":{ 1581 "shape":"NextToken", 1582 "documentation":"<p>The token passed by previous API calls until all requested bots are returned.</p>" 1583 } 1584 } 1585 }, 1586 "ListAppInstanceUserEndpointsRequest":{ 1587 "type":"structure", 1588 "required":["AppInstanceUserArn"], 1589 "members":{ 1590 "AppInstanceUserArn":{ 1591 "shape":"SensitiveChimeArn", 1592 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>", 1593 "location":"uri", 1594 "locationName":"appInstanceUserArn" 1595 }, 1596 "MaxResults":{ 1597 "shape":"MaxResults", 1598 "documentation":"<p>The maximum number of endpoints that you want to return.</p>", 1599 "location":"querystring", 1600 "locationName":"max-results" 1601 }, 1602 "NextToken":{ 1603 "shape":"NextToken", 1604 "documentation":"<p>The token passed by previous API calls until all requested endpoints are returned.</p>", 1605 "location":"querystring", 1606 "locationName":"next-token" 1607 } 1608 } 1609 }, 1610 "ListAppInstanceUserEndpointsResponse":{ 1611 "type":"structure", 1612 "members":{ 1613 "AppInstanceUserEndpoints":{ 1614 "shape":"AppInstanceUserEndpointSummaryList", 1615 "documentation":"<p>The information for each requested <code>AppInstanceUserEndpoint</code>.</p>" 1616 }, 1617 "NextToken":{ 1618 "shape":"NextToken", 1619 "documentation":"<p>The token passed by previous API calls until all requested endpoints are returned.</p>" 1620 } 1621 } 1622 }, 1623 "ListAppInstanceUsersRequest":{ 1624 "type":"structure", 1625 "required":["AppInstanceArn"], 1626 "members":{ 1627 "AppInstanceArn":{ 1628 "shape":"ChimeArn", 1629 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1630 "location":"querystring", 1631 "locationName":"app-instance-arn" 1632 }, 1633 "MaxResults":{ 1634 "shape":"MaxResults", 1635 "documentation":"<p>The maximum number of requests that you want returned.</p>", 1636 "location":"querystring", 1637 "locationName":"max-results" 1638 }, 1639 "NextToken":{ 1640 "shape":"NextToken", 1641 "documentation":"<p>The token passed by previous API calls until all requested users are returned.</p>", 1642 "location":"querystring", 1643 "locationName":"next-token" 1644 } 1645 } 1646 }, 1647 "ListAppInstanceUsersResponse":{ 1648 "type":"structure", 1649 "members":{ 1650 "AppInstanceArn":{ 1651 "shape":"ChimeArn", 1652 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>" 1653 }, 1654 "AppInstanceUsers":{ 1655 "shape":"AppInstanceUserList", 1656 "documentation":"<p>The information for each requested <code>AppInstanceUser</code>.</p>" 1657 }, 1658 "NextToken":{ 1659 "shape":"NextToken", 1660 "documentation":"<p>The token passed by previous API calls until all requested users are returned.</p>" 1661 } 1662 } 1663 }, 1664 "ListAppInstancesRequest":{ 1665 "type":"structure", 1666 "members":{ 1667 "MaxResults":{ 1668 "shape":"MaxResults", 1669 "documentation":"<p>The maximum number of <code>AppInstance</code>s that you want to return.</p>", 1670 "location":"querystring", 1671 "locationName":"max-results" 1672 }, 1673 "NextToken":{ 1674 "shape":"NextToken", 1675 "documentation":"<p>The token passed by previous API requests until you reach the maximum number of <code>AppInstances</code>.</p>", 1676 "location":"querystring", 1677 "locationName":"next-token" 1678 } 1679 } 1680 }, 1681 "ListAppInstancesResponse":{ 1682 "type":"structure", 1683 "members":{ 1684 "AppInstances":{ 1685 "shape":"AppInstanceList", 1686 "documentation":"<p>The information for each <code>AppInstance</code>.</p>" 1687 }, 1688 "NextToken":{ 1689 "shape":"NextToken", 1690 "documentation":"<p>The token passed by previous API requests until the maximum number of <code>AppInstance</code>s is reached.</p>" 1691 } 1692 } 1693 }, 1694 "ListTagsForResourceRequest":{ 1695 "type":"structure", 1696 "required":["ResourceARN"], 1697 "members":{ 1698 "ResourceARN":{ 1699 "shape":"ChimeArn", 1700 "documentation":"<p>The ARN of the resource.</p>", 1701 "location":"querystring", 1702 "locationName":"arn" 1703 } 1704 } 1705 }, 1706 "ListTagsForResourceResponse":{ 1707 "type":"structure", 1708 "members":{ 1709 "Tags":{ 1710 "shape":"TagList", 1711 "documentation":"<p>The tag key-value pairs.</p>" 1712 } 1713 } 1714 }, 1715 "MaxResults":{ 1716 "type":"integer", 1717 "max":50, 1718 "min":1 1719 }, 1720 "Metadata":{ 1721 "type":"string", 1722 "max":1024, 1723 "min":0, 1724 "pattern":".*", 1725 "sensitive":true 1726 }, 1727 "NextToken":{ 1728 "type":"string", 1729 "max":2048, 1730 "min":0, 1731 "pattern":".*", 1732 "sensitive":true 1733 }, 1734 "NonEmptyResourceName":{ 1735 "type":"string", 1736 "max":256, 1737 "min":1, 1738 "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", 1739 "sensitive":true 1740 }, 1741 "NonEmptySensitiveString1600":{ 1742 "type":"string", 1743 "max":1600, 1744 "min":1, 1745 "pattern":".*", 1746 "sensitive":true 1747 }, 1748 "NotFoundException":{ 1749 "type":"structure", 1750 "members":{ 1751 "Code":{"shape":"ErrorCode"}, 1752 "Message":{"shape":"String"} 1753 }, 1754 "documentation":"<p>One or more of the resources in the request does not exist in the system.</p>", 1755 "error":{"httpStatusCode":404}, 1756 "exception":true 1757 }, 1758 "PutAppInstanceRetentionSettingsRequest":{ 1759 "type":"structure", 1760 "required":[ 1761 "AppInstanceArn", 1762 "AppInstanceRetentionSettings" 1763 ], 1764 "members":{ 1765 "AppInstanceArn":{ 1766 "shape":"ChimeArn", 1767 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 1768 "location":"uri", 1769 "locationName":"appInstanceArn" 1770 }, 1771 "AppInstanceRetentionSettings":{ 1772 "shape":"AppInstanceRetentionSettings", 1773 "documentation":"<p>The time in days to retain data. Data type: number.</p>" 1774 } 1775 } 1776 }, 1777 "PutAppInstanceRetentionSettingsResponse":{ 1778 "type":"structure", 1779 "members":{ 1780 "AppInstanceRetentionSettings":{ 1781 "shape":"AppInstanceRetentionSettings", 1782 "documentation":"<p>The time in days to retain data. Data type: number.</p>" 1783 }, 1784 "InitiateDeletionTimestamp":{ 1785 "shape":"Timestamp", 1786 "documentation":"<p>The time at which the API deletes data.</p>" 1787 } 1788 } 1789 }, 1790 "PutAppInstanceUserExpirationSettingsRequest":{ 1791 "type":"structure", 1792 "required":["AppInstanceUserArn"], 1793 "members":{ 1794 "AppInstanceUserArn":{ 1795 "shape":"ChimeArn", 1796 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>", 1797 "location":"uri", 1798 "locationName":"appInstanceUserArn" 1799 }, 1800 "ExpirationSettings":{ 1801 "shape":"ExpirationSettings", 1802 "documentation":"<p>Settings that control the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>" 1803 } 1804 } 1805 }, 1806 "PutAppInstanceUserExpirationSettingsResponse":{ 1807 "type":"structure", 1808 "members":{ 1809 "AppInstanceUserArn":{ 1810 "shape":"ChimeArn", 1811 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>" 1812 }, 1813 "ExpirationSettings":{ 1814 "shape":"ExpirationSettings", 1815 "documentation":"<p>Settings that control the interval after which an <code>AppInstanceUser</code> is automatically deleted.</p>" 1816 } 1817 } 1818 }, 1819 "RegisterAppInstanceUserEndpointRequest":{ 1820 "type":"structure", 1821 "required":[ 1822 "AppInstanceUserArn", 1823 "Type", 1824 "ResourceArn", 1825 "EndpointAttributes", 1826 "ClientRequestToken" 1827 ], 1828 "members":{ 1829 "AppInstanceUserArn":{ 1830 "shape":"SensitiveChimeArn", 1831 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>", 1832 "location":"uri", 1833 "locationName":"appInstanceUserArn" 1834 }, 1835 "Name":{ 1836 "shape":"SensitiveString1600", 1837 "documentation":"<p>The name of the <code>AppInstanceUserEndpoint</code>.</p>" 1838 }, 1839 "Type":{ 1840 "shape":"AppInstanceUserEndpointType", 1841 "documentation":"<p>The type of the <code>AppInstanceUserEndpoint</code>. Supported types:</p> <ul> <li> <p> <code>APNS</code>: The mobile notification service for an Apple device.</p> </li> <li> <p> <code>APNS_SANDBOX</code>: The sandbox environment of the mobile notification service for an Apple device.</p> </li> <li> <p> <code>GCM</code>: The mobile notification service for an Android device.</p> </li> </ul> <p>Populate the <code>ResourceArn</code> value of each type as <code>PinpointAppArn</code>.</p>" 1842 }, 1843 "ResourceArn":{ 1844 "shape":"ChimeArn", 1845 "documentation":"<p>The ARN of the resource to which the endpoint belongs.</p>" 1846 }, 1847 "EndpointAttributes":{ 1848 "shape":"EndpointAttributes", 1849 "documentation":"<p>The attributes of an <code>Endpoint</code>.</p>" 1850 }, 1851 "ClientRequestToken":{ 1852 "shape":"ClientRequestToken", 1853 "documentation":"<p>The unique ID assigned to the request. Use different tokens to register other endpoints.</p>", 1854 "idempotencyToken":true 1855 }, 1856 "AllowMessages":{ 1857 "shape":"AllowMessages", 1858 "documentation":"<p>Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. <code>ALL</code> indicates the endpoint receives all messages. <code>NONE</code> indicates the endpoint receives no messages.</p>" 1859 } 1860 } 1861 }, 1862 "RegisterAppInstanceUserEndpointResponse":{ 1863 "type":"structure", 1864 "members":{ 1865 "AppInstanceUserArn":{ 1866 "shape":"ChimeArn", 1867 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>" 1868 }, 1869 "EndpointId":{ 1870 "shape":"String64", 1871 "documentation":"<p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>" 1872 } 1873 } 1874 }, 1875 "ResourceLimitExceededException":{ 1876 "type":"structure", 1877 "members":{ 1878 "Code":{"shape":"ErrorCode"}, 1879 "Message":{"shape":"String"} 1880 }, 1881 "documentation":"<p>The request exceeds the resource limit.</p>", 1882 "error":{"httpStatusCode":400}, 1883 "exception":true 1884 }, 1885 "ResourceName":{ 1886 "type":"string", 1887 "max":256, 1888 "min":0, 1889 "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*", 1890 "sensitive":true 1891 }, 1892 "RespondsTo":{ 1893 "type":"string", 1894 "enum":["STANDARD_MESSAGES"] 1895 }, 1896 "RetentionDays":{ 1897 "type":"integer", 1898 "max":5475, 1899 "min":1 1900 }, 1901 "SensitiveChimeArn":{ 1902 "type":"string", 1903 "max":1600, 1904 "min":5, 1905 "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}", 1906 "sensitive":true 1907 }, 1908 "SensitiveString1600":{ 1909 "type":"string", 1910 "max":1600, 1911 "min":0, 1912 "pattern":".*", 1913 "sensitive":true 1914 }, 1915 "ServiceFailureException":{ 1916 "type":"structure", 1917 "members":{ 1918 "Code":{"shape":"ErrorCode"}, 1919 "Message":{"shape":"String"} 1920 }, 1921 "documentation":"<p>The service encountered an unexpected error.</p>", 1922 "error":{"httpStatusCode":500}, 1923 "exception":true, 1924 "fault":true 1925 }, 1926 "ServiceUnavailableException":{ 1927 "type":"structure", 1928 "members":{ 1929 "Code":{"shape":"ErrorCode"}, 1930 "Message":{"shape":"String"} 1931 }, 1932 "documentation":"<p>The service is currently unavailable.</p>", 1933 "error":{"httpStatusCode":503}, 1934 "exception":true, 1935 "fault":true 1936 }, 1937 "StandardMessages":{ 1938 "type":"string", 1939 "enum":[ 1940 "AUTO", 1941 "ALL", 1942 "MENTIONS", 1943 "NONE" 1944 ] 1945 }, 1946 "String":{"type":"string"}, 1947 "String1600":{ 1948 "type":"string", 1949 "max":1600, 1950 "min":0, 1951 "pattern":".*" 1952 }, 1953 "String64":{ 1954 "type":"string", 1955 "max":64, 1956 "min":0, 1957 "pattern":".*" 1958 }, 1959 "Tag":{ 1960 "type":"structure", 1961 "required":[ 1962 "Key", 1963 "Value" 1964 ], 1965 "members":{ 1966 "Key":{ 1967 "shape":"TagKey", 1968 "documentation":"<p>The key in a tag.</p>" 1969 }, 1970 "Value":{ 1971 "shape":"TagValue", 1972 "documentation":"<p>The value in a tag.</p>" 1973 } 1974 }, 1975 "documentation":"<p>A tag object containing a key-value pair.</p>" 1976 }, 1977 "TagKey":{ 1978 "type":"string", 1979 "max":128, 1980 "min":1, 1981 "sensitive":true 1982 }, 1983 "TagKeyList":{ 1984 "type":"list", 1985 "member":{"shape":"TagKey"}, 1986 "max":50, 1987 "min":1 1988 }, 1989 "TagList":{ 1990 "type":"list", 1991 "member":{"shape":"Tag"}, 1992 "max":50, 1993 "min":1 1994 }, 1995 "TagResourceRequest":{ 1996 "type":"structure", 1997 "required":[ 1998 "ResourceARN", 1999 "Tags" 2000 ], 2001 "members":{ 2002 "ResourceARN":{ 2003 "shape":"ChimeArn", 2004 "documentation":"<p>The resource ARN.</p>" 2005 }, 2006 "Tags":{ 2007 "shape":"TagList", 2008 "documentation":"<p>The tag key-value pairs.</p>" 2009 } 2010 } 2011 }, 2012 "TagValue":{ 2013 "type":"string", 2014 "max":256, 2015 "min":1, 2016 "sensitive":true 2017 }, 2018 "TargetedMessages":{ 2019 "type":"string", 2020 "enum":[ 2021 "ALL", 2022 "NONE" 2023 ] 2024 }, 2025 "ThrottledClientException":{ 2026 "type":"structure", 2027 "members":{ 2028 "Code":{"shape":"ErrorCode"}, 2029 "Message":{"shape":"String"} 2030 }, 2031 "documentation":"<p>The client exceeded its request rate limit.</p>", 2032 "error":{"httpStatusCode":429}, 2033 "exception":true 2034 }, 2035 "Timestamp":{"type":"timestamp"}, 2036 "UnauthorizedClientException":{ 2037 "type":"structure", 2038 "members":{ 2039 "Code":{"shape":"ErrorCode"}, 2040 "Message":{"shape":"String"} 2041 }, 2042 "documentation":"<p>The client is not currently authorized to make the request.</p>", 2043 "error":{"httpStatusCode":401}, 2044 "exception":true 2045 }, 2046 "UntagResourceRequest":{ 2047 "type":"structure", 2048 "required":[ 2049 "ResourceARN", 2050 "TagKeys" 2051 ], 2052 "members":{ 2053 "ResourceARN":{ 2054 "shape":"ChimeArn", 2055 "documentation":"<p>The resource ARN.</p>" 2056 }, 2057 "TagKeys":{ 2058 "shape":"TagKeyList", 2059 "documentation":"<p>The tag keys.</p>" 2060 } 2061 } 2062 }, 2063 "UpdateAppInstanceBotRequest":{ 2064 "type":"structure", 2065 "required":[ 2066 "AppInstanceBotArn", 2067 "Name", 2068 "Metadata" 2069 ], 2070 "members":{ 2071 "AppInstanceBotArn":{ 2072 "shape":"ChimeArn", 2073 "documentation":"<p>The ARN of the <code>AppInstanceBot</code>.</p>", 2074 "location":"uri", 2075 "locationName":"appInstanceBotArn" 2076 }, 2077 "Name":{ 2078 "shape":"ResourceName", 2079 "documentation":"<p>The name of the <code>AppInstanceBot</code>.</p>" 2080 }, 2081 "Metadata":{ 2082 "shape":"Metadata", 2083 "documentation":"<p>The metadata of the <code>AppInstanceBot</code>.</p>" 2084 }, 2085 "Configuration":{ 2086 "shape":"Configuration", 2087 "documentation":"<p>The configuration for the bot update.</p>" 2088 } 2089 } 2090 }, 2091 "UpdateAppInstanceBotResponse":{ 2092 "type":"structure", 2093 "members":{ 2094 "AppInstanceBotArn":{ 2095 "shape":"ChimeArn", 2096 "documentation":"<p>The ARN of the <code>AppInstanceBot</code>.</p>" 2097 } 2098 } 2099 }, 2100 "UpdateAppInstanceRequest":{ 2101 "type":"structure", 2102 "required":[ 2103 "AppInstanceArn", 2104 "Name", 2105 "Metadata" 2106 ], 2107 "members":{ 2108 "AppInstanceArn":{ 2109 "shape":"ChimeArn", 2110 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>", 2111 "location":"uri", 2112 "locationName":"appInstanceArn" 2113 }, 2114 "Name":{ 2115 "shape":"NonEmptyResourceName", 2116 "documentation":"<p>The name that you want to change.</p>" 2117 }, 2118 "Metadata":{ 2119 "shape":"Metadata", 2120 "documentation":"<p>The metadata that you want to change.</p>" 2121 } 2122 } 2123 }, 2124 "UpdateAppInstanceResponse":{ 2125 "type":"structure", 2126 "members":{ 2127 "AppInstanceArn":{ 2128 "shape":"ChimeArn", 2129 "documentation":"<p>The ARN of the <code>AppInstance</code>.</p>" 2130 } 2131 } 2132 }, 2133 "UpdateAppInstanceUserEndpointRequest":{ 2134 "type":"structure", 2135 "required":[ 2136 "AppInstanceUserArn", 2137 "EndpointId" 2138 ], 2139 "members":{ 2140 "AppInstanceUserArn":{ 2141 "shape":"ChimeArn", 2142 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>", 2143 "location":"uri", 2144 "locationName":"appInstanceUserArn" 2145 }, 2146 "EndpointId":{ 2147 "shape":"String64", 2148 "documentation":"<p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>", 2149 "location":"uri", 2150 "locationName":"endpointId" 2151 }, 2152 "Name":{ 2153 "shape":"SensitiveString1600", 2154 "documentation":"<p>The name of the <code>AppInstanceUserEndpoint</code>.</p>" 2155 }, 2156 "AllowMessages":{ 2157 "shape":"AllowMessages", 2158 "documentation":"<p>Boolean that controls whether the <code>AppInstanceUserEndpoint</code> is opted in to receive messages. <code>ALL</code> indicates the endpoint will receive all messages. <code>NONE</code> indicates the endpoint will receive no messages.</p>" 2159 } 2160 } 2161 }, 2162 "UpdateAppInstanceUserEndpointResponse":{ 2163 "type":"structure", 2164 "members":{ 2165 "AppInstanceUserArn":{ 2166 "shape":"ChimeArn", 2167 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>" 2168 }, 2169 "EndpointId":{ 2170 "shape":"String64", 2171 "documentation":"<p>The unique identifier of the <code>AppInstanceUserEndpoint</code>.</p>" 2172 } 2173 } 2174 }, 2175 "UpdateAppInstanceUserRequest":{ 2176 "type":"structure", 2177 "required":[ 2178 "AppInstanceUserArn", 2179 "Name", 2180 "Metadata" 2181 ], 2182 "members":{ 2183 "AppInstanceUserArn":{ 2184 "shape":"ChimeArn", 2185 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>", 2186 "location":"uri", 2187 "locationName":"appInstanceUserArn" 2188 }, 2189 "Name":{ 2190 "shape":"UserName", 2191 "documentation":"<p>The name of the <code>AppInstanceUser</code>.</p>" 2192 }, 2193 "Metadata":{ 2194 "shape":"Metadata", 2195 "documentation":"<p>The metadata of the <code>AppInstanceUser</code>.</p>" 2196 } 2197 } 2198 }, 2199 "UpdateAppInstanceUserResponse":{ 2200 "type":"structure", 2201 "members":{ 2202 "AppInstanceUserArn":{ 2203 "shape":"ChimeArn", 2204 "documentation":"<p>The ARN of the <code>AppInstanceUser</code>.</p>" 2205 } 2206 } 2207 }, 2208 "UserId":{ 2209 "type":"string", 2210 "max":64, 2211 "min":1, 2212 "pattern":"[A-Za-z0-9]([A-Za-z0-9\\:\\-\\_\\.\\@]{0,62}[A-Za-z0-9])?", 2213 "sensitive":true 2214 }, 2215 "UserName":{ 2216 "type":"string", 2217 "max":100, 2218 "min":1, 2219 "pattern":".*\\S.*", 2220 "sensitive":true 2221 } 2222 }, 2223 "documentation":"<p>The Amazon Chime SDK Identity APIs in this section allow software developers to create and manage unique instances of their messaging applications. These APIs provide the overarching framework for creating and sending messages. For more information about the identity APIs, refer to <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Identity.html\">Amazon Chime SDK identity</a>.</p>" 2224} 2225