1{ 2 "version": "2.0", 3 "service": "<fullname>AWS Well-Architected Tool</fullname> <p>This is the <i>AWS Well-Architected Tool API Reference</i>. The AWS Well-Architected Tool API provides programmatic access to the <a href=\"http://aws.amazon.com/well-architected-tool\">AWS Well-Architected Tool</a> in the <a href=\"https://console.aws.amazon.com/wellarchitected\">AWS Management Console</a>. For information about the AWS Well-Architected Tool, see the <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html\">AWS Well-Architected Tool User Guide</a>.</p>", 4 "operations": { 5 "AssociateLenses": "<p>Associate a lens to a workload.</p>", 6 "CreateMilestone": "<p>Create a milestone for an existing workload.</p>", 7 "CreateWorkload": "<p>Create a new workload.</p> <p>The owner of a workload can share the workload with other AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html\">Defining a Workload</a> in the <i>AWS Well-Architected Tool User Guide</i>.</p>", 8 "CreateWorkloadShare": "<p>Create a workload share.</p> <p>The owner of a workload can share it with other AWS accounts and IAM users in the same AWS Region. Shared access to a workload is not removed until the workload invitation is deleted.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html\">Sharing a Workload</a> in the <i>AWS Well-Architected Tool User Guide</i>.</p>", 9 "DeleteWorkload": "<p>Delete an existing workload.</p>", 10 "DeleteWorkloadShare": "<p>Delete a workload share.</p>", 11 "DisassociateLenses": "<p>Disassociate a lens from a workload.</p> <note> <p>The AWS Well-Architected Framework lens (<code>wellarchitected</code>) cannot be removed from a workload.</p> </note>", 12 "GetAnswer": "<p>Get lens review.</p>", 13 "GetLensReview": "<p>Get lens review.</p>", 14 "GetLensReviewReport": "<p>Get lens review report.</p>", 15 "GetLensVersionDifference": "<p>Get lens version differences.</p>", 16 "GetMilestone": "<p>Get a milestone for an existing workload.</p>", 17 "GetWorkload": "<p>Get an existing workload.</p>", 18 "ListAnswers": "<p>List of answers.</p>", 19 "ListLensReviewImprovements": "<p>List lens review improvements.</p>", 20 "ListLensReviews": "<p>List lens reviews.</p>", 21 "ListLenses": "<p>List the available lenses.</p>", 22 "ListMilestones": "<p>List all milestones for an existing workload.</p>", 23 "ListNotifications": "<p>List lens notifications.</p>", 24 "ListShareInvitations": "<p>List the workload invitations.</p>", 25 "ListWorkloadShares": "<p>List the workload shares associated with the workload.</p>", 26 "ListWorkloads": "<p>List workloads. Paginated.</p>", 27 "UpdateAnswer": "<p>Update the answer.</p>", 28 "UpdateLensReview": "<p>Update lens review.</p>", 29 "UpdateShareInvitation": "<p>Update a workload invitation.</p>", 30 "UpdateWorkload": "<p>Update an existing workload.</p>", 31 "UpdateWorkloadShare": "<p>Update a workload share.</p>", 32 "UpgradeLensReview": "<p>Upgrade lens review.</p>" 33 }, 34 "shapes": { 35 "AccessDeniedException": { 36 "base": "<p>User does not have sufficient access to perform this action.</p>", 37 "refs": { 38 } 39 }, 40 "Answer": { 41 "base": "<p>An answer of the question.</p>", 42 "refs": { 43 "GetAnswerOutput$Answer": null, 44 "UpdateAnswerOutput$Answer": null 45 } 46 }, 47 "AnswerSummaries": { 48 "base": "<p>List of answer summaries of lens review in a workload.</p>", 49 "refs": { 50 "ListAnswersOutput$AnswerSummaries": null 51 } 52 }, 53 "AnswerSummary": { 54 "base": "<p>An answer summary of a lens review in a workload.</p>", 55 "refs": { 56 "AnswerSummaries$member": null 57 } 58 }, 59 "AssociateLensesInput": { 60 "base": "<p>Input to associate lens reviews.</p>", 61 "refs": { 62 } 63 }, 64 "AwsAccountId": { 65 "base": "<p>An AWS account ID.</p>", 66 "refs": { 67 "ShareInvitationSummary$SharedBy": null, 68 "Workload$Owner": null, 69 "WorkloadAccountIds$member": null, 70 "WorkloadShare$SharedBy": null, 71 "WorkloadSummary$Owner": null 72 } 73 }, 74 "AwsRegion": { 75 "base": "<p>An AWS Region, for example, <code>us-west-2</code> or <code>ap-northeast-1</code>.</p>", 76 "refs": { 77 "WorkloadAwsRegions$member": null 78 } 79 }, 80 "Base64String": { 81 "base": "<p>The Base64-encoded string representation of a lens review report.</p> <p>This data can be used to create a PDF file.</p>", 82 "refs": { 83 "LensReviewReport$Base64String": null 84 } 85 }, 86 "Choice": { 87 "base": "<p>A choice available to answer question.</p>", 88 "refs": { 89 "Choices$member": null 90 } 91 }, 92 "ChoiceDescription": { 93 "base": "<p>The description of a choice.</p>", 94 "refs": { 95 "Choice$Description": null 96 } 97 }, 98 "ChoiceId": { 99 "base": "<p>The ID of a choice.</p>", 100 "refs": { 101 "Choice$ChoiceId": null, 102 "SelectedChoices$member": null 103 } 104 }, 105 "ChoiceTitle": { 106 "base": "<p>The title of a choice.</p>", 107 "refs": { 108 "Choice$Title": null 109 } 110 }, 111 "Choices": { 112 "base": "<p>List of choices available for a question.</p>", 113 "refs": { 114 "Answer$Choices": null, 115 "AnswerSummary$Choices": null 116 } 117 }, 118 "ClientRequestToken": { 119 "base": "<p>A unique case-sensitive string used to ensure that this request is idempotent (executes only once).</p> <p>You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned. </p> <important> <p>This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.</p> </important>", 120 "refs": { 121 "CreateMilestoneInput$ClientRequestToken": null, 122 "CreateWorkloadInput$ClientRequestToken": null, 123 "CreateWorkloadShareInput$ClientRequestToken": null, 124 "DeleteWorkloadInput$ClientRequestToken": null, 125 "DeleteWorkloadShareInput$ClientRequestToken": null, 126 "UpgradeLensReviewInput$ClientRequestToken": null 127 } 128 }, 129 "ConflictException": { 130 "base": "<p>The resource already exists.</p>", 131 "refs": { 132 } 133 }, 134 "Count": { 135 "base": "<p>A non-negative integer that denotes how many.</p>", 136 "refs": { 137 "RiskCounts$value": null 138 } 139 }, 140 "CreateMilestoneInput": { 141 "base": "<p>Input for milestone creation.</p>", 142 "refs": { 143 } 144 }, 145 "CreateMilestoneOutput": { 146 "base": "<p>Output of a create milestone call.</p>", 147 "refs": { 148 } 149 }, 150 "CreateWorkloadInput": { 151 "base": "<p>Input for workload creation.</p>", 152 "refs": { 153 } 154 }, 155 "CreateWorkloadOutput": { 156 "base": "<p>Output of a create workload call.</p>", 157 "refs": { 158 } 159 }, 160 "CreateWorkloadShareInput": { 161 "base": "<p>Input for Create Workload Share</p>", 162 "refs": { 163 } 164 }, 165 "CreateWorkloadShareOutput": { 166 "base": "<p>Input for Create Workload Share</p>", 167 "refs": { 168 } 169 }, 170 "DeleteWorkloadInput": { 171 "base": "<p>Input for workload deletion.</p>", 172 "refs": { 173 } 174 }, 175 "DeleteWorkloadShareInput": { 176 "base": "<p>Input for Delete Workload Share</p>", 177 "refs": { 178 } 179 }, 180 "DifferenceStatus": { 181 "base": null, 182 "refs": { 183 "PillarDifference$DifferenceStatus": "<p>Indicates the type of change to the pillar.</p>", 184 "QuestionDifference$DifferenceStatus": "<p>Indicates the type of change to the question.</p>" 185 } 186 }, 187 "DisassociateLensesInput": { 188 "base": "<p>Input to disassociate lens reviews.</p>", 189 "refs": { 190 } 191 }, 192 "ExceptionMessage": { 193 "base": "<p>Description of the error.</p>", 194 "refs": { 195 "AccessDeniedException$Message": null, 196 "ConflictException$Message": null, 197 "InternalServerException$Message": null, 198 "ResourceNotFoundException$Message": null, 199 "ServiceQuotaExceededException$Message": null, 200 "ThrottlingException$Message": null, 201 "ValidationException$Message": null, 202 "ValidationExceptionField$Message": null 203 } 204 }, 205 "ExceptionResourceId": { 206 "base": "<p>Identifier of the resource affected.</p>", 207 "refs": { 208 "ConflictException$ResourceId": null, 209 "ResourceNotFoundException$ResourceId": null, 210 "ServiceQuotaExceededException$ResourceId": null 211 } 212 }, 213 "ExceptionResourceType": { 214 "base": "<p>Type of the resource affected.</p>", 215 "refs": { 216 "ConflictException$ResourceType": null, 217 "ResourceNotFoundException$ResourceType": null, 218 "ServiceQuotaExceededException$ResourceType": null 219 } 220 }, 221 "GetAnswerInput": { 222 "base": "<p>Input to get answer.</p>", 223 "refs": { 224 } 225 }, 226 "GetAnswerOutput": { 227 "base": "<p>Output of a get answer call.</p>", 228 "refs": { 229 } 230 }, 231 "GetLensReviewInput": { 232 "base": "<p>Input to get lens review.</p>", 233 "refs": { 234 } 235 }, 236 "GetLensReviewOutput": { 237 "base": "<p>Output of a get lens review call.</p>", 238 "refs": { 239 } 240 }, 241 "GetLensReviewReportInput": { 242 "base": "<p>Input to get lens review report.</p>", 243 "refs": { 244 } 245 }, 246 "GetLensReviewReportOutput": { 247 "base": "<p>Output of a get lens review report call.</p>", 248 "refs": { 249 } 250 }, 251 "GetLensVersionDifferenceInput": { 252 "base": null, 253 "refs": { 254 } 255 }, 256 "GetLensVersionDifferenceOutput": { 257 "base": null, 258 "refs": { 259 } 260 }, 261 "GetMilestoneInput": { 262 "base": "<p>Input to get a milestone.</p>", 263 "refs": { 264 } 265 }, 266 "GetMilestoneOutput": { 267 "base": "<p>Output of a get milestone call.</p>", 268 "refs": { 269 } 270 }, 271 "GetWorkloadInput": { 272 "base": "<p>Input to get a workload.</p>", 273 "refs": { 274 } 275 }, 276 "GetWorkloadOutput": { 277 "base": "<p>Output of a get workload call.</p>", 278 "refs": { 279 } 280 }, 281 "HelpfulResourceUrl": { 282 "base": "<p>The helpful resource URL for a question.</p>", 283 "refs": { 284 "Answer$HelpfulResourceUrl": null 285 } 286 }, 287 "ImprovementPlanUrl": { 288 "base": "<p>The improvement plan URL for a question.</p>", 289 "refs": { 290 "Answer$ImprovementPlanUrl": null, 291 "ImprovementSummary$ImprovementPlanUrl": null 292 } 293 }, 294 "ImprovementSummaries": { 295 "base": "<p>List of improvement summaries of lens review in a workload.</p>", 296 "refs": { 297 "ListLensReviewImprovementsOutput$ImprovementSummaries": null 298 } 299 }, 300 "ImprovementSummary": { 301 "base": "<p>An improvement summary of a lens review in a workload.</p>", 302 "refs": { 303 "ImprovementSummaries$member": null 304 } 305 }, 306 "InternalServerException": { 307 "base": "<p>There is a problem with the AWS Well-Architected Tool API service.</p>", 308 "refs": { 309 } 310 }, 311 "IsApplicable": { 312 "base": "<p>Defines whether this question is applicable to a lens review.</p>", 313 "refs": { 314 "Answer$IsApplicable": null, 315 "AnswerSummary$IsApplicable": null, 316 "UpdateAnswerInput$IsApplicable": null 317 } 318 }, 319 "IsReviewOwnerUpdateAcknowledged": { 320 "base": null, 321 "refs": { 322 "UpdateWorkloadInput$IsReviewOwnerUpdateAcknowledged": "<p>Flag indicating whether the workload owner has acknowledged that the <i>Review owner</i> field is required.</p> <p>If a <b>Review owner</b> is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.</p>", 323 "Workload$IsReviewOwnerUpdateAcknowledged": "<p>Flag indicating whether the workload owner has acknowledged that the <i>Review owner</i> field is required.</p> <p>If a <b>Review owner</b> is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.</p>" 324 } 325 }, 326 "LensAlias": { 327 "base": "<p>The alias of the lens, for example, <code>serverless</code>.</p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>", 328 "refs": { 329 "GetAnswerInput$LensAlias": null, 330 "GetAnswerOutput$LensAlias": null, 331 "GetLensReviewInput$LensAlias": null, 332 "GetLensReviewReportInput$LensAlias": null, 333 "GetLensVersionDifferenceInput$LensAlias": null, 334 "GetLensVersionDifferenceOutput$LensAlias": null, 335 "LensAliases$member": null, 336 "LensReview$LensAlias": null, 337 "LensReviewReport$LensAlias": null, 338 "LensReviewSummary$LensAlias": null, 339 "LensSummary$LensAlias": null, 340 "LensUpgradeSummary$LensAlias": null, 341 "ListAnswersInput$LensAlias": null, 342 "ListAnswersOutput$LensAlias": null, 343 "ListLensReviewImprovementsInput$LensAlias": null, 344 "ListLensReviewImprovementsOutput$LensAlias": null, 345 "UpdateAnswerInput$LensAlias": null, 346 "UpdateAnswerOutput$LensAlias": null, 347 "UpdateLensReviewInput$LensAlias": null, 348 "UpgradeLensReviewInput$LensAlias": null, 349 "WorkloadLenses$member": null 350 } 351 }, 352 "LensAliases": { 353 "base": "<p>List of lens aliases to associate or disassociate with a workload.</p> <p>Identify a lens using its <a>LensSummary$LensAlias</a>.</p>", 354 "refs": { 355 "AssociateLensesInput$LensAliases": null, 356 "DisassociateLensesInput$LensAliases": null 357 } 358 }, 359 "LensDescription": { 360 "base": "<p>The description of the lens.</p>", 361 "refs": { 362 "LensSummary$Description": null 363 } 364 }, 365 "LensName": { 366 "base": "<p>The full name of the lens.</p>", 367 "refs": { 368 "LensReview$LensName": null, 369 "LensReviewSummary$LensName": null, 370 "LensSummary$LensName": null 371 } 372 }, 373 "LensReview": { 374 "base": "<p>A lens review of a question.</p>", 375 "refs": { 376 "GetLensReviewOutput$LensReview": null, 377 "UpdateLensReviewOutput$LensReview": null 378 } 379 }, 380 "LensReviewReport": { 381 "base": "<p>A report of a lens review.</p>", 382 "refs": { 383 "GetLensReviewReportOutput$LensReviewReport": null 384 } 385 }, 386 "LensReviewSummaries": { 387 "base": "<p>List of lens summaries of lens reviews of a workload.</p>", 388 "refs": { 389 "ListLensReviewsOutput$LensReviewSummaries": null 390 } 391 }, 392 "LensReviewSummary": { 393 "base": "<p>A lens review summary of a workload.</p>", 394 "refs": { 395 "LensReviewSummaries$member": null 396 } 397 }, 398 "LensStatus": { 399 "base": null, 400 "refs": { 401 "LensReview$LensStatus": "<p>The status of the lens.</p>", 402 "LensReviewSummary$LensStatus": "<p>The status of the lens.</p>" 403 } 404 }, 405 "LensSummaries": { 406 "base": "<p>List of lens summaries of available lenses.</p>", 407 "refs": { 408 "ListLensesOutput$LensSummaries": null 409 } 410 }, 411 "LensSummary": { 412 "base": "<p>A lens summary of a lens.</p>", 413 "refs": { 414 "LensSummaries$member": null 415 } 416 }, 417 "LensUpgradeSummary": { 418 "base": "<p>Lens upgrade summary return object.</p>", 419 "refs": { 420 "NotificationSummary$LensUpgradeSummary": "<p>Summary of lens upgrade.</p>" 421 } 422 }, 423 "LensVersion": { 424 "base": null, 425 "refs": { 426 "GetLensVersionDifferenceInput$BaseLensVersion": "<p>The base version of the lens.</p>", 427 "GetLensVersionDifferenceOutput$BaseLensVersion": "<p>The base version of the lens.</p>", 428 "GetLensVersionDifferenceOutput$LatestLensVersion": "<p>The latest version of the lens.</p>", 429 "LensReview$LensVersion": "<p>The version of the lens.</p>", 430 "LensReviewSummary$LensVersion": "<p>The version of the lens.</p>", 431 "LensSummary$LensVersion": "<p>The version of the lens.</p>", 432 "LensUpgradeSummary$CurrentLensVersion": "<p>The current version of the lens.</p>", 433 "LensUpgradeSummary$LatestLensVersion": "<p>The latest version of the lens.</p>" 434 } 435 }, 436 "ListAnswersInput": { 437 "base": "<p>Input to list answers.</p>", 438 "refs": { 439 } 440 }, 441 "ListAnswersMaxResults": { 442 "base": null, 443 "refs": { 444 "ListAnswersInput$MaxResults": "<p>The maximum number of results to return for this request.</p>" 445 } 446 }, 447 "ListAnswersOutput": { 448 "base": "<p>Output of a list answers call.</p>", 449 "refs": { 450 } 451 }, 452 "ListLensReviewImprovementsInput": { 453 "base": "<p>Input to list lens review improvements.</p>", 454 "refs": { 455 } 456 }, 457 "ListLensReviewImprovementsMaxResults": { 458 "base": null, 459 "refs": { 460 "ListLensReviewImprovementsInput$MaxResults": "<p>The maximum number of results to return for this request.</p>" 461 } 462 }, 463 "ListLensReviewImprovementsOutput": { 464 "base": "<p>Output of a list lens review improvements call.</p>", 465 "refs": { 466 } 467 }, 468 "ListLensReviewsInput": { 469 "base": "<p>Input to list lens reviews.</p>", 470 "refs": { 471 } 472 }, 473 "ListLensReviewsOutput": { 474 "base": "<p>Output of a list lens reviews call.</p>", 475 "refs": { 476 } 477 }, 478 "ListLensesInput": { 479 "base": "<p>Input to list lenses.</p>", 480 "refs": { 481 } 482 }, 483 "ListLensesOutput": { 484 "base": "<p>Output of a list lenses call.</p>", 485 "refs": { 486 } 487 }, 488 "ListMilestonesInput": { 489 "base": "<p>Input to list all milestones for a workload.</p>", 490 "refs": { 491 } 492 }, 493 "ListMilestonesOutput": { 494 "base": "<p>Output of a list milestones call.</p>", 495 "refs": { 496 } 497 }, 498 "ListNotificationsInput": { 499 "base": null, 500 "refs": { 501 } 502 }, 503 "ListNotificationsMaxResults": { 504 "base": null, 505 "refs": { 506 "ListNotificationsInput$MaxResults": "<p>The maximum number of results to return for this request.</p>" 507 } 508 }, 509 "ListNotificationsOutput": { 510 "base": null, 511 "refs": { 512 } 513 }, 514 "ListShareInvitationsInput": { 515 "base": "<p>Input for List Share Invitations</p>", 516 "refs": { 517 } 518 }, 519 "ListShareInvitationsMaxResults": { 520 "base": null, 521 "refs": { 522 "ListShareInvitationsInput$MaxResults": "<p>The maximum number of results to return for this request.</p>" 523 } 524 }, 525 "ListShareInvitationsOutput": { 526 "base": "<p>Input for List Share Invitations</p>", 527 "refs": { 528 } 529 }, 530 "ListWorkloadSharesInput": { 531 "base": "<p>Input for List Workload Share</p>", 532 "refs": { 533 } 534 }, 535 "ListWorkloadSharesMaxResults": { 536 "base": null, 537 "refs": { 538 "ListWorkloadSharesInput$MaxResults": "<p>The maximum number of results to return for this request.</p>" 539 } 540 }, 541 "ListWorkloadSharesOutput": { 542 "base": "<p>Input for List Workload Share</p>", 543 "refs": { 544 } 545 }, 546 "ListWorkloadsInput": { 547 "base": "<p>Input to list all workloads.</p>", 548 "refs": { 549 } 550 }, 551 "ListWorkloadsMaxResults": { 552 "base": null, 553 "refs": { 554 "ListWorkloadsInput$MaxResults": "<p>The maximum number of results to return for this request.</p>" 555 } 556 }, 557 "ListWorkloadsOutput": { 558 "base": "<p>Output of a list workloads call.</p>", 559 "refs": { 560 } 561 }, 562 "MaxResults": { 563 "base": "<p>The maximum number of results to return for this request.</p>", 564 "refs": { 565 "ListLensReviewsInput$MaxResults": null, 566 "ListLensesInput$MaxResults": null, 567 "ListMilestonesInput$MaxResults": null 568 } 569 }, 570 "Milestone": { 571 "base": "<p>A milestone return object.</p>", 572 "refs": { 573 "GetMilestoneOutput$Milestone": null 574 } 575 }, 576 "MilestoneName": { 577 "base": "<p>The name of the milestone in a workload.</p> <p>Milestone names must be unique within a workload.</p>", 578 "refs": { 579 "CreateMilestoneInput$MilestoneName": null, 580 "Milestone$MilestoneName": null, 581 "MilestoneSummary$MilestoneName": null, 582 "UpgradeLensReviewInput$MilestoneName": null 583 } 584 }, 585 "MilestoneNumber": { 586 "base": "<p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>", 587 "refs": { 588 "CreateMilestoneOutput$MilestoneNumber": null, 589 "GetAnswerInput$MilestoneNumber": null, 590 "GetAnswerOutput$MilestoneNumber": null, 591 "GetLensReviewInput$MilestoneNumber": null, 592 "GetLensReviewOutput$MilestoneNumber": null, 593 "GetLensReviewReportInput$MilestoneNumber": null, 594 "GetLensReviewReportOutput$MilestoneNumber": null, 595 "GetMilestoneInput$MilestoneNumber": null, 596 "ListAnswersInput$MilestoneNumber": null, 597 "ListAnswersOutput$MilestoneNumber": null, 598 "ListLensReviewImprovementsInput$MilestoneNumber": null, 599 "ListLensReviewImprovementsOutput$MilestoneNumber": null, 600 "ListLensReviewsInput$MilestoneNumber": null, 601 "ListLensReviewsOutput$MilestoneNumber": null, 602 "Milestone$MilestoneNumber": null, 603 "MilestoneSummary$MilestoneNumber": null 604 } 605 }, 606 "MilestoneSummaries": { 607 "base": "<p>A list of milestone summaries.</p>", 608 "refs": { 609 "ListMilestonesOutput$MilestoneSummaries": null 610 } 611 }, 612 "MilestoneSummary": { 613 "base": "<p>A milestone summary return object.</p>", 614 "refs": { 615 "MilestoneSummaries$member": null 616 } 617 }, 618 "NextToken": { 619 "base": "<p>The token to use to retrieve the next set of results.</p>", 620 "refs": { 621 "LensReview$NextToken": null, 622 "ListAnswersInput$NextToken": null, 623 "ListAnswersOutput$NextToken": null, 624 "ListLensReviewImprovementsInput$NextToken": null, 625 "ListLensReviewImprovementsOutput$NextToken": null, 626 "ListLensReviewsInput$NextToken": null, 627 "ListLensReviewsOutput$NextToken": null, 628 "ListLensesInput$NextToken": null, 629 "ListLensesOutput$NextToken": null, 630 "ListMilestonesInput$NextToken": null, 631 "ListMilestonesOutput$NextToken": null, 632 "ListNotificationsInput$NextToken": null, 633 "ListNotificationsOutput$NextToken": null, 634 "ListShareInvitationsInput$NextToken": null, 635 "ListShareInvitationsOutput$NextToken": null, 636 "ListWorkloadSharesInput$NextToken": null, 637 "ListWorkloadSharesOutput$NextToken": null, 638 "ListWorkloadsInput$NextToken": null, 639 "ListWorkloadsOutput$NextToken": null 640 } 641 }, 642 "Notes": { 643 "base": "<p>The notes associated with the workload.</p>", 644 "refs": { 645 "Answer$Notes": null, 646 "CreateWorkloadInput$Notes": null, 647 "LensReview$Notes": null, 648 "PillarNotes$value": null, 649 "PillarReviewSummary$Notes": null, 650 "UpdateAnswerInput$Notes": null, 651 "UpdateLensReviewInput$LensNotes": null, 652 "UpdateWorkloadInput$Notes": null, 653 "Workload$Notes": null 654 } 655 }, 656 "NotificationSummaries": { 657 "base": null, 658 "refs": { 659 "ListNotificationsOutput$NotificationSummaries": "<p>List of lens notification summaries in a workload.</p>" 660 } 661 }, 662 "NotificationSummary": { 663 "base": "<p>A notification summary return object.</p>", 664 "refs": { 665 "NotificationSummaries$member": null 666 } 667 }, 668 "NotificationType": { 669 "base": null, 670 "refs": { 671 "NotificationSummary$Type": "<p>The type of notification.</p>" 672 } 673 }, 674 "PermissionType": { 675 "base": "<p>Permission granted on a workload share.</p>", 676 "refs": { 677 "CreateWorkloadShareInput$PermissionType": null, 678 "ShareInvitationSummary$PermissionType": null, 679 "UpdateWorkloadShareInput$PermissionType": null, 680 "WorkloadShare$PermissionType": null, 681 "WorkloadShareSummary$PermissionType": null 682 } 683 }, 684 "PillarDifference": { 685 "base": "<p>A pillar difference return object.</p>", 686 "refs": { 687 "PillarDifferences$member": null 688 } 689 }, 690 "PillarDifferences": { 691 "base": null, 692 "refs": { 693 "VersionDifferences$PillarDifferences": "<p>The differences between the base and latest versions of the lens.</p>" 694 } 695 }, 696 "PillarId": { 697 "base": "<p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>", 698 "refs": { 699 "Answer$PillarId": null, 700 "AnswerSummary$PillarId": null, 701 "ImprovementSummary$PillarId": null, 702 "ListAnswersInput$PillarId": null, 703 "ListLensReviewImprovementsInput$PillarId": null, 704 "PillarDifference$PillarId": null, 705 "PillarNotes$key": null, 706 "PillarReviewSummary$PillarId": null, 707 "WorkloadPillarPriorities$member": null 708 } 709 }, 710 "PillarName": { 711 "base": "<p>The name of the pillar.</p>", 712 "refs": { 713 "PillarReviewSummary$PillarName": null 714 } 715 }, 716 "PillarNotes": { 717 "base": "<p>List of pillar notes of a lens review in a workload.</p>", 718 "refs": { 719 "UpdateLensReviewInput$PillarNotes": null 720 } 721 }, 722 "PillarReviewSummaries": { 723 "base": "<p>List of pillar review summaries of lens review in a workload.</p>", 724 "refs": { 725 "LensReview$PillarReviewSummaries": null 726 } 727 }, 728 "PillarReviewSummary": { 729 "base": "<p>A pillar review summary of a lens review.</p>", 730 "refs": { 731 "PillarReviewSummaries$member": null 732 } 733 }, 734 "QuestionDescription": { 735 "base": "<p>The description of the question.</p>", 736 "refs": { 737 "Answer$QuestionDescription": null 738 } 739 }, 740 "QuestionDifference": { 741 "base": "<p>A question difference return object.</p>", 742 "refs": { 743 "QuestionDifferences$member": null 744 } 745 }, 746 "QuestionDifferences": { 747 "base": null, 748 "refs": { 749 "PillarDifference$QuestionDifferences": "<p>List of question differences.</p>" 750 } 751 }, 752 "QuestionId": { 753 "base": "<p>The ID of the question.</p>", 754 "refs": { 755 "Answer$QuestionId": null, 756 "AnswerSummary$QuestionId": null, 757 "GetAnswerInput$QuestionId": null, 758 "ImprovementSummary$QuestionId": null, 759 "QuestionDifference$QuestionId": null, 760 "UpdateAnswerInput$QuestionId": null 761 } 762 }, 763 "QuestionTitle": { 764 "base": "<p>The title of the question.</p>", 765 "refs": { 766 "Answer$QuestionTitle": null, 767 "AnswerSummary$QuestionTitle": null, 768 "ImprovementSummary$QuestionTitle": null, 769 "QuestionDifference$QuestionTitle": null 770 } 771 }, 772 "QuotaCode": { 773 "base": "<p>Service Quotas requirement to identify originating quota.</p>", 774 "refs": { 775 "ServiceQuotaExceededException$QuotaCode": null, 776 "ThrottlingException$QuotaCode": null 777 } 778 }, 779 "ResourceNotFoundException": { 780 "base": "<p>The requested resource was not found.</p>", 781 "refs": { 782 } 783 }, 784 "Risk": { 785 "base": "<p>The risk for a given workload, lens review, pillar, or question.</p>", 786 "refs": { 787 "Answer$Risk": null, 788 "AnswerSummary$Risk": null, 789 "ImprovementSummary$Risk": null, 790 "RiskCounts$key": null 791 } 792 }, 793 "RiskCounts": { 794 "base": "<p>A map from risk names to the count of how questions have that rating.</p>", 795 "refs": { 796 "LensReview$RiskCounts": null, 797 "LensReviewSummary$RiskCounts": null, 798 "PillarReviewSummary$RiskCounts": null, 799 "Workload$RiskCounts": null, 800 "WorkloadSummary$RiskCounts": null 801 } 802 }, 803 "SelectedChoices": { 804 "base": "<p>List of selected choice IDs in a question answer.</p> <p>The values entered replace the previously selected choices.</p>", 805 "refs": { 806 "Answer$SelectedChoices": null, 807 "AnswerSummary$SelectedChoices": null, 808 "UpdateAnswerInput$SelectedChoices": null 809 } 810 }, 811 "ServiceCode": { 812 "base": "<p>Service Quotas requirement to identify originating service.</p>", 813 "refs": { 814 "ServiceQuotaExceededException$ServiceCode": null, 815 "ThrottlingException$ServiceCode": null 816 } 817 }, 818 "ServiceQuotaExceededException": { 819 "base": "<p>The user has reached their resource quota.</p>", 820 "refs": { 821 } 822 }, 823 "ShareId": { 824 "base": "<p>The ID associated with the workload share.</p>", 825 "refs": { 826 "CreateWorkloadShareOutput$ShareId": null, 827 "DeleteWorkloadShareInput$ShareId": null, 828 "UpdateWorkloadShareInput$ShareId": null, 829 "WorkloadShare$ShareId": null, 830 "WorkloadShareSummary$ShareId": null 831 } 832 }, 833 "ShareInvitation": { 834 "base": "<p>The share invitation.</p>", 835 "refs": { 836 "UpdateShareInvitationOutput$ShareInvitation": "<p>The updated workload share invitation.</p>" 837 } 838 }, 839 "ShareInvitationAction": { 840 "base": "<p>Share invitation action taken by contributor.</p>", 841 "refs": { 842 "UpdateShareInvitationInput$ShareInvitationAction": null 843 } 844 }, 845 "ShareInvitationId": { 846 "base": null, 847 "refs": { 848 "ShareInvitation$ShareInvitationId": "<p>The ID assigned to the share invitation.</p>", 849 "ShareInvitationSummary$ShareInvitationId": "<p>The ID assigned to the share invitation.</p>", 850 "UpdateShareInvitationInput$ShareInvitationId": "<p>The ID assigned to the share invitation.</p>", 851 "Workload$ShareInvitationId": "<p>The ID assigned to the share invitation.</p>" 852 } 853 }, 854 "ShareInvitationSummaries": { 855 "base": null, 856 "refs": { 857 "ListShareInvitationsOutput$ShareInvitationSummaries": "<p>List of share invitation summaries in a workload.</p>" 858 } 859 }, 860 "ShareInvitationSummary": { 861 "base": "<p>A share invitation summary return object.</p>", 862 "refs": { 863 "ShareInvitationSummaries$member": null 864 } 865 }, 866 "ShareStatus": { 867 "base": "<p>The status of a workload share.</p>", 868 "refs": { 869 "WorkloadShare$Status": null, 870 "WorkloadShareSummary$Status": null 871 } 872 }, 873 "SharedWith": { 874 "base": "<p>The AWS account ID or IAM role with which the workload is shared.</p>", 875 "refs": { 876 "CreateWorkloadShareInput$SharedWith": null, 877 "ShareInvitationSummary$SharedWith": null, 878 "WorkloadShare$SharedWith": null, 879 "WorkloadShareSummary$SharedWith": null 880 } 881 }, 882 "SharedWithPrefix": { 883 "base": null, 884 "refs": { 885 "ListWorkloadSharesInput$SharedWithPrefix": "<p>The AWS account ID or IAM role with which the workload is shared.</p>" 886 } 887 }, 888 "ThrottlingException": { 889 "base": "<p>Request was denied due to request throttling.</p>", 890 "refs": { 891 } 892 }, 893 "Timestamp": { 894 "base": "<p>The date and time recorded.</p>", 895 "refs": { 896 "LensReview$UpdatedAt": null, 897 "LensReviewSummary$UpdatedAt": null, 898 "Milestone$RecordedAt": null, 899 "MilestoneSummary$RecordedAt": null, 900 "Workload$UpdatedAt": null, 901 "Workload$ReviewRestrictionDate": null, 902 "WorkloadSummary$UpdatedAt": null 903 } 904 }, 905 "UpdateAnswerInput": { 906 "base": "<p>Input to update answer.</p>", 907 "refs": { 908 } 909 }, 910 "UpdateAnswerOutput": { 911 "base": "<p>Output of a update answer call.</p>", 912 "refs": { 913 } 914 }, 915 "UpdateLensReviewInput": { 916 "base": "<p>Input for update lens review.</p>", 917 "refs": { 918 } 919 }, 920 "UpdateLensReviewOutput": { 921 "base": "<p>Output of a update lens review call.</p>", 922 "refs": { 923 } 924 }, 925 "UpdateShareInvitationInput": { 926 "base": "<p>Input for Update Share Invitation</p>", 927 "refs": { 928 } 929 }, 930 "UpdateShareInvitationOutput": { 931 "base": null, 932 "refs": { 933 } 934 }, 935 "UpdateWorkloadInput": { 936 "base": "<p>Input to update a workload.</p>", 937 "refs": { 938 } 939 }, 940 "UpdateWorkloadOutput": { 941 "base": "<p>Output of an update workload call.</p>", 942 "refs": { 943 } 944 }, 945 "UpdateWorkloadShareInput": { 946 "base": "<p>Input for Update Workload Share</p>", 947 "refs": { 948 } 949 }, 950 "UpdateWorkloadShareOutput": { 951 "base": "<p>Input for Update Workload Share</p>", 952 "refs": { 953 } 954 }, 955 "UpgradeLensReviewInput": { 956 "base": null, 957 "refs": { 958 } 959 }, 960 "ValidationException": { 961 "base": "<p>The user input is not valid.</p>", 962 "refs": { 963 } 964 }, 965 "ValidationExceptionField": { 966 "base": "<p>Stores information about a field passed inside a request that resulted in an exception.</p>", 967 "refs": { 968 "ValidationExceptionFieldList$member": null 969 } 970 }, 971 "ValidationExceptionFieldList": { 972 "base": "<p>The fields that caused the error, if applicable.</p>", 973 "refs": { 974 "ValidationException$Fields": null 975 } 976 }, 977 "ValidationExceptionFieldName": { 978 "base": "<p>The field name for which validation failed.</p>", 979 "refs": { 980 "ValidationExceptionField$Name": null 981 } 982 }, 983 "ValidationExceptionReason": { 984 "base": "<p>The reason why the request failed validation.</p>", 985 "refs": { 986 "ValidationException$Reason": null 987 } 988 }, 989 "VersionDifferences": { 990 "base": "<p>The differences between the base and latest versions of the lens.</p>", 991 "refs": { 992 "GetLensVersionDifferenceOutput$VersionDifferences": null 993 } 994 }, 995 "Workload": { 996 "base": "<p>A workload return object.</p>", 997 "refs": { 998 "GetWorkloadOutput$Workload": null, 999 "Milestone$Workload": null, 1000 "UpdateWorkloadOutput$Workload": null 1001 } 1002 }, 1003 "WorkloadAccountIds": { 1004 "base": "<p>The list of AWS account IDs associated with the workload.</p>", 1005 "refs": { 1006 "CreateWorkloadInput$AccountIds": null, 1007 "UpdateWorkloadInput$AccountIds": null, 1008 "Workload$AccountIds": null 1009 } 1010 }, 1011 "WorkloadArchitecturalDesign": { 1012 "base": "<p>The URL of the architectural design for the workload.</p>", 1013 "refs": { 1014 "CreateWorkloadInput$ArchitecturalDesign": null, 1015 "UpdateWorkloadInput$ArchitecturalDesign": null, 1016 "Workload$ArchitecturalDesign": null 1017 } 1018 }, 1019 "WorkloadArn": { 1020 "base": "<p>The ARN for the workload.</p>", 1021 "refs": { 1022 "CreateWorkloadOutput$WorkloadArn": null, 1023 "Workload$WorkloadArn": null, 1024 "WorkloadSummary$WorkloadArn": null 1025 } 1026 }, 1027 "WorkloadAwsRegions": { 1028 "base": "<p>The list of AWS Regions associated with the workload, for example, <code>us-east-2</code>, or <code>ca-central-1</code>.</p>", 1029 "refs": { 1030 "CreateWorkloadInput$AwsRegions": null, 1031 "UpdateWorkloadInput$AwsRegions": null, 1032 "Workload$AwsRegions": null 1033 } 1034 }, 1035 "WorkloadDescription": { 1036 "base": "<p>The description for the workload.</p>", 1037 "refs": { 1038 "CreateWorkloadInput$Description": null, 1039 "UpdateWorkloadInput$Description": null, 1040 "Workload$Description": null 1041 } 1042 }, 1043 "WorkloadEnvironment": { 1044 "base": "<p>The environment for the workload.</p>", 1045 "refs": { 1046 "CreateWorkloadInput$Environment": null, 1047 "UpdateWorkloadInput$Environment": null, 1048 "Workload$Environment": null 1049 } 1050 }, 1051 "WorkloadId": { 1052 "base": "<p>The ID assigned to the workload. This ID is unique within an AWS Region.</p>", 1053 "refs": { 1054 "AssociateLensesInput$WorkloadId": null, 1055 "CreateMilestoneInput$WorkloadId": null, 1056 "CreateMilestoneOutput$WorkloadId": null, 1057 "CreateWorkloadOutput$WorkloadId": null, 1058 "CreateWorkloadShareInput$WorkloadId": null, 1059 "CreateWorkloadShareOutput$WorkloadId": null, 1060 "DeleteWorkloadInput$WorkloadId": null, 1061 "DeleteWorkloadShareInput$WorkloadId": null, 1062 "DisassociateLensesInput$WorkloadId": null, 1063 "GetAnswerInput$WorkloadId": null, 1064 "GetAnswerOutput$WorkloadId": null, 1065 "GetLensReviewInput$WorkloadId": null, 1066 "GetLensReviewOutput$WorkloadId": null, 1067 "GetLensReviewReportInput$WorkloadId": null, 1068 "GetLensReviewReportOutput$WorkloadId": null, 1069 "GetMilestoneInput$WorkloadId": null, 1070 "GetMilestoneOutput$WorkloadId": null, 1071 "GetWorkloadInput$WorkloadId": null, 1072 "LensUpgradeSummary$WorkloadId": null, 1073 "ListAnswersInput$WorkloadId": null, 1074 "ListAnswersOutput$WorkloadId": null, 1075 "ListLensReviewImprovementsInput$WorkloadId": null, 1076 "ListLensReviewImprovementsOutput$WorkloadId": null, 1077 "ListLensReviewsInput$WorkloadId": null, 1078 "ListLensReviewsOutput$WorkloadId": null, 1079 "ListMilestonesInput$WorkloadId": null, 1080 "ListMilestonesOutput$WorkloadId": null, 1081 "ListNotificationsInput$WorkloadId": null, 1082 "ListWorkloadSharesInput$WorkloadId": null, 1083 "ListWorkloadSharesOutput$WorkloadId": null, 1084 "ShareInvitation$WorkloadId": null, 1085 "ShareInvitationSummary$WorkloadId": null, 1086 "UpdateAnswerInput$WorkloadId": null, 1087 "UpdateAnswerOutput$WorkloadId": null, 1088 "UpdateLensReviewInput$WorkloadId": null, 1089 "UpdateLensReviewOutput$WorkloadId": null, 1090 "UpdateWorkloadInput$WorkloadId": null, 1091 "UpdateWorkloadShareInput$WorkloadId": null, 1092 "UpdateWorkloadShareOutput$WorkloadId": null, 1093 "UpgradeLensReviewInput$WorkloadId": null, 1094 "Workload$WorkloadId": null, 1095 "WorkloadShare$WorkloadId": null, 1096 "WorkloadSummary$WorkloadId": null 1097 } 1098 }, 1099 "WorkloadImprovementStatus": { 1100 "base": "<p>The improvement status for a workload.</p>", 1101 "refs": { 1102 "UpdateWorkloadInput$ImprovementStatus": null, 1103 "Workload$ImprovementStatus": null, 1104 "WorkloadSummary$ImprovementStatus": null 1105 } 1106 }, 1107 "WorkloadIndustry": { 1108 "base": "<p>The industry for the workload.</p>", 1109 "refs": { 1110 "CreateWorkloadInput$Industry": null, 1111 "UpdateWorkloadInput$Industry": null, 1112 "Workload$Industry": null 1113 } 1114 }, 1115 "WorkloadIndustryType": { 1116 "base": "<p>The industry type for the workload.</p> <p>If specified, must be one of the following:</p> <ul> <li> <p> <code>Agriculture</code> </p> </li> <li> <p> <code>Automobile</code> </p> </li> <li> <p> <code>Defense</code> </p> </li> <li> <p> <code>Design and Engineering</code> </p> </li> <li> <p> <code>Digital Advertising</code> </p> </li> <li> <p> <code>Education</code> </p> </li> <li> <p> <code>Environmental Protection</code> </p> </li> <li> <p> <code>Financial Services</code> </p> </li> <li> <p> <code>Gaming</code> </p> </li> <li> <p> <code>General Public Services</code> </p> </li> <li> <p> <code>Healthcare</code> </p> </li> <li> <p> <code>Hospitality</code> </p> </li> <li> <p> <code>InfoTech</code> </p> </li> <li> <p> <code>Justice and Public Safety</code> </p> </li> <li> <p> <code>Life Sciences</code> </p> </li> <li> <p> <code>Manufacturing</code> </p> </li> <li> <p> <code>Media & Entertainment</code> </p> </li> <li> <p> <code>Mining & Resources</code> </p> </li> <li> <p> <code>Oil & Gas</code> </p> </li> <li> <p> <code>Power & Utilities</code> </p> </li> <li> <p> <code>Professional Services</code> </p> </li> <li> <p> <code>Real Estate & Construction</code> </p> </li> <li> <p> <code>Retail & Wholesale</code> </p> </li> <li> <p> <code>Social Protection</code> </p> </li> <li> <p> <code>Telecommunications</code> </p> </li> <li> <p> <code>Travel, Transportation & Logistics</code> </p> </li> <li> <p> <code>Other</code> </p> </li> </ul>", 1117 "refs": { 1118 "CreateWorkloadInput$IndustryType": null, 1119 "UpdateWorkloadInput$IndustryType": null, 1120 "Workload$IndustryType": null 1121 } 1122 }, 1123 "WorkloadLenses": { 1124 "base": "<p>The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>", 1125 "refs": { 1126 "CreateWorkloadInput$Lenses": null, 1127 "Workload$Lenses": null, 1128 "WorkloadSummary$Lenses": null 1129 } 1130 }, 1131 "WorkloadName": { 1132 "base": "<p>The name of the workload.</p> <p>The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.</p>", 1133 "refs": { 1134 "CreateWorkloadInput$WorkloadName": null, 1135 "LensUpgradeSummary$WorkloadName": null, 1136 "ShareInvitationSummary$WorkloadName": null, 1137 "UpdateWorkloadInput$WorkloadName": null, 1138 "Workload$WorkloadName": null, 1139 "WorkloadShare$WorkloadName": null, 1140 "WorkloadSummary$WorkloadName": null 1141 } 1142 }, 1143 "WorkloadNamePrefix": { 1144 "base": "<p>An optional string added to the beginning of each workload name returned in the results.</p>", 1145 "refs": { 1146 "ListShareInvitationsInput$WorkloadNamePrefix": null, 1147 "ListWorkloadsInput$WorkloadNamePrefix": null 1148 } 1149 }, 1150 "WorkloadNonAwsRegion": { 1151 "base": null, 1152 "refs": { 1153 "WorkloadNonAwsRegions$member": null 1154 } 1155 }, 1156 "WorkloadNonAwsRegions": { 1157 "base": "<p> The list of non-AWS Regions associated with the workload.</p>", 1158 "refs": { 1159 "CreateWorkloadInput$NonAwsRegions": null, 1160 "UpdateWorkloadInput$NonAwsRegions": null, 1161 "Workload$NonAwsRegions": null 1162 } 1163 }, 1164 "WorkloadPillarPriorities": { 1165 "base": "<p>The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its <a>PillarReviewSummary$PillarId</a>.</p>", 1166 "refs": { 1167 "CreateWorkloadInput$PillarPriorities": null, 1168 "UpdateWorkloadInput$PillarPriorities": null, 1169 "Workload$PillarPriorities": null 1170 } 1171 }, 1172 "WorkloadReviewOwner": { 1173 "base": "<p>The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.</p>", 1174 "refs": { 1175 "CreateWorkloadInput$ReviewOwner": null, 1176 "UpdateWorkloadInput$ReviewOwner": null, 1177 "Workload$ReviewOwner": null 1178 } 1179 }, 1180 "WorkloadShare": { 1181 "base": "<p>A workload share return object.</p>", 1182 "refs": { 1183 "UpdateWorkloadShareOutput$WorkloadShare": null 1184 } 1185 }, 1186 "WorkloadShareSummaries": { 1187 "base": "<p>A list of workload share summaries.</p>", 1188 "refs": { 1189 "ListWorkloadSharesOutput$WorkloadShareSummaries": null 1190 } 1191 }, 1192 "WorkloadShareSummary": { 1193 "base": "<p>A workload share summary return object.</p>", 1194 "refs": { 1195 "WorkloadShareSummaries$member": null 1196 } 1197 }, 1198 "WorkloadSummaries": { 1199 "base": "<p>A list of workload summaries.</p>", 1200 "refs": { 1201 "ListWorkloadsOutput$WorkloadSummaries": null 1202 } 1203 }, 1204 "WorkloadSummary": { 1205 "base": "<p>A workload summary return object.</p>", 1206 "refs": { 1207 "MilestoneSummary$WorkloadSummary": null, 1208 "WorkloadSummaries$member": null 1209 } 1210 } 1211 } 1212} 1213