Table of Contents
WellArchitected.Client¶A low-level client representing AWS Well-Architected Tool
This is the Well-Architected Tool API Reference . The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.
import boto3
client = boto3.client('wellarchitected')
These are the available methods:
associate_lenses()can_paginate()close()create_lens_share()create_lens_version()create_milestone()create_workload()create_workload_share()delete_lens()delete_lens_share()delete_workload()delete_workload_share()disassociate_lenses()export_lens()get_answer()get_lens()get_lens_review()get_lens_review_report()get_lens_version_difference()get_milestone()get_paginator()get_waiter()get_workload()import_lens()list_answers()list_check_details()list_check_summaries()list_lens_review_improvements()list_lens_reviews()list_lens_shares()list_lenses()list_milestones()list_notifications()list_share_invitations()list_tags_for_resource()list_workload_shares()list_workloads()tag_resource()untag_resource()update_answer()update_global_settings()update_lens_review()update_share_invitation()update_workload()update_workload_share()upgrade_lens_review()associate_lenses(**kwargs)¶Associate a lens to a workload.
Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.
Note
Disclaimer
By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.
See also: AWS API Documentation
Request Syntax
response = client.associate_lenses(
WorkloadId='string',
LensAliases=[
'string',
]
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[REQUIRED]
List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.
Identify a lens using its LensSummary$LensAlias.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
None
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
Create a lens share.
The owner of a lens can share it with other Amazon Web Services accounts, IAM users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted.
Note
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.create_lens_share(
LensAlias='string',
SharedWith='string',
ClientRequestToken='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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[REQUIRED]
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
[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 it 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
Response Syntax
{
'ShareId': 'string'
}
Response Structure
(dict) --
ShareId (string) --
The ID associated with the workload share.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ServiceQuotaExceededExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptioncreate_lens_version(**kwargs)¶Create a new lens version.
A lens can have up to 100 versions.
After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
See also: AWS API Documentation
Request Syntax
response = client.create_lens_version(
LensAlias='string',
LensVersion='string',
IsMajorVersion=True|False,
ClientRequestToken='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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[REQUIRED]
The version of the lens being created.
[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 it 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
Response Syntax
{
'LensArn': 'string',
'LensVersion': 'string'
}
Response Structure
(dict) --
LensArn (string) --
The ARN for the lens.
LensVersion (string) --
The version of the lens.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ServiceQuotaExceededExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptioncreate_milestone(**kwargs)¶Create a milestone for an existing workload.
See also: AWS API Documentation
Request Syntax
response = client.create_milestone(
WorkloadId='string',
MilestoneName='string',
ClientRequestToken='string'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[REQUIRED]
The name of the milestone in a workload.
Milestone names must be unique within a workload.
[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 it 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
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123
}
Response Structure
(dict) --
Output of a create milestone 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.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ServiceQuotaExceededExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptioncreate_workload(**kwargs)¶Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, IAM 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 .
See also: AWS API Documentation
Request Syntax
response = 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'
},
Applications=[
'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.
[REQUIRED]
The description for the workload.
[REQUIRED]
The environment for the workload.
The list of Amazon Web Services account IDs associated with the workload.
An Amazon Web Services account ID.
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
The list of non-Amazon Web Services Regions associated with the workload.
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
The industry type for the workload.
If specified, must be one of the following:
AgricultureAutomobileDefenseDesign and EngineeringDigital AdvertisingEducationEnvironmental ProtectionFinancial ServicesGamingGeneral Public ServicesHealthcareHospitalityInfoTechJustice and Public SafetyLife SciencesManufacturingMedia & EntertainmentMining & ResourcesOil & GasPower & UtilitiesProfessional ServicesReal Estate & ConstructionRetail & WholesaleSocial ProtectionTelecommunicationsTravel, Transportation & LogisticsOther[REQUIRED]
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[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 it 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.
The tags to be associated with the workload.
Well-Architected discovery configuration settings associated to the workload.
Discovery integration status in respect to Trusted Advisor for the workload.
List of AppRegistry application ARNs associated to the workload.
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.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.ServiceQuotaExceededExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionCreate a workload share.
The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
For more information, see Sharing a Workload in the Well-Architected Tool User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_workload_share(
WorkloadId='string',
SharedWith='string',
PermissionType='READONLY'|'CONTRIBUTOR',
ClientRequestToken='string'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[REQUIRED]
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
[REQUIRED]
Permission granted on a workload share.
[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 it 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
Response Syntax
{
'WorkloadId': 'string',
'ShareId': 'string'
}
Response Structure
(dict) --
Input for Create Workload Share
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
ShareId (string) --
The ID associated with the workload share.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ServiceQuotaExceededExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptiondelete_lens(**kwargs)¶Delete an existing lens.
Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Note
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.delete_lens(
LensAlias='string',
ClientRequestToken='string',
LensStatus='ALL'|'DRAFT'|'PUBLISHED'
)
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[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 it 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.
[REQUIRED]
The status of the lens to be deleted.
None
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionDelete a lens share.
After the lens share is deleted, Amazon Web Services accounts, IAM users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Note
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.delete_lens_share(
ShareId='string',
LensAlias='string',
ClientRequestToken='string'
)
[REQUIRED]
The ID associated with the workload share.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[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 it 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.
None
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptiondelete_workload(**kwargs)¶Delete an existing workload.
See also: AWS API Documentation
Request Syntax
response = client.delete_workload(
WorkloadId='string',
ClientRequestToken='string'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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 it 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.
None
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionDelete a workload share.
See also: AWS API Documentation
Request Syntax
response = client.delete_workload_share(
ShareId='string',
WorkloadId='string',
ClientRequestToken='string'
)
[REQUIRED]
The ID associated with the workload share.
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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 it 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.
None
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptiondisassociate_lenses(**kwargs)¶Disassociate a lens from a workload.
Up to 10 lenses can be disassociated from a workload in a single API operation.
Note
The Amazon Web Services Well-Architected Framework lens ( wellarchitected ) cannot be removed from a workload.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_lenses(
WorkloadId='string',
LensAliases=[
'string',
]
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[REQUIRED]
List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.
Identify a lens using its LensSummary$LensAlias.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
None
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionexport_lens(**kwargs)¶Export an existing lens.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide . Only the owner of a lens can export it.
Note
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
See also: AWS API Documentation
Request Syntax
response = client.export_lens(
LensAlias='string',
LensVersion='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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
dict
Response Syntax
{
'LensJSON': 'string'
}
Response Structure
(dict) --
LensJSON (string) --
The JSON for the lens.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionget_answer(**kwargs)¶Get the answer to a specific question in a workload review.
See also: AWS API Documentation
Request Syntax
response = client.get_answer(
WorkloadId='string',
LensAlias='string',
QuestionId='string',
MilestoneNumber=123
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[REQUIRED]
The ID of the question.
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'
}
}
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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.
This value is only available if the question has been answered.
HelpfulResourceUrl (string) --
The helpful resource URL for a question.
HelpfulResourceDisplayText (string) --
The helpful resource text to be displayed.
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 choice level helpful resource.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
ImprovementPlan (dict) --
The choice level 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. 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.
Type (string) --
Type of additional resource.
Content (list) --
The URLs for additional resources, either helpful resources or improvement plans. 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.
Reason (string) --
The reason why the question is not applicable to your workload.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionget_lens(**kwargs)¶Get an existing lens.
See also: AWS API Documentation
Request Syntax
response = client.get_lens(
LensAlias='string',
LensVersion='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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
dict
Response Syntax
{
'Lens': {
'LensArn': 'string',
'LensVersion': 'string',
'Name': 'string',
'Description': 'string',
'Owner': 'string',
'ShareInvitationId': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Lens (dict) --
A lens return object.
LensArn (string) --
The ARN of a lens.
LensVersion (string) --
The version of a lens.
Name (string) --
The full name of the lens.
Description (string) --
The description of the lens.
Owner (string) --
The Amazon Web Services account ID that owns the lens.
ShareInvitationId (string) --
The ID assigned to the share invitation.
Tags (dict) --
The tags assigned to the lens.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionget_lens_review(**kwargs)¶Get lens review.
See also: AWS API Documentation
Request Syntax
response = client.get_lens_review(
WorkloadId='string',
LensAlias='string',
MilestoneNumber=123
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
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
}
},
],
'UpdatedAt': datetime(2015, 1, 1),
'Notes': 'string',
'RiskCounts': {
'string': 123
},
'NextToken': 'string'
}
}
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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.
RiskCounts (dict) --
A map from risk names to the count of how 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.
UpdatedAt (datetime) --
The date and time recorded.
Notes (string) --
The notes associated with the workload.
RiskCounts (dict) --
A map from risk names to the count of how 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.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionget_lens_review_report(**kwargs)¶Get lens review report.
See also: AWS API Documentation
Request Syntax
response = client.get_lens_review_report(
WorkloadId='string',
LensAlias='string',
MilestoneNumber=123
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
The milestone number.
A workload can have a maximum of 100 milestones.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123,
'LensReviewReport': {
'LensAlias': 'string',
'LensArn': 'string',
'Base64String': 'string'
}
}
Response Structure
(dict) --
Output of a get lens review report 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.
LensReviewReport (dict) --
A report of a lens review.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
Base64String (string) --
The Base64-encoded string representation of a lens review report.
This data can be used to create a PDF file.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionget_lens_version_difference(**kwargs)¶Get lens version differences.
See also: AWS API Documentation
Request Syntax
response = client.get_lens_version_difference(
LensAlias='string',
BaseLensVersion='string',
TargetLensVersion='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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
dict
Response Syntax
{
'LensAlias': 'string',
'LensArn': 'string',
'BaseLensVersion': 'string',
'TargetLensVersion': 'string',
'LatestLensVersion': 'string',
'VersionDifferences': {
'PillarDifferences': [
{
'PillarId': 'string',
'PillarName': 'string',
'DifferenceStatus': 'UPDATED'|'NEW'|'DELETED',
'QuestionDifferences': [
{
'QuestionId': 'string',
'QuestionTitle': 'string',
'DifferenceStatus': 'UPDATED'|'NEW'|'DELETED'
},
]
},
]
}
}
Response Structure
(dict) --
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
BaseLensVersion (string) --
The base version of the lens.
TargetLensVersion (string) --
The target lens version for the lens.
LatestLensVersion (string) --
The latest version of the lens.
VersionDifferences (dict) --
The differences between the base and latest versions of the lens.
PillarDifferences (list) --
The differences between the base and latest versions of the lens.
(dict) --
A pillar difference return object.
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.
DifferenceStatus (string) --
Indicates the type of change to the pillar.
QuestionDifferences (list) --
List of question differences.
(dict) --
A question difference return object.
QuestionId (string) --
The ID of the question.
QuestionTitle (string) --
The title of the question.
DifferenceStatus (string) --
Indicates the type of change to the question.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionget_milestone(**kwargs)¶Get a milestone for an existing workload.
See also: AWS API Documentation
Request Syntax
response = client.get_milestone(
WorkloadId='string',
MilestoneNumber=123
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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'
},
'Applications': [
'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.
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:
AgricultureAutomobileDefenseDesign and EngineeringDigital AdvertisingEducationEnvironmental ProtectionFinancial ServicesGamingGeneral Public ServicesHealthcareHospitalityInfoTechJustice and Public SafetyLife SciencesManufacturingMedia & EntertainmentMining & ResourcesOil & GasPower & UtilitiesProfessional ServicesReal Estate & ConstructionRetail & WholesaleSocial ProtectionTelecommunicationsTravel, Transportation & LogisticsOtherIndustry (string) --
The industry for the workload.
Notes (string) --
The notes associated with the workload.
ImprovementStatus (string) --
The improvement status for a workload.
RiskCounts (dict) --
A map from risk names to the count of how 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.
(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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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.
DiscoveryConfig (dict) --
Discovery configuration associated to the workload.
TrustedAdvisorIntegrationStatus (string) --
Discovery integration status in respect to Trusted Advisor for the workload.
Applications (list) --
List of AppRegistry application ARNs associated to the workload.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
get_workload(**kwargs)¶Get an existing workload.
See also: AWS API Documentation
Request Syntax
response = client.get_workload(
WorkloadId='string'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
{
'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'
},
'Applications': [
'string',
]
}
}
Response Structure
Output of a get workload call.
A workload return object.
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
The ARN for the workload.
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.
The description for the workload.
The environment for the workload.
The date and time recorded.
The list of Amazon Web Services account IDs associated with the workload.
An Amazon Web Services account ID.
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
The list of non-Amazon Web Services Regions associated with the workload.
The URL of the architectural design for the workload.
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
The date and time recorded.
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.
The industry type for the workload.
If specified, must be one of the following:
AgricultureAutomobileDefenseDesign and EngineeringDigital AdvertisingEducationEnvironmental ProtectionFinancial ServicesGamingGeneral Public ServicesHealthcareHospitalityInfoTechJustice and Public SafetyLife SciencesManufacturingMedia & EntertainmentMining & ResourcesOil & GasPower & UtilitiesProfessional ServicesReal Estate & ConstructionRetail & WholesaleSocial ProtectionTelecommunicationsTravel, Transportation & LogisticsOtherThe industry for the workload.
The notes associated with the workload.
The improvement status for a workload.
A map from risk names to the count of how questions have that rating.
The risk for a given workload, lens review, pillar, or question.
A non-negative integer that denotes how many.
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
An Amazon Web Services account ID.
The ID assigned to the share invitation.
The tags associated with the workload.
Discovery configuration associated to the workload.
Discovery integration status in respect to Trusted Advisor for the workload.
List of AppRegistry application ARNs associated to the workload.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionimport_lens(**kwargs)¶Import a new lens.
The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide .
A custom lens cannot exceed 500 KB in size.
Note
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
See also: AWS API Documentation
Request Syntax
response = client.import_lens(
LensAlias='string',
JSONString='string',
ClientRequestToken='string',
Tags={
'string': '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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[REQUIRED]
The JSON representation of a lens.
[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 it 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.
Tags to associate to a lens.
dict
Response Syntax
{
'LensArn': 'string',
'Status': 'IN_PROGRESS'|'COMPLETE'|'ERROR'
}
Response Structure
(dict) --
LensArn (string) --
The ARN for the lens.
Status (string) --
The status of the imported lens.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ServiceQuotaExceededExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_answers(**kwargs)¶List of answers.
See also: AWS API Documentation
Request Syntax
response = client.list_answers(
WorkloadId='string',
LensAlias='string',
PillarId='string',
MilestoneNumber=123,
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
The milestone number.
A workload can have a maximum of 100 milestones.
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'
},
],
'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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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 choice level helpful resource.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
ImprovementPlan (dict) --
The choice level 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. 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.
Type (string) --
Type of additional resource.
Content (list) --
The URLs for additional resources, either helpful resources or improvement plans. 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.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_check_details(**kwargs)¶List of Trusted Advisor check details by account related to the workload.
See also: AWS API Documentation
Request Syntax
response = client.list_check_details(
WorkloadId='string',
NextToken='string',
MaxResults=123,
LensArn='string',
PillarId='string',
QuestionId='string',
ChoiceId='string'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[REQUIRED]
Well-Architected Lens ARN.
[REQUIRED]
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
[REQUIRED]
The ID of the question.
[REQUIRED]
The ID of a choice.
dict
Response Syntax
{
'CheckDetails': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Provider': 'TRUSTED_ADVISOR',
'LensArn': 'string',
'PillarId': 'string',
'QuestionId': 'string',
'ChoiceId': 'string',
'Status': 'OKAY'|'WARNING'|'ERROR'|'NOT_AVAILABLE'|'FETCH_FAILED',
'AccountId': 'string',
'FlaggedResources': 123,
'Reason': 'ASSUME_ROLE_ERROR'|'ACCESS_DENIED'|'UNKNOWN_ERROR'|'PREMIUM_SUPPORT_REQUIRED',
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CheckDetails (list) --
The details about the Trusted Advisor checks related to the Well-Architected best practice.
(dict) --
Account details for a Well-Architected best practice in relation to Trusted Advisor checks.
Id (string) --
Trusted Advisor check ID.
Name (string) --
Trusted Advisor check name.
Description (string) --
Trusted Advisor check description.
Provider (string) --
Provider of the check related to the best practice.
LensArn (string) --
Well-Architected Lens ARN associated to the check.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
QuestionId (string) --
The ID of the question.
ChoiceId (string) --
The ID of a choice.
Status (string) --
Status associated to the check.
AccountId (string) --
An Amazon Web Services account ID.
FlaggedResources (integer) --
Count of flagged resources associated to the check.
Reason (string) --
Reason associated to the check.
UpdatedAt (datetime) --
The date and time recorded.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_check_summaries(**kwargs)¶List of Trusted Advisor checks summarized for all accounts related to the workload.
See also: AWS API Documentation
Request Syntax
response = client.list_check_summaries(
WorkloadId='string',
NextToken='string',
MaxResults=123,
LensArn='string',
PillarId='string',
QuestionId='string',
ChoiceId='string'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[REQUIRED]
Well-Architected Lens ARN.
[REQUIRED]
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
[REQUIRED]
The ID of the question.
[REQUIRED]
The ID of a choice.
dict
Response Syntax
{
'CheckSummaries': [
{
'Id': 'string',
'Name': 'string',
'Provider': 'TRUSTED_ADVISOR',
'Description': 'string',
'UpdatedAt': datetime(2015, 1, 1),
'LensArn': 'string',
'PillarId': 'string',
'QuestionId': 'string',
'ChoiceId': 'string',
'Status': 'OKAY'|'WARNING'|'ERROR'|'NOT_AVAILABLE'|'FETCH_FAILED',
'AccountSummary': {
'string': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CheckSummaries (list) --
List of Trusted Advisor summaries related to the Well-Architected best practice.
(dict) --
Trusted Advisor check summary.
Id (string) --
Trusted Advisor check ID.
Name (string) --
Trusted Advisor check name.
Provider (string) --
Provider of the check related to the best practice.
Description (string) --
Trusted Advisor check description.
UpdatedAt (datetime) --
The date and time recorded.
LensArn (string) --
Well-Architected Lens ARN associated to the check.
PillarId (string) --
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
QuestionId (string) --
The ID of the question.
ChoiceId (string) --
The ID of a choice.
Status (string) --
Status associated to the check.
AccountSummary (dict) --
Account summary associated to the check.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_lens_review_improvements(**kwargs)¶List lens review improvements.
See also: AWS API Documentation
Request Syntax
response = client.list_lens_review_improvements(
WorkloadId='string',
LensAlias='string',
PillarId='string',
MilestoneNumber=123,
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
The milestone number.
A workload can have a maximum of 100 milestones.
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'
},
]
},
],
'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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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.
This value is only available if the question has been answered.
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.
This value is only available if the question has been answered.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_lens_reviews(**kwargs)¶List lens reviews.
See also: AWS API Documentation
Request Syntax
response = client.list_lens_reviews(
WorkloadId='string',
MilestoneNumber=123,
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
The milestone number.
A workload can have a maximum of 100 milestones.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123,
'LensReviewSummaries': [
{
'LensAlias': 'string',
'LensArn': 'string',
'LensVersion': 'string',
'LensName': 'string',
'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED',
'UpdatedAt': datetime(2015, 1, 1),
'RiskCounts': {
'string': 123
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output of a list lens reviews 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.
LensReviewSummaries (list) --
List of lens summaries of lens reviews of a workload.
(dict) --
A lens review summary of a workload.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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.
UpdatedAt (datetime) --
The date and time recorded.
RiskCounts (dict) --
A map from risk names to the count of how 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.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionList the lens shares associated with the lens.
See also: AWS API Documentation
Request Syntax
response = client.list_lens_shares(
LensAlias='string',
SharedWithPrefix='string',
NextToken='string',
MaxResults=123,
Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED'
)
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
dict
Response Syntax
{
'LensShareSummaries': [
{
'ShareId': 'string',
'SharedWith': 'string',
'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
'StatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
LensShareSummaries (list) --
A list of lens share summaries.
(dict) --
A lens share summary return object.
ShareId (string) --
The ID associated with the workload share.
SharedWith (string) --
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
Status (string) --
The status of a workload share.
StatusMessage (string) --
Optional message to compliment the Status field.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_lenses(**kwargs)¶List the available lenses.
See also: AWS API Documentation
Request Syntax
response = client.list_lenses(
NextToken='string',
MaxResults=123,
LensType='AWS_OFFICIAL'|'CUSTOM_SHARED'|'CUSTOM_SELF',
LensStatus='ALL'|'DRAFT'|'PUBLISHED',
LensName='string'
)
dict
Response Syntax
{
'LensSummaries': [
{
'LensArn': 'string',
'LensAlias': 'string',
'LensName': 'string',
'LensType': 'AWS_OFFICIAL'|'CUSTOM_SHARED'|'CUSTOM_SELF',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'LensVersion': 'string',
'Owner': 'string',
'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output of a list lenses call.
LensSummaries (list) --
List of lens summaries of available lenses.
(dict) --
A lens summary of a lens.
LensArn (string) --
The ARN of the lens.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
LensName (string) --
The full name of the lens.
LensType (string) --
The type of the lens.
Description (string) --
The description of the lens.
CreatedAt (datetime) --
The date and time recorded.
UpdatedAt (datetime) --
The date and time recorded.
LensVersion (string) --
The version of the lens.
Owner (string) --
An Amazon Web Services account ID.
LensStatus (string) --
The status of the lens.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_milestones(**kwargs)¶List all milestones for an existing workload.
See also: AWS API Documentation
Request Syntax
response = client.list_milestones(
WorkloadId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneSummaries': [
{
'MilestoneNumber': 123,
'MilestoneName': 'string',
'RecordedAt': datetime(2015, 1, 1),
'WorkloadSummary': {
'WorkloadId': 'string',
'WorkloadArn': 'string',
'WorkloadName': 'string',
'Owner': 'string',
'UpdatedAt': datetime(2015, 1, 1),
'Lenses': [
'string',
],
'RiskCounts': {
'string': 123
},
'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output of a list milestones call.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
MilestoneSummaries (list) --
A list of milestone summaries.
(dict) --
A milestone summary 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.
WorkloadSummary (dict) --
A workload summary 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.
Owner (string) --
An Amazon Web Services account ID.
UpdatedAt (datetime) --
The date and time recorded.
Lenses (list) --
The list of lenses associated with the workload. Each lens is identified by its LensSummary$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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
RiskCounts (dict) --
A map from risk names to the count of how 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.
ImprovementStatus (string) --
The improvement status for a workload.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_notifications(**kwargs)¶List lens notifications.
See also: AWS API Documentation
Request Syntax
response = client.list_notifications(
WorkloadId='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NotificationSummaries': [
{
'Type': 'LENS_VERSION_UPGRADED'|'LENS_VERSION_DEPRECATED',
'LensUpgradeSummary': {
'WorkloadId': 'string',
'WorkloadName': 'string',
'LensAlias': 'string',
'LensArn': 'string',
'CurrentLensVersion': 'string',
'LatestLensVersion': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
NotificationSummaries (list) --
List of lens notification summaries in a workload.
(dict) --
A notification summary return object.
Type (string) --
The type of notification.
LensUpgradeSummary (dict) --
Summary of lens upgrade.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
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.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
CurrentLensVersion (string) --
The current version of the lens.
LatestLensVersion (string) --
The latest version of the lens.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionList the workload invitations.
See also: AWS API Documentation
Request Syntax
response = client.list_share_invitations(
WorkloadNamePrefix='string',
LensNamePrefix='string',
ShareResourceType='WORKLOAD'|'LENS',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'ShareInvitationSummaries': [
{
'ShareInvitationId': 'string',
'SharedBy': 'string',
'SharedWith': 'string',
'PermissionType': 'READONLY'|'CONTRIBUTOR',
'ShareResourceType': 'WORKLOAD'|'LENS',
'WorkloadName': 'string',
'WorkloadId': 'string',
'LensName': 'string',
'LensArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Input for List Share Invitations
ShareInvitationSummaries (list) --
List of share invitation summaries in a workload.
(dict) --
A share invitation summary return object.
ShareInvitationId (string) --
The ID assigned to the share invitation.
SharedBy (string) --
An Amazon Web Services account ID.
SharedWith (string) --
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
PermissionType (string) --
Permission granted on a workload share.
ShareResourceType (string) --
The resource type of the share invitation.
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.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensName (string) --
The full name of the lens.
LensArn (string) --
The ARN for the lens.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionList the tags for a resource.
Note
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
WorkloadArn='string'
)
[REQUIRED]
The ARN for the workload.
{
'Tags': {
'string': 'string'
}
}
Response Structure
The tags for the resource.
Exceptions
WellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionList the workload shares associated with the workload.
See also: AWS API Documentation
Request Syntax
response = client.list_workload_shares(
WorkloadId='string',
SharedWithPrefix='string',
NextToken='string',
MaxResults=123,
Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
dict
Response Syntax
{
'WorkloadId': 'string',
'WorkloadShareSummaries': [
{
'ShareId': 'string',
'SharedWith': 'string',
'PermissionType': 'READONLY'|'CONTRIBUTOR',
'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
'StatusMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Input for List Workload Share
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadShareSummaries (list) --
A list of workload share summaries.
(dict) --
A workload share summary return object.
ShareId (string) --
The ID associated with the workload share.
SharedWith (string) --
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
PermissionType (string) --
Permission granted on a workload share.
Status (string) --
The status of a workload share.
StatusMessage (string) --
Optional message to compliment the Status field.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionlist_workloads(**kwargs)¶List workloads. Paginated.
See also: AWS API Documentation
Request Syntax
response = client.list_workloads(
WorkloadNamePrefix='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'WorkloadSummaries': [
{
'WorkloadId': 'string',
'WorkloadArn': 'string',
'WorkloadName': 'string',
'Owner': 'string',
'UpdatedAt': datetime(2015, 1, 1),
'Lenses': [
'string',
],
'RiskCounts': {
'string': 123
},
'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Output of a list workloads call.
WorkloadSummaries (list) --
A list of workload summaries.
(dict) --
A workload summary 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.
Owner (string) --
An Amazon Web Services account ID.
UpdatedAt (datetime) --
The date and time recorded.
Lenses (list) --
The list of lenses associated with the workload. Each lens is identified by its LensSummary$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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
RiskCounts (dict) --
A map from risk names to the count of how 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.
ImprovementStatus (string) --
The improvement status for a workload.
NextToken (string) --
The token to use to retrieve the next set of results.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptiontag_resource(**kwargs)¶Adds one or more tags to the specified resource.
Note
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
WorkloadArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The ARN for the workload.
[REQUIRED]
The tags for the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
WellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Deletes specified tags from a resource.
Note
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
WorkloadArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The ARN for the workload.
[REQUIRED]
A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
WellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionupdate_answer(**kwargs)¶Update the answer to a specific question in a workload review.
See also: AWS API Documentation
Request Syntax
response = 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'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[REQUIRED]
The ID of the question.
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
The ID of a choice.
A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
The ID of a choice.
A list of choices to be updated.
The status of a choice.
The reason why a choice is non-applicable to a question in your workload.
The notes associated with a choice.
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'
}
}
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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.
This value is only available if the question has been answered.
HelpfulResourceUrl (string) --
The helpful resource URL for a question.
HelpfulResourceDisplayText (string) --
The helpful resource text to be displayed.
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 choice level helpful resource.
DisplayText (string) --
The display text for the choice content.
Url (string) --
The URL for the choice content.
ImprovementPlan (dict) --
The choice level 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. 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.
Type (string) --
Type of additional resource.
Content (list) --
The URLs for additional resources, either helpful resources or improvement plans. 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.
Reason (string) --
The reason why the question is not applicable to your workload.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionupdate_global_settings(**kwargs)¶Updates whether the Amazon Web Services account is opted into organization sharing features.
See also: AWS API Documentation
Request Syntax
response = client.update_global_settings(
OrganizationSharingStatus='ENABLED'|'DISABLED'
)
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionupdate_lens_review(**kwargs)¶Update lens review.
See also: AWS API Documentation
Request Syntax
response = client.update_lens_review(
WorkloadId='string',
LensAlias='string',
LensNotes='string',
PillarNotes={
'string': 'string'
}
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
List of pillar notes of a lens review in a workload.
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
The notes associated with the workload.
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
}
},
],
'UpdatedAt': datetime(2015, 1, 1),
'Notes': 'string',
'RiskCounts': {
'string': 123
},
'NextToken': 'string'
}
}
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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.
RiskCounts (dict) --
A map from risk names to the count of how 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.
UpdatedAt (datetime) --
The date and time recorded.
Notes (string) --
The notes associated with the workload.
RiskCounts (dict) --
A map from risk names to the count of how 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.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionUpdate a workload or custom lens share invitation.
Note
This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.
See also: AWS API Documentation
Request Syntax
response = client.update_share_invitation(
ShareInvitationId='string',
ShareInvitationAction='ACCEPT'|'REJECT'
)
[REQUIRED]
The ID assigned to the share invitation.
[REQUIRED]
Share invitation action taken by contributor.
dict
Response Syntax
{
'ShareInvitation': {
'ShareInvitationId': 'string',
'ShareResourceType': 'WORKLOAD'|'LENS',
'WorkloadId': 'string',
'LensAlias': 'string',
'LensArn': 'string'
}
}
Response Structure
(dict) --
ShareInvitation (dict) --
The updated workload or custom lens share invitation.
ShareInvitationId (string) --
The ID assigned to the share invitation.
ShareResourceType (string) --
The resource type of the share invitation.
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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
LensArn (string) --
The ARN for the lens.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionupdate_workload(**kwargs)¶Update an existing workload.
See also: AWS API Documentation
Request Syntax
response = 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'
},
Applications=[
'string',
]
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
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.
The list of Amazon Web Services account IDs associated with the workload.
An Amazon Web Services account ID.
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
The list of non-Amazon Web Services Regions associated with the workload.
The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
The ID used to identify a pillar, for example, security .
A pillar is identified by its PillarReviewSummary$PillarId.
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.
The industry type for the workload.
If specified, must be one of the following:
AgricultureAutomobileDefenseDesign and EngineeringDigital AdvertisingEducationEnvironmental ProtectionFinancial ServicesGamingGeneral Public ServicesHealthcareHospitalityInfoTechJustice and Public SafetyLife SciencesManufacturingMedia & EntertainmentMining & ResourcesOil & GasPower & UtilitiesProfessional ServicesReal Estate & ConstructionRetail & WholesaleSocial ProtectionTelecommunicationsTravel, Transportation & LogisticsOtherWell-Architected discovery configuration settings to associate to the workload.
Discovery integration status in respect to Trusted Advisor for the workload.
List of AppRegistry application ARNs to associate to the workload.
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'
},
'Applications': [
'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.
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:
AgricultureAutomobileDefenseDesign and EngineeringDigital AdvertisingEducationEnvironmental ProtectionFinancial ServicesGamingGeneral Public ServicesHealthcareHospitalityInfoTechJustice and Public SafetyLife SciencesManufacturingMedia & EntertainmentMining & ResourcesOil & GasPower & UtilitiesProfessional ServicesReal Estate & ConstructionRetail & WholesaleSocial ProtectionTelecommunicationsTravel, Transportation & LogisticsOtherIndustry (string) --
The industry for the workload.
Notes (string) --
The notes associated with the workload.
ImprovementStatus (string) --
The improvement status for a workload.
RiskCounts (dict) --
A map from risk names to the count of how 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.
(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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
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.
DiscoveryConfig (dict) --
Discovery configuration associated to the workload.
TrustedAdvisorIntegrationStatus (string) --
Discovery integration status in respect to Trusted Advisor for the workload.
Applications (list) --
List of AppRegistry application ARNs associated to the workload.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionUpdate a workload share.
See also: AWS API Documentation
Request Syntax
response = client.update_workload_share(
ShareId='string',
WorkloadId='string',
PermissionType='READONLY'|'CONTRIBUTOR'
)
[REQUIRED]
The ID associated with the workload share.
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[REQUIRED]
Permission granted on a workload share.
dict
Response Syntax
{
'WorkloadId': 'string',
'WorkloadShare': {
'ShareId': 'string',
'SharedBy': 'string',
'SharedWith': 'string',
'PermissionType': 'READONLY'|'CONTRIBUTOR',
'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
'WorkloadName': 'string',
'WorkloadId': 'string'
}
}
Response Structure
(dict) --
Input for Update Workload Share
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadShare (dict) --
A workload share return object.
ShareId (string) --
The ID associated with the workload share.
SharedBy (string) --
An Amazon Web Services account ID.
SharedWith (string) --
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
PermissionType (string) --
Permission granted on a workload share.
Status (string) --
The status of a workload share.
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.
WorkloadId (string) --
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionupgrade_lens_review(**kwargs)¶Upgrade lens review.
See also: AWS API Documentation
Request Syntax
response = client.upgrade_lens_review(
WorkloadId='string',
LensAlias='string',
MilestoneName='string',
ClientRequestToken='string'
)
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
[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-west-2::lens/serverless .
For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .
Each lens is identified by its LensSummary$LensAlias.
[REQUIRED]
The name of the milestone in a workload.
Milestone names must be unique within a workload.
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.
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.
None
Exceptions
WellArchitected.Client.exceptions.ValidationExceptionWellArchitected.Client.exceptions.ResourceNotFoundExceptionWellArchitected.Client.exceptions.ConflictExceptionWellArchitected.Client.exceptions.InternalServerExceptionWellArchitected.Client.exceptions.AccessDeniedExceptionWellArchitected.Client.exceptions.ThrottlingExceptionThe available paginators are: