Amazon Well-Architected Tool Workloads API is one of 13 APIs that Amazon Well-Architected Tool publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Workloads. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, pricing, a JSON-LD context, and 1 JSON Schema.
This API exposes
27 operations
across 23 paths,
and defines 143 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://wellarchitected.{region}.amazonaws.com, https://wellarchitected.{region}.amazonaws.com, http://wellarchitected.{region}.amazonaws.com.cn, https://wellarchitected.{region}.amazonaws.com.cn.
The identity and technical contract details declared by the specification.
TrustedAdvisorIntegrationStatus
string
HelpfulResourceUrl
string
The helpful resource URL. For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the he…
PillarReviewSummaries
array
List of pillar review summaries of lens review in a workload.
AnswerSummary
object
An answer summary of a lens review in a workload.
10 properties
PillarName
string
The name of the pillar.
RiskCounts
object
A map from risk names to the count of how many questions have that rating.
MilestoneNumber
integer
The milestone number. A workload can have a maximum of 100 milestones.
CreateWorkloadOutput
object
Output of a create workload call.
2 properties
WorkloadEnvironment
string
The environment for the workload.
ShareId
string
The ID associated with the share.
WorkloadResourceDefinition
array
ListWorkloadSharesOutput
object
Input for List Workload Share
3 properties
LensReviewSummary
object
A lens review summary of a workload.
9 properties
SelectedChoices
array
List of selected choice IDs in a question answer. The values entered replace the previously selected choices.
CreateMilestoneOutput
object
Output of a create milestone call.
2 properties
Answer
object
An answer of the question.
14 properties
AwsAccountId
string
An Amazon Web Services account ID.
WorkloadName
string
The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking f…
Workload
object
A workload return object.
27 properties
GetMilestoneOutput
object
Output of a get milestone call.
2 properties
WorkloadNonAwsRegion
string
ChoiceId
string
The ID of a choice.
WorkloadDiscoveryConfig
object
Discovery configuration associated to the workload.
2 properties
NextToken
string
The token to use to retrieve the next set of results.
ImprovementSummary
object
An improvement summary of a lens review in a workload.
6 properties
UpdateWorkloadShareOutput
object
Input for Update Workload Share
2 properties
AdditionalResources
object
The choice level additional resources for a custom lens. This field does not apply to Amazon Web Services official lenses.
2 properties
WorkloadShareSummaries
array
A list of workload share summaries.
AnswerSummaries
array
List of answer summaries of lens review in a workload.
WorkloadReviewOwner
string
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
WorkloadShare
object
A workload share return object.
7 properties
UpdateAnswerOutput
object
Output of a update answer call.
4 properties
ListCheckDetailsOutput
object
2 properties
CheckSummary
object
Trusted Advisor check summary.
11 properties
Count
integer
A non-negative integer that denotes how many.
WorkloadArn
string
The ARN for the workload.
ChoiceAnswer
object
A choice that has been answered on a question in your workload.
4 properties
WorkloadShareSummary
object
A workload share summary return object.
5 properties
ChoiceContentDisplayText
string
AwsRegion
string
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
ShareStatus
string
The status of the share request.
ChoiceTitle
string
The title of a choice.
SharedWith
string
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
WorkloadAccountIds
array
The list of Amazon Web Services account IDs associated with the workload.
ServiceQuotaExceededException
Notes
string
The notes associated with the workload.
ChoiceAnswerSummaries
array
CheckFailureReason
string
CheckDetail
object
Account details for a Well-Architected best practice in relation to Trusted Advisor checks.
13 properties
GetLensReviewOutput
object
Output of a get lens review call.
3 properties
PillarId
string
The ID used to identify a pillar, for example, security . A pillar is identified by its PillarReviewSummary$PillarId .
ResourceNotFoundException
IsApplicable
boolean
Defines whether this question is applicable to a lens review.
WorkloadDescription
string
The description for the workload.
WorkloadProfile
object
The profile associated with a workload.
2 properties
WorkloadApplications
array
UpdateWorkloadOutput
object
Output of an update workload call.
1 property
MilestoneSummaries
array
A list of milestone summaries.
QuestionId
string
The ID of the question.
WorkloadArchitecturalDesign
string
The URL of the architectural design for the workload.
WorkloadImprovementStatus
string
The improvement status for a workload.
LensReviewReport
object
A report of a lens review.
3 properties
Choices
array
List of choices available for a question.
WorkloadLenses
array
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias .
ListCheckSummariesOutput
object
2 properties
WorkloadPillarPriorities
array
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId .
QuestionTitle
string
The title of the question.
WorkloadSummary
object
A workload summary return object.
10 properties
AdditionalResourceType
string
ImprovementPlanUrl
string
The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value d…
GetLensReviewReportOutput
object
Output of a get lens review report call.
3 properties
CreateWorkloadShareOutput
object
Input for Create Workload Share
2 properties
PermissionType
string
Permission granted on a share request.
QuestionDescription
string
The description of the question.
ChoiceImprovementPlans
array
UpdateLensReviewOutput
object
Output of a update lens review call.
2 properties
ChoiceAnswerSummary
object
A choice summary that has been answered on a question in your workload.
3 properties
LensReviewSummaries
array
List of lens summaries of lens reviews of a workload.
Base64String
string
The Base64-encoded string representation of a lens review report. This data can be used to create a PDF file. Only returned by GetConsolidatedReport when PDF f…
LensName
string
The full name of the lens.
MilestoneSummary
object
A milestone summary return object.
4 properties
LensReview
object
A lens review of a question.
12 properties
ChoiceContent
object
The choice content.
2 properties
GetWorkloadOutput
object
Output of a get workload call.
1 property
ListMilestonesOutput
object
Output of a list milestones call.
3 properties
WorkloadIndustry
string
The industry for the workload.
IsReviewOwnerUpdateAcknowledged
boolean
AccountSummary
object
Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.
ChoiceImprovementPlan
object
The choice level improvement plan.
3 properties
PillarReviewSummary
object
A pillar review summary of a lens review.
5 properties
ListAnswersOutput
object
Output of a list answers call.
6 properties
MilestoneName
string
The name of the milestone in a workload. Milestone names must be unique within a workload.
WorkloadAwsRegions
array
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
Milestone
object
A milestone return object.
4 properties
ChoiceUpdate
object
A list of choices to be updated.
3 properties
1 required
WorkloadId
string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadNonAwsRegions
array
The list of non-Amazon Web Services Regions associated with the workload.
Risk
string
The risk for a given workload, lens review, pillar, or question.
GetAnswerOutput
object
Output of a get answer call.
5 properties
WorkloadIndustryType
string
The industry type for the workload. If specified, must be one of the following: Agriculture Automobile Defense Design and Engineering Digital Advertising Educa…
ListLensReviewImprovementsOutput
object
Output of a list lens review improvements call.
6 properties
Timestamp
string
The date and time recorded.
Choice
object
A choice available to answer question.
6 properties
ChoiceDescription
string
The description of a choice.
LensAlias
string
The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchit…
ListLensReviewsOutput
object
Output of a list lens reviews call.
4 properties
AdditionalResourcesList
array
ImprovementSummaries
array
List of improvement summaries of lens review in a workload.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon Well-Architected Tool publishes across the network.
