1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2023-06-05", 5 "endpointPrefix":"bedrock-agent", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"Agents for Amazon Bedrock", 9 "serviceId":"Bedrock Agent", 10 "signatureVersion":"v4", 11 "signingName":"bedrock", 12 "uid":"bedrock-agent-2023-06-05" 13 }, 14 "operations":{ 15 "AssociateAgentKnowledgeBase":{ 16 "name":"AssociateAgentKnowledgeBase", 17 "http":{ 18 "method":"PUT", 19 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/", 20 "responseCode":200 21 }, 22 "input":{"shape":"AssociateAgentKnowledgeBaseRequest"}, 23 "output":{"shape":"AssociateAgentKnowledgeBaseResponse"}, 24 "errors":[ 25 {"shape":"ThrottlingException"}, 26 {"shape":"AccessDeniedException"}, 27 {"shape":"ValidationException"}, 28 {"shape":"InternalServerException"}, 29 {"shape":"ResourceNotFoundException"}, 30 {"shape":"ConflictException"}, 31 {"shape":"ServiceQuotaExceededException"} 32 ], 33 "documentation":"<p>Associate a Knowledge Base to an existing Amazon Bedrock Agent</p>", 34 "idempotent":true 35 }, 36 "CreateAgent":{ 37 "name":"CreateAgent", 38 "http":{ 39 "method":"PUT", 40 "requestUri":"/agents/", 41 "responseCode":202 42 }, 43 "input":{"shape":"CreateAgentRequest"}, 44 "output":{"shape":"CreateAgentResponse"}, 45 "errors":[ 46 {"shape":"ThrottlingException"}, 47 {"shape":"AccessDeniedException"}, 48 {"shape":"ValidationException"}, 49 {"shape":"InternalServerException"}, 50 {"shape":"ConflictException"}, 51 {"shape":"ServiceQuotaExceededException"} 52 ], 53 "documentation":"<p>Creates an Amazon Bedrock Agent</p>", 54 "idempotent":true 55 }, 56 "CreateAgentActionGroup":{ 57 "name":"CreateAgentActionGroup", 58 "http":{ 59 "method":"PUT", 60 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/", 61 "responseCode":200 62 }, 63 "input":{"shape":"CreateAgentActionGroupRequest"}, 64 "output":{"shape":"CreateAgentActionGroupResponse"}, 65 "errors":[ 66 {"shape":"ThrottlingException"}, 67 {"shape":"AccessDeniedException"}, 68 {"shape":"ValidationException"}, 69 {"shape":"InternalServerException"}, 70 {"shape":"ResourceNotFoundException"}, 71 {"shape":"ConflictException"}, 72 {"shape":"ServiceQuotaExceededException"} 73 ], 74 "documentation":"<p>Creates an Action Group for existing Amazon Bedrock Agent</p>", 75 "idempotent":true 76 }, 77 "CreateAgentAlias":{ 78 "name":"CreateAgentAlias", 79 "http":{ 80 "method":"PUT", 81 "requestUri":"/agents/{agentId}/agentaliases/", 82 "responseCode":202 83 }, 84 "input":{"shape":"CreateAgentAliasRequest"}, 85 "output":{"shape":"CreateAgentAliasResponse"}, 86 "errors":[ 87 {"shape":"ThrottlingException"}, 88 {"shape":"AccessDeniedException"}, 89 {"shape":"ValidationException"}, 90 {"shape":"InternalServerException"}, 91 {"shape":"ResourceNotFoundException"}, 92 {"shape":"ConflictException"}, 93 {"shape":"ServiceQuotaExceededException"} 94 ], 95 "documentation":"<p>Creates an Alias for an existing Amazon Bedrock Agent</p>", 96 "idempotent":true 97 }, 98 "CreateDataSource":{ 99 "name":"CreateDataSource", 100 "http":{ 101 "method":"PUT", 102 "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/", 103 "responseCode":200 104 }, 105 "input":{"shape":"CreateDataSourceRequest"}, 106 "output":{"shape":"CreateDataSourceResponse"}, 107 "errors":[ 108 {"shape":"ThrottlingException"}, 109 {"shape":"AccessDeniedException"}, 110 {"shape":"ValidationException"}, 111 {"shape":"InternalServerException"}, 112 {"shape":"ResourceNotFoundException"}, 113 {"shape":"ConflictException"}, 114 {"shape":"ServiceQuotaExceededException"} 115 ], 116 "documentation":"<p>Create a new data source</p>", 117 "idempotent":true 118 }, 119 "CreateKnowledgeBase":{ 120 "name":"CreateKnowledgeBase", 121 "http":{ 122 "method":"PUT", 123 "requestUri":"/knowledgebases/", 124 "responseCode":202 125 }, 126 "input":{"shape":"CreateKnowledgeBaseRequest"}, 127 "output":{"shape":"CreateKnowledgeBaseResponse"}, 128 "errors":[ 129 {"shape":"ThrottlingException"}, 130 {"shape":"AccessDeniedException"}, 131 {"shape":"ValidationException"}, 132 {"shape":"InternalServerException"}, 133 {"shape":"ConflictException"}, 134 {"shape":"ServiceQuotaExceededException"} 135 ], 136 "documentation":"<p>Create a new knowledge base</p>", 137 "idempotent":true 138 }, 139 "DeleteAgent":{ 140 "name":"DeleteAgent", 141 "http":{ 142 "method":"DELETE", 143 "requestUri":"/agents/{agentId}/", 144 "responseCode":202 145 }, 146 "input":{"shape":"DeleteAgentRequest"}, 147 "output":{"shape":"DeleteAgentResponse"}, 148 "errors":[ 149 {"shape":"ThrottlingException"}, 150 {"shape":"AccessDeniedException"}, 151 {"shape":"ValidationException"}, 152 {"shape":"InternalServerException"}, 153 {"shape":"ResourceNotFoundException"}, 154 {"shape":"ConflictException"} 155 ], 156 "documentation":"<p>Deletes an Agent for existing Amazon Bedrock Agent</p>", 157 "idempotent":true 158 }, 159 "DeleteAgentActionGroup":{ 160 "name":"DeleteAgentActionGroup", 161 "http":{ 162 "method":"DELETE", 163 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/", 164 "responseCode":204 165 }, 166 "input":{"shape":"DeleteAgentActionGroupRequest"}, 167 "output":{"shape":"DeleteAgentActionGroupResponse"}, 168 "errors":[ 169 {"shape":"ThrottlingException"}, 170 {"shape":"AccessDeniedException"}, 171 {"shape":"ValidationException"}, 172 {"shape":"InternalServerException"}, 173 {"shape":"ResourceNotFoundException"}, 174 {"shape":"ConflictException"} 175 ], 176 "documentation":"<p>Deletes an Action Group for existing Amazon Bedrock Agent.</p>", 177 "idempotent":true 178 }, 179 "DeleteAgentAlias":{ 180 "name":"DeleteAgentAlias", 181 "http":{ 182 "method":"DELETE", 183 "requestUri":"/agents/{agentId}/agentaliases/{agentAliasId}/", 184 "responseCode":202 185 }, 186 "input":{"shape":"DeleteAgentAliasRequest"}, 187 "output":{"shape":"DeleteAgentAliasResponse"}, 188 "errors":[ 189 {"shape":"ThrottlingException"}, 190 {"shape":"AccessDeniedException"}, 191 {"shape":"ValidationException"}, 192 {"shape":"InternalServerException"}, 193 {"shape":"ResourceNotFoundException"} 194 ], 195 "documentation":"<p>Deletes an Alias for a Amazon Bedrock Agent</p>", 196 "idempotent":true 197 }, 198 "DeleteAgentVersion":{ 199 "name":"DeleteAgentVersion", 200 "http":{ 201 "method":"DELETE", 202 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/", 203 "responseCode":202 204 }, 205 "input":{"shape":"DeleteAgentVersionRequest"}, 206 "output":{"shape":"DeleteAgentVersionResponse"}, 207 "errors":[ 208 {"shape":"ThrottlingException"}, 209 {"shape":"AccessDeniedException"}, 210 {"shape":"ValidationException"}, 211 {"shape":"InternalServerException"}, 212 {"shape":"ResourceNotFoundException"}, 213 {"shape":"ConflictException"} 214 ], 215 "documentation":"<p>Deletes an Agent version for existing Amazon Bedrock Agent</p>", 216 "idempotent":true 217 }, 218 "DeleteDataSource":{ 219 "name":"DeleteDataSource", 220 "http":{ 221 "method":"DELETE", 222 "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}", 223 "responseCode":202 224 }, 225 "input":{"shape":"DeleteDataSourceRequest"}, 226 "output":{"shape":"DeleteDataSourceResponse"}, 227 "errors":[ 228 {"shape":"ThrottlingException"}, 229 {"shape":"AccessDeniedException"}, 230 {"shape":"ValidationException"}, 231 {"shape":"InternalServerException"}, 232 {"shape":"ResourceNotFoundException"}, 233 {"shape":"ConflictException"} 234 ], 235 "documentation":"<p>Delete an existing data source</p>", 236 "idempotent":true 237 }, 238 "DeleteKnowledgeBase":{ 239 "name":"DeleteKnowledgeBase", 240 "http":{ 241 "method":"DELETE", 242 "requestUri":"/knowledgebases/{knowledgeBaseId}", 243 "responseCode":202 244 }, 245 "input":{"shape":"DeleteKnowledgeBaseRequest"}, 246 "output":{"shape":"DeleteKnowledgeBaseResponse"}, 247 "errors":[ 248 {"shape":"ThrottlingException"}, 249 {"shape":"AccessDeniedException"}, 250 {"shape":"ValidationException"}, 251 {"shape":"InternalServerException"}, 252 {"shape":"ResourceNotFoundException"}, 253 {"shape":"ConflictException"} 254 ], 255 "documentation":"<p>Delete an existing knowledge base</p>", 256 "idempotent":true 257 }, 258 "DisassociateAgentKnowledgeBase":{ 259 "name":"DisassociateAgentKnowledgeBase", 260 "http":{ 261 "method":"DELETE", 262 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/", 263 "responseCode":204 264 }, 265 "input":{"shape":"DisassociateAgentKnowledgeBaseRequest"}, 266 "output":{"shape":"DisassociateAgentKnowledgeBaseResponse"}, 267 "errors":[ 268 {"shape":"ThrottlingException"}, 269 {"shape":"AccessDeniedException"}, 270 {"shape":"ValidationException"}, 271 {"shape":"InternalServerException"}, 272 {"shape":"ResourceNotFoundException"}, 273 {"shape":"ConflictException"} 274 ], 275 "documentation":"<p>Disassociate an existing Knowledge Base from an Amazon Bedrock Agent</p>", 276 "idempotent":true 277 }, 278 "GetAgent":{ 279 "name":"GetAgent", 280 "http":{ 281 "method":"GET", 282 "requestUri":"/agents/{agentId}/", 283 "responseCode":200 284 }, 285 "input":{"shape":"GetAgentRequest"}, 286 "output":{"shape":"GetAgentResponse"}, 287 "errors":[ 288 {"shape":"ThrottlingException"}, 289 {"shape":"AccessDeniedException"}, 290 {"shape":"ValidationException"}, 291 {"shape":"InternalServerException"}, 292 {"shape":"ResourceNotFoundException"} 293 ], 294 "documentation":"<p>Gets an Agent for existing Amazon Bedrock Agent</p>" 295 }, 296 "GetAgentActionGroup":{ 297 "name":"GetAgentActionGroup", 298 "http":{ 299 "method":"GET", 300 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/", 301 "responseCode":200 302 }, 303 "input":{"shape":"GetAgentActionGroupRequest"}, 304 "output":{"shape":"GetAgentActionGroupResponse"}, 305 "errors":[ 306 {"shape":"ThrottlingException"}, 307 {"shape":"AccessDeniedException"}, 308 {"shape":"ValidationException"}, 309 {"shape":"InternalServerException"}, 310 {"shape":"ResourceNotFoundException"} 311 ], 312 "documentation":"<p>Gets an Action Group for existing Amazon Bedrock Agent Version</p>" 313 }, 314 "GetAgentAlias":{ 315 "name":"GetAgentAlias", 316 "http":{ 317 "method":"GET", 318 "requestUri":"/agents/{agentId}/agentaliases/{agentAliasId}/", 319 "responseCode":200 320 }, 321 "input":{"shape":"GetAgentAliasRequest"}, 322 "output":{"shape":"GetAgentAliasResponse"}, 323 "errors":[ 324 {"shape":"ThrottlingException"}, 325 {"shape":"AccessDeniedException"}, 326 {"shape":"ValidationException"}, 327 {"shape":"InternalServerException"}, 328 {"shape":"ResourceNotFoundException"} 329 ], 330 "documentation":"<p>Describes an Alias for a Amazon Bedrock Agent</p>" 331 }, 332 "GetAgentKnowledgeBase":{ 333 "name":"GetAgentKnowledgeBase", 334 "http":{ 335 "method":"GET", 336 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/", 337 "responseCode":200 338 }, 339 "input":{"shape":"GetAgentKnowledgeBaseRequest"}, 340 "output":{"shape":"GetAgentKnowledgeBaseResponse"}, 341 "errors":[ 342 {"shape":"ThrottlingException"}, 343 {"shape":"AccessDeniedException"}, 344 {"shape":"ValidationException"}, 345 {"shape":"InternalServerException"}, 346 {"shape":"ResourceNotFoundException"} 347 ], 348 "documentation":"<p>Gets a knowledge base associated to an existing Amazon Bedrock Agent Version</p>" 349 }, 350 "GetAgentVersion":{ 351 "name":"GetAgentVersion", 352 "http":{ 353 "method":"GET", 354 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/", 355 "responseCode":200 356 }, 357 "input":{"shape":"GetAgentVersionRequest"}, 358 "output":{"shape":"GetAgentVersionResponse"}, 359 "errors":[ 360 {"shape":"ThrottlingException"}, 361 {"shape":"AccessDeniedException"}, 362 {"shape":"ValidationException"}, 363 {"shape":"InternalServerException"}, 364 {"shape":"ResourceNotFoundException"} 365 ], 366 "documentation":"<p>Gets an Agent version for existing Amazon Bedrock Agent</p>" 367 }, 368 "GetDataSource":{ 369 "name":"GetDataSource", 370 "http":{ 371 "method":"GET", 372 "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}", 373 "responseCode":200 374 }, 375 "input":{"shape":"GetDataSourceRequest"}, 376 "output":{"shape":"GetDataSourceResponse"}, 377 "errors":[ 378 {"shape":"ThrottlingException"}, 379 {"shape":"AccessDeniedException"}, 380 {"shape":"ValidationException"}, 381 {"shape":"InternalServerException"}, 382 {"shape":"ResourceNotFoundException"} 383 ], 384 "documentation":"<p>Get an existing data source</p>" 385 }, 386 "GetIngestionJob":{ 387 "name":"GetIngestionJob", 388 "http":{ 389 "method":"GET", 390 "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}", 391 "responseCode":200 392 }, 393 "input":{"shape":"GetIngestionJobRequest"}, 394 "output":{"shape":"GetIngestionJobResponse"}, 395 "errors":[ 396 {"shape":"ThrottlingException"}, 397 {"shape":"AccessDeniedException"}, 398 {"shape":"ValidationException"}, 399 {"shape":"InternalServerException"}, 400 {"shape":"ResourceNotFoundException"} 401 ], 402 "documentation":"<p>Get an ingestion job</p>" 403 }, 404 "GetKnowledgeBase":{ 405 "name":"GetKnowledgeBase", 406 "http":{ 407 "method":"GET", 408 "requestUri":"/knowledgebases/{knowledgeBaseId}", 409 "responseCode":200 410 }, 411 "input":{"shape":"GetKnowledgeBaseRequest"}, 412 "output":{"shape":"GetKnowledgeBaseResponse"}, 413 "errors":[ 414 {"shape":"ThrottlingException"}, 415 {"shape":"AccessDeniedException"}, 416 {"shape":"ValidationException"}, 417 {"shape":"InternalServerException"}, 418 {"shape":"ResourceNotFoundException"} 419 ], 420 "documentation":"<p>Get an existing knowledge base</p>" 421 }, 422 "ListAgentActionGroups":{ 423 "name":"ListAgentActionGroups", 424 "http":{ 425 "method":"POST", 426 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/", 427 "responseCode":200 428 }, 429 "input":{"shape":"ListAgentActionGroupsRequest"}, 430 "output":{"shape":"ListAgentActionGroupsResponse"}, 431 "errors":[ 432 {"shape":"ThrottlingException"}, 433 {"shape":"AccessDeniedException"}, 434 {"shape":"ValidationException"}, 435 {"shape":"InternalServerException"}, 436 {"shape":"ResourceNotFoundException"} 437 ], 438 "documentation":"<p>Lists an Action Group for existing Amazon Bedrock Agent Version</p>" 439 }, 440 "ListAgentAliases":{ 441 "name":"ListAgentAliases", 442 "http":{ 443 "method":"POST", 444 "requestUri":"/agents/{agentId}/agentaliases/", 445 "responseCode":200 446 }, 447 "input":{"shape":"ListAgentAliasesRequest"}, 448 "output":{"shape":"ListAgentAliasesResponse"}, 449 "errors":[ 450 {"shape":"ThrottlingException"}, 451 {"shape":"AccessDeniedException"}, 452 {"shape":"ValidationException"}, 453 {"shape":"InternalServerException"}, 454 {"shape":"ResourceNotFoundException"} 455 ], 456 "documentation":"<p>Lists all the Aliases for an Amazon Bedrock Agent</p>" 457 }, 458 "ListAgentKnowledgeBases":{ 459 "name":"ListAgentKnowledgeBases", 460 "http":{ 461 "method":"POST", 462 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/", 463 "responseCode":200 464 }, 465 "input":{"shape":"ListAgentKnowledgeBasesRequest"}, 466 "output":{"shape":"ListAgentKnowledgeBasesResponse"}, 467 "errors":[ 468 {"shape":"ThrottlingException"}, 469 {"shape":"AccessDeniedException"}, 470 {"shape":"ValidationException"}, 471 {"shape":"InternalServerException"}, 472 {"shape":"ResourceNotFoundException"} 473 ], 474 "documentation":"<p>List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version</p>" 475 }, 476 "ListAgentVersions":{ 477 "name":"ListAgentVersions", 478 "http":{ 479 "method":"POST", 480 "requestUri":"/agents/{agentId}/agentversions/", 481 "responseCode":200 482 }, 483 "input":{"shape":"ListAgentVersionsRequest"}, 484 "output":{"shape":"ListAgentVersionsResponse"}, 485 "errors":[ 486 {"shape":"ThrottlingException"}, 487 {"shape":"AccessDeniedException"}, 488 {"shape":"ValidationException"}, 489 {"shape":"InternalServerException"}, 490 {"shape":"ResourceNotFoundException"} 491 ], 492 "documentation":"<p>Lists Agent Versions</p>" 493 }, 494 "ListAgents":{ 495 "name":"ListAgents", 496 "http":{ 497 "method":"POST", 498 "requestUri":"/agents/", 499 "responseCode":200 500 }, 501 "input":{"shape":"ListAgentsRequest"}, 502 "output":{"shape":"ListAgentsResponse"}, 503 "errors":[ 504 {"shape":"ThrottlingException"}, 505 {"shape":"AccessDeniedException"}, 506 {"shape":"ValidationException"}, 507 {"shape":"InternalServerException"} 508 ], 509 "documentation":"<p>Lists Agents</p>" 510 }, 511 "ListDataSources":{ 512 "name":"ListDataSources", 513 "http":{ 514 "method":"POST", 515 "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/", 516 "responseCode":200 517 }, 518 "input":{"shape":"ListDataSourcesRequest"}, 519 "output":{"shape":"ListDataSourcesResponse"}, 520 "errors":[ 521 {"shape":"ThrottlingException"}, 522 {"shape":"AccessDeniedException"}, 523 {"shape":"ValidationException"}, 524 {"shape":"InternalServerException"}, 525 {"shape":"ResourceNotFoundException"} 526 ], 527 "documentation":"<p>List data sources</p>" 528 }, 529 "ListIngestionJobs":{ 530 "name":"ListIngestionJobs", 531 "http":{ 532 "method":"POST", 533 "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/", 534 "responseCode":200 535 }, 536 "input":{"shape":"ListIngestionJobsRequest"}, 537 "output":{"shape":"ListIngestionJobsResponse"}, 538 "errors":[ 539 {"shape":"ThrottlingException"}, 540 {"shape":"AccessDeniedException"}, 541 {"shape":"ValidationException"}, 542 {"shape":"InternalServerException"}, 543 {"shape":"ResourceNotFoundException"} 544 ], 545 "documentation":"<p>List ingestion jobs</p>" 546 }, 547 "ListKnowledgeBases":{ 548 "name":"ListKnowledgeBases", 549 "http":{ 550 "method":"POST", 551 "requestUri":"/knowledgebases/", 552 "responseCode":200 553 }, 554 "input":{"shape":"ListKnowledgeBasesRequest"}, 555 "output":{"shape":"ListKnowledgeBasesResponse"}, 556 "errors":[ 557 {"shape":"ThrottlingException"}, 558 {"shape":"AccessDeniedException"}, 559 {"shape":"ValidationException"}, 560 {"shape":"InternalServerException"} 561 ], 562 "documentation":"<p>List Knowledge Bases</p>" 563 }, 564 "ListTagsForResource":{ 565 "name":"ListTagsForResource", 566 "http":{ 567 "method":"GET", 568 "requestUri":"/tags/{resourceArn}", 569 "responseCode":200 570 }, 571 "input":{"shape":"ListTagsForResourceRequest"}, 572 "output":{"shape":"ListTagsForResourceResponse"}, 573 "errors":[ 574 {"shape":"ThrottlingException"}, 575 {"shape":"AccessDeniedException"}, 576 {"shape":"ValidationException"}, 577 {"shape":"InternalServerException"}, 578 {"shape":"ResourceNotFoundException"} 579 ], 580 "documentation":"<p>List tags for a resource</p>" 581 }, 582 "PrepareAgent":{ 583 "name":"PrepareAgent", 584 "http":{ 585 "method":"POST", 586 "requestUri":"/agents/{agentId}/", 587 "responseCode":202 588 }, 589 "input":{"shape":"PrepareAgentRequest"}, 590 "output":{"shape":"PrepareAgentResponse"}, 591 "errors":[ 592 {"shape":"ThrottlingException"}, 593 {"shape":"AccessDeniedException"}, 594 {"shape":"ValidationException"}, 595 {"shape":"InternalServerException"}, 596 {"shape":"ResourceNotFoundException"}, 597 {"shape":"ConflictException"}, 598 {"shape":"ServiceQuotaExceededException"} 599 ], 600 "documentation":"<p>Prepares an existing Amazon Bedrock Agent to receive runtime requests</p>" 601 }, 602 "StartIngestionJob":{ 603 "name":"StartIngestionJob", 604 "http":{ 605 "method":"PUT", 606 "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/", 607 "responseCode":202 608 }, 609 "input":{"shape":"StartIngestionJobRequest"}, 610 "output":{"shape":"StartIngestionJobResponse"}, 611 "errors":[ 612 {"shape":"ThrottlingException"}, 613 {"shape":"AccessDeniedException"}, 614 {"shape":"ValidationException"}, 615 {"shape":"InternalServerException"}, 616 {"shape":"ResourceNotFoundException"}, 617 {"shape":"ConflictException"}, 618 {"shape":"ServiceQuotaExceededException"} 619 ], 620 "documentation":"<p>Start a new ingestion job</p>", 621 "idempotent":true 622 }, 623 "TagResource":{ 624 "name":"TagResource", 625 "http":{ 626 "method":"POST", 627 "requestUri":"/tags/{resourceArn}", 628 "responseCode":200 629 }, 630 "input":{"shape":"TagResourceRequest"}, 631 "output":{"shape":"TagResourceResponse"}, 632 "errors":[ 633 {"shape":"ThrottlingException"}, 634 {"shape":"AccessDeniedException"}, 635 {"shape":"ValidationException"}, 636 {"shape":"InternalServerException"}, 637 {"shape":"ResourceNotFoundException"}, 638 {"shape":"ServiceQuotaExceededException"} 639 ], 640 "documentation":"<p>Tag a resource</p>" 641 }, 642 "UntagResource":{ 643 "name":"UntagResource", 644 "http":{ 645 "method":"DELETE", 646 "requestUri":"/tags/{resourceArn}", 647 "responseCode":200 648 }, 649 "input":{"shape":"UntagResourceRequest"}, 650 "output":{"shape":"UntagResourceResponse"}, 651 "errors":[ 652 {"shape":"ThrottlingException"}, 653 {"shape":"AccessDeniedException"}, 654 {"shape":"ValidationException"}, 655 {"shape":"InternalServerException"}, 656 {"shape":"ResourceNotFoundException"} 657 ], 658 "documentation":"<p>Untag a resource</p>", 659 "idempotent":true 660 }, 661 "UpdateAgent":{ 662 "name":"UpdateAgent", 663 "http":{ 664 "method":"PUT", 665 "requestUri":"/agents/{agentId}/", 666 "responseCode":202 667 }, 668 "input":{"shape":"UpdateAgentRequest"}, 669 "output":{"shape":"UpdateAgentResponse"}, 670 "errors":[ 671 {"shape":"ThrottlingException"}, 672 {"shape":"AccessDeniedException"}, 673 {"shape":"ValidationException"}, 674 {"shape":"InternalServerException"}, 675 {"shape":"ResourceNotFoundException"}, 676 {"shape":"ConflictException"}, 677 {"shape":"ServiceQuotaExceededException"} 678 ], 679 "documentation":"<p>Updates an existing Amazon Bedrock Agent</p>", 680 "idempotent":true 681 }, 682 "UpdateAgentActionGroup":{ 683 "name":"UpdateAgentActionGroup", 684 "http":{ 685 "method":"PUT", 686 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/", 687 "responseCode":200 688 }, 689 "input":{"shape":"UpdateAgentActionGroupRequest"}, 690 "output":{"shape":"UpdateAgentActionGroupResponse"}, 691 "errors":[ 692 {"shape":"ThrottlingException"}, 693 {"shape":"AccessDeniedException"}, 694 {"shape":"ValidationException"}, 695 {"shape":"InternalServerException"}, 696 {"shape":"ResourceNotFoundException"}, 697 {"shape":"ConflictException"}, 698 {"shape":"ServiceQuotaExceededException"} 699 ], 700 "documentation":"<p>Updates an existing Action Group for Amazon Bedrock Agent</p>", 701 "idempotent":true 702 }, 703 "UpdateAgentAlias":{ 704 "name":"UpdateAgentAlias", 705 "http":{ 706 "method":"PUT", 707 "requestUri":"/agents/{agentId}/agentaliases/{agentAliasId}/", 708 "responseCode":202 709 }, 710 "input":{"shape":"UpdateAgentAliasRequest"}, 711 "output":{"shape":"UpdateAgentAliasResponse"}, 712 "errors":[ 713 {"shape":"ThrottlingException"}, 714 {"shape":"AccessDeniedException"}, 715 {"shape":"ValidationException"}, 716 {"shape":"InternalServerException"}, 717 {"shape":"ResourceNotFoundException"}, 718 {"shape":"ConflictException"}, 719 {"shape":"ServiceQuotaExceededException"} 720 ], 721 "documentation":"<p>Updates an existing Alias for an Amazon Bedrock Agent</p>", 722 "idempotent":true 723 }, 724 "UpdateAgentKnowledgeBase":{ 725 "name":"UpdateAgentKnowledgeBase", 726 "http":{ 727 "method":"PUT", 728 "requestUri":"/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/", 729 "responseCode":200 730 }, 731 "input":{"shape":"UpdateAgentKnowledgeBaseRequest"}, 732 "output":{"shape":"UpdateAgentKnowledgeBaseResponse"}, 733 "errors":[ 734 {"shape":"ThrottlingException"}, 735 {"shape":"AccessDeniedException"}, 736 {"shape":"ValidationException"}, 737 {"shape":"InternalServerException"}, 738 {"shape":"ResourceNotFoundException"}, 739 {"shape":"ConflictException"} 740 ], 741 "documentation":"<p>Updates an existing Knowledge Base associated to an Amazon Bedrock Agent</p>", 742 "idempotent":true 743 }, 744 "UpdateDataSource":{ 745 "name":"UpdateDataSource", 746 "http":{ 747 "method":"PUT", 748 "requestUri":"/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}", 749 "responseCode":200 750 }, 751 "input":{"shape":"UpdateDataSourceRequest"}, 752 "output":{"shape":"UpdateDataSourceResponse"}, 753 "errors":[ 754 {"shape":"ThrottlingException"}, 755 {"shape":"AccessDeniedException"}, 756 {"shape":"ValidationException"}, 757 {"shape":"InternalServerException"}, 758 {"shape":"ResourceNotFoundException"}, 759 {"shape":"ConflictException"} 760 ], 761 "documentation":"<p>Update an existing data source</p>", 762 "idempotent":true 763 }, 764 "UpdateKnowledgeBase":{ 765 "name":"UpdateKnowledgeBase", 766 "http":{ 767 "method":"PUT", 768 "requestUri":"/knowledgebases/{knowledgeBaseId}", 769 "responseCode":202 770 }, 771 "input":{"shape":"UpdateKnowledgeBaseRequest"}, 772 "output":{"shape":"UpdateKnowledgeBaseResponse"}, 773 "errors":[ 774 {"shape":"ThrottlingException"}, 775 {"shape":"AccessDeniedException"}, 776 {"shape":"ValidationException"}, 777 {"shape":"InternalServerException"}, 778 {"shape":"ResourceNotFoundException"}, 779 {"shape":"ConflictException"} 780 ], 781 "documentation":"<p>Update an existing knowledge base</p>", 782 "idempotent":true 783 } 784 }, 785 "shapes":{ 786 "APISchema":{ 787 "type":"structure", 788 "members":{ 789 "s3":{"shape":"S3Identifier"}, 790 "payload":{"shape":"Payload"} 791 }, 792 "documentation":"<p>Contains information about the API Schema for the Action Group</p>", 793 "union":true 794 }, 795 "AccessDeniedException":{ 796 "type":"structure", 797 "members":{ 798 "message":{"shape":"NonBlankString"} 799 }, 800 "documentation":"<p>This exception is thrown when a request is denied per access permissions</p>", 801 "error":{ 802 "httpStatusCode":403, 803 "senderFault":true 804 }, 805 "exception":true 806 }, 807 "ActionGroupExecutor":{ 808 "type":"structure", 809 "members":{ 810 "lambda":{"shape":"LambdaArn"} 811 }, 812 "documentation":"<p>Type of Executors for an Action Group</p>", 813 "union":true 814 }, 815 "ActionGroupSignature":{ 816 "type":"string", 817 "documentation":"<p>Action Group Signature for a BuiltIn Action</p>", 818 "enum":["AMAZON.UserInput"] 819 }, 820 "ActionGroupState":{ 821 "type":"string", 822 "documentation":"<p>State of the action group</p>", 823 "enum":[ 824 "ENABLED", 825 "DISABLED" 826 ] 827 }, 828 "ActionGroupSummaries":{ 829 "type":"list", 830 "member":{"shape":"ActionGroupSummary"}, 831 "documentation":"<p>List of ActionGroup Summaries</p>", 832 "max":10, 833 "min":0 834 }, 835 "ActionGroupSummary":{ 836 "type":"structure", 837 "required":[ 838 "actionGroupId", 839 "actionGroupName", 840 "actionGroupState", 841 "updatedAt" 842 ], 843 "members":{ 844 "actionGroupId":{"shape":"Id"}, 845 "actionGroupName":{"shape":"Name"}, 846 "actionGroupState":{"shape":"ActionGroupState"}, 847 "description":{"shape":"Description"}, 848 "updatedAt":{"shape":"DateTimestamp"} 849 }, 850 "documentation":"<p>ActionGroup Summary</p>" 851 }, 852 "Agent":{ 853 "type":"structure", 854 "required":[ 855 "agentId", 856 "agentName", 857 "agentArn", 858 "agentVersion", 859 "agentStatus", 860 "idleSessionTTLInSeconds", 861 "agentResourceRoleArn", 862 "createdAt", 863 "updatedAt" 864 ], 865 "members":{ 866 "agentId":{"shape":"Id"}, 867 "agentName":{"shape":"Name"}, 868 "agentArn":{"shape":"AgentArn"}, 869 "agentVersion":{"shape":"DraftVersion"}, 870 "clientToken":{"shape":"ClientToken"}, 871 "instruction":{"shape":"Instruction"}, 872 "agentStatus":{"shape":"AgentStatus"}, 873 "foundationModel":{"shape":"ModelIdentifier"}, 874 "description":{"shape":"Description"}, 875 "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, 876 "agentResourceRoleArn":{"shape":"AgentRoleArn"}, 877 "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, 878 "createdAt":{"shape":"DateTimestamp"}, 879 "updatedAt":{"shape":"DateTimestamp"}, 880 "preparedAt":{"shape":"DateTimestamp"}, 881 "failureReasons":{"shape":"FailureReasons"}, 882 "recommendedActions":{"shape":"RecommendedActions"}, 883 "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} 884 }, 885 "documentation":"<p>Contains the information of an agent</p>" 886 }, 887 "AgentActionGroup":{ 888 "type":"structure", 889 "required":[ 890 "agentId", 891 "agentVersion", 892 "actionGroupId", 893 "actionGroupName", 894 "createdAt", 895 "updatedAt", 896 "actionGroupState" 897 ], 898 "members":{ 899 "agentId":{"shape":"Id"}, 900 "agentVersion":{"shape":"Version"}, 901 "actionGroupId":{"shape":"Id"}, 902 "actionGroupName":{"shape":"Name"}, 903 "clientToken":{"shape":"ClientToken"}, 904 "description":{"shape":"Description"}, 905 "createdAt":{"shape":"DateTimestamp"}, 906 "updatedAt":{"shape":"DateTimestamp"}, 907 "parentActionSignature":{"shape":"ActionGroupSignature"}, 908 "actionGroupExecutor":{"shape":"ActionGroupExecutor"}, 909 "apiSchema":{"shape":"APISchema"}, 910 "actionGroupState":{"shape":"ActionGroupState"} 911 }, 912 "documentation":"<p>Contains the information of an Agent Action Group</p>" 913 }, 914 "AgentAlias":{ 915 "type":"structure", 916 "required":[ 917 "agentId", 918 "agentAliasId", 919 "agentAliasName", 920 "agentAliasArn", 921 "routingConfiguration", 922 "createdAt", 923 "updatedAt", 924 "agentAliasStatus" 925 ], 926 "members":{ 927 "agentId":{"shape":"Id"}, 928 "agentAliasId":{"shape":"AgentAliasId"}, 929 "agentAliasName":{"shape":"Name"}, 930 "agentAliasArn":{"shape":"AgentAliasArn"}, 931 "clientToken":{"shape":"ClientToken"}, 932 "description":{"shape":"Description"}, 933 "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"}, 934 "createdAt":{"shape":"DateTimestamp"}, 935 "updatedAt":{"shape":"DateTimestamp"}, 936 "agentAliasHistoryEvents":{"shape":"AgentAliasHistoryEvents"}, 937 "agentAliasStatus":{"shape":"AgentAliasStatus"} 938 }, 939 "documentation":"<p>Contains the information of an agent alias</p>" 940 }, 941 "AgentAliasArn":{ 942 "type":"string", 943 "documentation":"<p>Arn representation of the Agent Alias.</p>", 944 "max":2048, 945 "min":0, 946 "pattern":"arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}" 947 }, 948 "AgentAliasHistoryEvent":{ 949 "type":"structure", 950 "members":{ 951 "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"}, 952 "endDate":{"shape":"DateTimestamp"}, 953 "startDate":{"shape":"DateTimestamp"} 954 }, 955 "documentation":"<p>History event for an alias for an Agent.</p>" 956 }, 957 "AgentAliasHistoryEvents":{ 958 "type":"list", 959 "member":{"shape":"AgentAliasHistoryEvent"}, 960 "documentation":"<p>The list of history events for an alias for an Agent.</p>", 961 "max":10, 962 "min":0 963 }, 964 "AgentAliasId":{ 965 "type":"string", 966 "documentation":"<p>Id for an Agent Alias generated at the server side.</p>", 967 "max":10, 968 "min":10, 969 "pattern":"(\\bTSTALIASID\\b|[0-9a-zA-Z]+)" 970 }, 971 "AgentAliasRoutingConfiguration":{ 972 "type":"list", 973 "member":{"shape":"AgentAliasRoutingConfigurationListItem"}, 974 "documentation":"<p>Routing configuration for an Agent alias.</p>", 975 "max":1, 976 "min":0 977 }, 978 "AgentAliasRoutingConfigurationListItem":{ 979 "type":"structure", 980 "required":["agentVersion"], 981 "members":{ 982 "agentVersion":{"shape":"Version"} 983 }, 984 "documentation":"<p>Details about the routing configuration for an Agent alias.</p>" 985 }, 986 "AgentAliasStatus":{ 987 "type":"string", 988 "documentation":"<p>The statuses an Agent Alias can be in.</p>", 989 "enum":[ 990 "CREATING", 991 "PREPARED", 992 "FAILED", 993 "UPDATING", 994 "DELETING" 995 ] 996 }, 997 "AgentAliasSummaries":{ 998 "type":"list", 999 "member":{"shape":"AgentAliasSummary"}, 1000 "documentation":"<p>The list of summaries of all the aliases for an Agent.</p>", 1001 "max":10, 1002 "min":0 1003 }, 1004 "AgentAliasSummary":{ 1005 "type":"structure", 1006 "required":[ 1007 "agentAliasId", 1008 "agentAliasName", 1009 "agentAliasStatus", 1010 "createdAt", 1011 "updatedAt" 1012 ], 1013 "members":{ 1014 "agentAliasId":{"shape":"AgentAliasId"}, 1015 "agentAliasName":{"shape":"Name"}, 1016 "description":{"shape":"Description"}, 1017 "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"}, 1018 "agentAliasStatus":{"shape":"AgentAliasStatus"}, 1019 "createdAt":{"shape":"DateTimestamp"}, 1020 "updatedAt":{"shape":"DateTimestamp"} 1021 }, 1022 "documentation":"<p>Summary of an alias for an Agent.</p>" 1023 }, 1024 "AgentArn":{ 1025 "type":"string", 1026 "documentation":"<p>Arn representation of the Agent.</p>", 1027 "max":2048, 1028 "min":0, 1029 "pattern":"arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}" 1030 }, 1031 "AgentKnowledgeBase":{ 1032 "type":"structure", 1033 "required":[ 1034 "agentId", 1035 "agentVersion", 1036 "knowledgeBaseId", 1037 "description", 1038 "createdAt", 1039 "updatedAt", 1040 "knowledgeBaseState" 1041 ], 1042 "members":{ 1043 "agentId":{"shape":"Id"}, 1044 "agentVersion":{"shape":"Version"}, 1045 "knowledgeBaseId":{"shape":"Id"}, 1046 "description":{"shape":"Description"}, 1047 "createdAt":{"shape":"DateTimestamp"}, 1048 "updatedAt":{"shape":"DateTimestamp"}, 1049 "knowledgeBaseState":{"shape":"KnowledgeBaseState"} 1050 }, 1051 "documentation":"<p>Contains the information of an Agent Knowledge Base.</p>" 1052 }, 1053 "AgentKnowledgeBaseSummaries":{ 1054 "type":"list", 1055 "member":{"shape":"AgentKnowledgeBaseSummary"}, 1056 "documentation":"<p>List of Agent Knowledge Base Summaries</p>", 1057 "max":10, 1058 "min":0 1059 }, 1060 "AgentKnowledgeBaseSummary":{ 1061 "type":"structure", 1062 "required":[ 1063 "knowledgeBaseId", 1064 "knowledgeBaseState", 1065 "updatedAt" 1066 ], 1067 "members":{ 1068 "knowledgeBaseId":{"shape":"Id"}, 1069 "description":{"shape":"Description"}, 1070 "knowledgeBaseState":{"shape":"KnowledgeBaseState"}, 1071 "updatedAt":{"shape":"DateTimestamp"} 1072 }, 1073 "documentation":"<p>Agent Knowledge Base Summary</p>" 1074 }, 1075 "AgentRoleArn":{ 1076 "type":"string", 1077 "documentation":"<p>ARN of a IAM role.</p>", 1078 "max":2048, 1079 "min":0, 1080 "pattern":"arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents.+" 1081 }, 1082 "AgentStatus":{ 1083 "type":"string", 1084 "documentation":"<p>Schema Type for Action APIs.</p>", 1085 "enum":[ 1086 "CREATING", 1087 "PREPARING", 1088 "PREPARED", 1089 "NOT_PREPARED", 1090 "DELETING", 1091 "FAILED", 1092 "VERSIONING", 1093 "UPDATING" 1094 ] 1095 }, 1096 "AgentSummaries":{ 1097 "type":"list", 1098 "member":{"shape":"AgentSummary"}, 1099 "documentation":"<p>List of AgentSummary.</p>", 1100 "max":10, 1101 "min":0 1102 }, 1103 "AgentSummary":{ 1104 "type":"structure", 1105 "required":[ 1106 "agentId", 1107 "agentName", 1108 "agentStatus", 1109 "updatedAt" 1110 ], 1111 "members":{ 1112 "agentId":{"shape":"Id"}, 1113 "agentName":{"shape":"Name"}, 1114 "agentStatus":{"shape":"AgentStatus"}, 1115 "description":{"shape":"Description"}, 1116 "updatedAt":{"shape":"DateTimestamp"}, 1117 "latestAgentVersion":{"shape":"Version"} 1118 }, 1119 "documentation":"<p>Summary of Agent.</p>" 1120 }, 1121 "AgentVersion":{ 1122 "type":"structure", 1123 "required":[ 1124 "agentId", 1125 "agentName", 1126 "agentArn", 1127 "version", 1128 "agentStatus", 1129 "idleSessionTTLInSeconds", 1130 "agentResourceRoleArn", 1131 "createdAt", 1132 "updatedAt" 1133 ], 1134 "members":{ 1135 "agentId":{"shape":"Id"}, 1136 "agentName":{"shape":"Name"}, 1137 "agentArn":{"shape":"AgentArn"}, 1138 "version":{"shape":"NumericalVersion"}, 1139 "instruction":{"shape":"Instruction"}, 1140 "agentStatus":{"shape":"AgentStatus"}, 1141 "foundationModel":{"shape":"ModelIdentifier"}, 1142 "description":{"shape":"Description"}, 1143 "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, 1144 "agentResourceRoleArn":{"shape":"AgentRoleArn"}, 1145 "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, 1146 "createdAt":{"shape":"DateTimestamp"}, 1147 "updatedAt":{"shape":"DateTimestamp"}, 1148 "failureReasons":{"shape":"FailureReasons"}, 1149 "recommendedActions":{"shape":"RecommendedActions"}, 1150 "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} 1151 }, 1152 "documentation":"<p>Contains the information of an agent version.</p>" 1153 }, 1154 "AgentVersionSummaries":{ 1155 "type":"list", 1156 "member":{"shape":"AgentVersionSummary"}, 1157 "documentation":"<p>List of AgentVersionSummary.</p>", 1158 "max":10, 1159 "min":0 1160 }, 1161 "AgentVersionSummary":{ 1162 "type":"structure", 1163 "required":[ 1164 "agentName", 1165 "agentStatus", 1166 "agentVersion", 1167 "createdAt", 1168 "updatedAt" 1169 ], 1170 "members":{ 1171 "agentName":{"shape":"Name"}, 1172 "agentStatus":{"shape":"AgentStatus"}, 1173 "agentVersion":{"shape":"Version"}, 1174 "createdAt":{"shape":"DateTimestamp"}, 1175 "updatedAt":{"shape":"DateTimestamp"}, 1176 "description":{"shape":"Description"} 1177 }, 1178 "documentation":"<p>Summary of agent version.</p>" 1179 }, 1180 "AssociateAgentKnowledgeBaseRequest":{ 1181 "type":"structure", 1182 "required":[ 1183 "agentId", 1184 "agentVersion", 1185 "knowledgeBaseId", 1186 "description" 1187 ], 1188 "members":{ 1189 "agentId":{ 1190 "shape":"Id", 1191 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1192 "location":"uri", 1193 "locationName":"agentId" 1194 }, 1195 "agentVersion":{ 1196 "shape":"DraftVersion", 1197 "documentation":"<p>Draft Version of the Agent.</p>", 1198 "location":"uri", 1199 "locationName":"agentVersion" 1200 }, 1201 "knowledgeBaseId":{"shape":"Id"}, 1202 "description":{"shape":"Description"}, 1203 "knowledgeBaseState":{"shape":"KnowledgeBaseState"} 1204 }, 1205 "documentation":"<p>Associate Agent Knowledge Base Request</p>" 1206 }, 1207 "AssociateAgentKnowledgeBaseResponse":{ 1208 "type":"structure", 1209 "required":["agentKnowledgeBase"], 1210 "members":{ 1211 "agentKnowledgeBase":{"shape":"AgentKnowledgeBase"} 1212 }, 1213 "documentation":"<p>Associate Agent Knowledge Base Response</p>" 1214 }, 1215 "BasePromptTemplate":{ 1216 "type":"string", 1217 "documentation":"<p>Base Prompt Template.</p>", 1218 "max":100000, 1219 "min":1 1220 }, 1221 "BedrockEmbeddingModelArn":{ 1222 "type":"string", 1223 "documentation":"<p>Arn of a Bedrock model.</p>", 1224 "max":1011, 1225 "min":20, 1226 "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))" 1227 }, 1228 "Boolean":{ 1229 "type":"boolean", 1230 "box":true 1231 }, 1232 "ChunkingConfiguration":{ 1233 "type":"structure", 1234 "required":["chunkingStrategy"], 1235 "members":{ 1236 "chunkingStrategy":{"shape":"ChunkingStrategy"}, 1237 "fixedSizeChunkingConfiguration":{"shape":"FixedSizeChunkingConfiguration"} 1238 }, 1239 "documentation":"<p>Configures chunking strategy</p>" 1240 }, 1241 "ChunkingStrategy":{ 1242 "type":"string", 1243 "documentation":"<p>The type of chunking strategy</p>", 1244 "enum":[ 1245 "FIXED_SIZE", 1246 "NONE" 1247 ] 1248 }, 1249 "ClientToken":{ 1250 "type":"string", 1251 "documentation":"<p>Client specified token used for idempotency checks</p>", 1252 "max":256, 1253 "min":33, 1254 "pattern":"[a-zA-Z0-9](-*[a-zA-Z0-9])*" 1255 }, 1256 "ColumnName":{ 1257 "type":"string", 1258 "documentation":"<p>Name of the column</p>", 1259 "max":63, 1260 "min":0, 1261 "pattern":"[a-zA-Z0-9_\\-]+" 1262 }, 1263 "ConflictException":{ 1264 "type":"structure", 1265 "members":{ 1266 "message":{"shape":"NonBlankString"} 1267 }, 1268 "documentation":"<p>This exception is thrown when there is a conflict performing an operation</p>", 1269 "error":{ 1270 "httpStatusCode":409, 1271 "senderFault":true 1272 }, 1273 "exception":true 1274 }, 1275 "CreateAgentActionGroupRequest":{ 1276 "type":"structure", 1277 "required":[ 1278 "agentId", 1279 "agentVersion", 1280 "actionGroupName" 1281 ], 1282 "members":{ 1283 "agentId":{ 1284 "shape":"Id", 1285 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1286 "location":"uri", 1287 "locationName":"agentId" 1288 }, 1289 "agentVersion":{ 1290 "shape":"DraftVersion", 1291 "documentation":"<p>Draft Version of the Agent.</p>", 1292 "location":"uri", 1293 "locationName":"agentVersion" 1294 }, 1295 "actionGroupName":{"shape":"Name"}, 1296 "clientToken":{ 1297 "shape":"ClientToken", 1298 "idempotencyToken":true 1299 }, 1300 "description":{"shape":"Description"}, 1301 "parentActionGroupSignature":{"shape":"ActionGroupSignature"}, 1302 "actionGroupExecutor":{"shape":"ActionGroupExecutor"}, 1303 "apiSchema":{"shape":"APISchema"}, 1304 "actionGroupState":{"shape":"ActionGroupState"} 1305 }, 1306 "documentation":"<p>Create Action Group Request</p>" 1307 }, 1308 "CreateAgentActionGroupResponse":{ 1309 "type":"structure", 1310 "required":["agentActionGroup"], 1311 "members":{ 1312 "agentActionGroup":{"shape":"AgentActionGroup"} 1313 }, 1314 "documentation":"<p>Create Action Group Response</p>" 1315 }, 1316 "CreateAgentAliasRequest":{ 1317 "type":"structure", 1318 "required":[ 1319 "agentId", 1320 "agentAliasName" 1321 ], 1322 "members":{ 1323 "agentId":{ 1324 "shape":"Id", 1325 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1326 "location":"uri", 1327 "locationName":"agentId" 1328 }, 1329 "agentAliasName":{"shape":"Name"}, 1330 "clientToken":{ 1331 "shape":"ClientToken", 1332 "idempotencyToken":true 1333 }, 1334 "description":{"shape":"Description"}, 1335 "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"}, 1336 "tags":{"shape":"TagsMap"} 1337 }, 1338 "documentation":"<p>Create Agent Alias Request</p>" 1339 }, 1340 "CreateAgentAliasResponse":{ 1341 "type":"structure", 1342 "required":["agentAlias"], 1343 "members":{ 1344 "agentAlias":{"shape":"AgentAlias"} 1345 }, 1346 "documentation":"<p>Create Agent Alias Response</p>" 1347 }, 1348 "CreateAgentRequest":{ 1349 "type":"structure", 1350 "required":[ 1351 "agentName", 1352 "agentResourceRoleArn" 1353 ], 1354 "members":{ 1355 "agentName":{"shape":"Name"}, 1356 "clientToken":{ 1357 "shape":"ClientToken", 1358 "idempotencyToken":true 1359 }, 1360 "instruction":{"shape":"Instruction"}, 1361 "foundationModel":{"shape":"ModelIdentifier"}, 1362 "description":{"shape":"Description"}, 1363 "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, 1364 "agentResourceRoleArn":{"shape":"AgentRoleArn"}, 1365 "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, 1366 "tags":{"shape":"TagsMap"}, 1367 "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} 1368 }, 1369 "documentation":"<p>Create Agent Request</p>" 1370 }, 1371 "CreateAgentResponse":{ 1372 "type":"structure", 1373 "required":["agent"], 1374 "members":{ 1375 "agent":{"shape":"Agent"} 1376 }, 1377 "documentation":"<p>Create Agent Response</p>" 1378 }, 1379 "CreateDataSourceRequest":{ 1380 "type":"structure", 1381 "required":[ 1382 "knowledgeBaseId", 1383 "name", 1384 "dataSourceConfiguration" 1385 ], 1386 "members":{ 1387 "knowledgeBaseId":{ 1388 "shape":"Id", 1389 "location":"uri", 1390 "locationName":"knowledgeBaseId" 1391 }, 1392 "clientToken":{ 1393 "shape":"ClientToken", 1394 "idempotencyToken":true 1395 }, 1396 "name":{"shape":"Name"}, 1397 "description":{"shape":"Description"}, 1398 "dataSourceConfiguration":{"shape":"DataSourceConfiguration"}, 1399 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 1400 "vectorIngestionConfiguration":{"shape":"VectorIngestionConfiguration"} 1401 } 1402 }, 1403 "CreateDataSourceResponse":{ 1404 "type":"structure", 1405 "required":["dataSource"], 1406 "members":{ 1407 "dataSource":{"shape":"DataSource"} 1408 } 1409 }, 1410 "CreateKnowledgeBaseRequest":{ 1411 "type":"structure", 1412 "required":[ 1413 "name", 1414 "roleArn", 1415 "knowledgeBaseConfiguration", 1416 "storageConfiguration" 1417 ], 1418 "members":{ 1419 "clientToken":{ 1420 "shape":"ClientToken", 1421 "idempotencyToken":true 1422 }, 1423 "name":{"shape":"Name"}, 1424 "description":{"shape":"Description"}, 1425 "roleArn":{"shape":"KnowledgeBaseRoleArn"}, 1426 "knowledgeBaseConfiguration":{"shape":"KnowledgeBaseConfiguration"}, 1427 "storageConfiguration":{"shape":"StorageConfiguration"}, 1428 "tags":{"shape":"TagsMap"} 1429 } 1430 }, 1431 "CreateKnowledgeBaseResponse":{ 1432 "type":"structure", 1433 "required":["knowledgeBase"], 1434 "members":{ 1435 "knowledgeBase":{"shape":"KnowledgeBase"} 1436 } 1437 }, 1438 "CreationMode":{ 1439 "type":"string", 1440 "documentation":"<p>Creation Mode for Prompt Configuration.</p>", 1441 "enum":[ 1442 "DEFAULT", 1443 "OVERRIDDEN" 1444 ] 1445 }, 1446 "DataSource":{ 1447 "type":"structure", 1448 "required":[ 1449 "knowledgeBaseId", 1450 "dataSourceId", 1451 "name", 1452 "status", 1453 "dataSourceConfiguration", 1454 "createdAt", 1455 "updatedAt" 1456 ], 1457 "members":{ 1458 "knowledgeBaseId":{"shape":"Id"}, 1459 "dataSourceId":{"shape":"Id"}, 1460 "name":{"shape":"Name"}, 1461 "status":{"shape":"DataSourceStatus"}, 1462 "description":{"shape":"Description"}, 1463 "dataSourceConfiguration":{"shape":"DataSourceConfiguration"}, 1464 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 1465 "vectorIngestionConfiguration":{"shape":"VectorIngestionConfiguration"}, 1466 "createdAt":{"shape":"DateTimestamp"}, 1467 "updatedAt":{"shape":"DateTimestamp"} 1468 }, 1469 "documentation":"<p>Contains the information of a data source.</p>" 1470 }, 1471 "DataSourceConfiguration":{ 1472 "type":"structure", 1473 "required":["type"], 1474 "members":{ 1475 "type":{"shape":"DataSourceType"}, 1476 "s3Configuration":{"shape":"S3DataSourceConfiguration"} 1477 }, 1478 "documentation":"<p>Specifies a raw data source location to ingest.</p>" 1479 }, 1480 "DataSourceStatus":{ 1481 "type":"string", 1482 "documentation":"<p>The status of a data source.</p>", 1483 "enum":[ 1484 "AVAILABLE", 1485 "DELETING" 1486 ] 1487 }, 1488 "DataSourceSummaries":{ 1489 "type":"list", 1490 "member":{"shape":"DataSourceSummary"}, 1491 "documentation":"<p>list of data source summaries</p>" 1492 }, 1493 "DataSourceSummary":{ 1494 "type":"structure", 1495 "required":[ 1496 "knowledgeBaseId", 1497 "dataSourceId", 1498 "name", 1499 "status", 1500 "updatedAt" 1501 ], 1502 "members":{ 1503 "knowledgeBaseId":{"shape":"Id"}, 1504 "dataSourceId":{"shape":"Id"}, 1505 "name":{"shape":"Name"}, 1506 "status":{"shape":"DataSourceStatus"}, 1507 "description":{"shape":"Description"}, 1508 "updatedAt":{"shape":"DateTimestamp"} 1509 }, 1510 "documentation":"<p>Summary information of a data source.</p>" 1511 }, 1512 "DataSourceType":{ 1513 "type":"string", 1514 "documentation":"<p>The type of the data source location.</p>", 1515 "enum":["S3"] 1516 }, 1517 "DateTimestamp":{ 1518 "type":"timestamp", 1519 "documentation":"<p>Time Stamp.</p>", 1520 "timestampFormat":"iso8601" 1521 }, 1522 "DeleteAgentActionGroupRequest":{ 1523 "type":"structure", 1524 "required":[ 1525 "agentId", 1526 "agentVersion", 1527 "actionGroupId" 1528 ], 1529 "members":{ 1530 "agentId":{ 1531 "shape":"Id", 1532 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1533 "location":"uri", 1534 "locationName":"agentId" 1535 }, 1536 "agentVersion":{ 1537 "shape":"DraftVersion", 1538 "documentation":"<p>Draft Version of the Agent.</p>", 1539 "location":"uri", 1540 "locationName":"agentVersion" 1541 }, 1542 "actionGroupId":{ 1543 "shape":"Id", 1544 "documentation":"<p>Id generated at the server side when an Agent ActionGroup is created</p>", 1545 "location":"uri", 1546 "locationName":"actionGroupId" 1547 }, 1548 "skipResourceInUseCheck":{ 1549 "shape":"Boolean", 1550 "documentation":"<p>Skips checking if resource is in use when set to true. Defaults to false</p>", 1551 "location":"querystring", 1552 "locationName":"skipResourceInUseCheck" 1553 } 1554 }, 1555 "documentation":"<p>Delete Action Group Request</p>" 1556 }, 1557 "DeleteAgentActionGroupResponse":{ 1558 "type":"structure", 1559 "members":{ 1560 }, 1561 "documentation":"<p>Delete Action Group Response</p>" 1562 }, 1563 "DeleteAgentAliasRequest":{ 1564 "type":"structure", 1565 "required":[ 1566 "agentId", 1567 "agentAliasId" 1568 ], 1569 "members":{ 1570 "agentId":{ 1571 "shape":"Id", 1572 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1573 "location":"uri", 1574 "locationName":"agentId" 1575 }, 1576 "agentAliasId":{ 1577 "shape":"AgentAliasId", 1578 "documentation":"<p>Id generated at the server side when an Agent Alias is created</p>", 1579 "location":"uri", 1580 "locationName":"agentAliasId" 1581 } 1582 }, 1583 "documentation":"<p>Delete Agent Alias Request</p>" 1584 }, 1585 "DeleteAgentAliasResponse":{ 1586 "type":"structure", 1587 "required":[ 1588 "agentId", 1589 "agentAliasId", 1590 "agentAliasStatus" 1591 ], 1592 "members":{ 1593 "agentId":{"shape":"Id"}, 1594 "agentAliasId":{"shape":"AgentAliasId"}, 1595 "agentAliasStatus":{"shape":"AgentAliasStatus"} 1596 }, 1597 "documentation":"<p>Delete Agent Alias Response</p>" 1598 }, 1599 "DeleteAgentRequest":{ 1600 "type":"structure", 1601 "required":["agentId"], 1602 "members":{ 1603 "agentId":{ 1604 "shape":"Id", 1605 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1606 "location":"uri", 1607 "locationName":"agentId" 1608 }, 1609 "skipResourceInUseCheck":{ 1610 "shape":"Boolean", 1611 "documentation":"<p>Skips checking if resource is in use when set to true. Defaults to false</p>", 1612 "location":"querystring", 1613 "locationName":"skipResourceInUseCheck" 1614 } 1615 }, 1616 "documentation":"<p>Delete Agent Request</p>" 1617 }, 1618 "DeleteAgentResponse":{ 1619 "type":"structure", 1620 "required":[ 1621 "agentId", 1622 "agentStatus" 1623 ], 1624 "members":{ 1625 "agentId":{"shape":"Id"}, 1626 "agentStatus":{"shape":"AgentStatus"} 1627 }, 1628 "documentation":"<p>Delete Agent Response</p>" 1629 }, 1630 "DeleteAgentVersionRequest":{ 1631 "type":"structure", 1632 "required":[ 1633 "agentId", 1634 "agentVersion" 1635 ], 1636 "members":{ 1637 "agentId":{ 1638 "shape":"Id", 1639 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1640 "location":"uri", 1641 "locationName":"agentId" 1642 }, 1643 "agentVersion":{ 1644 "shape":"NumericalVersion", 1645 "location":"uri", 1646 "locationName":"agentVersion" 1647 }, 1648 "skipResourceInUseCheck":{ 1649 "shape":"Boolean", 1650 "documentation":"<p>Skips checking if resource is in use when set to true. Defaults to false</p>", 1651 "location":"querystring", 1652 "locationName":"skipResourceInUseCheck" 1653 } 1654 }, 1655 "documentation":"<p>Delete Agent Version Request</p>" 1656 }, 1657 "DeleteAgentVersionResponse":{ 1658 "type":"structure", 1659 "required":[ 1660 "agentId", 1661 "agentVersion", 1662 "agentStatus" 1663 ], 1664 "members":{ 1665 "agentId":{"shape":"Id"}, 1666 "agentVersion":{"shape":"NumericalVersion"}, 1667 "agentStatus":{"shape":"AgentStatus"} 1668 }, 1669 "documentation":"<p>Delete Agent Version Response</p>" 1670 }, 1671 "DeleteDataSourceRequest":{ 1672 "type":"structure", 1673 "required":[ 1674 "knowledgeBaseId", 1675 "dataSourceId" 1676 ], 1677 "members":{ 1678 "knowledgeBaseId":{ 1679 "shape":"Id", 1680 "location":"uri", 1681 "locationName":"knowledgeBaseId" 1682 }, 1683 "dataSourceId":{ 1684 "shape":"Id", 1685 "location":"uri", 1686 "locationName":"dataSourceId" 1687 } 1688 } 1689 }, 1690 "DeleteDataSourceResponse":{ 1691 "type":"structure", 1692 "required":[ 1693 "knowledgeBaseId", 1694 "dataSourceId", 1695 "status" 1696 ], 1697 "members":{ 1698 "knowledgeBaseId":{"shape":"Id"}, 1699 "dataSourceId":{"shape":"Id"}, 1700 "status":{"shape":"DataSourceStatus"} 1701 } 1702 }, 1703 "DeleteKnowledgeBaseRequest":{ 1704 "type":"structure", 1705 "required":["knowledgeBaseId"], 1706 "members":{ 1707 "knowledgeBaseId":{ 1708 "shape":"Id", 1709 "location":"uri", 1710 "locationName":"knowledgeBaseId" 1711 } 1712 } 1713 }, 1714 "DeleteKnowledgeBaseResponse":{ 1715 "type":"structure", 1716 "required":[ 1717 "knowledgeBaseId", 1718 "status" 1719 ], 1720 "members":{ 1721 "knowledgeBaseId":{"shape":"Id"}, 1722 "status":{"shape":"KnowledgeBaseStatus"} 1723 } 1724 }, 1725 "Description":{ 1726 "type":"string", 1727 "documentation":"<p>Description of the Resource.</p>", 1728 "max":200, 1729 "min":1 1730 }, 1731 "DisassociateAgentKnowledgeBaseRequest":{ 1732 "type":"structure", 1733 "required":[ 1734 "agentId", 1735 "agentVersion", 1736 "knowledgeBaseId" 1737 ], 1738 "members":{ 1739 "agentId":{ 1740 "shape":"Id", 1741 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1742 "location":"uri", 1743 "locationName":"agentId" 1744 }, 1745 "agentVersion":{ 1746 "shape":"DraftVersion", 1747 "documentation":"<p>Draft Version of the Agent.</p>", 1748 "location":"uri", 1749 "locationName":"agentVersion" 1750 }, 1751 "knowledgeBaseId":{ 1752 "shape":"Id", 1753 "documentation":"<p>Id generated at the server side when a Knowledge Base is associated to an Agent</p>", 1754 "location":"uri", 1755 "locationName":"knowledgeBaseId" 1756 } 1757 }, 1758 "documentation":"<p>Disassociate Agent Knowledge Base Request</p>" 1759 }, 1760 "DisassociateAgentKnowledgeBaseResponse":{ 1761 "type":"structure", 1762 "members":{ 1763 }, 1764 "documentation":"<p>Disassociate Agent Knowledge Base Response</p>" 1765 }, 1766 "DraftVersion":{ 1767 "type":"string", 1768 "documentation":"<p>Draft Agent Version.</p>", 1769 "max":5, 1770 "min":5, 1771 "pattern":"DRAFT" 1772 }, 1773 "FailureReason":{ 1774 "type":"string", 1775 "documentation":"<p>Failure Reason for Error.</p>", 1776 "max":2048, 1777 "min":0 1778 }, 1779 "FailureReasons":{ 1780 "type":"list", 1781 "member":{"shape":"FailureReason"}, 1782 "documentation":"<p>Failure Reasons for Error.</p>", 1783 "max":2048, 1784 "min":0 1785 }, 1786 "FieldName":{ 1787 "type":"string", 1788 "documentation":"<p>Name of the field</p>", 1789 "max":2048, 1790 "min":0, 1791 "pattern":".*" 1792 }, 1793 "FixedSizeChunkingConfiguration":{ 1794 "type":"structure", 1795 "required":[ 1796 "maxTokens", 1797 "overlapPercentage" 1798 ], 1799 "members":{ 1800 "maxTokens":{ 1801 "shape":"FixedSizeChunkingConfigurationMaxTokensInteger", 1802 "documentation":"<p>The maximum number of tokens per chunk.</p>" 1803 }, 1804 "overlapPercentage":{ 1805 "shape":"FixedSizeChunkingConfigurationOverlapPercentageInteger", 1806 "documentation":"<p>The overlap percentage between adjacent chunks.</p>" 1807 } 1808 }, 1809 "documentation":"<p>Configures fixed size chunking strategy</p>" 1810 }, 1811 "FixedSizeChunkingConfigurationMaxTokensInteger":{ 1812 "type":"integer", 1813 "box":true, 1814 "min":1 1815 }, 1816 "FixedSizeChunkingConfigurationOverlapPercentageInteger":{ 1817 "type":"integer", 1818 "box":true, 1819 "max":99, 1820 "min":1 1821 }, 1822 "GetAgentActionGroupRequest":{ 1823 "type":"structure", 1824 "required":[ 1825 "agentId", 1826 "agentVersion", 1827 "actionGroupId" 1828 ], 1829 "members":{ 1830 "agentId":{ 1831 "shape":"Id", 1832 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1833 "location":"uri", 1834 "locationName":"agentId" 1835 }, 1836 "agentVersion":{ 1837 "shape":"Version", 1838 "documentation":"<p>Version number generated when a version is created</p>", 1839 "location":"uri", 1840 "locationName":"agentVersion" 1841 }, 1842 "actionGroupId":{ 1843 "shape":"Id", 1844 "documentation":"<p>Id generated at the server side when an Agent Action Group is created</p>", 1845 "location":"uri", 1846 "locationName":"actionGroupId" 1847 } 1848 }, 1849 "documentation":"<p>Get Action Group Request</p>" 1850 }, 1851 "GetAgentActionGroupResponse":{ 1852 "type":"structure", 1853 "required":["agentActionGroup"], 1854 "members":{ 1855 "agentActionGroup":{"shape":"AgentActionGroup"} 1856 }, 1857 "documentation":"<p>Get Action Group Response</p>" 1858 }, 1859 "GetAgentAliasRequest":{ 1860 "type":"structure", 1861 "required":[ 1862 "agentId", 1863 "agentAliasId" 1864 ], 1865 "members":{ 1866 "agentId":{ 1867 "shape":"Id", 1868 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1869 "location":"uri", 1870 "locationName":"agentId" 1871 }, 1872 "agentAliasId":{ 1873 "shape":"AgentAliasId", 1874 "documentation":"<p>Id generated at the server side when an Agent Alias is created</p>", 1875 "location":"uri", 1876 "locationName":"agentAliasId" 1877 } 1878 }, 1879 "documentation":"<p>Get Agent Alias Request</p>" 1880 }, 1881 "GetAgentAliasResponse":{ 1882 "type":"structure", 1883 "required":["agentAlias"], 1884 "members":{ 1885 "agentAlias":{"shape":"AgentAlias"} 1886 }, 1887 "documentation":"<p>Get Agent Alias Response</p>" 1888 }, 1889 "GetAgentKnowledgeBaseRequest":{ 1890 "type":"structure", 1891 "required":[ 1892 "agentId", 1893 "agentVersion", 1894 "knowledgeBaseId" 1895 ], 1896 "members":{ 1897 "agentId":{ 1898 "shape":"Id", 1899 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1900 "location":"uri", 1901 "locationName":"agentId" 1902 }, 1903 "agentVersion":{ 1904 "shape":"Version", 1905 "documentation":"<p>Version number generated when a version is created</p>", 1906 "location":"uri", 1907 "locationName":"agentVersion" 1908 }, 1909 "knowledgeBaseId":{ 1910 "shape":"Id", 1911 "documentation":"<p>Id generated at the server side when a Knowledge Base is associated</p>", 1912 "location":"uri", 1913 "locationName":"knowledgeBaseId" 1914 } 1915 }, 1916 "documentation":"<p>Get Agent Knowledge Base Request</p>" 1917 }, 1918 "GetAgentKnowledgeBaseResponse":{ 1919 "type":"structure", 1920 "required":["agentKnowledgeBase"], 1921 "members":{ 1922 "agentKnowledgeBase":{"shape":"AgentKnowledgeBase"} 1923 }, 1924 "documentation":"<p>Get Agent Knowledge Base Response</p>" 1925 }, 1926 "GetAgentRequest":{ 1927 "type":"structure", 1928 "required":["agentId"], 1929 "members":{ 1930 "agentId":{ 1931 "shape":"Id", 1932 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1933 "location":"uri", 1934 "locationName":"agentId" 1935 } 1936 }, 1937 "documentation":"<p>Get Agent Request</p>" 1938 }, 1939 "GetAgentResponse":{ 1940 "type":"structure", 1941 "required":["agent"], 1942 "members":{ 1943 "agent":{"shape":"Agent"} 1944 }, 1945 "documentation":"<p>Get Agent Response</p>" 1946 }, 1947 "GetAgentVersionRequest":{ 1948 "type":"structure", 1949 "required":[ 1950 "agentId", 1951 "agentVersion" 1952 ], 1953 "members":{ 1954 "agentId":{ 1955 "shape":"Id", 1956 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 1957 "location":"uri", 1958 "locationName":"agentId" 1959 }, 1960 "agentVersion":{ 1961 "shape":"NumericalVersion", 1962 "location":"uri", 1963 "locationName":"agentVersion" 1964 } 1965 }, 1966 "documentation":"<p>Get Agent Version Request</p>" 1967 }, 1968 "GetAgentVersionResponse":{ 1969 "type":"structure", 1970 "required":["agentVersion"], 1971 "members":{ 1972 "agentVersion":{"shape":"AgentVersion"} 1973 }, 1974 "documentation":"<p>Get Agent Version Response</p>" 1975 }, 1976 "GetDataSourceRequest":{ 1977 "type":"structure", 1978 "required":[ 1979 "knowledgeBaseId", 1980 "dataSourceId" 1981 ], 1982 "members":{ 1983 "knowledgeBaseId":{ 1984 "shape":"Id", 1985 "location":"uri", 1986 "locationName":"knowledgeBaseId" 1987 }, 1988 "dataSourceId":{ 1989 "shape":"Id", 1990 "location":"uri", 1991 "locationName":"dataSourceId" 1992 } 1993 } 1994 }, 1995 "GetDataSourceResponse":{ 1996 "type":"structure", 1997 "required":["dataSource"], 1998 "members":{ 1999 "dataSource":{"shape":"DataSource"} 2000 } 2001 }, 2002 "GetIngestionJobRequest":{ 2003 "type":"structure", 2004 "required":[ 2005 "knowledgeBaseId", 2006 "dataSourceId", 2007 "ingestionJobId" 2008 ], 2009 "members":{ 2010 "knowledgeBaseId":{ 2011 "shape":"Id", 2012 "location":"uri", 2013 "locationName":"knowledgeBaseId" 2014 }, 2015 "dataSourceId":{ 2016 "shape":"Id", 2017 "location":"uri", 2018 "locationName":"dataSourceId" 2019 }, 2020 "ingestionJobId":{ 2021 "shape":"Id", 2022 "location":"uri", 2023 "locationName":"ingestionJobId" 2024 } 2025 } 2026 }, 2027 "GetIngestionJobResponse":{ 2028 "type":"structure", 2029 "required":["ingestionJob"], 2030 "members":{ 2031 "ingestionJob":{"shape":"IngestionJob"} 2032 } 2033 }, 2034 "GetKnowledgeBaseRequest":{ 2035 "type":"structure", 2036 "required":["knowledgeBaseId"], 2037 "members":{ 2038 "knowledgeBaseId":{ 2039 "shape":"Id", 2040 "location":"uri", 2041 "locationName":"knowledgeBaseId" 2042 } 2043 } 2044 }, 2045 "GetKnowledgeBaseResponse":{ 2046 "type":"structure", 2047 "required":["knowledgeBase"], 2048 "members":{ 2049 "knowledgeBase":{"shape":"KnowledgeBase"} 2050 } 2051 }, 2052 "Id":{ 2053 "type":"string", 2054 "documentation":"<p>Identifier for a resource.</p>", 2055 "pattern":"[0-9a-zA-Z]{10}" 2056 }, 2057 "InferenceConfiguration":{ 2058 "type":"structure", 2059 "members":{ 2060 "temperature":{"shape":"Temperature"}, 2061 "topP":{"shape":"TopP"}, 2062 "topK":{"shape":"TopK"}, 2063 "maximumLength":{"shape":"MaximumLength"}, 2064 "stopSequences":{"shape":"StopSequences"} 2065 }, 2066 "documentation":"<p>Configuration for inference in prompt configuration</p>" 2067 }, 2068 "IngestionJob":{ 2069 "type":"structure", 2070 "required":[ 2071 "knowledgeBaseId", 2072 "dataSourceId", 2073 "ingestionJobId", 2074 "status", 2075 "startedAt", 2076 "updatedAt" 2077 ], 2078 "members":{ 2079 "knowledgeBaseId":{"shape":"Id"}, 2080 "dataSourceId":{"shape":"Id"}, 2081 "ingestionJobId":{"shape":"Id"}, 2082 "description":{"shape":"Description"}, 2083 "status":{"shape":"IngestionJobStatus"}, 2084 "statistics":{"shape":"IngestionJobStatistics"}, 2085 "failureReasons":{"shape":"FailureReasons"}, 2086 "startedAt":{"shape":"DateTimestamp"}, 2087 "updatedAt":{"shape":"DateTimestamp"} 2088 }, 2089 "documentation":"<p>Contains the information of an ingestion job.</p>" 2090 }, 2091 "IngestionJobFilter":{ 2092 "type":"structure", 2093 "required":[ 2094 "attribute", 2095 "operator", 2096 "values" 2097 ], 2098 "members":{ 2099 "attribute":{"shape":"IngestionJobFilterAttribute"}, 2100 "operator":{"shape":"IngestionJobFilterOperator"}, 2101 "values":{"shape":"IngestionJobFilterValues"} 2102 }, 2103 "documentation":"<p>Filters the response returned by ListIngestionJobs operation.</p>" 2104 }, 2105 "IngestionJobFilterAttribute":{ 2106 "type":"string", 2107 "documentation":"<p>The name of the field to filter ingestion jobs.</p>", 2108 "enum":["STATUS"] 2109 }, 2110 "IngestionJobFilterOperator":{ 2111 "type":"string", 2112 "documentation":"<p>The operator used to filter ingestion jobs.</p>", 2113 "enum":["EQ"] 2114 }, 2115 "IngestionJobFilterValue":{ 2116 "type":"string", 2117 "documentation":"<p>The value used to filter ingestion jobs.</p>", 2118 "max":100, 2119 "min":0, 2120 "pattern":".*" 2121 }, 2122 "IngestionJobFilterValues":{ 2123 "type":"list", 2124 "member":{"shape":"IngestionJobFilterValue"}, 2125 "documentation":"<p>The list of values used to filter ingestion jobs.</p>", 2126 "max":10, 2127 "min":0 2128 }, 2129 "IngestionJobFilters":{ 2130 "type":"list", 2131 "member":{"shape":"IngestionJobFilter"}, 2132 "documentation":"<p>List of IngestionJobFilters</p>", 2133 "max":1, 2134 "min":1 2135 }, 2136 "IngestionJobSortBy":{ 2137 "type":"structure", 2138 "required":[ 2139 "attribute", 2140 "order" 2141 ], 2142 "members":{ 2143 "attribute":{"shape":"IngestionJobSortByAttribute"}, 2144 "order":{"shape":"SortOrder"} 2145 }, 2146 "documentation":"<p>Sorts the response returned by ListIngestionJobs operation.</p>" 2147 }, 2148 "IngestionJobSortByAttribute":{ 2149 "type":"string", 2150 "documentation":"<p>The name of the field to sort ingestion jobs.</p>", 2151 "enum":[ 2152 "STATUS", 2153 "STARTED_AT" 2154 ] 2155 }, 2156 "IngestionJobStatistics":{ 2157 "type":"structure", 2158 "members":{ 2159 "numberOfDocumentsScanned":{ 2160 "shape":"PrimitiveLong", 2161 "documentation":"<p>Number of scanned documents</p>" 2162 }, 2163 "numberOfNewDocumentsIndexed":{ 2164 "shape":"PrimitiveLong", 2165 "documentation":"<p>Number of indexed documents</p>" 2166 }, 2167 "numberOfModifiedDocumentsIndexed":{ 2168 "shape":"PrimitiveLong", 2169 "documentation":"<p>Number of modified documents indexed</p>" 2170 }, 2171 "numberOfDocumentsDeleted":{ 2172 "shape":"PrimitiveLong", 2173 "documentation":"<p>Number of deleted documents</p>" 2174 }, 2175 "numberOfDocumentsFailed":{ 2176 "shape":"PrimitiveLong", 2177 "documentation":"<p>Number of failed documents</p>" 2178 } 2179 }, 2180 "documentation":"<p>The document level statistics of an ingestion job</p>" 2181 }, 2182 "IngestionJobStatus":{ 2183 "type":"string", 2184 "documentation":"<p>The status of an ingestion job.</p>", 2185 "enum":[ 2186 "STARTING", 2187 "IN_PROGRESS", 2188 "COMPLETE", 2189 "FAILED" 2190 ] 2191 }, 2192 "IngestionJobSummaries":{ 2193 "type":"list", 2194 "member":{"shape":"IngestionJobSummary"}, 2195 "documentation":"<p>List of IngestionJobSummaries</p>" 2196 }, 2197 "IngestionJobSummary":{ 2198 "type":"structure", 2199 "required":[ 2200 "knowledgeBaseId", 2201 "dataSourceId", 2202 "ingestionJobId", 2203 "status", 2204 "startedAt", 2205 "updatedAt" 2206 ], 2207 "members":{ 2208 "knowledgeBaseId":{"shape":"Id"}, 2209 "dataSourceId":{"shape":"Id"}, 2210 "ingestionJobId":{"shape":"Id"}, 2211 "description":{"shape":"Description"}, 2212 "status":{"shape":"IngestionJobStatus"}, 2213 "startedAt":{"shape":"DateTimestamp"}, 2214 "updatedAt":{"shape":"DateTimestamp"}, 2215 "statistics":{"shape":"IngestionJobStatistics"} 2216 }, 2217 "documentation":"<p>Summary information of an ingestion job.</p>" 2218 }, 2219 "Instruction":{ 2220 "type":"string", 2221 "documentation":"<p>Instruction for the agent.</p>", 2222 "max":1200, 2223 "min":40, 2224 "sensitive":true 2225 }, 2226 "InternalServerException":{ 2227 "type":"structure", 2228 "members":{ 2229 "message":{"shape":"NonBlankString"} 2230 }, 2231 "documentation":"<p>This exception is thrown if there was an unexpected error during processing of request</p>", 2232 "error":{"httpStatusCode":500}, 2233 "exception":true, 2234 "fault":true 2235 }, 2236 "KmsKeyArn":{ 2237 "type":"string", 2238 "documentation":"<p>A KMS key ARN</p>", 2239 "max":2048, 2240 "min":1, 2241 "pattern":"arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}" 2242 }, 2243 "KnowledgeBase":{ 2244 "type":"structure", 2245 "required":[ 2246 "knowledgeBaseId", 2247 "name", 2248 "knowledgeBaseArn", 2249 "roleArn", 2250 "knowledgeBaseConfiguration", 2251 "storageConfiguration", 2252 "status", 2253 "createdAt", 2254 "updatedAt" 2255 ], 2256 "members":{ 2257 "knowledgeBaseId":{"shape":"Id"}, 2258 "name":{"shape":"Name"}, 2259 "knowledgeBaseArn":{"shape":"KnowledgeBaseArn"}, 2260 "description":{"shape":"Description"}, 2261 "roleArn":{"shape":"KnowledgeBaseRoleArn"}, 2262 "knowledgeBaseConfiguration":{"shape":"KnowledgeBaseConfiguration"}, 2263 "storageConfiguration":{"shape":"StorageConfiguration"}, 2264 "status":{"shape":"KnowledgeBaseStatus"}, 2265 "createdAt":{"shape":"DateTimestamp"}, 2266 "updatedAt":{"shape":"DateTimestamp"}, 2267 "failureReasons":{"shape":"FailureReasons"} 2268 }, 2269 "documentation":"<p>Contains the information of a knowledge base.</p>" 2270 }, 2271 "KnowledgeBaseArn":{ 2272 "type":"string", 2273 "documentation":"<p>ARN of a KnowledgeBase</p>", 2274 "max":128, 2275 "min":0, 2276 "pattern":"arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+" 2277 }, 2278 "KnowledgeBaseConfiguration":{ 2279 "type":"structure", 2280 "required":["type"], 2281 "members":{ 2282 "type":{"shape":"KnowledgeBaseType"}, 2283 "vectorKnowledgeBaseConfiguration":{"shape":"VectorKnowledgeBaseConfiguration"} 2284 }, 2285 "documentation":"<p>Configures a bedrock knowledge base.</p>" 2286 }, 2287 "KnowledgeBaseRoleArn":{ 2288 "type":"string", 2289 "documentation":"<p>ARN of a IAM role.</p>", 2290 "max":2048, 2291 "min":0, 2292 "pattern":"arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForKnowledgeBase.+" 2293 }, 2294 "KnowledgeBaseState":{ 2295 "type":"string", 2296 "documentation":"<p>State of the knowledge base; whether it is enabled or disabled</p>", 2297 "enum":[ 2298 "ENABLED", 2299 "DISABLED" 2300 ] 2301 }, 2302 "KnowledgeBaseStatus":{ 2303 "type":"string", 2304 "documentation":"<p>The status of a knowledge base.</p>", 2305 "enum":[ 2306 "CREATING", 2307 "ACTIVE", 2308 "DELETING", 2309 "UPDATING", 2310 "FAILED" 2311 ] 2312 }, 2313 "KnowledgeBaseStorageType":{ 2314 "type":"string", 2315 "documentation":"<p>The storage type of a knowledge base.</p>", 2316 "enum":[ 2317 "OPENSEARCH_SERVERLESS", 2318 "PINECONE", 2319 "REDIS_ENTERPRISE_CLOUD", 2320 "RDS" 2321 ] 2322 }, 2323 "KnowledgeBaseSummaries":{ 2324 "type":"list", 2325 "member":{"shape":"KnowledgeBaseSummary"}, 2326 "documentation":"<p>List of KnowledgeBaseSummaries</p>" 2327 }, 2328 "KnowledgeBaseSummary":{ 2329 "type":"structure", 2330 "required":[ 2331 "knowledgeBaseId", 2332 "name", 2333 "status", 2334 "updatedAt" 2335 ], 2336 "members":{ 2337 "knowledgeBaseId":{"shape":"Id"}, 2338 "name":{"shape":"Name"}, 2339 "description":{"shape":"Description"}, 2340 "status":{"shape":"KnowledgeBaseStatus"}, 2341 "updatedAt":{"shape":"DateTimestamp"} 2342 }, 2343 "documentation":"<p>Summary information of a knowledge base.</p>" 2344 }, 2345 "KnowledgeBaseType":{ 2346 "type":"string", 2347 "documentation":"<p>The type of a knowledge base.</p>", 2348 "enum":["VECTOR"] 2349 }, 2350 "LambdaArn":{ 2351 "type":"string", 2352 "documentation":"<p>ARN of a Lambda.</p>", 2353 "max":2048, 2354 "min":0, 2355 "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" 2356 }, 2357 "ListAgentActionGroupsRequest":{ 2358 "type":"structure", 2359 "required":[ 2360 "agentId", 2361 "agentVersion" 2362 ], 2363 "members":{ 2364 "agentId":{ 2365 "shape":"Id", 2366 "documentation":"<p>Id generated at the server side when an Agent is Listed</p>", 2367 "location":"uri", 2368 "locationName":"agentId" 2369 }, 2370 "agentVersion":{ 2371 "shape":"Version", 2372 "documentation":"<p>Id generated at the server side when an Agent is Listed</p>", 2373 "location":"uri", 2374 "locationName":"agentVersion" 2375 }, 2376 "maxResults":{"shape":"MaxResults"}, 2377 "nextToken":{"shape":"NextToken"} 2378 }, 2379 "documentation":"<p>List Action Groups Request</p>" 2380 }, 2381 "ListAgentActionGroupsResponse":{ 2382 "type":"structure", 2383 "required":["actionGroupSummaries"], 2384 "members":{ 2385 "actionGroupSummaries":{"shape":"ActionGroupSummaries"}, 2386 "nextToken":{"shape":"NextToken"} 2387 }, 2388 "documentation":"<p>List Action Groups Response</p>" 2389 }, 2390 "ListAgentAliasesRequest":{ 2391 "type":"structure", 2392 "required":["agentId"], 2393 "members":{ 2394 "agentId":{ 2395 "shape":"Id", 2396 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 2397 "location":"uri", 2398 "locationName":"agentId" 2399 }, 2400 "maxResults":{"shape":"MaxResults"}, 2401 "nextToken":{"shape":"NextToken"} 2402 }, 2403 "documentation":"<p>List Agent Aliases Request</p>" 2404 }, 2405 "ListAgentAliasesResponse":{ 2406 "type":"structure", 2407 "required":["agentAliasSummaries"], 2408 "members":{ 2409 "agentAliasSummaries":{"shape":"AgentAliasSummaries"}, 2410 "nextToken":{"shape":"NextToken"} 2411 }, 2412 "documentation":"<p>List Agent Aliases Response</p>" 2413 }, 2414 "ListAgentKnowledgeBasesRequest":{ 2415 "type":"structure", 2416 "required":[ 2417 "agentId", 2418 "agentVersion" 2419 ], 2420 "members":{ 2421 "agentId":{ 2422 "shape":"Id", 2423 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 2424 "location":"uri", 2425 "locationName":"agentId" 2426 }, 2427 "agentVersion":{ 2428 "shape":"Version", 2429 "documentation":"<p>Version number generated when a version is created</p>", 2430 "location":"uri", 2431 "locationName":"agentVersion" 2432 }, 2433 "maxResults":{"shape":"MaxResults"}, 2434 "nextToken":{"shape":"NextToken"} 2435 }, 2436 "documentation":"<p>List Agent Knowledge Bases Request</p>" 2437 }, 2438 "ListAgentKnowledgeBasesResponse":{ 2439 "type":"structure", 2440 "required":["agentKnowledgeBaseSummaries"], 2441 "members":{ 2442 "agentKnowledgeBaseSummaries":{"shape":"AgentKnowledgeBaseSummaries"}, 2443 "nextToken":{"shape":"NextToken"} 2444 }, 2445 "documentation":"<p>List Agent Knowledge Bases Response</p>" 2446 }, 2447 "ListAgentVersionsRequest":{ 2448 "type":"structure", 2449 "required":["agentId"], 2450 "members":{ 2451 "agentId":{ 2452 "shape":"Id", 2453 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 2454 "location":"uri", 2455 "locationName":"agentId" 2456 }, 2457 "maxResults":{"shape":"MaxResults"}, 2458 "nextToken":{"shape":"NextToken"} 2459 }, 2460 "documentation":"<p>List Agent Versions Request</p>" 2461 }, 2462 "ListAgentVersionsResponse":{ 2463 "type":"structure", 2464 "required":["agentVersionSummaries"], 2465 "members":{ 2466 "agentVersionSummaries":{"shape":"AgentVersionSummaries"}, 2467 "nextToken":{"shape":"NextToken"} 2468 }, 2469 "documentation":"<p>List Agent Versions Response</p>" 2470 }, 2471 "ListAgentsRequest":{ 2472 "type":"structure", 2473 "members":{ 2474 "maxResults":{"shape":"MaxResults"}, 2475 "nextToken":{"shape":"NextToken"} 2476 }, 2477 "documentation":"<p>List Agent Request</p>" 2478 }, 2479 "ListAgentsResponse":{ 2480 "type":"structure", 2481 "required":["agentSummaries"], 2482 "members":{ 2483 "agentSummaries":{"shape":"AgentSummaries"}, 2484 "nextToken":{"shape":"NextToken"} 2485 }, 2486 "documentation":"<p>List Agent Response</p>" 2487 }, 2488 "ListDataSourcesRequest":{ 2489 "type":"structure", 2490 "required":["knowledgeBaseId"], 2491 "members":{ 2492 "knowledgeBaseId":{ 2493 "shape":"Id", 2494 "location":"uri", 2495 "locationName":"knowledgeBaseId" 2496 }, 2497 "maxResults":{"shape":"MaxResults"}, 2498 "nextToken":{"shape":"NextToken"} 2499 } 2500 }, 2501 "ListDataSourcesResponse":{ 2502 "type":"structure", 2503 "required":["dataSourceSummaries"], 2504 "members":{ 2505 "dataSourceSummaries":{"shape":"DataSourceSummaries"}, 2506 "nextToken":{"shape":"NextToken"} 2507 } 2508 }, 2509 "ListIngestionJobsRequest":{ 2510 "type":"structure", 2511 "required":[ 2512 "knowledgeBaseId", 2513 "dataSourceId" 2514 ], 2515 "members":{ 2516 "knowledgeBaseId":{ 2517 "shape":"Id", 2518 "location":"uri", 2519 "locationName":"knowledgeBaseId" 2520 }, 2521 "dataSourceId":{ 2522 "shape":"Id", 2523 "location":"uri", 2524 "locationName":"dataSourceId" 2525 }, 2526 "filters":{"shape":"IngestionJobFilters"}, 2527 "sortBy":{"shape":"IngestionJobSortBy"}, 2528 "maxResults":{"shape":"MaxResults"}, 2529 "nextToken":{"shape":"NextToken"} 2530 } 2531 }, 2532 "ListIngestionJobsResponse":{ 2533 "type":"structure", 2534 "required":["ingestionJobSummaries"], 2535 "members":{ 2536 "ingestionJobSummaries":{"shape":"IngestionJobSummaries"}, 2537 "nextToken":{"shape":"NextToken"} 2538 } 2539 }, 2540 "ListKnowledgeBasesRequest":{ 2541 "type":"structure", 2542 "members":{ 2543 "maxResults":{"shape":"MaxResults"}, 2544 "nextToken":{"shape":"NextToken"} 2545 } 2546 }, 2547 "ListKnowledgeBasesResponse":{ 2548 "type":"structure", 2549 "required":["knowledgeBaseSummaries"], 2550 "members":{ 2551 "knowledgeBaseSummaries":{"shape":"KnowledgeBaseSummaries"}, 2552 "nextToken":{"shape":"NextToken"} 2553 } 2554 }, 2555 "ListTagsForResourceRequest":{ 2556 "type":"structure", 2557 "required":["resourceArn"], 2558 "members":{ 2559 "resourceArn":{ 2560 "shape":"TaggableResourcesArn", 2561 "location":"uri", 2562 "locationName":"resourceArn" 2563 } 2564 } 2565 }, 2566 "ListTagsForResourceResponse":{ 2567 "type":"structure", 2568 "members":{ 2569 "tags":{"shape":"TagsMap"} 2570 } 2571 }, 2572 "MaxResults":{ 2573 "type":"integer", 2574 "documentation":"<p>Max Results.</p>", 2575 "box":true, 2576 "max":1000, 2577 "min":1 2578 }, 2579 "MaximumLength":{ 2580 "type":"integer", 2581 "documentation":"<p>Maximum length of output</p>", 2582 "box":true, 2583 "max":4096, 2584 "min":0 2585 }, 2586 "ModelIdentifier":{ 2587 "type":"string", 2588 "documentation":"<p>ARN or name of a Bedrock model.</p>", 2589 "max":2048, 2590 "min":1, 2591 "pattern":"arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)" 2592 }, 2593 "Name":{ 2594 "type":"string", 2595 "documentation":"<p>Name for a resource.</p>", 2596 "pattern":"([0-9a-zA-Z][_-]?){1,100}" 2597 }, 2598 "NextToken":{ 2599 "type":"string", 2600 "documentation":"<p>Opaque continuation token of previous paginated response.</p>", 2601 "max":2048, 2602 "min":1, 2603 "pattern":"\\S*" 2604 }, 2605 "NonBlankString":{ 2606 "type":"string", 2607 "documentation":"<p>Non Blank String</p>", 2608 "pattern":"[\\s\\S]+" 2609 }, 2610 "NumericalVersion":{ 2611 "type":"string", 2612 "documentation":"<p>Numerical Agent Version.</p>", 2613 "pattern":"[0-9]{1,5}" 2614 }, 2615 "OpenSearchServerlessCollectionArn":{ 2616 "type":"string", 2617 "documentation":"<p>Arn of an OpenSearch Serverless collection.</p>", 2618 "max":2048, 2619 "min":0, 2620 "pattern":"arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:collection/[a-z0-9-]{3,32}" 2621 }, 2622 "OpenSearchServerlessConfiguration":{ 2623 "type":"structure", 2624 "required":[ 2625 "collectionArn", 2626 "vectorIndexName", 2627 "fieldMapping" 2628 ], 2629 "members":{ 2630 "collectionArn":{"shape":"OpenSearchServerlessCollectionArn"}, 2631 "vectorIndexName":{"shape":"OpenSearchServerlessIndexName"}, 2632 "fieldMapping":{"shape":"OpenSearchServerlessFieldMapping"} 2633 }, 2634 "documentation":"<p>Contains the configurations to use OpenSearch Serverless to store knowledge base data.</p>" 2635 }, 2636 "OpenSearchServerlessFieldMapping":{ 2637 "type":"structure", 2638 "required":[ 2639 "vectorField", 2640 "textField", 2641 "metadataField" 2642 ], 2643 "members":{ 2644 "vectorField":{"shape":"FieldName"}, 2645 "textField":{"shape":"FieldName"}, 2646 "metadataField":{"shape":"FieldName"} 2647 }, 2648 "documentation":"<p>A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names</p>" 2649 }, 2650 "OpenSearchServerlessIndexName":{ 2651 "type":"string", 2652 "documentation":"<p>Arn of an OpenSearch Serverless index.</p>", 2653 "max":2048, 2654 "min":0, 2655 "pattern":".*" 2656 }, 2657 "Payload":{ 2658 "type":"string", 2659 "documentation":"<p>String OpenAPI Payload</p>", 2660 "sensitive":true 2661 }, 2662 "PineconeConfiguration":{ 2663 "type":"structure", 2664 "required":[ 2665 "connectionString", 2666 "credentialsSecretArn", 2667 "fieldMapping" 2668 ], 2669 "members":{ 2670 "connectionString":{"shape":"PineconeConnectionString"}, 2671 "credentialsSecretArn":{"shape":"SecretArn"}, 2672 "namespace":{"shape":"PineconeNamespace"}, 2673 "fieldMapping":{"shape":"PineconeFieldMapping"} 2674 }, 2675 "documentation":"<p>Contains the configurations to use Pinecone to store knowledge base data.</p>" 2676 }, 2677 "PineconeConnectionString":{ 2678 "type":"string", 2679 "documentation":"<p>Pinecone connection string</p>", 2680 "max":2048, 2681 "min":0, 2682 "pattern":".*" 2683 }, 2684 "PineconeFieldMapping":{ 2685 "type":"structure", 2686 "required":[ 2687 "textField", 2688 "metadataField" 2689 ], 2690 "members":{ 2691 "textField":{"shape":"FieldName"}, 2692 "metadataField":{"shape":"FieldName"} 2693 }, 2694 "documentation":"<p>A mapping of Bedrock Knowledge Base fields to Pinecone field names</p>" 2695 }, 2696 "PineconeNamespace":{ 2697 "type":"string", 2698 "documentation":"<p>Pinecone namespace</p>", 2699 "max":2048, 2700 "min":0, 2701 "pattern":".*" 2702 }, 2703 "PrepareAgentRequest":{ 2704 "type":"structure", 2705 "required":["agentId"], 2706 "members":{ 2707 "agentId":{ 2708 "shape":"Id", 2709 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 2710 "location":"uri", 2711 "locationName":"agentId" 2712 } 2713 }, 2714 "documentation":"<p>PrepareAgent Request</p>" 2715 }, 2716 "PrepareAgentResponse":{ 2717 "type":"structure", 2718 "required":[ 2719 "agentId", 2720 "agentStatus", 2721 "agentVersion", 2722 "preparedAt" 2723 ], 2724 "members":{ 2725 "agentId":{"shape":"Id"}, 2726 "agentStatus":{"shape":"AgentStatus"}, 2727 "agentVersion":{"shape":"Version"}, 2728 "preparedAt":{"shape":"DateTimestamp"} 2729 }, 2730 "documentation":"<p>PrepareAgent Response</p>" 2731 }, 2732 "PrimitiveLong":{"type":"long"}, 2733 "PromptConfiguration":{ 2734 "type":"structure", 2735 "members":{ 2736 "promptType":{"shape":"PromptType"}, 2737 "promptCreationMode":{"shape":"CreationMode"}, 2738 "promptState":{"shape":"PromptState"}, 2739 "basePromptTemplate":{"shape":"BasePromptTemplate"}, 2740 "inferenceConfiguration":{"shape":"InferenceConfiguration"}, 2741 "parserMode":{"shape":"CreationMode"} 2742 }, 2743 "documentation":"<p>BasePromptConfiguration per Prompt Type.</p>" 2744 }, 2745 "PromptConfigurations":{ 2746 "type":"list", 2747 "member":{"shape":"PromptConfiguration"}, 2748 "documentation":"<p>List of BasePromptConfiguration</p>", 2749 "max":10, 2750 "min":0 2751 }, 2752 "PromptOverrideConfiguration":{ 2753 "type":"structure", 2754 "required":["promptConfigurations"], 2755 "members":{ 2756 "promptConfigurations":{"shape":"PromptConfigurations"}, 2757 "overrideLambda":{"shape":"LambdaArn"} 2758 }, 2759 "documentation":"<p>Configuration for prompt override.</p>", 2760 "sensitive":true 2761 }, 2762 "PromptState":{ 2763 "type":"string", 2764 "documentation":"<p>Prompt State.</p>", 2765 "enum":[ 2766 "ENABLED", 2767 "DISABLED" 2768 ] 2769 }, 2770 "PromptType":{ 2771 "type":"string", 2772 "documentation":"<p>Prompt Type.</p>", 2773 "enum":[ 2774 "PRE_PROCESSING", 2775 "ORCHESTRATION", 2776 "POST_PROCESSING", 2777 "KNOWLEDGE_BASE_RESPONSE_GENERATION" 2778 ] 2779 }, 2780 "RdsArn":{ 2781 "type":"string", 2782 "documentation":"<p>Arn of a RDS Resource.</p>", 2783 "pattern":"arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}" 2784 }, 2785 "RdsConfiguration":{ 2786 "type":"structure", 2787 "required":[ 2788 "resourceArn", 2789 "credentialsSecretArn", 2790 "databaseName", 2791 "tableName", 2792 "fieldMapping" 2793 ], 2794 "members":{ 2795 "resourceArn":{"shape":"RdsArn"}, 2796 "credentialsSecretArn":{"shape":"SecretArn"}, 2797 "databaseName":{"shape":"RdsDatabaseName"}, 2798 "tableName":{"shape":"RdsTableName"}, 2799 "fieldMapping":{"shape":"RdsFieldMapping"} 2800 }, 2801 "documentation":"<p>Contains the configurations to use RDS to store knowledge base data.</p>" 2802 }, 2803 "RdsDatabaseName":{ 2804 "type":"string", 2805 "documentation":"<p>Name of the database within RDS</p>", 2806 "max":63, 2807 "min":0, 2808 "pattern":"[a-zA-Z0-9_\\-]+" 2809 }, 2810 "RdsFieldMapping":{ 2811 "type":"structure", 2812 "required":[ 2813 "primaryKeyField", 2814 "vectorField", 2815 "textField", 2816 "metadataField" 2817 ], 2818 "members":{ 2819 "primaryKeyField":{"shape":"ColumnName"}, 2820 "vectorField":{"shape":"ColumnName"}, 2821 "textField":{"shape":"ColumnName"}, 2822 "metadataField":{"shape":"ColumnName"} 2823 }, 2824 "documentation":"<p>A mapping of Bedrock Knowledge Base fields to RDS column names</p>" 2825 }, 2826 "RdsTableName":{ 2827 "type":"string", 2828 "documentation":"<p>Name of the table within RDS</p>", 2829 "max":63, 2830 "min":0, 2831 "pattern":"[a-zA-Z0-9_\\.\\-]+" 2832 }, 2833 "RecommendedAction":{ 2834 "type":"string", 2835 "documentation":"<p>The recommended action users can take to resolve an error in failureReasons.</p>", 2836 "max":2048, 2837 "min":0 2838 }, 2839 "RecommendedActions":{ 2840 "type":"list", 2841 "member":{"shape":"RecommendedAction"}, 2842 "documentation":"<p>The recommended actions users can take to resolve an error in failureReasons.</p>", 2843 "max":2048, 2844 "min":0 2845 }, 2846 "RedisEnterpriseCloudConfiguration":{ 2847 "type":"structure", 2848 "required":[ 2849 "endpoint", 2850 "vectorIndexName", 2851 "credentialsSecretArn", 2852 "fieldMapping" 2853 ], 2854 "members":{ 2855 "endpoint":{"shape":"RedisEnterpriseCloudEndpoint"}, 2856 "vectorIndexName":{"shape":"RedisEnterpriseCloudIndexName"}, 2857 "credentialsSecretArn":{"shape":"SecretArn"}, 2858 "fieldMapping":{"shape":"RedisEnterpriseCloudFieldMapping"} 2859 }, 2860 "documentation":"<p>Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.</p>" 2861 }, 2862 "RedisEnterpriseCloudEndpoint":{ 2863 "type":"string", 2864 "documentation":"<p>Redis enterprise cloud endpoint</p>", 2865 "max":2048, 2866 "min":0, 2867 "pattern":".*" 2868 }, 2869 "RedisEnterpriseCloudFieldMapping":{ 2870 "type":"structure", 2871 "required":[ 2872 "vectorField", 2873 "textField", 2874 "metadataField" 2875 ], 2876 "members":{ 2877 "vectorField":{"shape":"FieldName"}, 2878 "textField":{"shape":"FieldName"}, 2879 "metadataField":{"shape":"FieldName"} 2880 }, 2881 "documentation":"<p>A mapping of Bedrock Knowledge Base fields to Redis Cloud field names</p>" 2882 }, 2883 "RedisEnterpriseCloudIndexName":{ 2884 "type":"string", 2885 "documentation":"<p>Name of a redis enterprise cloud index</p>", 2886 "max":2048, 2887 "min":0, 2888 "pattern":".*" 2889 }, 2890 "ResourceNotFoundException":{ 2891 "type":"structure", 2892 "members":{ 2893 "message":{"shape":"NonBlankString"} 2894 }, 2895 "documentation":"<p>This exception is thrown when a resource referenced by the operation does not exist</p>", 2896 "error":{ 2897 "httpStatusCode":404, 2898 "senderFault":true 2899 }, 2900 "exception":true 2901 }, 2902 "S3BucketArn":{ 2903 "type":"string", 2904 "documentation":"<p>A S3 bucket ARN</p>", 2905 "max":2048, 2906 "min":1, 2907 "pattern":"arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]" 2908 }, 2909 "S3BucketName":{ 2910 "type":"string", 2911 "documentation":"<p>A bucket in S3.</p>", 2912 "max":63, 2913 "min":3, 2914 "pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" 2915 }, 2916 "S3DataSourceConfiguration":{ 2917 "type":"structure", 2918 "required":["bucketArn"], 2919 "members":{ 2920 "bucketArn":{"shape":"S3BucketArn"}, 2921 "inclusionPrefixes":{"shape":"S3Prefixes"} 2922 }, 2923 "documentation":"<p>Configures an S3 data source location.</p>" 2924 }, 2925 "S3Identifier":{ 2926 "type":"structure", 2927 "members":{ 2928 "s3BucketName":{"shape":"S3BucketName"}, 2929 "s3ObjectKey":{"shape":"S3ObjectKey"} 2930 }, 2931 "documentation":"<p>The identifier for the S3 resource.</p>" 2932 }, 2933 "S3ObjectKey":{ 2934 "type":"string", 2935 "documentation":"<p>A object key in S3.</p>", 2936 "max":1024, 2937 "min":1, 2938 "pattern":"[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*" 2939 }, 2940 "S3Prefix":{ 2941 "type":"string", 2942 "documentation":"<p>Prefix for s3 object.</p>", 2943 "max":300, 2944 "min":1 2945 }, 2946 "S3Prefixes":{ 2947 "type":"list", 2948 "member":{"shape":"S3Prefix"}, 2949 "documentation":"<p>A list of S3 prefixes.</p>", 2950 "max":1, 2951 "min":1 2952 }, 2953 "SecretArn":{ 2954 "type":"string", 2955 "documentation":"<p>Arn of a SecretsManager Secret.</p>", 2956 "pattern":"arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}" 2957 }, 2958 "ServerSideEncryptionConfiguration":{ 2959 "type":"structure", 2960 "members":{ 2961 "kmsKeyArn":{"shape":"KmsKeyArn"} 2962 }, 2963 "documentation":"<p>Server-side encryption configuration.</p>" 2964 }, 2965 "ServiceQuotaExceededException":{ 2966 "type":"structure", 2967 "members":{ 2968 "message":{"shape":"NonBlankString"} 2969 }, 2970 "documentation":"<p>This exception is thrown when a request is made beyond the service quota</p>", 2971 "error":{ 2972 "httpStatusCode":402, 2973 "senderFault":true 2974 }, 2975 "exception":true 2976 }, 2977 "SessionTTL":{ 2978 "type":"integer", 2979 "documentation":"<p>Max Session Time.</p>", 2980 "box":true, 2981 "max":3600, 2982 "min":60 2983 }, 2984 "SortOrder":{ 2985 "type":"string", 2986 "documentation":"<p>Order to sort results by.</p>", 2987 "enum":[ 2988 "ASCENDING", 2989 "DESCENDING" 2990 ] 2991 }, 2992 "StartIngestionJobRequest":{ 2993 "type":"structure", 2994 "required":[ 2995 "knowledgeBaseId", 2996 "dataSourceId" 2997 ], 2998 "members":{ 2999 "knowledgeBaseId":{ 3000 "shape":"Id", 3001 "location":"uri", 3002 "locationName":"knowledgeBaseId" 3003 }, 3004 "dataSourceId":{ 3005 "shape":"Id", 3006 "location":"uri", 3007 "locationName":"dataSourceId" 3008 }, 3009 "clientToken":{ 3010 "shape":"ClientToken", 3011 "idempotencyToken":true 3012 }, 3013 "description":{"shape":"Description"} 3014 } 3015 }, 3016 "StartIngestionJobResponse":{ 3017 "type":"structure", 3018 "required":["ingestionJob"], 3019 "members":{ 3020 "ingestionJob":{"shape":"IngestionJob"} 3021 } 3022 }, 3023 "StopSequences":{ 3024 "type":"list", 3025 "member":{"shape":"String"}, 3026 "documentation":"<p>List of stop sequences</p>", 3027 "max":4, 3028 "min":0 3029 }, 3030 "StorageConfiguration":{ 3031 "type":"structure", 3032 "required":["type"], 3033 "members":{ 3034 "type":{"shape":"KnowledgeBaseStorageType"}, 3035 "opensearchServerlessConfiguration":{"shape":"OpenSearchServerlessConfiguration"}, 3036 "pineconeConfiguration":{"shape":"PineconeConfiguration"}, 3037 "redisEnterpriseCloudConfiguration":{"shape":"RedisEnterpriseCloudConfiguration"}, 3038 "rdsConfiguration":{"shape":"RdsConfiguration"} 3039 }, 3040 "documentation":"<p>Configures the physical storage of ingested data in a knowledge base.</p>" 3041 }, 3042 "String":{"type":"string"}, 3043 "TagKey":{ 3044 "type":"string", 3045 "documentation":"<p>Key of a tag</p>", 3046 "max":128, 3047 "min":1, 3048 "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" 3049 }, 3050 "TagKeyList":{ 3051 "type":"list", 3052 "member":{"shape":"TagKey"}, 3053 "documentation":"<p>List of Tag Keys</p>", 3054 "max":200, 3055 "min":0 3056 }, 3057 "TagResourceRequest":{ 3058 "type":"structure", 3059 "required":[ 3060 "resourceArn", 3061 "tags" 3062 ], 3063 "members":{ 3064 "resourceArn":{ 3065 "shape":"TaggableResourcesArn", 3066 "location":"uri", 3067 "locationName":"resourceArn" 3068 }, 3069 "tags":{"shape":"TagsMap"} 3070 } 3071 }, 3072 "TagResourceResponse":{ 3073 "type":"structure", 3074 "members":{ 3075 } 3076 }, 3077 "TagValue":{ 3078 "type":"string", 3079 "documentation":"<p>Value of a tag</p>", 3080 "max":256, 3081 "min":0, 3082 "pattern":"[a-zA-Z0-9\\s._:/=+@-]*" 3083 }, 3084 "TaggableResourcesArn":{ 3085 "type":"string", 3086 "documentation":"<p>ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]</p>", 3087 "max":1011, 3088 "min":20, 3089 "pattern":".*(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$).*" 3090 }, 3091 "TagsMap":{ 3092 "type":"map", 3093 "key":{"shape":"TagKey"}, 3094 "value":{"shape":"TagValue"}, 3095 "documentation":"<p>A map of tag keys and values</p>" 3096 }, 3097 "Temperature":{ 3098 "type":"float", 3099 "documentation":"<p>Controls randomness, higher values increase diversity</p>", 3100 "box":true, 3101 "max":1, 3102 "min":0 3103 }, 3104 "ThrottlingException":{ 3105 "type":"structure", 3106 "members":{ 3107 "message":{"shape":"NonBlankString"} 3108 }, 3109 "documentation":"<p>This exception is thrown when the number of requests exceeds the limit</p>", 3110 "error":{ 3111 "httpStatusCode":429, 3112 "senderFault":true 3113 }, 3114 "exception":true 3115 }, 3116 "TopK":{ 3117 "type":"integer", 3118 "documentation":"<p>Sample from the k most likely next tokens</p>", 3119 "box":true, 3120 "max":500, 3121 "min":0 3122 }, 3123 "TopP":{ 3124 "type":"float", 3125 "documentation":"<p>Cumulative probability cutoff for token selection</p>", 3126 "box":true, 3127 "max":1, 3128 "min":0 3129 }, 3130 "UntagResourceRequest":{ 3131 "type":"structure", 3132 "required":[ 3133 "resourceArn", 3134 "tagKeys" 3135 ], 3136 "members":{ 3137 "resourceArn":{ 3138 "shape":"TaggableResourcesArn", 3139 "location":"uri", 3140 "locationName":"resourceArn" 3141 }, 3142 "tagKeys":{ 3143 "shape":"TagKeyList", 3144 "location":"querystring", 3145 "locationName":"tagKeys" 3146 } 3147 } 3148 }, 3149 "UntagResourceResponse":{ 3150 "type":"structure", 3151 "members":{ 3152 } 3153 }, 3154 "UpdateAgentActionGroupRequest":{ 3155 "type":"structure", 3156 "required":[ 3157 "agentId", 3158 "agentVersion", 3159 "actionGroupId", 3160 "actionGroupName" 3161 ], 3162 "members":{ 3163 "agentId":{ 3164 "shape":"Id", 3165 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 3166 "location":"uri", 3167 "locationName":"agentId" 3168 }, 3169 "agentVersion":{ 3170 "shape":"DraftVersion", 3171 "documentation":"<p>Draft Version of the Agent.</p>", 3172 "location":"uri", 3173 "locationName":"agentVersion" 3174 }, 3175 "actionGroupId":{ 3176 "shape":"Id", 3177 "documentation":"<p>Id generated at the server side when an Action Group is created under Agent</p>", 3178 "location":"uri", 3179 "locationName":"actionGroupId" 3180 }, 3181 "actionGroupName":{"shape":"Name"}, 3182 "description":{"shape":"Description"}, 3183 "parentActionGroupSignature":{"shape":"ActionGroupSignature"}, 3184 "actionGroupExecutor":{"shape":"ActionGroupExecutor"}, 3185 "actionGroupState":{"shape":"ActionGroupState"}, 3186 "apiSchema":{"shape":"APISchema"} 3187 }, 3188 "documentation":"<p>Update Action Group Request</p>" 3189 }, 3190 "UpdateAgentActionGroupResponse":{ 3191 "type":"structure", 3192 "required":["agentActionGroup"], 3193 "members":{ 3194 "agentActionGroup":{"shape":"AgentActionGroup"} 3195 }, 3196 "documentation":"<p>Update Action Group Response</p>" 3197 }, 3198 "UpdateAgentAliasRequest":{ 3199 "type":"structure", 3200 "required":[ 3201 "agentId", 3202 "agentAliasId", 3203 "agentAliasName" 3204 ], 3205 "members":{ 3206 "agentId":{ 3207 "shape":"Id", 3208 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 3209 "location":"uri", 3210 "locationName":"agentId" 3211 }, 3212 "agentAliasId":{ 3213 "shape":"AgentAliasId", 3214 "documentation":"<p>Id generated at the server side when an Agent Alias is created</p>", 3215 "location":"uri", 3216 "locationName":"agentAliasId" 3217 }, 3218 "agentAliasName":{"shape":"Name"}, 3219 "description":{"shape":"Description"}, 3220 "routingConfiguration":{"shape":"AgentAliasRoutingConfiguration"} 3221 }, 3222 "documentation":"<p>Update Agent Alias Request</p>" 3223 }, 3224 "UpdateAgentAliasResponse":{ 3225 "type":"structure", 3226 "required":["agentAlias"], 3227 "members":{ 3228 "agentAlias":{"shape":"AgentAlias"} 3229 }, 3230 "documentation":"<p>Update Agent Alias Response</p>" 3231 }, 3232 "UpdateAgentKnowledgeBaseRequest":{ 3233 "type":"structure", 3234 "required":[ 3235 "agentId", 3236 "agentVersion", 3237 "knowledgeBaseId" 3238 ], 3239 "members":{ 3240 "agentId":{ 3241 "shape":"Id", 3242 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 3243 "location":"uri", 3244 "locationName":"agentId" 3245 }, 3246 "agentVersion":{ 3247 "shape":"DraftVersion", 3248 "documentation":"<p>Draft Version of the Agent.</p>", 3249 "location":"uri", 3250 "locationName":"agentVersion" 3251 }, 3252 "knowledgeBaseId":{ 3253 "shape":"Id", 3254 "documentation":"<p>Id generated at the server side when a Knowledge Base is associated to an Agent</p>", 3255 "location":"uri", 3256 "locationName":"knowledgeBaseId" 3257 }, 3258 "description":{"shape":"Description"}, 3259 "knowledgeBaseState":{"shape":"KnowledgeBaseState"} 3260 }, 3261 "documentation":"<p>Update Agent Knowledge Base Request</p>" 3262 }, 3263 "UpdateAgentKnowledgeBaseResponse":{ 3264 "type":"structure", 3265 "required":["agentKnowledgeBase"], 3266 "members":{ 3267 "agentKnowledgeBase":{"shape":"AgentKnowledgeBase"} 3268 }, 3269 "documentation":"<p>Update Agent Knowledge Base Response</p>" 3270 }, 3271 "UpdateAgentRequest":{ 3272 "type":"structure", 3273 "required":[ 3274 "agentId", 3275 "agentName", 3276 "agentResourceRoleArn" 3277 ], 3278 "members":{ 3279 "agentId":{ 3280 "shape":"Id", 3281 "documentation":"<p>Id generated at the server side when an Agent is created</p>", 3282 "location":"uri", 3283 "locationName":"agentId" 3284 }, 3285 "agentName":{"shape":"Name"}, 3286 "instruction":{"shape":"Instruction"}, 3287 "foundationModel":{"shape":"ModelIdentifier"}, 3288 "description":{"shape":"Description"}, 3289 "idleSessionTTLInSeconds":{"shape":"SessionTTL"}, 3290 "agentResourceRoleArn":{"shape":"AgentRoleArn"}, 3291 "customerEncryptionKeyArn":{"shape":"KmsKeyArn"}, 3292 "promptOverrideConfiguration":{"shape":"PromptOverrideConfiguration"} 3293 }, 3294 "documentation":"<p>Update Agent Request</p>" 3295 }, 3296 "UpdateAgentResponse":{ 3297 "type":"structure", 3298 "required":["agent"], 3299 "members":{ 3300 "agent":{"shape":"Agent"} 3301 }, 3302 "documentation":"<p>Update Agent Response</p>" 3303 }, 3304 "UpdateDataSourceRequest":{ 3305 "type":"structure", 3306 "required":[ 3307 "knowledgeBaseId", 3308 "dataSourceId", 3309 "name", 3310 "dataSourceConfiguration" 3311 ], 3312 "members":{ 3313 "knowledgeBaseId":{ 3314 "shape":"Id", 3315 "location":"uri", 3316 "locationName":"knowledgeBaseId" 3317 }, 3318 "dataSourceId":{ 3319 "shape":"Id", 3320 "location":"uri", 3321 "locationName":"dataSourceId" 3322 }, 3323 "name":{"shape":"Name"}, 3324 "description":{"shape":"Description"}, 3325 "dataSourceConfiguration":{"shape":"DataSourceConfiguration"}, 3326 "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, 3327 "vectorIngestionConfiguration":{"shape":"VectorIngestionConfiguration"} 3328 } 3329 }, 3330 "UpdateDataSourceResponse":{ 3331 "type":"structure", 3332 "required":["dataSource"], 3333 "members":{ 3334 "dataSource":{"shape":"DataSource"} 3335 } 3336 }, 3337 "UpdateKnowledgeBaseRequest":{ 3338 "type":"structure", 3339 "required":[ 3340 "knowledgeBaseId", 3341 "name", 3342 "roleArn", 3343 "knowledgeBaseConfiguration", 3344 "storageConfiguration" 3345 ], 3346 "members":{ 3347 "knowledgeBaseId":{ 3348 "shape":"Id", 3349 "location":"uri", 3350 "locationName":"knowledgeBaseId" 3351 }, 3352 "name":{"shape":"Name"}, 3353 "description":{"shape":"Description"}, 3354 "roleArn":{"shape":"KnowledgeBaseRoleArn"}, 3355 "knowledgeBaseConfiguration":{"shape":"KnowledgeBaseConfiguration"}, 3356 "storageConfiguration":{"shape":"StorageConfiguration"} 3357 } 3358 }, 3359 "UpdateKnowledgeBaseResponse":{ 3360 "type":"structure", 3361 "required":["knowledgeBase"], 3362 "members":{ 3363 "knowledgeBase":{"shape":"KnowledgeBase"} 3364 } 3365 }, 3366 "ValidationException":{ 3367 "type":"structure", 3368 "members":{ 3369 "message":{"shape":"NonBlankString"}, 3370 "fieldList":{"shape":"ValidationExceptionFieldList"} 3371 }, 3372 "documentation":"<p>This exception is thrown when the request's input validation fails</p>", 3373 "error":{ 3374 "httpStatusCode":400, 3375 "senderFault":true 3376 }, 3377 "exception":true 3378 }, 3379 "ValidationExceptionField":{ 3380 "type":"structure", 3381 "required":[ 3382 "name", 3383 "message" 3384 ], 3385 "members":{ 3386 "name":{"shape":"NonBlankString"}, 3387 "message":{"shape":"NonBlankString"} 3388 }, 3389 "documentation":"<p>Stores information about a field passed inside a request that resulted in an exception</p>" 3390 }, 3391 "ValidationExceptionFieldList":{ 3392 "type":"list", 3393 "member":{"shape":"ValidationExceptionField"}, 3394 "documentation":"<p>list of ValidationExceptionField</p>" 3395 }, 3396 "VectorIngestionConfiguration":{ 3397 "type":"structure", 3398 "members":{ 3399 "chunkingConfiguration":{"shape":"ChunkingConfiguration"} 3400 }, 3401 "documentation":"<p>Configures ingestion for a vector knowledge base</p>" 3402 }, 3403 "VectorKnowledgeBaseConfiguration":{ 3404 "type":"structure", 3405 "required":["embeddingModelArn"], 3406 "members":{ 3407 "embeddingModelArn":{"shape":"BedrockEmbeddingModelArn"} 3408 }, 3409 "documentation":"<p>Configurations for a vector knowledge base.</p>" 3410 }, 3411 "Version":{ 3412 "type":"string", 3413 "documentation":"<p>Agent Version.</p>", 3414 "max":5, 3415 "min":1, 3416 "pattern":"(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})" 3417 } 3418 }, 3419 "documentation":"<p>An example service, deployed with the Octane Service creator, which will echo the string</p>" 3420} 3421