2024/04/16 - AWS Well-Architected Tool - 2 new 11 updated api methods
Changes AWS Well-Architected now has a Connector for Jira to allow customers to efficiently track workload risks and improvement efforts and create closed-loop mechanisms.
Update integration features.
See also: AWS API Documentation
Request Syntax
client.update_integration(
WorkloadId='string',
ClientRequestToken='string',
IntegratingService='JIRA'
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
string
[REQUIRED]
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 the original request has completed successfully, the result of the original request is returned.
Warning
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
This field is autopopulated if not provided.
string
[REQUIRED]
Which integrated service to update.
None
Global settings for all workloads.
See also: AWS API Documentation
Request Syntax
client.get_global_settings()
dict
Response Syntax
{
'OrganizationSharingStatus': 'ENABLED'|'DISABLED',
'DiscoveryIntegrationStatus': 'ENABLED'|'DISABLED',
'JiraConfiguration': {
'IntegrationStatus': 'CONFIGURED'|'NOT_CONFIGURED',
'IssueManagementStatus': 'ENABLED'|'DISABLED',
'IssueManagementType': 'AUTO'|'MANUAL',
'Subdomain': 'string',
'JiraProjectKey': 'string',
'StatusMessage': 'string'
}
}
Response Structure
(dict) --
OrganizationSharingStatus (string) --
Amazon Web Services Organizations sharing status.
DiscoveryIntegrationStatus (string) --
Discovery integration status.
JiraConfiguration (dict) --
Jira configuration status.
IntegrationStatus (string) --
Account-level: Configuration status of the Jira integration.
IssueManagementStatus (string) --
Account-level: Jira issue management status.
IssueManagementType (string) --
Account-level: Jira issue management type.
Subdomain (string) --
Account-level: Jira subdomain URL.
JiraProjectKey (string) --
Account-level: Jira project key to sync workloads to.
StatusMessage (string) --
Account-level: Status message on configuration of the Jira integration.
{'JiraConfiguration': {'IssueManagementStatus': 'ENABLED | DISABLED | INHERIT',
'IssueManagementType': 'AUTO | MANUAL',
'JiraProjectKey': 'string'}}
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide .
Warning
Either AwsRegions , NonAwsRegions , or both must be specified when creating a workload.
You also must specify ReviewOwner , even though the parameter is listed as not being required in the following section.
When creating a workload using a review template, you must have the following IAM permissions:
wellarchitected:GetReviewTemplate
wellarchitected:GetReviewTemplateAnswer
wellarchitected:ListReviewTemplateAnswers
wellarchitected:GetReviewTemplateLensReview
See also: AWS API Documentation
Request Syntax
client.create_workload(
WorkloadName='string',
Description='string',
Environment='PRODUCTION'|'PREPRODUCTION',
AccountIds=[
'string',
],
AwsRegions=[
'string',
],
NonAwsRegions=[
'string',
],
PillarPriorities=[
'string',
],
ArchitecturalDesign='string',
ReviewOwner='string',
IndustryType='string',
Industry='string',
Lenses=[
'string',
],
Notes='string',
ClientRequestToken='string',
Tags={
'string': 'string'
},
DiscoveryConfig={
'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
'WorkloadResourceDefinition': [
'WORKLOAD_METADATA'|'APP_REGISTRY',
]
},
Applications=[
'string',
],
ProfileArns=[
'string',
],
ReviewTemplateArns=[
'string',
],
JiraConfiguration={
'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT',
'IssueManagementType': 'AUTO'|'MANUAL',
'JiraProjectKey': 'string'
}
)
string
[REQUIRED]
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 for uniqueness.
string
[REQUIRED]
The description for the workload.
string
[REQUIRED]
The environment for the workload.
list
The list of Amazon Web Services account IDs associated with the workload.
(string) --
An Amazon Web Services account ID.
list
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
(string) --
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
list
The list of non-Amazon Web Services Regions associated with the workload.
(string) --
list
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
(string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
string
The URL of the architectural design for the workload.
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.
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
string
The industry for the workload.
list
[REQUIRED]
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.
(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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
string
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
string
[REQUIRED]
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 the original request has completed successfully, the result of the original request is returned.
Warning
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
This field is autopopulated if not provided.
dict
The tags to be associated with the workload.
(string) --
(string) --
dict
Well-Architected discovery configuration settings associated to the workload.
TrustedAdvisorIntegrationStatus (string) --
Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition (list) --
The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
(string) --
list
List of AppRegistry application ARNs associated to the workload.
(string) --
list
The list of profile ARNs associated with the workload.
(string) --
list
The list of review template ARNs to associate with the workload.
(string) --
dict
Jira configuration settings when creating a workload.
IssueManagementStatus (string) --
Workload-level: Jira issue management status.
IssueManagementType (string) --
Workload-level: Jira issue management type.
JiraProjectKey (string) --
Workload-level: Jira project key to sync workloads to.
dict
Response Syntax
{
'WorkloadId': 'string',
'WorkloadArn': 'string'
}
Response Structure
(dict) --
Output of a create workload call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadArn (string) --
The ARN for the workload.
{'Answer': {'JiraConfiguration': {'JiraIssueUrl': 'string',
'LastSyncedTime': 'timestamp'}}}
Get the answer to a specific question in a workload review.
See also: AWS API Documentation
Request Syntax
client.get_answer(
WorkloadId='string',
LensAlias='string',
QuestionId='string',
MilestoneNumber=123
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
string
[REQUIRED]
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
string
[REQUIRED]
The ID of the question.
integer
The milestone number.
A workload can have a maximum of 100 milestones.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123,
'LensAlias': 'string',
'LensArn': 'string',
'Answer': {
'QuestionId': 'string',
'PillarId': 'string',
'QuestionTitle': 'string',
'QuestionDescription': 'string',
'ImprovementPlanUrl': 'string',
'HelpfulResourceUrl': 'string',
'HelpfulResourceDisplayText': 'string',
'Choices': [
{
'ChoiceId': 'string',
'Title': 'string',
'Description': 'string',
'HelpfulResource': {
'DisplayText': 'string',
'Url': 'string'
},
'ImprovementPlan': {
'DisplayText': 'string',
'Url': 'string'
},
'AdditionalResources': [
{
'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN',
'Content': [
{
'DisplayText': 'string',
'Url': 'string'
},
]
},
]
},
],
'SelectedChoices': [
'string',
],
'ChoiceAnswers': [
{
'ChoiceId': 'string',
'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
'Notes': 'string'
},
],
'IsApplicable': True|False,
'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
'Notes': 'string',
'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
'JiraConfiguration': {
'JiraIssueUrl': 'string',
'LastSyncedTime': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Output of a get answer call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
MilestoneNumber (integer) --
The milestone number.
A workload can have a maximum of 100 milestones.
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
Answer (dict) --
An answer of the question.
QuestionId (string) --
The ID of the question.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
QuestionTitle (string) --
The title of the question.
QuestionDescription (string) --
The description of the question.
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 does not apply to custom lenses.
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 helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.
HelpfulResourceDisplayText (string) --
The helpful resource text to be displayed for a custom lens.
This field does not apply to Amazon Web Services official lenses.
Choices (list) --
List of choices available for a question.
(dict) --
A choice available to answer question.
ChoiceId (string) --
The ID of a choice.
Title (string) --
The title of a choice.
Description (string) --
The description of a choice.
HelpfulResource (dict) --
The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
ImprovementPlan (dict) --
The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
AdditionalResources (list) --
The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE , one of type IMPROVEMENT_PLAN , or both.
(dict) --
The choice level additional resources for a custom lens.
This field does not apply to Amazon Web Services official lenses.
Type (string) --
Type of additional resource for a custom lens.
Content (list) --
The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
(dict) --
The choice content.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
SelectedChoices (list) --
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
(string) --
The ID of a choice.
ChoiceAnswers (list) --
A list of selected choices to a question in your workload.
(dict) --
A choice that has been answered on a question in your workload.
ChoiceId (string) --
The ID of a choice.
Status (string) --
The status of a choice.
Reason (string) --
The reason why a choice is non-applicable to a question in your workload.
Notes (string) --
The notes associated with a choice.
IsApplicable (boolean) --
Defines whether this question is applicable to a lens review.
Risk (string) --
The risk for a given workload, lens review, pillar, or question.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
Reason (string) --
The reason why the question is not applicable to your workload.
JiraConfiguration (dict) --
Configuration of the Jira integration.
JiraIssueUrl (string) --
The URL of the associated Jira issue.
LastSyncedTime (datetime) --
The date and time recorded.
{'LensReview': {'JiraConfiguration': {'SelectedPillars': [{'PillarId': 'string',
'SelectedQuestionIds': ['string']}]}}}
Get lens review.
See also: AWS API Documentation
Request Syntax
client.get_lens_review(
WorkloadId='string',
LensAlias='string',
MilestoneNumber=123
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
string
[REQUIRED]
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
integer
The milestone number.
A workload can have a maximum of 100 milestones.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123,
'LensReview': {
'LensAlias': 'string',
'LensArn': 'string',
'LensVersion': 'string',
'LensName': 'string',
'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED',
'PillarReviewSummaries': [
{
'PillarId': 'string',
'PillarName': 'string',
'Notes': 'string',
'RiskCounts': {
'string': 123
},
'PrioritizedRiskCounts': {
'string': 123
}
},
],
'JiraConfiguration': {
'SelectedPillars': [
{
'PillarId': 'string',
'SelectedQuestionIds': [
'string',
]
},
]
},
'UpdatedAt': datetime(2015, 1, 1),
'Notes': 'string',
'RiskCounts': {
'string': 123
},
'NextToken': 'string',
'Profiles': [
{
'ProfileArn': 'string',
'ProfileVersion': 'string'
},
],
'PrioritizedRiskCounts': {
'string': 123
}
}
}
Response Structure
(dict) --
Output of a get lens review call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
MilestoneNumber (integer) --
The milestone number.
A workload can have a maximum of 100 milestones.
LensReview (dict) --
A lens review of a question.
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
LensVersion (string) --
The version of the lens.
LensName (string) --
The full name of the lens.
LensStatus (string) --
The status of the lens.
PillarReviewSummaries (list) --
List of pillar review summaries of lens review in a workload.
(dict) --
A pillar review summary of a lens review.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
PillarName (string) --
The name of the pillar.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
RiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
PrioritizedRiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
JiraConfiguration (dict) --
Jira configuration status of the Lens review.
SelectedPillars (list) --
Selected pillars in the workload.
(dict) --
The selected pillar.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
SelectedQuestionIds (list) --
Selected question IDs in the selected pillar.
(string) --
UpdatedAt (datetime) --
The date and time recorded.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
RiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
NextToken (string) --
The token to use to retrieve the next set of results.
Profiles (list) --
The profiles associated with the workload.
(dict) --
The profile associated with a workload.
ProfileArn (string) --
The profile ARN.
ProfileVersion (string) --
The profile version.
PrioritizedRiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
{'Milestone': {'Workload': {'JiraConfiguration': {'IssueManagementStatus': 'ENABLED '
'| '
'DISABLED '
'| '
'INHERIT',
'IssueManagementType': 'AUTO '
'| '
'MANUAL',
'JiraProjectKey': 'string',
'StatusMessage': 'string'}}}}
Get a milestone for an existing workload.
See also: AWS API Documentation
Request Syntax
client.get_milestone(
WorkloadId='string',
MilestoneNumber=123
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
integer
[REQUIRED]
The milestone number.
A workload can have a maximum of 100 milestones.
dict
Response Syntax
{
'WorkloadId': 'string',
'Milestone': {
'MilestoneNumber': 123,
'MilestoneName': 'string',
'RecordedAt': datetime(2015, 1, 1),
'Workload': {
'WorkloadId': 'string',
'WorkloadArn': 'string',
'WorkloadName': 'string',
'Description': 'string',
'Environment': 'PRODUCTION'|'PREPRODUCTION',
'UpdatedAt': datetime(2015, 1, 1),
'AccountIds': [
'string',
],
'AwsRegions': [
'string',
],
'NonAwsRegions': [
'string',
],
'ArchitecturalDesign': 'string',
'ReviewOwner': 'string',
'ReviewRestrictionDate': datetime(2015, 1, 1),
'IsReviewOwnerUpdateAcknowledged': True|False,
'IndustryType': 'string',
'Industry': 'string',
'Notes': 'string',
'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED',
'RiskCounts': {
'string': 123
},
'PillarPriorities': [
'string',
],
'Lenses': [
'string',
],
'Owner': 'string',
'ShareInvitationId': 'string',
'Tags': {
'string': 'string'
},
'DiscoveryConfig': {
'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
'WorkloadResourceDefinition': [
'WORKLOAD_METADATA'|'APP_REGISTRY',
]
},
'Applications': [
'string',
],
'Profiles': [
{
'ProfileArn': 'string',
'ProfileVersion': 'string'
},
],
'PrioritizedRiskCounts': {
'string': 123
},
'JiraConfiguration': {
'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT',
'IssueManagementType': 'AUTO'|'MANUAL',
'JiraProjectKey': 'string',
'StatusMessage': 'string'
}
}
}
}
Response Structure
(dict) --
Output of a get milestone call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Milestone (dict) --
A milestone return object.
MilestoneNumber (integer) --
The milestone number.
A workload can have a maximum of 100 milestones.
MilestoneName (string) --
The name of the milestone in a workload.
Milestone names must be unique within a workload.
RecordedAt (datetime) --
The date and time recorded.
Workload (dict) --
A workload return object.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadArn (string) --
The ARN for the workload.
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 for uniqueness.
Description (string) --
The description for the workload.
Environment (string) --
The environment for the workload.
UpdatedAt (datetime) --
The date and time recorded.
AccountIds (list) --
The list of Amazon Web Services account IDs associated with the workload.
(string) --
An Amazon Web Services account ID.
AwsRegions (list) --
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
(string) --
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
NonAwsRegions (list) --
The list of non-Amazon Web Services Regions associated with the workload.
(string) --
ArchitecturalDesign (string) --
The URL of the architectural design for the workload.
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.
ReviewRestrictionDate (datetime) --
The date and time recorded.
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.
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
Industry (string) --
The industry for the workload.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
ImprovementStatus (string) --
The improvement status for a workload.
RiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
PillarPriorities (list) --
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
(string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
Lenses (list) --
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.
(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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
Owner (string) --
An Amazon Web Services account ID.
ShareInvitationId (string) --
The ID assigned to the share invitation.
Tags (dict) --
The tags associated with the workload.
(string) --
(string) --
DiscoveryConfig (dict) --
Discovery configuration associated to the workload.
TrustedAdvisorIntegrationStatus (string) --
Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition (list) --
The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
(string) --
Applications (list) --
List of AppRegistry application ARNs associated to the workload.
(string) --
Profiles (list) --
Profile associated with a workload.
(dict) --
The profile associated with a workload.
ProfileArn (string) --
The profile ARN.
ProfileVersion (string) --
The profile version.
PrioritizedRiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
JiraConfiguration (dict) --
Jira configuration for a specific workload.
IssueManagementStatus (string) --
Workload-level: Jira issue management status.
IssueManagementType (string) --
Workload-level: Jira issue management type.
JiraProjectKey (string) --
Workload-level: Jira project key to sync workloads to.
StatusMessage (string) --
Workload-level: Status message on configuration of the Jira integration.
{'Workload': {'JiraConfiguration': {'IssueManagementStatus': 'ENABLED | '
'DISABLED | '
'INHERIT',
'IssueManagementType': 'AUTO | MANUAL',
'JiraProjectKey': 'string',
'StatusMessage': 'string'}}}
Get an existing workload.
See also: AWS API Documentation
Request Syntax
client.get_workload(
WorkloadId='string'
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
dict
Response Syntax
{
'Workload': {
'WorkloadId': 'string',
'WorkloadArn': 'string',
'WorkloadName': 'string',
'Description': 'string',
'Environment': 'PRODUCTION'|'PREPRODUCTION',
'UpdatedAt': datetime(2015, 1, 1),
'AccountIds': [
'string',
],
'AwsRegions': [
'string',
],
'NonAwsRegions': [
'string',
],
'ArchitecturalDesign': 'string',
'ReviewOwner': 'string',
'ReviewRestrictionDate': datetime(2015, 1, 1),
'IsReviewOwnerUpdateAcknowledged': True|False,
'IndustryType': 'string',
'Industry': 'string',
'Notes': 'string',
'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED',
'RiskCounts': {
'string': 123
},
'PillarPriorities': [
'string',
],
'Lenses': [
'string',
],
'Owner': 'string',
'ShareInvitationId': 'string',
'Tags': {
'string': 'string'
},
'DiscoveryConfig': {
'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
'WorkloadResourceDefinition': [
'WORKLOAD_METADATA'|'APP_REGISTRY',
]
},
'Applications': [
'string',
],
'Profiles': [
{
'ProfileArn': 'string',
'ProfileVersion': 'string'
},
],
'PrioritizedRiskCounts': {
'string': 123
},
'JiraConfiguration': {
'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT',
'IssueManagementType': 'AUTO'|'MANUAL',
'JiraProjectKey': 'string',
'StatusMessage': 'string'
}
}
}
Response Structure
(dict) --
Output of a get workload call.
Workload (dict) --
A workload return object.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadArn (string) --
The ARN for the workload.
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 for uniqueness.
Description (string) --
The description for the workload.
Environment (string) --
The environment for the workload.
UpdatedAt (datetime) --
The date and time recorded.
AccountIds (list) --
The list of Amazon Web Services account IDs associated with the workload.
(string) --
An Amazon Web Services account ID.
AwsRegions (list) --
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
(string) --
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
NonAwsRegions (list) --
The list of non-Amazon Web Services Regions associated with the workload.
(string) --
ArchitecturalDesign (string) --
The URL of the architectural design for the workload.
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.
ReviewRestrictionDate (datetime) --
The date and time recorded.
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.
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
Industry (string) --
The industry for the workload.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
ImprovementStatus (string) --
The improvement status for a workload.
RiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
PillarPriorities (list) --
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
(string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
Lenses (list) --
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.
(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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
Owner (string) --
An Amazon Web Services account ID.
ShareInvitationId (string) --
The ID assigned to the share invitation.
Tags (dict) --
The tags associated with the workload.
(string) --
(string) --
DiscoveryConfig (dict) --
Discovery configuration associated to the workload.
TrustedAdvisorIntegrationStatus (string) --
Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition (list) --
The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
(string) --
Applications (list) --
List of AppRegistry application ARNs associated to the workload.
(string) --
Profiles (list) --
Profile associated with a workload.
(dict) --
The profile associated with a workload.
ProfileArn (string) --
The profile ARN.
ProfileVersion (string) --
The profile version.
PrioritizedRiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
JiraConfiguration (dict) --
Jira configuration for a specific workload.
IssueManagementStatus (string) --
Workload-level: Jira issue management status.
IssueManagementType (string) --
Workload-level: Jira issue management type.
JiraProjectKey (string) --
Workload-level: Jira project key to sync workloads to.
StatusMessage (string) --
Workload-level: Status message on configuration of the Jira integration.
{'AnswerSummaries': {'JiraConfiguration': {'JiraIssueUrl': 'string',
'LastSyncedTime': 'timestamp'}}}
List of answers for a particular workload and lens.
See also: AWS API Documentation
Request Syntax
client.list_answers(
WorkloadId='string',
LensAlias='string',
PillarId='string',
MilestoneNumber=123,
NextToken='string',
MaxResults=123,
QuestionPriority='PRIORITIZED'|'NONE'
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
string
[REQUIRED]
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
string
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
integer
The milestone number.
A workload can have a maximum of 100 milestones.
string
The token to use to retrieve the next set of results.
integer
The maximum number of results to return for this request.
string
The priority of the question.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123,
'LensAlias': 'string',
'LensArn': 'string',
'AnswerSummaries': [
{
'QuestionId': 'string',
'PillarId': 'string',
'QuestionTitle': 'string',
'Choices': [
{
'ChoiceId': 'string',
'Title': 'string',
'Description': 'string',
'HelpfulResource': {
'DisplayText': 'string',
'Url': 'string'
},
'ImprovementPlan': {
'DisplayText': 'string',
'Url': 'string'
},
'AdditionalResources': [
{
'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN',
'Content': [
{
'DisplayText': 'string',
'Url': 'string'
},
]
},
]
},
],
'SelectedChoices': [
'string',
],
'ChoiceAnswerSummaries': [
{
'ChoiceId': 'string',
'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
},
],
'IsApplicable': True|False,
'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
'QuestionType': 'PRIORITIZED'|'NON_PRIORITIZED',
'JiraConfiguration': {
'JiraIssueUrl': 'string',
'LastSyncedTime': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output of a list answers call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
MilestoneNumber (integer) --
The milestone number.
A workload can have a maximum of 100 milestones.
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
AnswerSummaries (list) --
List of answer summaries of lens review in a workload.
(dict) --
An answer summary of a lens review in a workload.
QuestionId (string) --
The ID of the question.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
QuestionTitle (string) --
The title of the question.
Choices (list) --
List of choices available for a question.
(dict) --
A choice available to answer question.
ChoiceId (string) --
The ID of a choice.
Title (string) --
The title of a choice.
Description (string) --
The description of a choice.
HelpfulResource (dict) --
The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
ImprovementPlan (dict) --
The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
AdditionalResources (list) --
The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE , one of type IMPROVEMENT_PLAN , or both.
(dict) --
The choice level additional resources for a custom lens.
This field does not apply to Amazon Web Services official lenses.
Type (string) --
Type of additional resource for a custom lens.
Content (list) --
The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
(dict) --
The choice content.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
SelectedChoices (list) --
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
(string) --
The ID of a choice.
ChoiceAnswerSummaries (list) --
A list of selected choices to a question in your workload.
(dict) --
A choice summary that has been answered on a question in your workload.
ChoiceId (string) --
The ID of a choice.
Status (string) --
The status of a choice.
Reason (string) --
The reason why a choice is non-applicable to a question in your workload.
IsApplicable (boolean) --
Defines whether this question is applicable to a lens review.
Risk (string) --
The risk for a given workload, lens review, pillar, or question.
Reason (string) --
The reason why a choice is non-applicable to a question in your workload.
QuestionType (string) --
The type of the question.
JiraConfiguration (dict) --
Configuration of the Jira integration.
JiraIssueUrl (string) --
The URL of the associated Jira issue.
LastSyncedTime (datetime) --
The date and time recorded.
NextToken (string) --
The token to use to retrieve the next set of results.
{'ImprovementSummaries': {'JiraConfiguration': {'JiraIssueUrl': 'string',
'LastSyncedTime': 'timestamp'}}}
List the improvements of a particular lens review.
See also: AWS API Documentation
Request Syntax
client.list_lens_review_improvements(
WorkloadId='string',
LensAlias='string',
PillarId='string',
MilestoneNumber=123,
NextToken='string',
MaxResults=123,
QuestionPriority='PRIORITIZED'|'NONE'
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
string
[REQUIRED]
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
string
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
integer
The milestone number.
A workload can have a maximum of 100 milestones.
string
The token to use to retrieve the next set of results.
integer
The maximum number of results to return for this request.
string
The priority of the question.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123,
'LensAlias': 'string',
'LensArn': 'string',
'ImprovementSummaries': [
{
'QuestionId': 'string',
'PillarId': 'string',
'QuestionTitle': 'string',
'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
'ImprovementPlanUrl': 'string',
'ImprovementPlans': [
{
'ChoiceId': 'string',
'DisplayText': 'string',
'ImprovementPlanUrl': 'string'
},
],
'JiraConfiguration': {
'JiraIssueUrl': 'string',
'LastSyncedTime': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output of a list lens review improvements call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
MilestoneNumber (integer) --
The milestone number.
A workload can have a maximum of 100 milestones.
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
ImprovementSummaries (list) --
List of improvement summaries of lens review in a workload.
(dict) --
An improvement summary of a lens review in a workload.
QuestionId (string) --
The ID of the question.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
QuestionTitle (string) --
The title of the question.
Risk (string) --
The risk for a given workload, lens review, pillar, or question.
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 does not apply to custom lenses.
ImprovementPlans (list) --
The improvement plan details.
(dict) --
The choice level improvement plan.
ChoiceId (string) --
The ID of a choice.
DisplayText (string) --
The display text for the improvement plan.
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 does not apply to custom lenses.
JiraConfiguration (dict) --
Configuration of the Jira integration.
JiraIssueUrl (string) --
The URL of the associated Jira issue.
LastSyncedTime (datetime) --
The date and time recorded.
NextToken (string) --
The token to use to retrieve the next set of results.
{'Answer': {'JiraConfiguration': {'JiraIssueUrl': 'string',
'LastSyncedTime': 'timestamp'}}}
Update the answer to a specific question in a workload review.
See also: AWS API Documentation
Request Syntax
client.update_answer(
WorkloadId='string',
LensAlias='string',
QuestionId='string',
SelectedChoices=[
'string',
],
ChoiceUpdates={
'string': {
'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
'Notes': 'string'
}
},
Notes='string',
IsApplicable=True|False,
Reason='OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
string
[REQUIRED]
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
string
[REQUIRED]
The ID of the question.
list
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
(string) --
The ID of a choice.
dict
A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
(string) --
The ID of a choice.
(dict) --
A list of choices to be updated.
Status (string) -- [REQUIRED]
The status of a choice.
Reason (string) --
The reason why a choice is non-applicable to a question in your workload.
Notes (string) --
The notes associated with a choice.
string
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
boolean
Defines whether this question is applicable to a lens review.
string
The reason why a question is not applicable to your workload.
dict
Response Syntax
{
'WorkloadId': 'string',
'LensAlias': 'string',
'LensArn': 'string',
'Answer': {
'QuestionId': 'string',
'PillarId': 'string',
'QuestionTitle': 'string',
'QuestionDescription': 'string',
'ImprovementPlanUrl': 'string',
'HelpfulResourceUrl': 'string',
'HelpfulResourceDisplayText': 'string',
'Choices': [
{
'ChoiceId': 'string',
'Title': 'string',
'Description': 'string',
'HelpfulResource': {
'DisplayText': 'string',
'Url': 'string'
},
'ImprovementPlan': {
'DisplayText': 'string',
'Url': 'string'
},
'AdditionalResources': [
{
'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN',
'Content': [
{
'DisplayText': 'string',
'Url': 'string'
},
]
},
]
},
],
'SelectedChoices': [
'string',
],
'ChoiceAnswers': [
{
'ChoiceId': 'string',
'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
'Notes': 'string'
},
],
'IsApplicable': True|False,
'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
'Notes': 'string',
'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
'JiraConfiguration': {
'JiraIssueUrl': 'string',
'LastSyncedTime': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Output of a update answer call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
Answer (dict) --
An answer of the question.
QuestionId (string) --
The ID of the question.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
QuestionTitle (string) --
The title of the question.
QuestionDescription (string) --
The description of the question.
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 does not apply to custom lenses.
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 helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.
HelpfulResourceDisplayText (string) --
The helpful resource text to be displayed for a custom lens.
This field does not apply to Amazon Web Services official lenses.
Choices (list) --
List of choices available for a question.
(dict) --
A choice available to answer question.
ChoiceId (string) --
The ID of a choice.
Title (string) --
The title of a choice.
Description (string) --
The description of a choice.
HelpfulResource (dict) --
The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
ImprovementPlan (dict) --
The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
AdditionalResources (list) --
The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE , one of type IMPROVEMENT_PLAN , or both.
(dict) --
The choice level additional resources for a custom lens.
This field does not apply to Amazon Web Services official lenses.
Type (string) --
Type of additional resource for a custom lens.
Content (list) --
The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
(dict) --
The choice content.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
SelectedChoices (list) --
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
(string) --
The ID of a choice.
ChoiceAnswers (list) --
A list of selected choices to a question in your workload.
(dict) --
A choice that has been answered on a question in your workload.
ChoiceId (string) --
The ID of a choice.
Status (string) --
The status of a choice.
Reason (string) --
The reason why a choice is non-applicable to a question in your workload.
Notes (string) --
The notes associated with a choice.
IsApplicable (boolean) --
Defines whether this question is applicable to a lens review.
Risk (string) --
The risk for a given workload, lens review, pillar, or question.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
Reason (string) --
The reason why the question is not applicable to your workload.
JiraConfiguration (dict) --
Configuration of the Jira integration.
JiraIssueUrl (string) --
The URL of the associated Jira issue.
LastSyncedTime (datetime) --
The date and time recorded.
{'JiraConfiguration': {'IntegrationStatus': 'NOT_CONFIGURED',
'IssueManagementStatus': 'ENABLED | DISABLED',
'IssueManagementType': 'AUTO | MANUAL',
'JiraProjectKey': 'string'}}
Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
See also: AWS API Documentation
Request Syntax
client.update_global_settings(
OrganizationSharingStatus='ENABLED'|'DISABLED',
DiscoveryIntegrationStatus='ENABLED'|'DISABLED',
JiraConfiguration={
'IssueManagementStatus': 'ENABLED'|'DISABLED',
'IssueManagementType': 'AUTO'|'MANUAL',
'JiraProjectKey': 'string',
'IntegrationStatus': 'NOT_CONFIGURED'
}
)
string
The status of organization sharing settings.
string
The status of discovery support settings.
dict
The status of Jira integration settings.
IssueManagementStatus (string) --
Account-level: Jira issue management status.
IssueManagementType (string) --
Account-level: Jira issue management type.
JiraProjectKey (string) --
Account-level: Jira project key to sync workloads to.
IntegrationStatus (string) --
Account-level: Configuration status of the Jira integration.
None
{'JiraConfiguration': {'SelectedPillars': [{'PillarId': 'string',
'SelectedQuestionIds': ['string']}]}}
Response {'LensReview': {'JiraConfiguration': {'SelectedPillars': [{'PillarId': 'string',
'SelectedQuestionIds': ['string']}]}}}
Update lens review for a particular workload.
See also: AWS API Documentation
Request Syntax
client.update_lens_review(
WorkloadId='string',
LensAlias='string',
LensNotes='string',
PillarNotes={
'string': 'string'
},
JiraConfiguration={
'SelectedPillars': [
{
'PillarId': 'string',
'SelectedQuestionIds': [
'string',
]
},
]
}
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
string
[REQUIRED]
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
string
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
dict
List of pillar notes of a lens review in a workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
(string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
(string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
dict
Configuration of the Jira integration.
SelectedPillars (list) --
Selected pillars in the workload.
(dict) --
The selected pillar.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
SelectedQuestionIds (list) --
Selected question IDs in the selected pillar.
(string) --
dict
Response Syntax
{
'WorkloadId': 'string',
'LensReview': {
'LensAlias': 'string',
'LensArn': 'string',
'LensVersion': 'string',
'LensName': 'string',
'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED',
'PillarReviewSummaries': [
{
'PillarId': 'string',
'PillarName': 'string',
'Notes': 'string',
'RiskCounts': {
'string': 123
},
'PrioritizedRiskCounts': {
'string': 123
}
},
],
'JiraConfiguration': {
'SelectedPillars': [
{
'PillarId': 'string',
'SelectedQuestionIds': [
'string',
]
},
]
},
'UpdatedAt': datetime(2015, 1, 1),
'Notes': 'string',
'RiskCounts': {
'string': 123
},
'NextToken': 'string',
'Profiles': [
{
'ProfileArn': 'string',
'ProfileVersion': 'string'
},
],
'PrioritizedRiskCounts': {
'string': 123
}
}
}
Response Structure
(dict) --
Output of a update lens review call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensReview (dict) --
A lens review of a question.
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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
LensVersion (string) --
The version of the lens.
LensName (string) --
The full name of the lens.
LensStatus (string) --
The status of the lens.
PillarReviewSummaries (list) --
List of pillar review summaries of lens review in a workload.
(dict) --
A pillar review summary of a lens review.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
PillarName (string) --
The name of the pillar.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
RiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
PrioritizedRiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
JiraConfiguration (dict) --
Jira configuration status of the Lens review.
SelectedPillars (list) --
Selected pillars in the workload.
(dict) --
The selected pillar.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
SelectedQuestionIds (list) --
Selected question IDs in the selected pillar.
(string) --
UpdatedAt (datetime) --
The date and time recorded.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
RiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
NextToken (string) --
The token to use to retrieve the next set of results.
Profiles (list) --
The profiles associated with the workload.
(dict) --
The profile associated with a workload.
ProfileArn (string) --
The profile ARN.
ProfileVersion (string) --
The profile version.
PrioritizedRiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
{'JiraConfiguration': {'IssueManagementStatus': 'ENABLED | DISABLED | INHERIT',
'IssueManagementType': 'AUTO | MANUAL',
'JiraProjectKey': 'string'}}
Response {'Workload': {'JiraConfiguration': {'IssueManagementStatus': 'ENABLED | '
'DISABLED | '
'INHERIT',
'IssueManagementType': 'AUTO | MANUAL',
'JiraProjectKey': 'string',
'StatusMessage': 'string'}}}
Update an existing workload.
See also: AWS API Documentation
Request Syntax
client.update_workload(
WorkloadId='string',
WorkloadName='string',
Description='string',
Environment='PRODUCTION'|'PREPRODUCTION',
AccountIds=[
'string',
],
AwsRegions=[
'string',
],
NonAwsRegions=[
'string',
],
PillarPriorities=[
'string',
],
ArchitecturalDesign='string',
ReviewOwner='string',
IsReviewOwnerUpdateAcknowledged=True|False,
IndustryType='string',
Industry='string',
Notes='string',
ImprovementStatus='NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED',
DiscoveryConfig={
'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
'WorkloadResourceDefinition': [
'WORKLOAD_METADATA'|'APP_REGISTRY',
]
},
Applications=[
'string',
],
JiraConfiguration={
'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT',
'IssueManagementType': 'AUTO'|'MANUAL',
'JiraProjectKey': 'string'
}
)
string
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
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 for uniqueness.
string
The description for the workload.
string
The environment for the workload.
list
The list of Amazon Web Services account IDs associated with the workload.
(string) --
An Amazon Web Services account ID.
list
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
(string) --
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
list
The list of non-Amazon Web Services Regions associated with the workload.
(string) --
list
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
(string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
string
The URL of the architectural design for the workload.
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.
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.
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
string
The industry for the workload.
string
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
string
The improvement status for a workload.
dict
Well-Architected discovery configuration settings to associate to the workload.
TrustedAdvisorIntegrationStatus (string) --
Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition (list) --
The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
(string) --
list
List of AppRegistry application ARNs to associate to the workload.
(string) --
dict
Configuration of the Jira integration.
IssueManagementStatus (string) --
Workload-level: Jira issue management status.
IssueManagementType (string) --
Workload-level: Jira issue management type.
JiraProjectKey (string) --
Workload-level: Jira project key to sync workloads to.
dict
Response Syntax
{
'Workload': {
'WorkloadId': 'string',
'WorkloadArn': 'string',
'WorkloadName': 'string',
'Description': 'string',
'Environment': 'PRODUCTION'|'PREPRODUCTION',
'UpdatedAt': datetime(2015, 1, 1),
'AccountIds': [
'string',
],
'AwsRegions': [
'string',
],
'NonAwsRegions': [
'string',
],
'ArchitecturalDesign': 'string',
'ReviewOwner': 'string',
'ReviewRestrictionDate': datetime(2015, 1, 1),
'IsReviewOwnerUpdateAcknowledged': True|False,
'IndustryType': 'string',
'Industry': 'string',
'Notes': 'string',
'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED',
'RiskCounts': {
'string': 123
},
'PillarPriorities': [
'string',
],
'Lenses': [
'string',
],
'Owner': 'string',
'ShareInvitationId': 'string',
'Tags': {
'string': 'string'
},
'DiscoveryConfig': {
'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
'WorkloadResourceDefinition': [
'WORKLOAD_METADATA'|'APP_REGISTRY',
]
},
'Applications': [
'string',
],
'Profiles': [
{
'ProfileArn': 'string',
'ProfileVersion': 'string'
},
],
'PrioritizedRiskCounts': {
'string': 123
},
'JiraConfiguration': {
'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT',
'IssueManagementType': 'AUTO'|'MANUAL',
'JiraProjectKey': 'string',
'StatusMessage': 'string'
}
}
}
Response Structure
(dict) --
Output of an update workload call.
Workload (dict) --
A workload return object.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadArn (string) --
The ARN for the workload.
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 for uniqueness.
Description (string) --
The description for the workload.
Environment (string) --
The environment for the workload.
UpdatedAt (datetime) --
The date and time recorded.
AccountIds (list) --
The list of Amazon Web Services account IDs associated with the workload.
(string) --
An Amazon Web Services account ID.
AwsRegions (list) --
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
(string) --
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
NonAwsRegions (list) --
The list of non-Amazon Web Services Regions associated with the workload.
(string) --
ArchitecturalDesign (string) --
The URL of the architectural design for the workload.
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.
ReviewRestrictionDate (datetime) --
The date and time recorded.
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.
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
Industry (string) --
The industry for the workload.
Notes (string) --
The notes associated with the workload.
For a review template, these are the notes that will be associated with the workload when the template is applied.
ImprovementStatus (string) --
The improvement status for a workload.
RiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
PillarPriorities (list) --
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
(string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
Lenses (list) --
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.
(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:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
Each lens is identified by its LensSummary$LensAlias.
Owner (string) --
An Amazon Web Services account ID.
ShareInvitationId (string) --
The ID assigned to the share invitation.
Tags (dict) --
The tags associated with the workload.
(string) --
(string) --
DiscoveryConfig (dict) --
Discovery configuration associated to the workload.
TrustedAdvisorIntegrationStatus (string) --
Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition (list) --
The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
(string) --
Applications (list) --
List of AppRegistry application ARNs associated to the workload.
(string) --
Profiles (list) --
Profile associated with a workload.
(dict) --
The profile associated with a workload.
ProfileArn (string) --
The profile ARN.
ProfileVersion (string) --
The profile version.
PrioritizedRiskCounts (dict) --
A map from risk names to the count of how many questions have that rating.
(string) --
The risk for a given workload, lens review, pillar, or question.
(integer) --
A non-negative integer that denotes how many.
JiraConfiguration (dict) --
Jira configuration for a specific workload.
IssueManagementStatus (string) --
Workload-level: Jira issue management status.
IssueManagementType (string) --
Workload-level: Jira issue management type.
JiraProjectKey (string) --
Workload-level: Jira project key to sync workloads to.
StatusMessage (string) --
Workload-level: Status message on configuration of the Jira integration.