{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.wellarchitected#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

User does not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.wellarchitected#Answer": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "QuestionDescription": { "target": "com.amazonaws.wellarchitected#QuestionDescription" }, "ImprovementPlanUrl": { "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" }, "HelpfulResourceUrl": { "target": "com.amazonaws.wellarchitected#HelpfulResourceUrl" }, "Choices": { "target": "com.amazonaws.wellarchitected#Choices" }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" }, "Risk": { "target": "com.amazonaws.wellarchitected#Risk" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" } }, "traits": { "smithy.api#documentation": "

An answer of the question.

" } }, "com.amazonaws.wellarchitected#AnswerSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AnswerSummary" }, "traits": { "smithy.api#documentation": "

List of answer summaries of lens review in a workload.

" } }, "com.amazonaws.wellarchitected#AnswerSummary": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "Choices": { "target": "com.amazonaws.wellarchitected#Choices" }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" }, "Risk": { "target": "com.amazonaws.wellarchitected#Risk" } }, "traits": { "smithy.api#documentation": "

An answer summary of a lens review in a workload.

" } }, "com.amazonaws.wellarchitected#AssociateLenses": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#AssociateLensesInput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Associate a lens to a workload.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/associateLenses", "code": 200 } } }, "com.amazonaws.wellarchitected#AssociateLensesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAliases": { "target": "com.amazonaws.wellarchitected#LensAliases", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input to associate lens reviews.

" } }, "com.amazonaws.wellarchitected#AwsAccountId": { "type": "string", "traits": { "smithy.api#documentation": "

An AWS account ID.

", "smithy.api#pattern": "[0-9]{12}" } }, "com.amazonaws.wellarchitected#AwsRegion": { "type": "string", "traits": { "smithy.api#documentation": "

An AWS Region, for example, us-west-2 or\n ap-northeast-1.

", "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.wellarchitected#Base64String": { "type": "string", "traits": { "smithy.api#documentation": "

The Base64-encoded string representation of a lens review report.

\n

This data can be used to create a PDF file.

" } }, "com.amazonaws.wellarchitected#Choice": { "type": "structure", "members": { "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "Title": { "target": "com.amazonaws.wellarchitected#ChoiceTitle" }, "Description": { "target": "com.amazonaws.wellarchitected#ChoiceDescription" } }, "traits": { "smithy.api#documentation": "

A choice available to answer question.

" } }, "com.amazonaws.wellarchitected#ChoiceDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description of a choice.

", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#ChoiceId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID of a choice.

", "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.wellarchitected#ChoiceTitle": { "type": "string", "traits": { "smithy.api#documentation": "

The title of a choice.

", "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.wellarchitected#Choices": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Choice" }, "traits": { "smithy.api#documentation": "

List of choices available for a question.

" } }, "com.amazonaws.wellarchitected#ClientRequestToken": { "type": "string", "traits": { "smithy.api#documentation": "

A unique case-sensitive string used to ensure that this request is idempotent\n (executes only once).

\n

You should not reuse the same token for other requests. If you retry a request with\n the same client request token and the same parameters after it has completed\n successfully, the result of the original request is returned.

\n \n

This token is listed as required, however, if you do not specify it, the AWS SDKs\n automatically generate one for you. If you are not using the AWS SDK or the AWS CLI,\n you must provide this token or the request will fail.

\n " } }, "com.amazonaws.wellarchitected#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.wellarchitected#ExceptionResourceId", "traits": { "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.wellarchitected#ExceptionResourceType", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The resource already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.wellarchitected#Count": { "type": "integer", "traits": { "smithy.api#documentation": "

A non-negative integer that denotes how many.

", "smithy.api#range": { "min": 0 } } }, "com.amazonaws.wellarchitected#CreateMilestone": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateMilestoneInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateMilestoneOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a milestone for an existing workload.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/milestones", "code": 200 } } }, "com.amazonaws.wellarchitected#CreateMilestoneInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName", "traits": { "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for milestone creation.

" } }, "com.amazonaws.wellarchitected#CreateMilestoneOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" } }, "traits": { "smithy.api#documentation": "

Output of a create milestone call.

" } }, "com.amazonaws.wellarchitected#CreateWorkload": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateWorkloadInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateWorkloadOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a new workload.

\n

The owner of a workload can share the workload with other AWS accounts and IAM users\n in the same AWS Region. Only the owner of a workload can delete it.

\n

For more information, see Defining a Workload in the\n AWS Well-Architected Tool User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/workloads", "code": 200 } } }, "com.amazonaws.wellarchitected#CreateWorkloadInput": { "type": "structure", "members": { "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName", "traits": { "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.wellarchitected#WorkloadDescription", "traits": { "smithy.api#required": {} } }, "Environment": { "target": "com.amazonaws.wellarchitected#WorkloadEnvironment", "traits": { "smithy.api#required": {} } }, "AccountIds": { "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" }, "AwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" }, "NonAwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" }, "PillarPriorities": { "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" }, "ArchitecturalDesign": { "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" }, "ReviewOwner": { "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner", "traits": { "smithy.api#required": {} } }, "IndustryType": { "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" }, "Industry": { "target": "com.amazonaws.wellarchitected#WorkloadIndustry" }, "Lenses": { "target": "com.amazonaws.wellarchitected#WorkloadLenses", "traits": { "smithy.api#required": {} } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags to be associated with the workload.

" } } }, "traits": { "smithy.api#documentation": "

Input for workload creation.

" } }, "com.amazonaws.wellarchitected#CreateWorkloadOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn" } }, "traits": { "smithy.api#documentation": "

Output of a create workload call.

" } }, "com.amazonaws.wellarchitected#CreateWorkloadShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateWorkloadShareInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateWorkloadShareOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a workload share.

\n

The owner of a workload can share it with other AWS accounts and IAM users in the same\n AWS Region. Shared access to a workload is not removed until the workload invitation is\n deleted.

\n

For more information, see Sharing a Workload in the\n AWS Well-Architected Tool User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/shares", "code": 200 } } }, "com.amazonaws.wellarchitected#CreateWorkloadShareInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith", "traits": { "smithy.api#required": {} } }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType", "traits": { "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for Create Workload Share

" } }, "com.amazonaws.wellarchitected#CreateWorkloadShareOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" } }, "traits": { "smithy.api#documentation": "

Input for Create Workload Share

" } }, "com.amazonaws.wellarchitected#DeleteWorkload": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete an existing workload.

", "smithy.api#http": { "method": "DELETE", "uri": "/workloads/{WorkloadId}", "code": 200 } } }, "com.amazonaws.wellarchitected#DeleteWorkloadInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for workload deletion.

" } }, "com.amazonaws.wellarchitected#DeleteWorkloadShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a workload share.

", "smithy.api#http": { "method": "DELETE", "uri": "/workloads/{WorkloadId}/shares/{ShareId}", "code": 200 } } }, "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for Delete Workload Share

" } }, "com.amazonaws.wellarchitected#DifferenceStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "UPDATED", "name": "UPDATED" }, { "value": "NEW", "name": "NEW" }, { "value": "DELETED", "name": "DELETED" } ] } }, "com.amazonaws.wellarchitected#DisassociateLenses": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Disassociate a lens from a workload.

\n \n

The AWS Well-Architected Framework lens (wellarchitected) cannot be\n removed from a workload.

\n ", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/disassociateLenses", "code": 200 } } }, "com.amazonaws.wellarchitected#DisassociateLensesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAliases": { "target": "com.amazonaws.wellarchitected#LensAliases", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input to disassociate lens reviews.

" } }, "com.amazonaws.wellarchitected#ExceptionMessage": { "type": "string", "traits": { "smithy.api#documentation": "

Description of the error.

" } }, "com.amazonaws.wellarchitected#ExceptionResourceId": { "type": "string", "traits": { "smithy.api#documentation": "

Identifier of the resource affected.

" } }, "com.amazonaws.wellarchitected#ExceptionResourceType": { "type": "string", "traits": { "smithy.api#documentation": "

Type of the resource affected.

" } }, "com.amazonaws.wellarchitected#GetAnswer": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAnswerInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetAnswerOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get lens review.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", "code": 200 } } }, "com.amazonaws.wellarchitected#GetAnswerInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } } }, "traits": { "smithy.api#documentation": "

Input to get answer.

" } }, "com.amazonaws.wellarchitected#GetAnswerOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "Answer": { "target": "com.amazonaws.wellarchitected#Answer" } }, "traits": { "smithy.api#documentation": "

Output of a get answer call.

" } }, "com.amazonaws.wellarchitected#GetLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetLensReviewInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetLensReviewOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get lens review.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", "code": 200 } } }, "com.amazonaws.wellarchitected#GetLensReviewInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } } }, "traits": { "smithy.api#documentation": "

Input to get lens review.

" } }, "com.amazonaws.wellarchitected#GetLensReviewOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensReview": { "target": "com.amazonaws.wellarchitected#LensReview" } }, "traits": { "smithy.api#documentation": "

Output of a get lens review call.

" } }, "com.amazonaws.wellarchitected#GetLensReviewReport": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetLensReviewReportInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetLensReviewReportOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get lens review report.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/report", "code": 200 } } }, "com.amazonaws.wellarchitected#GetLensReviewReportInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } } }, "traits": { "smithy.api#documentation": "

Input to get lens review report.

" } }, "com.amazonaws.wellarchitected#GetLensReviewReportOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensReviewReport": { "target": "com.amazonaws.wellarchitected#LensReviewReport" } }, "traits": { "smithy.api#documentation": "

Output of a get lens review report call.

" } }, "com.amazonaws.wellarchitected#GetLensVersionDifference": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get lens version differences.

", "smithy.api#http": { "method": "GET", "uri": "/lenses/{LensAlias}/versionDifference", "code": 200 } } }, "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BaseLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The base version of the lens.

", "smithy.api#httpQuery": "BaseLensVersion", "smithy.api#required": {} } } } }, "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "BaseLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The base version of the lens.

" } }, "LatestLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The latest version of the lens.

" } }, "VersionDifferences": { "target": "com.amazonaws.wellarchitected#VersionDifferences" } } }, "com.amazonaws.wellarchitected#GetMilestone": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetMilestoneInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetMilestoneOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get a milestone for an existing workload.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/milestones/{MilestoneNumber}", "code": 200 } } }, "com.amazonaws.wellarchitected#GetMilestoneInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input to get a milestone.

" } }, "com.amazonaws.wellarchitected#GetMilestoneOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "Milestone": { "target": "com.amazonaws.wellarchitected#Milestone" } }, "traits": { "smithy.api#documentation": "

Output of a get milestone call.

" } }, "com.amazonaws.wellarchitected#GetWorkload": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetWorkloadInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get an existing workload.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}", "code": 200 } } }, "com.amazonaws.wellarchitected#GetWorkloadInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input to get a workload.

" } }, "com.amazonaws.wellarchitected#GetWorkloadOutput": { "type": "structure", "members": { "Workload": { "target": "com.amazonaws.wellarchitected#Workload" } }, "traits": { "smithy.api#documentation": "

Output of a get workload call.

" } }, "com.amazonaws.wellarchitected#HelpfulResourceUrl": { "type": "string", "traits": { "smithy.api#documentation": "

The helpful resource URL for a question.

", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.wellarchitected#ImprovementPlanUrl": { "type": "string", "traits": { "smithy.api#documentation": "

The improvement plan URL for a question.

", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.wellarchitected#ImprovementSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ImprovementSummary" }, "traits": { "smithy.api#documentation": "

List of improvement summaries of lens review in a workload.

" } }, "com.amazonaws.wellarchitected#ImprovementSummary": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "Risk": { "target": "com.amazonaws.wellarchitected#Risk" }, "ImprovementPlanUrl": { "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" } }, "traits": { "smithy.api#documentation": "

An improvement summary of a lens review in a workload.

" } }, "com.amazonaws.wellarchitected#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

There is a problem with the AWS Well-Architected Tool API service.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.wellarchitected#IsApplicable": { "type": "boolean", "traits": { "smithy.api#documentation": "

Defines whether this question is applicable to a lens review.

" } }, "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged": { "type": "boolean" }, "com.amazonaws.wellarchitected#LensAlias": { "type": "string", "traits": { "smithy.api#documentation": "

The alias of the lens, for example, serverless.

\n

Each lens is identified by its LensSummary$LensAlias.

", "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.wellarchitected#LensAliases": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "traits": { "smithy.api#documentation": "

List of lens aliases to associate or disassociate with a workload.

\n

Identify a lens using its LensSummary$LensAlias.

", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.wellarchitected#LensDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description of the lens.

", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#LensName": { "type": "string", "traits": { "smithy.api#documentation": "

The full name of the lens.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#LensReview": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of the lens.

" } }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName" }, "LensStatus": { "target": "com.amazonaws.wellarchitected#LensStatus", "traits": { "smithy.api#documentation": "

The status of the lens.

" } }, "PillarReviewSummaries": { "target": "com.amazonaws.wellarchitected#PillarReviewSummaries" }, "UpdatedAt": { "target": "com.amazonaws.wellarchitected#Timestamp" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

A lens review of a question.

" } }, "com.amazonaws.wellarchitected#LensReviewReport": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "Base64String": { "target": "com.amazonaws.wellarchitected#Base64String" } }, "traits": { "smithy.api#documentation": "

A report of a lens review.

" } }, "com.amazonaws.wellarchitected#LensReviewSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensReviewSummary" }, "traits": { "smithy.api#documentation": "

List of lens summaries of lens reviews of a workload.

" } }, "com.amazonaws.wellarchitected#LensReviewSummary": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of the lens.

" } }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName" }, "LensStatus": { "target": "com.amazonaws.wellarchitected#LensStatus", "traits": { "smithy.api#documentation": "

The status of the lens.

" } }, "UpdatedAt": { "target": "com.amazonaws.wellarchitected#Timestamp" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { "smithy.api#documentation": "

A lens review summary of a workload.

" } }, "com.amazonaws.wellarchitected#LensStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CURRENT", "name": "CURRENT" }, { "value": "NOT_CURRENT", "name": "NOT_CURRENT" }, { "value": "DEPRECATED", "name": "DEPRECATED" } ] } }, "com.amazonaws.wellarchitected#LensSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensSummary" }, "traits": { "smithy.api#documentation": "

List of lens summaries of available lenses.

" } }, "com.amazonaws.wellarchitected#LensSummary": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of the lens.

" } }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName" }, "Description": { "target": "com.amazonaws.wellarchitected#LensDescription" } }, "traits": { "smithy.api#documentation": "

A lens summary of a lens.

" } }, "com.amazonaws.wellarchitected#LensUpgradeSummary": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "CurrentLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The current version of the lens.

" } }, "LatestLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The latest version of the lens.

" } } }, "traits": { "smithy.api#documentation": "

Lens upgrade summary return object.

" } }, "com.amazonaws.wellarchitected#LensVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#ListAnswers": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAnswersInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListAnswersOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List of answers.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListAnswersInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId", "traits": { "smithy.api#httpQuery": "PillarId" } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#ListAnswersMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults" } } }, "traits": { "smithy.api#documentation": "

Input to list answers.

" } }, "com.amazonaws.wellarchitected#ListAnswersMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#ListAnswersOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "AnswerSummaries": { "target": "com.amazonaws.wellarchitected#AnswerSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list answers call.

" } }, "com.amazonaws.wellarchitected#ListLensReviewImprovements": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List lens review improvements.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId", "traits": { "smithy.api#httpQuery": "PillarId" } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults" } } }, "traits": { "smithy.api#documentation": "

Input to list lens review improvements.

" } }, "com.amazonaws.wellarchitected#ListLensReviewImprovementsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "ImprovementSummaries": { "target": "com.amazonaws.wellarchitected#ImprovementSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list lens review improvements call.

" } }, "com.amazonaws.wellarchitected#ListLensReviews": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListLensReviewsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListLensReviewsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List lens reviews.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListLensReviewsInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#httpQuery": "MaxResults" } } }, "traits": { "smithy.api#documentation": "

Input to list lens reviews.

" } }, "com.amazonaws.wellarchitected#ListLensReviewsOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensReviewSummaries": { "target": "com.amazonaws.wellarchitected#LensReviewSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list lens reviews call.

" } }, "com.amazonaws.wellarchitected#ListLenses": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListLensesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListLensesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the available lenses.

", "smithy.api#http": { "method": "GET", "uri": "/lenses", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListLensesInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#httpQuery": "MaxResults" } } }, "traits": { "smithy.api#documentation": "

Input to list lenses.

" } }, "com.amazonaws.wellarchitected#ListLensesOutput": { "type": "structure", "members": { "LensSummaries": { "target": "com.amazonaws.wellarchitected#LensSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list lenses call.

" } }, "com.amazonaws.wellarchitected#ListMilestones": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListMilestonesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListMilestonesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List all milestones for an existing workload.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/milestonesSummaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListMilestonesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults" } }, "traits": { "smithy.api#documentation": "

Input to list all milestones for a workload.

" } }, "com.amazonaws.wellarchitected#ListMilestonesOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneSummaries": { "target": "com.amazonaws.wellarchitected#MilestoneSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list milestones call.

" } }, "com.amazonaws.wellarchitected#ListNotifications": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListNotificationsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListNotificationsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List lens notifications.

", "smithy.api#http": { "method": "POST", "uri": "/notifications", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListNotificationsInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "MaxResults": { "target": "com.amazonaws.wellarchitected#ListNotificationsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

" } } } }, "com.amazonaws.wellarchitected#ListNotificationsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#ListNotificationsOutput": { "type": "structure", "members": { "NotificationSummaries": { "target": "com.amazonaws.wellarchitected#NotificationSummaries", "traits": { "smithy.api#documentation": "

List of lens notification summaries in a workload.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } } }, "com.amazonaws.wellarchitected#ListShareInvitations": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the workload invitations.

", "smithy.api#http": { "method": "GET", "uri": "/shareInvitations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListShareInvitationsInput": { "type": "structure", "members": { "WorkloadNamePrefix": { "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix", "traits": { "smithy.api#httpQuery": "WorkloadNamePrefix" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults" } } }, "traits": { "smithy.api#documentation": "

Input for List Share Invitations

" } }, "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { "type": "structure", "members": { "ShareInvitationSummaries": { "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", "traits": { "smithy.api#documentation": "

List of share invitation summaries in a workload.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Input for List Share Invitations

" } }, "com.amazonaws.wellarchitected#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

List the tags for a resource.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{WorkloadArn}", "code": 200 } } }, "com.amazonaws.wellarchitected#ListTagsForResourceInput": { "type": "structure", "members": { "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.wellarchitected#ListTagsForResourceOutput": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags for the resource.

" } } } }, "com.amazonaws.wellarchitected#ListWorkloadShares": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the workload shares associated with the workload.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/shares", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListWorkloadSharesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWithPrefix": { "target": "com.amazonaws.wellarchitected#SharedWithPrefix", "traits": { "smithy.api#documentation": "

The AWS account ID or IAM role with which the workload is shared.

", "smithy.api#httpQuery": "SharedWithPrefix" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults" } } }, "traits": { "smithy.api#documentation": "

Input for List Workload Share

" } }, "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadShareSummaries": { "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Input for List Workload Share

" } }, "com.amazonaws.wellarchitected#ListWorkloads": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List workloads. Paginated.

", "smithy.api#http": { "method": "POST", "uri": "/workloadsSummaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.wellarchitected#ListWorkloadsInput": { "type": "structure", "members": { "WorkloadNamePrefix": { "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "MaxResults": { "target": "com.amazonaws.wellarchitected#ListWorkloadsMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

" } } }, "traits": { "smithy.api#documentation": "

Input to list all workloads.

" } }, "com.amazonaws.wellarchitected#ListWorkloadsMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#ListWorkloadsOutput": { "type": "structure", "members": { "WorkloadSummaries": { "target": "com.amazonaws.wellarchitected#WorkloadSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list workloads call.

" } }, "com.amazonaws.wellarchitected#MaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#range": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#Milestone": { "type": "structure", "members": { "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName" }, "RecordedAt": { "target": "com.amazonaws.wellarchitected#Timestamp" }, "Workload": { "target": "com.amazonaws.wellarchitected#Workload" } }, "traits": { "smithy.api#documentation": "

A milestone return object.

" } }, "com.amazonaws.wellarchitected#MilestoneName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of the milestone in a workload.

\n

Milestone names must be unique within a workload.

", "smithy.api#length": { "min": 3, "max": 100 } } }, "com.amazonaws.wellarchitected#MilestoneNumber": { "type": "integer", "traits": { "smithy.api#documentation": "

The milestone number.

\n

A workload can have a maximum of 100 milestones.

", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.wellarchitected#MilestoneSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#MilestoneSummary" }, "traits": { "smithy.api#documentation": "

A list of milestone summaries.

" } }, "com.amazonaws.wellarchitected#MilestoneSummary": { "type": "structure", "members": { "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName" }, "RecordedAt": { "target": "com.amazonaws.wellarchitected#Timestamp" }, "WorkloadSummary": { "target": "com.amazonaws.wellarchitected#WorkloadSummary" } }, "traits": { "smithy.api#documentation": "

A milestone summary return object.

" } }, "com.amazonaws.wellarchitected#NextToken": { "type": "string", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next set of results.

" } }, "com.amazonaws.wellarchitected#Notes": { "type": "string", "traits": { "smithy.api#documentation": "

The notes associated with the workload.

", "smithy.api#length": { "min": 0, "max": 2084 } } }, "com.amazonaws.wellarchitected#NotificationSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#NotificationSummary" } }, "com.amazonaws.wellarchitected#NotificationSummary": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.wellarchitected#NotificationType", "traits": { "smithy.api#documentation": "

The type of notification.

" } }, "LensUpgradeSummary": { "target": "com.amazonaws.wellarchitected#LensUpgradeSummary", "traits": { "smithy.api#documentation": "

Summary of lens upgrade.

" } } }, "traits": { "smithy.api#documentation": "

A notification summary return object.

" } }, "com.amazonaws.wellarchitected#NotificationType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "LENS_VERSION_UPGRADED", "name": "LENS_VERSION_UPGRADED" }, { "value": "LENS_VERSION_DEPRECATED", "name": "LENS_VERSION_DEPRECATED" } ] } }, "com.amazonaws.wellarchitected#PermissionType": { "type": "string", "traits": { "smithy.api#documentation": "

Permission granted on a workload share.

", "smithy.api#enum": [ { "value": "READONLY", "name": "READONLY" }, { "value": "CONTRIBUTOR", "name": "CONTRIBUTOR" } ] } }, "com.amazonaws.wellarchitected#PillarDifference": { "type": "structure", "members": { "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "DifferenceStatus": { "target": "com.amazonaws.wellarchitected#DifferenceStatus", "traits": { "smithy.api#documentation": "

Indicates the type of change to the pillar.

" } }, "QuestionDifferences": { "target": "com.amazonaws.wellarchitected#QuestionDifferences", "traits": { "smithy.api#documentation": "

List of question differences.

" } } }, "traits": { "smithy.api#documentation": "

A pillar difference return object.

" } }, "com.amazonaws.wellarchitected#PillarDifferences": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarDifference" } }, "com.amazonaws.wellarchitected#PillarId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID used to identify a pillar, for example, security.

\n

A pillar is identified by its PillarReviewSummary$PillarId.

", "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.wellarchitected#PillarName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of the pillar.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#PillarNotes": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#PillarId" }, "value": { "target": "com.amazonaws.wellarchitected#Notes" }, "traits": { "smithy.api#documentation": "

List of pillar notes of a lens review in a workload.

" } }, "com.amazonaws.wellarchitected#PillarReviewSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarReviewSummary" }, "traits": { "smithy.api#documentation": "

List of pillar review summaries of lens review in a workload.

" } }, "com.amazonaws.wellarchitected#PillarReviewSummary": { "type": "structure", "members": { "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "PillarName": { "target": "com.amazonaws.wellarchitected#PillarName" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { "smithy.api#documentation": "

A pillar review summary of a lens review.

" } }, "com.amazonaws.wellarchitected#QuestionDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description of the question.

", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#QuestionDifference": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "DifferenceStatus": { "target": "com.amazonaws.wellarchitected#DifferenceStatus", "traits": { "smithy.api#documentation": "

Indicates the type of change to the question.

" } } }, "traits": { "smithy.api#documentation": "

A question difference return object.

" } }, "com.amazonaws.wellarchitected#QuestionDifferences": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#QuestionDifference" } }, "com.amazonaws.wellarchitected#QuestionId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID of the question.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#QuestionTitle": { "type": "string", "traits": { "smithy.api#documentation": "

The title of the question.

", "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.wellarchitected#QuotaCode": { "type": "string", "traits": { "smithy.api#documentation": "

Service Quotas requirement to identify originating quota.

" } }, "com.amazonaws.wellarchitected#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.wellarchitected#ExceptionResourceId", "traits": { "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.wellarchitected#ExceptionResourceType", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The requested resource was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.wellarchitected#Risk": { "type": "string", "traits": { "smithy.api#documentation": "

The risk for a given workload, lens review, pillar, or question.

", "smithy.api#enum": [ { "value": "UNANSWERED", "name": "UNANSWERED" }, { "value": "HIGH", "name": "HIGH" }, { "value": "MEDIUM", "name": "MEDIUM" }, { "value": "NONE", "name": "NONE" }, { "value": "NOT_APPLICABLE", "name": "NOT_APPLICABLE" } ] } }, "com.amazonaws.wellarchitected#RiskCounts": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#Risk" }, "value": { "target": "com.amazonaws.wellarchitected#Count" }, "traits": { "smithy.api#documentation": "

A map from risk names to the count of how questions have that rating.

" } }, "com.amazonaws.wellarchitected#SelectedChoices": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "traits": { "smithy.api#documentation": "

List of selected choice IDs in a question answer.

\n

The values entered replace the previously selected choices.

" } }, "com.amazonaws.wellarchitected#ServiceCode": { "type": "string", "traits": { "smithy.api#documentation": "

Service Quotas requirement to identify originating service.

" } }, "com.amazonaws.wellarchitected#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.wellarchitected#ExceptionResourceId" }, "ResourceType": { "target": "com.amazonaws.wellarchitected#ExceptionResourceType" }, "QuotaCode": { "target": "com.amazonaws.wellarchitected#QuotaCode", "traits": { "smithy.api#required": {} } }, "ServiceCode": { "target": "com.amazonaws.wellarchitected#ServiceCode", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The user has reached their resource quota.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.wellarchitected#ShareId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID associated with the workload share.

", "smithy.api#pattern": "[0-9a-f]{32}" } }, "com.amazonaws.wellarchitected#ShareInvitation": { "type": "structure", "members": { "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" } }, "traits": { "smithy.api#documentation": "

The share invitation.

" } }, "com.amazonaws.wellarchitected#ShareInvitationAction": { "type": "string", "traits": { "smithy.api#documentation": "

Share invitation action taken by contributor.

", "smithy.api#enum": [ { "value": "ACCEPT", "name": "ACCEPT" }, { "value": "REJECT", "name": "REJECT" } ] } }, "com.amazonaws.wellarchitected#ShareInvitationId": { "type": "string", "traits": { "smithy.api#pattern": "[0-9a-f]{32}" } }, "com.amazonaws.wellarchitected#ShareInvitationSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ShareInvitationSummary" } }, "com.amazonaws.wellarchitected#ShareInvitationSummary": { "type": "structure", "members": { "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } }, "SharedBy": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" } }, "traits": { "smithy.api#documentation": "

A share invitation summary return object.

" } }, "com.amazonaws.wellarchitected#ShareStatus": { "type": "string", "traits": { "smithy.api#documentation": "

The status of a workload share.

", "smithy.api#enum": [ { "value": "ACCEPTED", "name": "ACCEPTED" }, { "value": "REJECTED", "name": "REJECTED" }, { "value": "PENDING", "name": "PENDING" }, { "value": "REVOKED", "name": "REVOKED" }, { "value": "EXPIRED", "name": "EXPIRED" } ] } }, "com.amazonaws.wellarchitected#SharedWith": { "type": "string", "traits": { "smithy.api#documentation": "

The AWS account ID or IAM role with which the workload is shared.

", "smithy.api#length": { "min": 12, "max": 2048 } } }, "com.amazonaws.wellarchitected#SharedWithPrefix": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.wellarchitected#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#TagMap": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#TagKey" }, "value": { "target": "com.amazonaws.wellarchitected#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#TagResourceInput" }, "output": { "target": "com.amazonaws.wellarchitected#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Adds one or more tags to the specified resource.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{WorkloadArn}", "code": 200 } } }, "com.amazonaws.wellarchitected#TagResourceInput": { "type": "structure", "members": { "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags for the resource.

", "smithy.api#required": {} } } } }, "com.amazonaws.wellarchitected#TagResourceOutput": { "type": "structure", "members": {} }, "com.amazonaws.wellarchitected#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.wellarchitected#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.wellarchitected#QuotaCode" }, "ServiceCode": { "target": "com.amazonaws.wellarchitected#ServiceCode" } }, "traits": { "smithy.api#documentation": "

Request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.wellarchitected#Timestamp": { "type": "timestamp", "traits": { "smithy.api#documentation": "

The date and time recorded.

" } }, "com.amazonaws.wellarchitected#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UntagResourceInput" }, "output": { "target": "com.amazonaws.wellarchitected#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes specified tags from a resource.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{WorkloadArn}", "code": 200 } } }, "com.amazonaws.wellarchitected#UntagResourceInput": { "type": "structure", "members": { "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.wellarchitected#TagKeyList", "traits": { "smithy.api#documentation": "

The keys of the tags to be removed.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.wellarchitected#UntagResourceOutput": { "type": "structure", "members": {} }, "com.amazonaws.wellarchitected#UpdateAnswer": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateAnswerInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateAnswerOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update the answer to a specific question in a workload review.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", "code": 200 } } }, "com.amazonaws.wellarchitected#UpdateAnswerInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" } }, "traits": { "smithy.api#documentation": "

Input to update answer.

" } }, "com.amazonaws.wellarchitected#UpdateAnswerOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "Answer": { "target": "com.amazonaws.wellarchitected#Answer" } }, "traits": { "smithy.api#documentation": "

Output of a update answer call.

" } }, "com.amazonaws.wellarchitected#UpdateLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateLensReviewInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateLensReviewOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update lens review.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", "code": 200 } } }, "com.amazonaws.wellarchitected#UpdateLensReviewInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensNotes": { "target": "com.amazonaws.wellarchitected#Notes" }, "PillarNotes": { "target": "com.amazonaws.wellarchitected#PillarNotes" } }, "traits": { "smithy.api#documentation": "

Input for update lens review.

" } }, "com.amazonaws.wellarchitected#UpdateLensReviewOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "LensReview": { "target": "com.amazonaws.wellarchitected#LensReview" } }, "traits": { "smithy.api#documentation": "

Output of a update lens review call.

" } }, "com.amazonaws.wellarchitected#UpdateShareInvitation": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateShareInvitationInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateShareInvitationOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a workload invitation.

", "smithy.api#http": { "method": "PATCH", "uri": "/shareInvitations/{ShareInvitationId}", "code": 200 } } }, "com.amazonaws.wellarchitected#UpdateShareInvitationInput": { "type": "structure", "members": { "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ShareInvitationAction": { "target": "com.amazonaws.wellarchitected#ShareInvitationAction", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for Update Share Invitation

" } }, "com.amazonaws.wellarchitected#UpdateShareInvitationOutput": { "type": "structure", "members": { "ShareInvitation": { "target": "com.amazonaws.wellarchitected#ShareInvitation", "traits": { "smithy.api#documentation": "

The updated workload share invitation.

" } } } }, "com.amazonaws.wellarchitected#UpdateWorkload": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateWorkloadInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateWorkloadOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update an existing workload.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}", "code": 200 } } }, "com.amazonaws.wellarchitected#UpdateWorkloadInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "Description": { "target": "com.amazonaws.wellarchitected#WorkloadDescription" }, "Environment": { "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" }, "AccountIds": { "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" }, "AwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" }, "NonAwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" }, "PillarPriorities": { "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" }, "ArchitecturalDesign": { "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" }, "ReviewOwner": { "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" }, "IsReviewOwnerUpdateAcknowledged": { "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", "traits": { "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review\n owner field is required.

\n

If a Review owner is not added to the workload within\n 60 days of acknowledgement, access to the workload is restricted until an owner is\n added.

" } }, "IndustryType": { "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" }, "Industry": { "target": "com.amazonaws.wellarchitected#WorkloadIndustry" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "ImprovementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" } }, "traits": { "smithy.api#documentation": "

Input to update a workload.

" } }, "com.amazonaws.wellarchitected#UpdateWorkloadOutput": { "type": "structure", "members": { "Workload": { "target": "com.amazonaws.wellarchitected#Workload" } }, "traits": { "smithy.api#documentation": "

Output of an update workload call.

" } }, "com.amazonaws.wellarchitected#UpdateWorkloadShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a workload share.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/shares/{ShareId}", "code": 200 } } }, "com.amazonaws.wellarchitected#UpdateWorkloadShareInput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for Update Workload Share

" } }, "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadShare": { "target": "com.amazonaws.wellarchitected#WorkloadShare" } }, "traits": { "smithy.api#documentation": "

Input for Update Workload Share

" } }, "com.amazonaws.wellarchitected#UpgradeLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpgradeLensReviewInput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Upgrade lens review.

", "smithy.api#http": { "method": "PUT", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade", "code": 200 } } }, "com.amazonaws.wellarchitected#UpgradeLensReviewInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName", "traits": { "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken" } } }, "com.amazonaws.wellarchitected#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.wellarchitected#ValidationExceptionReason" }, "Fields": { "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldList" } }, "traits": { "smithy.api#documentation": "

The user input is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.wellarchitected#ValidationExceptionField": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldName", "traits": { "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Stores information about a field passed inside a request that resulted in an exception.

" } }, "com.amazonaws.wellarchitected#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ValidationExceptionField" }, "traits": { "smithy.api#documentation": "

The fields that caused the error, if applicable.

" } }, "com.amazonaws.wellarchitected#ValidationExceptionFieldName": { "type": "string", "traits": { "smithy.api#documentation": "

The field name for which validation failed.

" } }, "com.amazonaws.wellarchitected#ValidationExceptionReason": { "type": "string", "traits": { "smithy.api#documentation": "

The reason why the request failed validation.

", "smithy.api#enum": [ { "value": "UNKNOWN_OPERATION", "name": "UNKNOWN_OPERATION" }, { "value": "CANNOT_PARSE", "name": "CANNOT_PARSE" }, { "value": "FIELD_VALIDATION_FAILED", "name": "FIELD_VALIDATION_FAILED" }, { "value": "OTHER", "name": "OTHER" } ] } }, "com.amazonaws.wellarchitected#VersionDifferences": { "type": "structure", "members": { "PillarDifferences": { "target": "com.amazonaws.wellarchitected#PillarDifferences", "traits": { "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" } } }, "traits": { "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" } }, "com.amazonaws.wellarchitected#WellArchitectedApiServiceLambda": { "type": "service", "version": "2020-03-31", "operations": [ { "target": "com.amazonaws.wellarchitected#AssociateLenses" }, { "target": "com.amazonaws.wellarchitected#CreateMilestone" }, { "target": "com.amazonaws.wellarchitected#CreateWorkload" }, { "target": "com.amazonaws.wellarchitected#CreateWorkloadShare" }, { "target": "com.amazonaws.wellarchitected#DeleteWorkload" }, { "target": "com.amazonaws.wellarchitected#DeleteWorkloadShare" }, { "target": "com.amazonaws.wellarchitected#DisassociateLenses" }, { "target": "com.amazonaws.wellarchitected#GetAnswer" }, { "target": "com.amazonaws.wellarchitected#GetLensReview" }, { "target": "com.amazonaws.wellarchitected#GetLensReviewReport" }, { "target": "com.amazonaws.wellarchitected#GetLensVersionDifference" }, { "target": "com.amazonaws.wellarchitected#GetMilestone" }, { "target": "com.amazonaws.wellarchitected#GetWorkload" }, { "target": "com.amazonaws.wellarchitected#ListAnswers" }, { "target": "com.amazonaws.wellarchitected#ListLenses" }, { "target": "com.amazonaws.wellarchitected#ListLensReviewImprovements" }, { "target": "com.amazonaws.wellarchitected#ListLensReviews" }, { "target": "com.amazonaws.wellarchitected#ListMilestones" }, { "target": "com.amazonaws.wellarchitected#ListNotifications" }, { "target": "com.amazonaws.wellarchitected#ListShareInvitations" }, { "target": "com.amazonaws.wellarchitected#ListTagsForResource" }, { "target": "com.amazonaws.wellarchitected#ListWorkloads" }, { "target": "com.amazonaws.wellarchitected#ListWorkloadShares" }, { "target": "com.amazonaws.wellarchitected#TagResource" }, { "target": "com.amazonaws.wellarchitected#UntagResource" }, { "target": "com.amazonaws.wellarchitected#UpdateAnswer" }, { "target": "com.amazonaws.wellarchitected#UpdateLensReview" }, { "target": "com.amazonaws.wellarchitected#UpdateShareInvitation" }, { "target": "com.amazonaws.wellarchitected#UpdateWorkload" }, { "target": "com.amazonaws.wellarchitected#UpdateWorkloadShare" }, { "target": "com.amazonaws.wellarchitected#UpgradeLensReview" } ], "traits": { "aws.api#service": { "sdkId": "WellArchitected", "arnNamespace": "wellarchitected", "cloudFormationName": "WellArchitected", "cloudTrailEventSource": "wellarchitected.amazonaws.com", "endpointPrefix": "wellarchitected" }, "aws.auth#sigv4": { "name": "wellarchitected" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "AWS Well-Architected Tool\n \n

This is the AWS Well-Architected Tool API Reference. The AWS Well-Architected Tool API provides programmatic access to the \n AWS Well-Architected Tool in the \n AWS Management Console. For information \n about the AWS Well-Architected Tool, see the \n AWS Well-Architected Tool User Guide.

", "smithy.api#title": "AWS Well-Architected Tool" } }, "com.amazonaws.wellarchitected#Workload": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "Description": { "target": "com.amazonaws.wellarchitected#WorkloadDescription" }, "Environment": { "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" }, "UpdatedAt": { "target": "com.amazonaws.wellarchitected#Timestamp" }, "AccountIds": { "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" }, "AwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" }, "NonAwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" }, "ArchitecturalDesign": { "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" }, "ReviewOwner": { "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" }, "ReviewRestrictionDate": { "target": "com.amazonaws.wellarchitected#Timestamp" }, "IsReviewOwnerUpdateAcknowledged": { "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", "traits": { "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review\n owner field is required.

\n

If a Review owner is not added to the workload within\n 60 days of acknowledgement, access to the workload is restricted until an owner is\n added.

" } }, "IndustryType": { "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" }, "Industry": { "target": "com.amazonaws.wellarchitected#WorkloadIndustry" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "ImprovementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "PillarPriorities": { "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" }, "Lenses": { "target": "com.amazonaws.wellarchitected#WorkloadLenses" }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the workload.

" } } }, "traits": { "smithy.api#documentation": "

A workload return object.

" } }, "com.amazonaws.wellarchitected#WorkloadAccountIds": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "traits": { "smithy.api#documentation": "

The list of AWS account IDs associated with the workload.

", "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign": { "type": "string", "traits": { "smithy.api#documentation": "

The URL of the architectural design for the workload.

", "smithy.api#length": { "min": 0, "max": 2048 } } }, "com.amazonaws.wellarchitected#WorkloadArn": { "type": "string", "traits": { "smithy.api#documentation": "

The ARN for the workload.

" } }, "com.amazonaws.wellarchitected#WorkloadAwsRegions": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AwsRegion" }, "traits": { "smithy.api#documentation": "

The list of AWS Regions associated with the workload, for example,\n us-east-2, or ca-central-1.

", "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.wellarchitected#WorkloadDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description for the workload.

", "smithy.api#length": { "min": 3, "max": 250 } } }, "com.amazonaws.wellarchitected#WorkloadEnvironment": { "type": "string", "traits": { "smithy.api#documentation": "

The environment for the workload.

", "smithy.api#enum": [ { "value": "PRODUCTION", "name": "PRODUCTION" }, { "value": "PREPRODUCTION", "name": "PREPRODUCTION" } ] } }, "com.amazonaws.wellarchitected#WorkloadId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID assigned to the workload. This ID is unique within an AWS Region.

", "smithy.api#pattern": "[0-9a-f]{32}" } }, "com.amazonaws.wellarchitected#WorkloadImprovementStatus": { "type": "string", "traits": { "smithy.api#documentation": "

The improvement status for a workload.

", "smithy.api#enum": [ { "value": "NOT_APPLICABLE", "name": "NOT_APPLICABLE" }, { "value": "NOT_STARTED", "name": "NOT_STARTED" }, { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "COMPLETE", "name": "COMPLETE" }, { "value": "RISK_ACKNOWLEDGED", "name": "RISK_ACKNOWLEDGED" } ] } }, "com.amazonaws.wellarchitected#WorkloadIndustry": { "type": "string", "traits": { "smithy.api#documentation": "

The industry for the workload.

", "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadIndustryType": { "type": "string", "traits": { "smithy.api#documentation": "

The industry type for the workload.

\n

If specified, must be one of the following:

\n ", "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadLenses": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "traits": { "smithy.api#documentation": "

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

" } }, "com.amazonaws.wellarchitected#WorkloadName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of the workload.

\n

The name must be unique within an account within a Region. Spaces and capitalization\n are ignored when checking for uniqueness.

", "smithy.api#length": { "min": 3, "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadNamePrefix": { "type": "string", "traits": { "smithy.api#documentation": "

An optional string added to the beginning of each workload name returned in the\n results.

", "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadNonAwsRegion": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 25 } } }, "com.amazonaws.wellarchitected#WorkloadNonAwsRegions": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegion" }, "traits": { "smithy.api#documentation": "

The list of non-AWS Regions associated with the workload.

", "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.wellarchitected#WorkloadPillarPriorities": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarId" }, "traits": { "smithy.api#documentation": "

The priorities of the pillars, which are used to order items in the improvement plan.\n Each pillar is represented by its PillarReviewSummary$PillarId.

" } }, "com.amazonaws.wellarchitected#WorkloadReviewOwner": { "type": "string", "traits": { "smithy.api#documentation": "

The review owner of the workload. The name, email address, or identifier for the\n primary group or individual that owns the workload review process.

", "smithy.api#length": { "min": 3, "max": 255 } } }, "com.amazonaws.wellarchitected#WorkloadShare": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" }, "SharedBy": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType" }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" } }, "traits": { "smithy.api#documentation": "

A workload share return object.

" } }, "com.amazonaws.wellarchitected#WorkloadShareSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#WorkloadShareSummary" }, "traits": { "smithy.api#documentation": "

A list of workload share summaries.

" } }, "com.amazonaws.wellarchitected#WorkloadShareSummary": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType" }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus" } }, "traits": { "smithy.api#documentation": "

A workload share summary return object.

" } }, "com.amazonaws.wellarchitected#WorkloadSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#WorkloadSummary" }, "traits": { "smithy.api#documentation": "

A list of workload summaries.

" } }, "com.amazonaws.wellarchitected#WorkloadSummary": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "UpdatedAt": { "target": "com.amazonaws.wellarchitected#Timestamp" }, "Lenses": { "target": "com.amazonaws.wellarchitected#WorkloadLenses" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "ImprovementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" } }, "traits": { "smithy.api#documentation": "

A workload summary return object.

" } } } }