@datafire/amazonaws_wellarchitected v5.0.0

@datafire/amazonaws_wellarchitected

Client library for AWS Well-Architected Tool

Installation and Usage

npm install --save @datafire/amazonaws_wellarchitected

let amazonaws_wellarchitected = require('@datafire/amazonaws_wellarchitected').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS Well-Architected Tool This is the AWS Well-Architected Tool API Reference. The AWS Well-Architected Tool API provides programmatic access to the AWS Well-Architected Tool in the AWS Management Console. Managing workloads: CreateWorkload: Define a new workload. ListWorkloads: List workloads. GetWorkload: Get the properties of a workload. UpdateWorkload: Update the properties of a workload. DeleteWorkload: Delete a workload. Managing milestones: CreateMilestone: Create a milestone. ListMilestones: List milestones. GetMilestone: Get the properties of a milestone. Managing lenses: ListLenses: List the available lenses. AssociateLenses: Add one or more lenses to a workload. DisassociateLenses: Remove one or more lenses from a workload. ListNotifications: List lens notifications for a workload. GetLensVersionDifference: Get the differences between the version of a lens used in a workload and the latest version. UpgradeLensReview: Upgrade a workload to use the latest version of a lens. Managing reviews: ListLensReviews: List reviews associated with a workload. GetLensReview: Get pillar and risk data associated with a workload review. GetLensReviewReport: Get the report associated with a workload review. UpdateLensReview: Update the notes associated with a workload review. ListAnswers: List the questions and answers in a workload review. UpdateAnswer: Update the answer to a specific question in a workload review. ListLensReviewImprovements: List the improvement plan associated with a workload review. Managing workload shares: ListWorkloadShares: List the workload shares associated with a workload. CreateWorkloadShare: Create a workload share. UpdateWorkloadShare: Update a workload share. DeleteWorkloadShare: Delete a workload share. Managing workload share invitations: ListShareInvitations: List workload share invitations. UpdateShareInvitation: Update a workload share invitation. For information about the AWS Well-Architected Tool, see the AWS Well-Architected Tool User Guide.

Actions

ListLenses

amazonaws_wellarchitected.ListLenses({}, context)

Input

• input object
  • NextToken string
  • MaxResults integer

Output

• output ListLensesOutput

GetLensVersionDifference

amazonaws_wellarchitected.GetLensVersionDifference({
  "LensAlias": "",
  "BaseLensVersion": ""
}, context)

Input

• input object
  • LensAlias required string
  • BaseLensVersion required string

Output

• output GetLensVersionDifferenceOutput

ListNotifications

amazonaws_wellarchitected.ListNotifications({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults integer: The maximum number of results to return for this request.
  • NextToken string: The token to use to retrieve the next set of results.
  • WorkloadId string: The ID assigned to the workload. This ID is unique within an AWS Region.

Output

• output ListNotificationsOutput

ListShareInvitations

amazonaws_wellarchitected.ListShareInvitations({}, context)

Input

• input object
  • WorkloadNamePrefix string
  • NextToken string
  • MaxResults integer

Output

• output ListShareInvitationsOutput

UpdateShareInvitation

amazonaws_wellarchitected.UpdateShareInvitation({
  "ShareInvitationId": "",
  "ShareInvitationAction": ""
}, context)

Input

• input object
  • ShareInvitationId required string
  • ShareInvitationAction required string (values: ACCEPT, REJECT): Share invitation action taken by contributor.

Output

• output UpdateShareInvitationOutput

CreateWorkload

amazonaws_wellarchitected.CreateWorkload({
  "WorkloadName": "",
  "Description": "",
  "Environment": "",
  "ReviewOwner": "",
  "Lenses": [],
  "ClientRequestToken": ""
}, context)

Input

• input object
  • AccountIds array: The list of AWS account IDs associated with the workload.
    • items AwsAccountId
  • ArchitecturalDesign string: The URL of the architectural design for the workload.
  • AwsRegions array: The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
    • items AwsRegion
  • ClientRequestToken required string: A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned. This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.
  • Description required string: The description for the workload.
  • Environment required string (values: PRODUCTION, PREPRODUCTION): The environment for the workload.
  • Industry string: The industry for the workload.
  • IndustryType string: The industry type for the workload. If specified, must be one of the following: Agriculture Automobile Defense Design and Engineering Digital Advertising Education Environmental Protection Financial Services Gaming General Public Services Healthcare Hospitality InfoTech Justice and Public Safety Life Sciences Manufacturing Media & Entertainment Mining & Resources Oil & Gas Power & Utilities Professional Services Real Estate & Construction Retail & Wholesale Social Protection Telecommunications Travel, Transportation & Logistics Other
  • Lenses required array: The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
    • items LensAlias
  • NonAwsRegions array: The list of non-AWS Regions associated with the workload.
    • items WorkloadNonAwsRegion
  • Notes string: The notes associated with the workload.
  • PillarPriorities array: The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
    • items PillarId
  • ReviewOwner required 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.
  • WorkloadName required string: The name of the workload. The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

Output

• output CreateWorkloadOutput

GetWorkload

amazonaws_wellarchitected.GetWorkload({
  "WorkloadId": ""
}, context)

Input

• input object
  • WorkloadId required string

Output

• output GetWorkloadOutput

UpdateWorkload

amazonaws_wellarchitected.UpdateWorkload({
  "WorkloadId": ""
}, context)

Input

• input object
  • WorkloadId required string
  • AccountIds array: The list of AWS account IDs associated with the workload.
    • items AwsAccountId
  • ArchitecturalDesign string: The URL of the architectural design for the workload.
  • AwsRegions array: The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
    • items AwsRegion
  • Description string: The description for the workload.
  • Environment string (values: PRODUCTION, PREPRODUCTION): The environment for the workload.
  • ImprovementStatus string (values: NOT_APPLICABLE, NOT_STARTED, IN_PROGRESS, COMPLETE, RISK_ACKNOWLEDGED): The improvement status for a workload.
  • Industry string: The industry for the workload.
  • IndustryType string: The industry type for the workload. If specified, must be one of the following: Agriculture Automobile Defense Design and Engineering Digital Advertising Education Environmental Protection Financial Services Gaming General Public Services Healthcare Hospitality InfoTech Justice and Public Safety Life Sciences Manufacturing Media & Entertainment Mining & Resources Oil & Gas Power & Utilities Professional Services Real Estate & Construction Retail & Wholesale Social Protection Telecommunications Travel, Transportation & Logistics Other
  • IsReviewOwnerUpdateAcknowledged boolean: Flag indicating whether the workload owner has acknowledged that the Review owner field is required. If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
  • NonAwsRegions array: The list of non-AWS Regions associated with the workload.
    • items WorkloadNonAwsRegion
  • Notes string: The notes associated with the workload.
  • PillarPriorities array: The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
    • items PillarId
  • ReviewOwner 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.
  • WorkloadName string: The name of the workload. The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

Output

• output UpdateWorkloadOutput

DeleteWorkload

amazonaws_wellarchitected.DeleteWorkload({
  "WorkloadId": "",
  "ClientRequestToken": ""
}, context)

Input

• input object
  • WorkloadId required string
  • ClientRequestToken required string

Output

Output schema unknown

AssociateLenses

amazonaws_wellarchitected.AssociateLenses({
  "WorkloadId": "",
  "LensAliases": []
}, context)

Input

• input object
  • WorkloadId required string
  • LensAliases required array: List of lens aliases to associate or disassociate with a workload. Identify a lens using its LensSummary$LensAlias.
    • items LensAlias

Output

Output schema unknown

DisassociateLenses

amazonaws_wellarchitected.DisassociateLenses({
  "WorkloadId": "",
  "LensAliases": []
}, context)

Input

• input object
  • WorkloadId required string
  • LensAliases required array: List of lens aliases to associate or disassociate with a workload. Identify a lens using its LensSummary$LensAlias.
    • items LensAlias

Output

Output schema unknown

ListLensReviews

amazonaws_wellarchitected.ListLensReviews({
  "WorkloadId": ""
}, context)

Input

• input object
  • WorkloadId required string
  • MilestoneNumber integer
  • NextToken string
  • MaxResults integer

Output

• output ListLensReviewsOutput

GetLensReview

amazonaws_wellarchitected.GetLensReview({
  "WorkloadId": "",
  "LensAlias": ""
}, context)

Input

• input object
  • WorkloadId required string
  • LensAlias required string
  • MilestoneNumber integer

Output

• output GetLensReviewOutput

UpdateLensReview

amazonaws_wellarchitected.UpdateLensReview({
  "WorkloadId": "",
  "LensAlias": ""
}, context)

Input

• input object
  • WorkloadId required string
  • LensAlias required string
  • LensNotes string: The notes associated with the workload.
  • PillarNotes object: List of pillar notes of a lens review in a workload.

Output

• output UpdateLensReviewOutput

ListAnswers

amazonaws_wellarchitected.ListAnswers({
  "WorkloadId": "",
  "LensAlias": ""
}, context)

Input

• input object
  • WorkloadId required string
  • LensAlias required string
  • PillarId string
  • MilestoneNumber integer
  • NextToken string
  • MaxResults integer

Output

• output ListAnswersOutput

GetAnswer

amazonaws_wellarchitected.GetAnswer({
  "WorkloadId": "",
  "LensAlias": "",
  "QuestionId": ""
}, context)

Input

• input object
  • WorkloadId required string
  • LensAlias required string
  • QuestionId required string
  • MilestoneNumber integer

Output

• output GetAnswerOutput

UpdateAnswer

amazonaws_wellarchitected.UpdateAnswer({
  "WorkloadId": "",
  "LensAlias": "",
  "QuestionId": ""
}, context)

Input

• input object
  • WorkloadId required string
  • LensAlias required string
  • QuestionId required string
  • IsApplicable boolean: Defines whether this question is applicable to a lens review.
  • Notes string: The notes associated with the workload.
  • SelectedChoices array: List of selected choice IDs in a question answer.
    • items ChoiceId

Output

• output UpdateAnswerOutput

ListLensReviewImprovements

amazonaws_wellarchitected.ListLensReviewImprovements({
  "WorkloadId": "",
  "LensAlias": ""
}, context)

Input

• input object
  • WorkloadId required string
  • LensAlias required string
  • PillarId string
  • MilestoneNumber integer
  • NextToken string
  • MaxResults integer

Output

• output ListLensReviewImprovementsOutput

GetLensReviewReport

amazonaws_wellarchitected.GetLensReviewReport({
  "WorkloadId": "",
  "LensAlias": ""
}, context)

Input

• input object
  • WorkloadId required string
  • LensAlias required string
  • MilestoneNumber integer

Output

• output GetLensReviewReportOutput

UpgradeLensReview

amazonaws_wellarchitected.UpgradeLensReview({
  "WorkloadId": "",
  "LensAlias": "",
  "MilestoneName": ""
}, context)

Input

• input object
  • WorkloadId required string
  • LensAlias required string
  • ClientRequestToken string: A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned. This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.
  • MilestoneName required string: The name of the milestone in a workload. Milestone names must be unique within a workload.

Output

Output schema unknown

CreateMilestone

amazonaws_wellarchitected.CreateMilestone({
  "WorkloadId": "",
  "MilestoneName": "",
  "ClientRequestToken": ""
}, context)

Input

• input object
  • WorkloadId required string
  • ClientRequestToken required string: A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned. This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.
  • MilestoneName required string: The name of the milestone in a workload. Milestone names must be unique within a workload.

Output

• output CreateMilestoneOutput

GetMilestone

amazonaws_wellarchitected.GetMilestone({
  "WorkloadId": "",
  "MilestoneNumber": 0
}, context)

Input

• input object
  • WorkloadId required string
  • MilestoneNumber required integer

Output

• output GetMilestoneOutput

ListMilestones

amazonaws_wellarchitected.ListMilestones({
  "WorkloadId": ""
}, context)

Input

• input object
  • WorkloadId required string
  • MaxResults string
  • NextToken string
  • MaxResults integer: The maximum number of results to return for this request.
  • NextToken string: The token to use to retrieve the next set of results.

Output

• output ListMilestonesOutput

ListWorkloadShares

amazonaws_wellarchitected.ListWorkloadShares({
  "WorkloadId": ""
}, context)

Input

• input object
  • WorkloadId required string
  • SharedWithPrefix string
  • NextToken string
  • MaxResults integer

Output

• output ListWorkloadSharesOutput

CreateWorkloadShare

amazonaws_wellarchitected.CreateWorkloadShare({
  "WorkloadId": "",
  "SharedWith": "",
  "PermissionType": "",
  "ClientRequestToken": ""
}, context)

Input

• input object
  • WorkloadId required string
  • ClientRequestToken required string: A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned. This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.
  • PermissionType required string (values: READONLY, CONTRIBUTOR): Permission granted on a workload share.
  • SharedWith required string: The AWS account ID or IAM role with which the workload is shared.

Output

• output CreateWorkloadShareOutput

UpdateWorkloadShare

amazonaws_wellarchitected.UpdateWorkloadShare({
  "ShareId": "",
  "WorkloadId": "",
  "PermissionType": ""
}, context)

Input

• input object
  • ShareId required string
  • WorkloadId required string
  • PermissionType required string (values: READONLY, CONTRIBUTOR): Permission granted on a workload share.

Output

• output UpdateWorkloadShareOutput

DeleteWorkloadShare

amazonaws_wellarchitected.DeleteWorkloadShare({
  "ShareId": "",
  "WorkloadId": "",
  "ClientRequestToken": ""
}, context)

Input

• input object
  • ShareId required string
  • WorkloadId required string
  • ClientRequestToken required string

Output

Output schema unknown

ListWorkloads

amazonaws_wellarchitected.ListWorkloads({}, context)

Input

• input object
  • MaxResults string
  • NextToken string
  • MaxResults integer: The maximum number of results to return for this request.
  • NextToken string: The token to use to retrieve the next set of results.
  • WorkloadNamePrefix string: An optional string added to the beginning of each workload name returned in the results.

Output

• output ListWorkloadsOutput

Definitions

AccessDeniedException

Answer

• Answer object: An answer of the question.
  • Choices Choices
  • HelpfulResourceUrl HelpfulResourceUrl
  • ImprovementPlanUrl ImprovementPlanUrl
  • IsApplicable IsApplicable
  • Notes Notes
  • PillarId PillarId
  • QuestionDescription QuestionDescription
  • QuestionId QuestionId
  • QuestionTitle QuestionTitle
  • Risk Risk
  • SelectedChoices SelectedChoices

AnswerSummaries

• AnswerSummaries array: List of answer summaries of lens review in a workload.
  • items AnswerSummary

AnswerSummary

• AnswerSummary object: An answer summary of a lens review in a workload.
  • Choices Choices
  • IsApplicable IsApplicable
  • PillarId PillarId
  • QuestionId QuestionId
  • QuestionTitle QuestionTitle
  • Risk Risk
  • SelectedChoices SelectedChoices

AssociateLensesInput

• AssociateLensesInput object: Input to associate lens reviews.
  • LensAliases required LensAliases

AwsAccountId

• AwsAccountId string: An AWS account ID.

AwsRegion

• AwsRegion string: An AWS Region, for example, us-west-2 or ap-northeast-1.

Base64String

• Base64String string: The Base64-encoded string representation of a lens review report. This data can be used to create a PDF file.

Choice

• Choice object: A choice available to answer question.
  • ChoiceId ChoiceId
  • Description ChoiceDescription
  • Title ChoiceTitle

ChoiceDescription

• ChoiceDescription string: The description of a choice.

ChoiceId

• ChoiceId string: The ID of a choice.

ChoiceTitle

• ChoiceTitle string: The title of a choice.

Choices

• Choices array: List of choices available for a question.
  • items Choice

ClientRequestToken

• ClientRequestToken string: A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned. This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

ConflictException

Count

• Count integer: A non-negative integer that denotes how many.

CreateMilestoneInput

• CreateMilestoneInput object: Input for milestone creation.
  • ClientRequestToken required ClientRequestToken
  • MilestoneName required MilestoneName

CreateMilestoneOutput

• CreateMilestoneOutput object: Output of a create milestone call.
  • MilestoneNumber MilestoneNumber
  • WorkloadId WorkloadId

CreateWorkloadInput

• CreateWorkloadInput object: Input for workload creation.
  • AccountIds WorkloadAccountIds
  • ArchitecturalDesign WorkloadArchitecturalDesign
  • AwsRegions WorkloadAwsRegions
  • ClientRequestToken required ClientRequestToken
  • Description required WorkloadDescription
  • Environment required WorkloadEnvironment
  • Industry WorkloadIndustry
  • IndustryType WorkloadIndustryType
  • Lenses required WorkloadLenses
  • NonAwsRegions WorkloadNonAwsRegions
  • Notes Notes
  • PillarPriorities WorkloadPillarPriorities
  • ReviewOwner required WorkloadReviewOwner
  • WorkloadName required WorkloadName

CreateWorkloadOutput

• CreateWorkloadOutput object: Output of a create workload call.
  • WorkloadArn WorkloadArn
  • WorkloadId WorkloadId

CreateWorkloadShareInput

• CreateWorkloadShareInput object: Input for Create Workload Share
  • ClientRequestToken required ClientRequestToken
  • PermissionType required PermissionType
  • SharedWith required SharedWith

CreateWorkloadShareOutput

• CreateWorkloadShareOutput object: Input for Create Workload Share
  • ShareId ShareId
  • WorkloadId WorkloadId

DeleteWorkloadInput

• DeleteWorkloadInput object: Input for workload deletion.

DeleteWorkloadShareInput

• DeleteWorkloadShareInput object: Input for Delete Workload Share

DifferenceStatus

• DifferenceStatus string (values: UPDATED, NEW, DELETED)

DisassociateLensesInput

• DisassociateLensesInput object: Input to disassociate lens reviews.
  • LensAliases required LensAliases

GetAnswerInput

• GetAnswerInput object: Input to get answer.

GetAnswerOutput

• GetAnswerOutput object: Output of a get answer call.
  • Answer Answer
  • LensAlias LensAlias
  • MilestoneNumber MilestoneNumber
  • WorkloadId WorkloadId

GetLensReviewInput

• GetLensReviewInput object: Input to get lens review.

GetLensReviewOutput

• GetLensReviewOutput object: Output of a get lens review call.
  • LensReview LensReview
  • MilestoneNumber MilestoneNumber
  • WorkloadId WorkloadId

GetLensReviewReportInput

• GetLensReviewReportInput object: Input to get lens review report.

GetLensReviewReportOutput

• GetLensReviewReportOutput object: Output of a get lens review report call.
  • LensReviewReport LensReviewReport
  • MilestoneNumber MilestoneNumber
  • WorkloadId WorkloadId

GetLensVersionDifferenceInput

• GetLensVersionDifferenceInput object

GetLensVersionDifferenceOutput

• GetLensVersionDifferenceOutput object
  • BaseLensVersion
  • LatestLensVersion
  • LensAlias LensAlias
  • VersionDifferences VersionDifferences

GetMilestoneInput

• GetMilestoneInput object: Input to get a milestone.

GetMilestoneOutput

• GetMilestoneOutput object: Output of a get milestone call.
  • Milestone Milestone
  • WorkloadId WorkloadId

GetWorkloadInput

• GetWorkloadInput object: Input to get a workload.

GetWorkloadOutput

• GetWorkloadOutput object: Output of a get workload call.
  • Workload Workload

HelpfulResourceUrl

• HelpfulResourceUrl string: The helpful resource URL for a question.

ImprovementPlanUrl

• ImprovementPlanUrl string: The improvement plan URL for a question.

ImprovementSummaries

• ImprovementSummaries array: List of improvement summaries of lens review in a workload.
  • items ImprovementSummary

ImprovementSummary

• ImprovementSummary object: An improvement summary of a lens review in a workload.
  • ImprovementPlanUrl ImprovementPlanUrl
  • PillarId PillarId
  • QuestionId QuestionId
  • QuestionTitle QuestionTitle
  • Risk Risk

InternalServerException

IsApplicable

• IsApplicable boolean: Defines whether this question is applicable to a lens review.

IsReviewOwnerUpdateAcknowledged

• IsReviewOwnerUpdateAcknowledged boolean

LensAlias

• LensAlias string: The alias of the lens, for example, serverless. Each lens is identified by its LensSummary$LensAlias.

LensAliases

• LensAliases array: List of lens aliases to associate or disassociate with a workload. Identify a lens using its LensSummary$LensAlias.
  • items LensAlias

LensDescription

• LensDescription string: The description of the lens.

LensName

• LensName string: The full name of the lens.

LensReview

• LensReview object: A lens review of a question.
  • LensAlias LensAlias
  • LensName LensName
  • LensStatus
  • LensVersion
  • NextToken NextToken
  • Notes Notes
  • PillarReviewSummaries PillarReviewSummaries
  • RiskCounts RiskCounts
  • UpdatedAt Timestamp

LensReviewReport

• LensReviewReport object: A report of a lens review.
  • Base64String Base64String
  • LensAlias LensAlias

LensReviewSummaries

• LensReviewSummaries array: List of lens summaries of lens reviews of a workload.
  • items LensReviewSummary

LensReviewSummary

• LensReviewSummary object: A lens review summary of a workload.
  • LensAlias LensAlias
  • LensName LensName
  • LensStatus
  • LensVersion
  • RiskCounts RiskCounts
  • UpdatedAt Timestamp

LensStatus

• LensStatus string (values: CURRENT, NOT_CURRENT, DEPRECATED)

LensSummaries

• LensSummaries array: List of lens summaries of available lenses.
  • items LensSummary

LensSummary

• LensSummary object: A lens summary of a lens.
  • Description LensDescription
  • LensAlias LensAlias
  • LensName LensName
  • LensVersion

LensUpgradeSummary

• LensUpgradeSummary object: Lens upgrade summary return object.
  • CurrentLensVersion
  • LatestLensVersion
  • LensAlias LensAlias
  • WorkloadId WorkloadId
  • WorkloadName WorkloadName

LensVersion

• LensVersion string

ListAnswersInput

• ListAnswersInput object: Input to list answers.

ListAnswersMaxResults

• ListAnswersMaxResults integer

ListAnswersOutput

• ListAnswersOutput object: Output of a list answers call.
  • AnswerSummaries AnswerSummaries
  • LensAlias LensAlias
  • MilestoneNumber MilestoneNumber
  • NextToken NextToken
  • WorkloadId WorkloadId

ListLensReviewImprovementsInput

• ListLensReviewImprovementsInput object: Input to list lens review improvements.

ListLensReviewImprovementsMaxResults

• ListLensReviewImprovementsMaxResults integer

ListLensReviewImprovementsOutput

• ListLensReviewImprovementsOutput object: Output of a list lens review improvements call.
  • ImprovementSummaries ImprovementSummaries
  • LensAlias LensAlias
  • MilestoneNumber MilestoneNumber
  • NextToken NextToken
  • WorkloadId WorkloadId

ListLensReviewsInput

• ListLensReviewsInput object: Input to list lens reviews.

ListLensReviewsOutput

• ListLensReviewsOutput object: Output of a list lens reviews call.
  • LensReviewSummaries LensReviewSummaries
  • MilestoneNumber MilestoneNumber
  • NextToken NextToken
  • WorkloadId WorkloadId

ListLensesInput

• ListLensesInput object: Input to list lenses.

ListLensesOutput

• ListLensesOutput object: Output of a list lenses call.
  • LensSummaries LensSummaries
  • NextToken NextToken

ListMilestonesInput

• ListMilestonesInput object: Input to list all milestones for a workload.
  • MaxResults MaxResults
  • NextToken NextToken

ListMilestonesOutput

• ListMilestonesOutput object: Output of a list milestones call.
  • MilestoneSummaries MilestoneSummaries
  • NextToken NextToken
  • WorkloadId WorkloadId

ListNotificationsInput

• ListNotificationsInput object
  • MaxResults
  • NextToken NextToken
  • WorkloadId WorkloadId

ListNotificationsMaxResults

• ListNotificationsMaxResults integer

ListNotificationsOutput

• ListNotificationsOutput object
  • NextToken NextToken
  • NotificationSummaries
    • items NotificationSummary

ListShareInvitationsInput

• ListShareInvitationsInput object: Input for List Share Invitations

ListShareInvitationsMaxResults

• ListShareInvitationsMaxResults integer

ListShareInvitationsOutput

• ListShareInvitationsOutput object: Input for List Share Invitations
  • NextToken NextToken
  • ShareInvitationSummaries
    • items ShareInvitationSummary

ListWorkloadSharesInput

• ListWorkloadSharesInput object: Input for List Workload Share

ListWorkloadSharesMaxResults

• ListWorkloadSharesMaxResults integer

ListWorkloadSharesOutput

• ListWorkloadSharesOutput object: Input for List Workload Share
  • NextToken NextToken
  • WorkloadId WorkloadId
  • WorkloadShareSummaries WorkloadShareSummaries

ListWorkloadsInput

• ListWorkloadsInput object: Input to list all workloads.
  • MaxResults
  • NextToken NextToken
  • WorkloadNamePrefix WorkloadNamePrefix

ListWorkloadsMaxResults

• ListWorkloadsMaxResults integer

ListWorkloadsOutput

• ListWorkloadsOutput object: Output of a list workloads call.
  • NextToken NextToken
  • WorkloadSummaries WorkloadSummaries

MaxResults

• MaxResults integer: The maximum number of results to return for this request.

Milestone

• Milestone object: A milestone return object.
  • MilestoneName MilestoneName
  • MilestoneNumber MilestoneNumber
  • RecordedAt Timestamp
  • Workload Workload

MilestoneName

• MilestoneName string: The name of the milestone in a workload. Milestone names must be unique within a workload.

MilestoneNumber

• MilestoneNumber integer: The milestone number. A workload can have a maximum of 100 milestones.

MilestoneSummaries

• MilestoneSummaries array: A list of milestone summaries.
  • items MilestoneSummary

MilestoneSummary

• MilestoneSummary object: A milestone summary return object.
  • MilestoneName MilestoneName
  • MilestoneNumber MilestoneNumber
  • RecordedAt Timestamp
  • WorkloadSummary WorkloadSummary

NextToken

• NextToken string: The token to use to retrieve the next set of results.

Notes

• Notes string: The notes associated with the workload.

NotificationSummaries

• NotificationSummaries array
  • items NotificationSummary

NotificationSummary

• NotificationSummary object: A notification summary return object.
  • LensUpgradeSummary
    • CurrentLensVersion
    • LatestLensVersion
    • LensAlias LensAlias
    • WorkloadId WorkloadId
    • WorkloadName WorkloadName
  • Type

NotificationType

• NotificationType string (values: LENS_VERSION_UPGRADED, LENS_VERSION_DEPRECATED)

PermissionType

• PermissionType string (values: READONLY, CONTRIBUTOR): Permission granted on a workload share.

PillarDifference

• PillarDifference object: A pillar difference return object.
  • DifferenceStatus
  • PillarId PillarId
  • QuestionDifferences
    • items QuestionDifference

PillarDifferences

• PillarDifferences array
  • items PillarDifference

PillarId

• PillarId string: The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary$PillarId.

PillarName

• PillarName string: The name of the pillar.

PillarNotes

• PillarNotes object: List of pillar notes of a lens review in a workload.

PillarReviewSummaries

• PillarReviewSummaries array: List of pillar review summaries of lens review in a workload.
  • items PillarReviewSummary

PillarReviewSummary

• PillarReviewSummary object: A pillar review summary of a lens review.
  • Notes Notes
  • PillarId PillarId
  • PillarName PillarName
  • RiskCounts RiskCounts

QuestionDescription

• QuestionDescription string: The description of the question.

QuestionDifference

• QuestionDifference object: A question difference return object.
  • DifferenceStatus
  • QuestionId QuestionId
  • QuestionTitle QuestionTitle

QuestionDifferences

• QuestionDifferences array
  • items QuestionDifference

QuestionId

• QuestionId string: The ID of the question.

QuestionTitle

• QuestionTitle string: The title of the question.

ResourceNotFoundException

Risk

• Risk string (values: UNANSWERED, HIGH, MEDIUM, NONE, NOT_APPLICABLE): The risk for a given workload, lens review, pillar, or question.

RiskCounts

• RiskCounts object: A map from risk names to the count of how questions have that rating.

SelectedChoices

• SelectedChoices array: List of selected choice IDs in a question answer.
  • items ChoiceId

ServiceQuotaExceededException

ShareId

• ShareId string: The ID associated with the workload share.

ShareInvitation

• ShareInvitation object: The share invitation.
  • ShareInvitationId
  • WorkloadId WorkloadId

ShareInvitationAction

• ShareInvitationAction string (values: ACCEPT, REJECT): Share invitation action taken by contributor.

ShareInvitationId

• ShareInvitationId string

ShareInvitationSummaries

• ShareInvitationSummaries array
  • items ShareInvitationSummary

ShareInvitationSummary

• ShareInvitationSummary object: A share invitation summary return object.
  • PermissionType PermissionType
  • ShareInvitationId
  • SharedBy AwsAccountId
  • SharedWith SharedWith
  • WorkloadId WorkloadId
  • WorkloadName WorkloadName

ShareStatus

• ShareStatus string (values: ACCEPTED, REJECTED, PENDING, REVOKED, EXPIRED): The status of a workload share.

SharedWith

• SharedWith string: The AWS account ID or IAM role with which the workload is shared.

SharedWithPrefix

• SharedWithPrefix string

ThrottlingException

Timestamp

• Timestamp string: The date and time recorded.

UpdateAnswerInput

• UpdateAnswerInput object: Input to update answer.
  • IsApplicable IsApplicable
  • Notes Notes
  • SelectedChoices SelectedChoices

UpdateAnswerOutput

• UpdateAnswerOutput object: Output of a update answer call.
  • Answer Answer
  • LensAlias LensAlias
  • WorkloadId WorkloadId

UpdateLensReviewInput

• UpdateLensReviewInput object: Input for update lens review.
  • LensNotes Notes
  • PillarNotes PillarNotes

UpdateLensReviewOutput

• UpdateLensReviewOutput object: Output of a update lens review call.
  • LensReview LensReview
  • WorkloadId WorkloadId

UpdateShareInvitationInput

• UpdateShareInvitationInput object: Input for Update Share Invitation
  • ShareInvitationAction required ShareInvitationAction

UpdateShareInvitationOutput

• UpdateShareInvitationOutput object
  • ShareInvitation
    • ShareInvitationId
    • WorkloadId WorkloadId

UpdateWorkloadInput

• UpdateWorkloadInput object: Input to update a workload.
  • AccountIds WorkloadAccountIds
  • ArchitecturalDesign WorkloadArchitecturalDesign
  • AwsRegions WorkloadAwsRegions
  • Description WorkloadDescription
  • Environment WorkloadEnvironment
  • ImprovementStatus WorkloadImprovementStatus
  • Industry WorkloadIndustry
  • IndustryType WorkloadIndustryType
  • IsReviewOwnerUpdateAcknowledged
  • NonAwsRegions WorkloadNonAwsRegions
  • Notes Notes
  • PillarPriorities WorkloadPillarPriorities
  • ReviewOwner WorkloadReviewOwner
  • WorkloadName WorkloadName

UpdateWorkloadOutput

• UpdateWorkloadOutput object: Output of an update workload call.
  • Workload Workload

UpdateWorkloadShareInput

• UpdateWorkloadShareInput object: Input for Update Workload Share
  • PermissionType required PermissionType

UpdateWorkloadShareOutput

• UpdateWorkloadShareOutput object: Input for Update Workload Share
  • WorkloadId WorkloadId
  • WorkloadShare WorkloadShare

UpgradeLensReviewInput

• UpgradeLensReviewInput object
  • ClientRequestToken ClientRequestToken
  • MilestoneName required MilestoneName

ValidationException

VersionDifferences

• VersionDifferences object: The differences between the base and latest versions of the lens.
  • PillarDifferences
    • items PillarDifference

Workload

• Workload object: A workload return object.
  • AccountIds WorkloadAccountIds
  • ArchitecturalDesign WorkloadArchitecturalDesign
  • AwsRegions WorkloadAwsRegions
  • Description WorkloadDescription
  • Environment WorkloadEnvironment
  • ImprovementStatus WorkloadImprovementStatus
  • Industry WorkloadIndustry
  • IndustryType WorkloadIndustryType
  • IsReviewOwnerUpdateAcknowledged
  • Lenses WorkloadLenses
  • NonAwsRegions WorkloadNonAwsRegions
  • Notes Notes
  • Owner AwsAccountId
  • PillarPriorities WorkloadPillarPriorities
  • ReviewOwner WorkloadReviewOwner
  • ReviewRestrictionDate Timestamp
  • RiskCounts RiskCounts
  • ShareInvitationId
  • UpdatedAt Timestamp
  • WorkloadArn WorkloadArn
  • WorkloadId WorkloadId
  • WorkloadName WorkloadName

WorkloadAccountIds

• WorkloadAccountIds array: The list of AWS account IDs associated with the workload.
  • items AwsAccountId

WorkloadArchitecturalDesign

• WorkloadArchitecturalDesign string: The URL of the architectural design for the workload.

WorkloadArn

• WorkloadArn string: The ARN for the workload.

WorkloadAwsRegions

• WorkloadAwsRegions array: The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.
  • items AwsRegion

WorkloadDescription

• WorkloadDescription string: The description for the workload.

WorkloadEnvironment

• WorkloadEnvironment string (values: PRODUCTION, PREPRODUCTION): The environment for the workload.

WorkloadId

• WorkloadId string: The ID assigned to the workload. This ID is unique within an AWS Region.

WorkloadImprovementStatus

• WorkloadImprovementStatus string (values: NOT_APPLICABLE, NOT_STARTED, IN_PROGRESS, COMPLETE, RISK_ACKNOWLEDGED): The improvement status for a workload.

WorkloadIndustry

• WorkloadIndustry string: The industry for the workload.

WorkloadIndustryType

• WorkloadIndustryType string: The industry type for the workload. If specified, must be one of the following: Agriculture Automobile Defense Design and Engineering Digital Advertising Education Environmental Protection Financial Services Gaming General Public Services Healthcare Hospitality InfoTech Justice and Public Safety Life Sciences Manufacturing Media & Entertainment Mining & Resources Oil & Gas Power & Utilities Professional Services Real Estate & Construction Retail & Wholesale Social Protection Telecommunications Travel, Transportation & Logistics Other

WorkloadLenses

• WorkloadLenses array: The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
  • items LensAlias

WorkloadName

• WorkloadName string: The name of the workload. The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

WorkloadNamePrefix

• WorkloadNamePrefix string: An optional string added to the beginning of each workload name returned in the results.

WorkloadNonAwsRegion

• WorkloadNonAwsRegion string

WorkloadNonAwsRegions

• WorkloadNonAwsRegions array: The list of non-AWS Regions associated with the workload.
  • items WorkloadNonAwsRegion

WorkloadPillarPriorities

• 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.
  • items PillarId

WorkloadReviewOwner

• 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

• WorkloadShare object: A workload share return object.
  • PermissionType PermissionType
  • ShareId ShareId
  • SharedBy AwsAccountId
  • SharedWith SharedWith
  • Status ShareStatus
  • WorkloadId WorkloadId
  • WorkloadName WorkloadName

WorkloadShareSummaries

• WorkloadShareSummaries array: A list of workload share summaries.
  • items WorkloadShareSummary

WorkloadShareSummary

• WorkloadShareSummary object: A workload share summary return object.
  • PermissionType PermissionType
  • ShareId ShareId
  • SharedWith SharedWith
  • Status ShareStatus

WorkloadSummaries

• WorkloadSummaries array: A list of workload summaries.
  • items WorkloadSummary

WorkloadSummary

• WorkloadSummary object: A workload summary return object.
  • ImprovementStatus WorkloadImprovementStatus
  • Lenses WorkloadLenses
  • Owner AwsAccountId
  • RiskCounts RiskCounts
  • UpdatedAt Timestamp
  • WorkloadArn WorkloadArn
  • WorkloadId WorkloadId
  • WorkloadName WorkloadName