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 .
client = session.create_client('wellarchitected')
These are the available methods:
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',
]
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAliases (list) –
[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 .
(string) –
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
None
Exceptions
can_paginate
(operation_name)¶Check if an operation can be paginated.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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.
Create a lens share.
The owner of a lens can share it with other Amazon Web Services accounts and IAM users 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'
)
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
SharedWith (string) –
[REQUIRED]
The Amazon Web Services account ID or IAM role with which the workload is shared.
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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
create_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'
)
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
LensVersion (string) –
[REQUIRED]
The version of the lens being created.
IsMajorVersion (boolean) – Set to true if this new major lens version.
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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
create_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'
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
MilestoneName (string) –
[REQUIRED]
The name of the milestone in a workload.
Milestone names must be unique within a workload.
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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
create_workload
(**kwargs)¶Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts and IAM users 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'
}
)
WorkloadName (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.
Description (string) –
[REQUIRED]
The description for the workload.
Environment (string) –
[REQUIRED]
The environment for the workload.
AccountIds (list) –
The list of Amazon Web Services account IDs associated with the workload.
(string) –
An Amazon Web Services account ID.
AwsRegions (list) –
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2
, or ca-central-1
.
(string) –
An Amazon Web Services Region, for example, us-west-2
or ap-northeast-1
.
NonAwsRegions (list) –
The list of non-Amazon Web Services Regions associated with the workload.
(string) –
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 .
ArchitecturalDesign (string) – The URL of the architectural design for the workload.
ReviewOwner (string) –
[REQUIRED]
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
IndustryType (string) –
The industry type for the workload.
If specified, must be one of the following:
Agriculture
Automobile
Defense
Design and Engineering
Digital Advertising
Education
Environmental Protection
Financial Services
Gaming
General Public Services
Healthcare
Hospitality
InfoTech
Justice and Public Safety
Life Sciences
Manufacturing
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Professional Services
Real Estate & Construction
Retail & Wholesale
Social Protection
Telecommunications
Travel, Transportation & Logistics
Other
Industry (string) – The industry for the workload.
Lenses (list) –
[REQUIRED]
The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias .
(string) –
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
Notes (string) – The notes associated with the workload.
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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 (dict) –
The tags to be associated with the workload.
(string) –
(string) –
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
Create 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'
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
SharedWith (string) –
[REQUIRED]
The Amazon Web Services account ID or IAM role with which the workload is shared.
PermissionType (string) –
[REQUIRED]
Permission granted on a workload share.
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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
delete_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'
)
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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.
LensStatus (string) –
[REQUIRED]
The status of the lens to be deleted.
None
Exceptions
Delete a lens share.
After the lens share 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_share(
ShareId='string',
LensAlias='string',
ClientRequestToken='string'
)
ShareId (string) –
[REQUIRED]
The ID associated with the workload share.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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
delete_workload
(**kwargs)¶Delete an existing workload.
See also: AWS API Documentation
Request Syntax
response = client.delete_workload(
WorkloadId='string',
ClientRequestToken='string'
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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
Delete a workload share.
See also: AWS API Documentation
Request Syntax
response = client.delete_workload_share(
ShareId='string',
WorkloadId='string',
ClientRequestToken='string'
)
ShareId (string) –
[REQUIRED]
The ID associated with the workload share.
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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
disassociate_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',
]
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAliases (list) –
[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 .
(string) –
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
None
Exceptions
export_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'
)
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
LensVersion (string) – The lens version to be exported.
dict
Response Syntax
{
'LensJSON': 'string'
}
Response Structure
(dict) –
LensJSON (string) –
The JSON for the lens.
Exceptions
get_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
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
QuestionId (string) –
[REQUIRED]
The ID of the question.
MilestoneNumber (integer) –
The milestone number.
A workload can have a maximum of 100 milestones.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123,
'LensAlias': 'string',
'LensArn': 'string',
'Answer': {
'QuestionId': 'string',
'PillarId': 'string',
'QuestionTitle': 'string',
'QuestionDescription': 'string',
'ImprovementPlanUrl': 'string',
'HelpfulResourceUrl': 'string',
'HelpfulResourceDisplayText': 'string',
'Choices': [
{
'ChoiceId': 'string',
'Title': 'string',
'Description': 'string',
'HelpfulResource': {
'DisplayText': 'string',
'Url': 'string'
},
'ImprovementPlan': {
'DisplayText': 'string',
'Url': 'string'
}
},
],
'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 example, serverless
.
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.
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
get_lens
(**kwargs)¶Get an existing lens.
See also: AWS API Documentation
Request Syntax
response = client.get_lens(
LensAlias='string',
LensVersion='string'
)
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
LensVersion (string) – The lens version to be retrieved.
dict
Response Syntax
{
'Lens': {
'LensArn': 'string',
'LensVersion': 'string',
'Name': 'string',
'Description': 'string',
'Owner': 'string',
'ShareInvitationId': '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.
Exceptions
get_lens_review
(**kwargs)¶Get lens review.
See also: AWS API Documentation
Request Syntax
response = client.get_lens_review(
WorkloadId='string',
LensAlias='string',
MilestoneNumber=123
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
MilestoneNumber (integer) –
The milestone number.
A workload can have a maximum of 100 milestones.
dict
Response Syntax
{
'WorkloadId': 'string',
'MilestoneNumber': 123,
'LensReview': {
'LensAlias': 'string',
'LensArn': 'string',
'LensVersion': 'string',
'LensName': 'string',
'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED',
'PillarReviewSummaries': [
{
'PillarId': 'string',
'PillarName': 'string',
'Notes': 'string',
'RiskCounts': {
'string': 123
}
},
],
'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 example, serverless
.
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
get_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
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
MilestoneNumber (integer) –
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 example, serverless
.
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
get_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'
)
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
BaseLensVersion (string) – The base version of the lens.
TargetLensVersion (string) – The lens version to target a difference for.
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 example, serverless
.
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
get_milestone
(**kwargs)¶Get a milestone for an existing workload.
See also: AWS API Documentation
Request Syntax
response = client.get_milestone(
WorkloadId='string',
MilestoneNumber=123
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
MilestoneNumber (integer) –
[REQUIRED]
The milestone number.
A workload can have a maximum of 100 milestones.
dict
Response Syntax
{
'WorkloadId': 'string',
'Milestone': {
'MilestoneNumber': 123,
'MilestoneName': 'string',
'RecordedAt': datetime(2015, 1, 1),
'Workload': {
'WorkloadId': 'string',
'WorkloadArn': 'string',
'WorkloadName': 'string',
'Description': 'string',
'Environment': 'PRODUCTION'|'PREPRODUCTION',
'UpdatedAt': datetime(2015, 1, 1),
'AccountIds': [
'string',
],
'AwsRegions': [
'string',
],
'NonAwsRegions': [
'string',
],
'ArchitecturalDesign': 'string',
'ReviewOwner': 'string',
'ReviewRestrictionDate': datetime(2015, 1, 1),
'IsReviewOwnerUpdateAcknowledged': True|False,
'IndustryType': 'string',
'Industry': 'string',
'Notes': 'string',
'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED',
'RiskCounts': {
'string': 123
},
'PillarPriorities': [
'string',
],
'Lenses': [
'string',
],
'Owner': 'string',
'ShareInvitationId': 'string',
'Tags': {
'string': 'string'
}
}
}
}
Response Structure
(dict) –
Output of a get milestone call.
WorkloadId (string) –
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Milestone (dict) –
A milestone return object.
MilestoneNumber (integer) –
The milestone number.
A workload can have a maximum of 100 milestones.
MilestoneName (string) –
The name of the milestone in a workload.
Milestone names must be unique within a workload.
RecordedAt (datetime) –
The date and time recorded.
Workload (dict) –
A workload return object.
WorkloadId (string) –
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadArn (string) –
The ARN for the workload.
WorkloadName (string) –
The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
Description (string) –
The description for the workload.
Environment (string) –
The environment for the workload.
UpdatedAt (datetime) –
The date and time recorded.
AccountIds (list) –
The list of Amazon Web Services account IDs associated with the workload.
(string) –
An Amazon Web Services account ID.
AwsRegions (list) –
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2
, or ca-central-1
.
(string) –
An Amazon Web Services Region, for example, us-west-2
or ap-northeast-1
.
NonAwsRegions (list) –
The list of non-Amazon Web Services Regions associated with the workload.
(string) –
ArchitecturalDesign (string) –
The URL of the architectural design for the workload.
ReviewOwner (string) –
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
ReviewRestrictionDate (datetime) –
The date and time recorded.
IsReviewOwnerUpdateAcknowledged (boolean) –
Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
IndustryType (string) –
The industry type for the workload.
If specified, must be one of the following:
Agriculture
Automobile
Defense
Design and Engineering
Digital Advertising
Education
Environmental Protection
Financial Services
Gaming
General Public Services
Healthcare
Hospitality
InfoTech
Justice and Public Safety
Life Sciences
Manufacturing
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Professional Services
Real Estate & Construction
Retail & Wholesale
Social Protection
Telecommunications
Travel, Transportation & Logistics
Other
Industry (string) –
The industry for the workload.
Notes (string) –
The notes associated with the workload.
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 example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
Owner (string) –
An Amazon Web Services account ID.
ShareInvitationId (string) –
The ID assigned to the share invitation.
Tags (dict) –
The tags associated with the workload.
(string) –
(string) –
Exceptions
get_paginator
(operation_name)¶Create a paginator for an operation.
operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is 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")
.
OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate
method to
check if an operation is pageable.
L{botocore.paginate.Paginator}
A paginator object.
get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
waiter_name (str) – The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
The specified waiter object.
botocore.waiter.Waiter
get_workload
(**kwargs)¶Get an existing workload.
See also: AWS API Documentation
Request Syntax
response = client.get_workload(
WorkloadId='string'
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
dict
Response Syntax
{
'Workload': {
'WorkloadId': 'string',
'WorkloadArn': 'string',
'WorkloadName': 'string',
'Description': 'string',
'Environment': 'PRODUCTION'|'PREPRODUCTION',
'UpdatedAt': datetime(2015, 1, 1),
'AccountIds': [
'string',
],
'AwsRegions': [
'string',
],
'NonAwsRegions': [
'string',
],
'ArchitecturalDesign': 'string',
'ReviewOwner': 'string',
'ReviewRestrictionDate': datetime(2015, 1, 1),
'IsReviewOwnerUpdateAcknowledged': True|False,
'IndustryType': 'string',
'Industry': 'string',
'Notes': 'string',
'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED',
'RiskCounts': {
'string': 123
},
'PillarPriorities': [
'string',
],
'Lenses': [
'string',
],
'Owner': 'string',
'ShareInvitationId': 'string',
'Tags': {
'string': 'string'
}
}
}
Response Structure
(dict) –
Output of a get workload call.
Workload (dict) –
A workload return object.
WorkloadId (string) –
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadArn (string) –
The ARN for the workload.
WorkloadName (string) –
The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
Description (string) –
The description for the workload.
Environment (string) –
The environment for the workload.
UpdatedAt (datetime) –
The date and time recorded.
AccountIds (list) –
The list of Amazon Web Services account IDs associated with the workload.
(string) –
An Amazon Web Services account ID.
AwsRegions (list) –
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2
, or ca-central-1
.
(string) –
An Amazon Web Services Region, for example, us-west-2
or ap-northeast-1
.
NonAwsRegions (list) –
The list of non-Amazon Web Services Regions associated with the workload.
(string) –
ArchitecturalDesign (string) –
The URL of the architectural design for the workload.
ReviewOwner (string) –
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
ReviewRestrictionDate (datetime) –
The date and time recorded.
IsReviewOwnerUpdateAcknowledged (boolean) –
Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
IndustryType (string) –
The industry type for the workload.
If specified, must be one of the following:
Agriculture
Automobile
Defense
Design and Engineering
Digital Advertising
Education
Environmental Protection
Financial Services
Gaming
General Public Services
Healthcare
Hospitality
InfoTech
Justice and Public Safety
Life Sciences
Manufacturing
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Professional Services
Real Estate & Construction
Retail & Wholesale
Social Protection
Telecommunications
Travel, Transportation & Logistics
Other
Industry (string) –
The industry for the workload.
Notes (string) –
The notes associated with the workload.
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 example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
Owner (string) –
An Amazon Web Services account ID.
ShareInvitationId (string) –
The ID assigned to the share invitation.
Tags (dict) –
The tags associated with the workload.
(string) –
(string) –
Exceptions
import_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'
}
)
LensAlias (string) –
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
JSONString (string) –
[REQUIRED]
The JSON representation of a lens.
ClientRequestToken (string) –
[REQUIRED]
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after 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 (dict) –
Tags to associate to a lens.
(string) –
(string) –
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
list_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
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
PillarId (string) –
The ID used to identify a pillar, for example, security
.
A pillar is identified by its PillarReviewSummary$PillarId .
MilestoneNumber (integer) –
The milestone number.
A workload can have a maximum of 100 milestones.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
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'
}
},
],
'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 example, serverless
.
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.
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
list_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
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
PillarId (string) –
The ID used to identify a pillar, for example, security
.
A pillar is identified by its PillarReviewSummary$PillarId .
MilestoneNumber (integer) –
The milestone number.
A workload can have a maximum of 100 milestones.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
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 example, serverless
.
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
list_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
)
WorkloadId (string) –
[REQUIRED]
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.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
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 example, serverless
.
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
List 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
)
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
SharedWithPrefix (string) – The Amazon Web Services account ID or IAM role with which the lens is shared.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
dict
Response Syntax
{
'LensShareSummaries': [
{
'ShareId': 'string',
'SharedWith': 'string',
'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'
},
],
'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 or IAM role with which the workload is shared.
Status (string) –
The status of a workload share.
NextToken (string) –
The token to use to retrieve the next set of results.
Exceptions
list_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'
)
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
LensType (string) – The type of lenses to be returned.
LensStatus (string) – The status of lenses to be returned.
LensName (string) – The full name of the lens.
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 example, serverless
.
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
list_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
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
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 example, serverless
.
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
list_notifications
(**kwargs)¶List lens notifications.
See also: AWS API Documentation
Request Syntax
response = client.list_notifications(
WorkloadId='string',
NextToken='string',
MaxResults=123
)
WorkloadId (string) – The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
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 example, serverless
.
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
List 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
)
WorkloadNamePrefix (string) – An optional string added to the beginning of each workload name returned in the results.
LensNamePrefix (string) – An optional string added to the beginning of each lens name returned in the results.
ShareResourceType (string) – The type of share invitations to be returned.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
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 or IAM role 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
List the tags for a resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
WorkloadArn='string'
)
WorkloadArn (string) –
[REQUIRED]
The ARN for the workload.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) –
Tags (dict) –
The tags for the resource.
(string) –
(string) –
Exceptions
List 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
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
SharedWithPrefix (string) – The Amazon Web Services account ID or IAM role with which the workload is shared.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
dict
Response Syntax
{
'WorkloadId': 'string',
'WorkloadShareSummaries': [
{
'ShareId': 'string',
'SharedWith': 'string',
'PermissionType': 'READONLY'|'CONTRIBUTOR',
'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'
},
],
'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 or IAM role with which the workload is shared.
PermissionType (string) –
Permission granted on a workload share.
Status (string) –
The status of a workload share.
NextToken (string) –
The token to use to retrieve the next set of results.
Exceptions
list_workloads
(**kwargs)¶List workloads. Paginated.
See also: AWS API Documentation
Request Syntax
response = client.list_workloads(
WorkloadNamePrefix='string',
NextToken='string',
MaxResults=123
)
WorkloadNamePrefix (string) – An optional string added to the beginning of each workload name returned in the results.
NextToken (string) – The token to use to retrieve the next set of results.
MaxResults (integer) – The maximum number of results to return for this request.
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 example, serverless
.
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
tag_resource
(**kwargs)¶Adds one or more tags to the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
WorkloadArn='string',
Tags={
'string': 'string'
}
)
WorkloadArn (string) –
[REQUIRED]
The ARN for the workload.
Tags (dict) –
[REQUIRED]
The tags for the resource.
(string) –
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
untag_resource
(**kwargs)¶Deletes specified tags from a resource.
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',
]
)
WorkloadArn (string) –
[REQUIRED]
The ARN for the workload.
TagKeys (list) –
[REQUIRED]
A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.
(string) –
dict
Response Syntax
{}
Response Structure
(dict) –
Exceptions
update_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'
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
QuestionId (string) –
[REQUIRED]
The ID of the question.
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.
ChoiceUpdates (dict) –
A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
(string) –
The ID of a choice.
(dict) –
A list of choices to be updated.
Status (string) – [REQUIRED]
The status of a choice.
Reason (string) –
The reason why a choice is non-applicable to a question in your workload.
Notes (string) –
The notes associated with a choice.
Notes (string) – The notes associated with the workload.
IsApplicable (boolean) – Defines whether this question is applicable to a lens review.
Reason (string) – The reason why a question is not applicable to your workload.
dict
Response Syntax
{
'WorkloadId': 'string',
'LensAlias': 'string',
'LensArn': 'string',
'Answer': {
'QuestionId': 'string',
'PillarId': 'string',
'QuestionTitle': 'string',
'QuestionDescription': 'string',
'ImprovementPlanUrl': 'string',
'HelpfulResourceUrl': 'string',
'HelpfulResourceDisplayText': 'string',
'Choices': [
{
'ChoiceId': 'string',
'Title': 'string',
'Description': 'string',
'HelpfulResource': {
'DisplayText': 'string',
'Url': 'string'
},
'ImprovementPlan': {
'DisplayText': 'string',
'Url': 'string'
}
},
],
'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 example, serverless
.
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.
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
update_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'
}
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
LensNotes (string) – The notes associated with the workload.
PillarNotes (dict) –
List of pillar notes of a lens review in a workload.
(string) –
The ID used to identify a pillar, for example, security
.
A pillar is identified by its PillarReviewSummary$PillarId .
(string) –
The notes associated with the workload.
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 example, serverless
.
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
Update a workload invitation.
See also: AWS API Documentation
Request Syntax
response = client.update_share_invitation(
ShareInvitationId='string',
ShareInvitationAction='ACCEPT'|'REJECT'
)
ShareInvitationId (string) –
[REQUIRED]
The ID assigned to the share invitation.
ShareInvitationAction (string) –
[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 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 example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
LensArn (string) –
The ARN for the lens.
Exceptions
update_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'
)
WorkloadId (string) –
[REQUIRED]
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.
Description (string) – The description for the workload.
Environment (string) – The environment for the workload.
AccountIds (list) –
The list of Amazon Web Services account IDs associated with the workload.
(string) –
An Amazon Web Services account ID.
AwsRegions (list) –
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2
, or ca-central-1
.
(string) –
An Amazon Web Services Region, for example, us-west-2
or ap-northeast-1
.
NonAwsRegions (list) –
The list of non-Amazon Web Services Regions associated with the workload.
(string) –
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 .
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.
IsReviewOwnerUpdateAcknowledged (boolean) –
Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
IndustryType (string) –
The industry type for the workload.
If specified, must be one of the following:
Agriculture
Automobile
Defense
Design and Engineering
Digital Advertising
Education
Environmental Protection
Financial Services
Gaming
General Public Services
Healthcare
Hospitality
InfoTech
Justice and Public Safety
Life Sciences
Manufacturing
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Professional Services
Real Estate & Construction
Retail & Wholesale
Social Protection
Telecommunications
Travel, Transportation & Logistics
Other
Industry (string) – The industry for the workload.
Notes (string) – The notes associated with the workload.
ImprovementStatus (string) – The improvement status for a 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'
}
}
}
Response Structure
(dict) –
Output of an update workload call.
Workload (dict) –
A workload return object.
WorkloadId (string) –
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadArn (string) –
The ARN for the workload.
WorkloadName (string) –
The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
Description (string) –
The description for the workload.
Environment (string) –
The environment for the workload.
UpdatedAt (datetime) –
The date and time recorded.
AccountIds (list) –
The list of Amazon Web Services account IDs associated with the workload.
(string) –
An Amazon Web Services account ID.
AwsRegions (list) –
The list of Amazon Web Services Regions associated with the workload, for example, us-east-2
, or ca-central-1
.
(string) –
An Amazon Web Services Region, for example, us-west-2
or ap-northeast-1
.
NonAwsRegions (list) –
The list of non-Amazon Web Services Regions associated with the workload.
(string) –
ArchitecturalDesign (string) –
The URL of the architectural design for the workload.
ReviewOwner (string) –
The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
ReviewRestrictionDate (datetime) –
The date and time recorded.
IsReviewOwnerUpdateAcknowledged (boolean) –
Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
IndustryType (string) –
The industry type for the workload.
If specified, must be one of the following:
Agriculture
Automobile
Defense
Design and Engineering
Digital Advertising
Education
Environmental Protection
Financial Services
Gaming
General Public Services
Healthcare
Hospitality
InfoTech
Justice and Public Safety
Life Sciences
Manufacturing
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Professional Services
Real Estate & Construction
Retail & Wholesale
Social Protection
Telecommunications
Travel, Transportation & Logistics
Other
Industry (string) –
The industry for the workload.
Notes (string) –
The notes associated with the workload.
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 example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
Owner (string) –
An Amazon Web Services account ID.
ShareInvitationId (string) –
The ID assigned to the share invitation.
Tags (dict) –
The tags associated with the workload.
(string) –
(string) –
Exceptions
Update a workload share.
See also: AWS API Documentation
Request Syntax
response = client.update_workload_share(
ShareId='string',
WorkloadId='string',
PermissionType='READONLY'|'CONTRIBUTOR'
)
ShareId (string) –
[REQUIRED]
The ID associated with the workload share.
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
PermissionType (string) –
[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',
'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 or IAM role 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
upgrade_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'
)
WorkloadId (string) –
[REQUIRED]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
LensAlias (string) –
[REQUIRED]
The alias of the lens, for example, serverless
.
Each lens is identified by its LensSummary$LensAlias .
MilestoneName (string) –
[REQUIRED]
The name of the milestone in a workload.
Milestone names must be unique within a workload.
ClientRequestToken (string) –
A unique case-sensitive string used to ensure that this request is idempotent (executes only once).
You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.
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
Client exceptions are available on a client instance via the exceptions
property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
WellArchitected.Client.exceptions.
AccessDeniedException
¶User does not have sufficient access to perform this action.
Example
try:
...
except client.exceptions.AccessDeniedException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
User does not have sufficient access to perform this action.
Message (string) –
Description of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
WellArchitected.Client.exceptions.
ConflictException
¶The resource already exists.
Example
try:
...
except client.exceptions.ConflictException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The resource already exists.
Message (string) –
Description of the error.
ResourceId (string) –
Identifier of the resource affected.
ResourceType (string) –
Type of the resource affected.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
WellArchitected.Client.exceptions.
InternalServerException
¶There is a problem with the Well-Architected Tool API service.
Example
try:
...
except client.exceptions.InternalServerException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
There is a problem with the Well-Architected Tool API service.
Message (string) –
Description of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
WellArchitected.Client.exceptions.
ResourceNotFoundException
¶The requested resource was not found.
Example
try:
...
except client.exceptions.ResourceNotFoundException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The requested resource was not found.
Message (string) –
Description of the error.
ResourceId (string) –
Identifier of the resource affected.
ResourceType (string) –
Type of the resource affected.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
WellArchitected.Client.exceptions.
ServiceQuotaExceededException
¶The user has reached their resource quota.
Example
try:
...
except client.exceptions.ServiceQuotaExceededException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'ResourceId': 'string',
'ResourceType': 'string',
'QuotaCode': 'string',
'ServiceCode': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The user has reached their resource quota.
Message (string) –
Description of the error.
ResourceId (string) –
Identifier of the resource affected.
ResourceType (string) –
Type of the resource affected.
QuotaCode (string) –
Service Quotas requirement to identify originating quota.
ServiceCode (string) –
Service Quotas requirement to identify originating service.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
WellArchitected.Client.exceptions.
ThrottlingException
¶Request was denied due to request throttling.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'QuotaCode': 'string',
'ServiceCode': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
Request was denied due to request throttling.
Message (string) –
Description of the error.
QuotaCode (string) –
Service Quotas requirement to identify originating quota.
ServiceCode (string) –
Service Quotas requirement to identify originating service.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
WellArchitected.Client.exceptions.
ValidationException
¶The user input is not valid.
Example
try:
...
except client.exceptions.ValidationException as e:
print(e.response)
response
¶The parsed error response. All exceptions have a top level Error
key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Reason': 'UNKNOWN_OPERATION'|'CANNOT_PARSE'|'FIELD_VALIDATION_FAILED'|'OTHER',
'Fields': [
{
'Name': 'string',
'Message': 'string'
},
],
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) –
The user input is not valid.
Message (string) –
Description of the error.
Reason (string) –
The reason why the request failed validation.
Fields (list) –
The fields that caused the error, if applicable.
(dict) –
Stores information about a field passed inside a request that resulted in an exception.
Name (string) –
The field name for which validation failed.
Message (string) –
Description of the error.
Error (dict) – Normalized access to common exception attributes.
Code (string) – An identifier specifying the exception type.
Message (string) – A descriptive message explaining why the exception occured.
The available paginators are: