ListNotiﬁcations

List lens notiﬁcations.

Request Syntax

POST /notifications HTTP/1.1 Content-type: application/json {

"MaxResults": number, "NextToken": "string", "WorkloadId": "string"

}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults (p. 83)

The maximum number of results to return for this request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No NextToken (p. 83)

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

Type: String Required: No WorkloadId (p. 83)

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

Type: String

Pattern: [0-9a-f]{32}

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json

Response Elements

{

"NextToken": "string", "NotificationSummaries": [ {

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 83)

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

Type: String

NotiﬁcationSummaries (p. 83)

List of lens notiﬁcation summaries in a workload.

Type: Array of NotiﬁcationSummary (p. 153) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

AccessDeniedException

User does not have suﬃcient access to perform this action.

HTTP Status Code: 403 InternalServerException

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

HTTP Status Code: 500 ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The user input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

ListShareInvitations

List the workload invitations.

Request Syntax

GET /shareInvitations?

LensNamePrefix=LensNamePrefix&MaxResults=MaxResults&NextToken=NextToken&ShareResourceType=ShareResourceType&WorkloadNamePrefix=WorkloadNamePrefix HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

LensNamePreﬁx (p. 86)

An optional string added to the beginning of each lens name returned in the results.

Length Constraints: Maximum length of 100.

MaxResults (p. 86)

The maximum number of results to return for this request.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 86)

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

ShareResourceType (p. 86)

The type of share invitations to be returned.

Valid Values: WORKLOAD | LENS WorkloadNamePreﬁx (p. 86)

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

Length Constraints: Maximum length of 100.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"NextToken": "string",

"ShareInvitationSummaries": [ {

"LensArn": "string", "LensName": "string",

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 86)

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

Type: String

ShareInvitationSummaries (p. 86)

List of share invitation summaries in a workload.

Type: Array of ShareInvitationSummary (p. 160) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

AccessDeniedException

User does not have suﬃcient access to perform this action.

HTTP Status Code: 403 InternalServerException

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

HTTP Status Code: 500 ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The user input is not valid.

HTTP Status Code: 400

Request Syntax

GET /tags/WorkloadArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

WorkloadArn (p. 89)

The ARN for the workload.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "Tags": {

"string" : "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Tags (p. 89)

The tags for the resource.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

See Also

InternalServerException

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

HTTP Status Code: 500 ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

Request Syntax

POST /workloadsSummaries HTTP/1.1 Content-type: application/json {

"MaxResults": number, "NextToken": "string",

"WorkloadNamePrefix": "string"

}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults (p. 91)

The maximum number of results to return for this request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No NextToken (p. 91)

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

Type: String Required: No

WorkloadNamePreﬁx (p. 91)

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

Type: String

Length Constraints: Maximum length of 100.

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json {

Response Elements

"NextToken": "string", "WorkloadSummaries": [ {

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 91)

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

Type: String

WorkloadSummaries (p. 91) A list of workload summaries.

Type: Array of WorkloadSummary (p. 172) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

AccessDeniedException

User does not have suﬃcient access to perform this action.

HTTP Status Code: 403 InternalServerException

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

HTTP Status Code: 500 ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The user input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

ListWorkloadShares

List the workload shares associated with the workload.

Request Syntax

GET /workloads/WorkloadId/shares?

MaxResults=MaxResults&NextToken=NextToken&SharedWithPrefix=SharedWithPrefix HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 94)

The maximum number of results to return for this request.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 94)

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

SharedWithPreﬁx (p. 94)

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

Length Constraints: Maximum length of 100.

WorkloadId (p. 94)

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

Pattern: [0-9a-f]{32}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "NextToken": "string", "WorkloadId": "string", "WorkloadShareSummaries": [ {

"PermissionType": "string", "SharedWith": "string", "ShareId": "string", "Status": "string"

}

Response Elements

] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 94)

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

Type: String WorkloadId (p. 94)

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

Type: String

Pattern: [0-9a-f]{32}

WorkloadShareSummaries (p. 94) A list of workload share summaries.

Type: Array of WorkloadShareSummary (p. 171) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

AccessDeniedException

User does not have suﬃcient access to perform this action.

HTTP Status Code: 403 InternalServerException

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

HTTP Status Code: 500 ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404 ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The user input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

TagResource

Adds one or more tags to the speciﬁed resource.

Request Syntax

POST /tags/WorkloadArn HTTP/1.1 Content-type: application/json {

"Tags": {

"string" : "string"

}}

URI Request Parameters

The request uses the following URI parameters.

WorkloadArn (p. 97)

The ARN for the workload.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Tags (p. 97)

The tags for the resource.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

See Also

InternalServerException

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

HTTP Status Code: 500 ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

Request Syntax

DELETE /tags/WorkloadArn?tagKeys=TagKeys HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

TagKeys (p. 99)

A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes WorkloadArn (p. 99)

The ARN for the workload.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

InternalServerException

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

See Also

HTTP Status Code: 500 ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

Request Syntax

PATCH /workloads/WorkloadId/lensReviews/LensAlias/answers/QuestionId HTTP/1.1 Content-type: application/json

"IsApplicable": boolean, "Notes": "string", "Reason": "string",

"SelectedChoices": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.

LensAlias (p. 101)

The alias of the lens, for example, serverless.

Each lens is identiﬁed by its LensSummary:LensAlias (p. 147).

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes QuestionId (p. 101)

The ID of the question.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes WorkloadId (p. 101)

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

Pattern: [0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

Response Syntax

ChoiceUpdates (p. 101)

A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.

Type: String to ChoiceUpdate (p. 136) object map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No IsApplicable (p. 101)

Deﬁnes whether this question is applicable to a lens review.

Type: Boolean Required: No Notes (p. 101)

The notes associated with the workload.

Type: String

Length Constraints: Maximum length of 2084.

Required: No Reason (p. 101)

The reason why a question is not applicable to your workload.

Type: String

Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE

Required: No SelectedChoices (p. 101)

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Response Elements

"HelpfulResourceDisplayText": "string", "HelpfulResourceUrl": "string",

"ImprovementPlanUrl": "string", "IsApplicable": boolean, "Notes": "string", "PillarId": "string",

"QuestionDescription": "string", "QuestionId": "string",

"QuestionTitle": "string", "Reason": "string",

"Risk": "string",

"SelectedChoices": [ "string" ] },

"LensAlias": "string", "LensArn": "string", "WorkloadId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Answer (p. 102)

An answer of the question.

Type: Answer (p. 125) object LensAlias (p. 102)

The alias of the lens, for example, serverless.

Each lens is identiﬁed by its LensSummary:LensAlias (p. 147).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

LensArn (p. 102)

The ARN for the lens.

Type: String

Errors

WorkloadId (p. 102)

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

Type: String

Pattern: [0-9a-f]{32}

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

AccessDeniedException

User does not have suﬃcient access to perform this action.

HTTP Status Code: 403 ConﬂictException

The resource already exists.

HTTP Status Code: 409 InternalServerException

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

HTTP Status Code: 500 ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404 ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The user input is not valid.

HTTP Status Code: 400

Request Syntax

PATCH /workloads/WorkloadId/lensReviews/LensAlias HTTP/1.1 Content-type: application/json

{ "LensNotes": "string", "PillarNotes": { "string" : "string"

} }

URI Request Parameters

The request uses the following URI parameters.

LensAlias (p. 106)

The alias of the lens, for example, serverless.

Each lens is identiﬁed by its LensSummary:LensAlias (p. 147).

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes WorkloadId (p. 106)

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

Pattern: [0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

LensNotes (p. 106)

The notes associated with the workload.

Type: String

Length Constraints: Maximum length of 2084.

Required: No PillarNotes (p. 106)

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Response Syntax

Value Length Constraints: Maximum length of 2084.

Required: No "LensStatus": "string", "LensVersion": "string", "NextToken": "string",

"WorkloadId": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LensReview (p. 107)

A lens review of a question.

Type: LensReview (p. 141) object WorkloadId (p. 107)

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

Type: String

Pattern: [0-9a-f]{32}

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

See Also

AccessDeniedException

User does not have suﬃcient access to perform this action.

HTTP Status Code: 403 ConﬂictException

The resource already exists.

HTTP Status Code: 409 InternalServerException

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

HTTP Status Code: 500 ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404 ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The user input is not valid.

HTTP Status Code: 400

Request Syntax

PATCH /shareInvitations/ShareInvitationId HTTP/1.1 Content-type: application/json

{

"ShareInvitationAction": "string"

}

URI Request Parameters

The request uses the following URI parameters.

ShareInvitationId (p. 109)

The ID assigned to the share invitation.

Pattern: [0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

ShareInvitationAction (p. 109)

Share invitation action taken by contributor.

Type: String

Valid Values: ACCEPT | REJECT Required: Yes

Response Syntax

HTTP/1.1 200

Content-type: application/json {

"ShareInvitation": { "LensAlias": "string", "LensArn": "string",

"ShareInvitationId": "string", "ShareResourceType": "string", "WorkloadId": "string"

}}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ShareInvitation (p. 109)

The updated workload share invitation.

Type: ShareInvitation (p. 158) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 176).

AccessDeniedException

User does not have suﬃcient access to perform this action.

HTTP Status Code: 403 ConﬂictException

The resource already exists.

HTTP Status Code: 409 InternalServerException

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

HTTP Status Code: 500 ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404 ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429 ValidationException

The user input is not valid.

HTTP Status Code: 400

Request Syntax

PATCH /workloads/WorkloadId HTTP/1.1 Content-type: application/json {

"AccountIds": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "Description": "string", "Environment": "string", "ImprovementStatus": "string", "Industry": "string",

"IndustryType": "string",

"IsReviewOwnerUpdateAcknowledged": boolean, "NonAwsRegions": [ "string" ],

"Notes": "string",

"PillarPriorities": [ "string" ], "ReviewOwner": "string",

"WorkloadName": "string"

}

URI Request Parameters

The request uses the following URI parameters.

WorkloadId (p. 112)

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

Pattern: [0-9a-f]{32}

Required: Yes

Request Body

The request accepts the following data in JSON format.

AccountIds (p. 112)

The list of AWS account IDs associated with the workload.

Type: Array of strings

Array Members: Maximum number of 100 items.

Pattern: [0-9]{12}

Required: No

ArchitecturalDesign (p. 112)

The URL of the architectural design for the workload.

Request Body

Type: String

Length Constraints: Maximum length of 2048.

Required: No AwsRegions (p. 112)

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

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Maximum length of 100.

Required: No Description (p. 112)

The description for the workload.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 250.

在文檔中 AWS Well-Architected Tool (頁 93-134)

ListNotiﬁcations