WellArchitected *************** Client ====== class WellArchitected.Client A low-level client representing AWS Well-Architected Tool This is the *Well-Architected Tool API Reference*. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide. import boto3 client = boto3.client('wellarchitected') These are the available methods: * associate_lenses * associate_profiles * can_paginate * close * create_lens_share * create_lens_version * create_milestone * create_profile * create_profile_share * create_review_template * create_template_share * create_workload * create_workload_share * delete_lens * delete_lens_share * delete_profile * delete_profile_share * delete_review_template * delete_template_share * delete_workload * delete_workload_share * disassociate_lenses * disassociate_profiles * export_lens * get_answer * get_consolidated_report * get_global_settings * get_lens * get_lens_review * get_lens_review_report * get_lens_version_difference * get_milestone * get_paginator * get_profile * get_profile_template * get_review_template * get_review_template_answer * get_review_template_lens_review * get_waiter * get_workload * import_lens * list_answers * list_check_details * list_check_summaries * list_lens_review_improvements * list_lens_reviews * list_lens_shares * list_lenses * list_milestones * list_notifications * list_profile_notifications * list_profile_shares * list_profiles * list_review_template_answers * list_review_templates * list_share_invitations * list_tags_for_resource * list_template_shares * list_workload_shares * list_workloads * tag_resource * untag_resource * update_answer * update_global_settings * update_integration * update_lens_review * update_profile * update_review_template * update_review_template_answer * update_review_template_lens_review * update_share_invitation * update_workload * update_workload_share * upgrade_lens_review * upgrade_profile_version * upgrade_review_template_lens_review WellArchitected / Client / list_review_template_answers list_review_template_answers **************************** WellArchitected.Client.list_review_template_answers(**kwargs) List the answers of a review template. See also: AWS API Documentation **Request Syntax** response = client.list_review_template_answers( TemplateArn='string', LensAlias='string', PillarId='string', NextToken='string', MaxResults=123 ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The ARN of the review template. * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **PillarId** (*string*) -- The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **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. Return type: dict Returns: **Response Syntax** { 'TemplateArn': 'string', 'LensAlias': 'string', 'AnswerSummaries': [ { 'QuestionId': 'string', 'PillarId': 'string', 'QuestionTitle': 'string', 'Choices': [ { 'ChoiceId': 'string', 'Title': 'string', 'Description': 'string', 'HelpfulResource': { 'DisplayText': 'string', 'Url': 'string' }, 'ImprovementPlan': { 'DisplayText': 'string', 'Url': 'string' }, 'AdditionalResources': [ { 'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN', 'Content': [ { 'DisplayText': 'string', 'Url': 'string' }, ] }, ] }, ], 'SelectedChoices': [ 'string', ], 'ChoiceAnswerSummaries': [ { 'ChoiceId': 'string', 'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE' }, ], 'IsApplicable': True|False, 'AnswerStatus': 'UNANSWERED'|'ANSWERED', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE', 'QuestionType': 'PRIORITIZED'|'NON_PRIORITIZED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TemplateArn** *(string) --* The ARN of the review template. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **AnswerSummaries** *(list) --* List of answer summaries of a lens review in a review template. * *(dict) --* The summary of review template answers. * **QuestionId** *(string) --* The ID of the question. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionTitle** *(string) --* The title of the question. * **Choices** *(list) --* List of choices available for a question. * *(dict) --* A choice available to answer question. * **ChoiceId** *(string) --* The ID of a choice. * **Title** *(string) --* The title of a choice. * **Description** *(string) --* The description of a choice. * **HelpfulResource** *(dict) --* The helpful resource (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one helpful resource. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **ImprovementPlan** *(dict) --* The improvement plan (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one improvement plan. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **AdditionalResources** *(list) --* The additional resources for a choice in a custom lens. A choice can have up to two additional resources: one of type "HELPFUL_RESOURCE", one of type "IMPROVEMENT_PLAN", or both. * *(dict) --* The choice level additional resources for a custom lens. This field does not apply to Amazon Web Services official lenses. * **Type** *(string) --* Type of additional resource for a custom lens. * **Content** *(list) --* The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified. * *(dict) --* The choice content. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **SelectedChoices** *(list) --* List of selected choice IDs in a question answer. The values entered replace the previously selected choices. * *(string) --* The ID of a choice. * **ChoiceAnswerSummaries** *(list) --* A list of selected choices to a question in the review template. * *(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. * **AnswerStatus** *(string) --* The status of whether or not this question has been answered. * **Reason** *(string) --* The reason why a choice is not-applicable to a question in the review template. * **QuestionType** *(string) --* The type of question. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_profile_template get_profile_template ******************** WellArchitected.Client.get_profile_template() Get profile template. See also: AWS API Documentation **Request Syntax** response = client.get_profile_template() Return type: dict Returns: **Response Syntax** { 'ProfileTemplate': { 'TemplateName': 'string', 'TemplateQuestions': [ { 'QuestionId': 'string', 'QuestionTitle': 'string', 'QuestionDescription': 'string', 'QuestionChoices': [ { 'ChoiceId': 'string', 'ChoiceTitle': 'string', 'ChoiceDescription': 'string' }, ], 'MinSelectedChoices': 123, 'MaxSelectedChoices': 123 }, ], 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **ProfileTemplate** *(dict) --* The profile template. * **TemplateName** *(string) --* The name of the profile template. * **TemplateQuestions** *(list) --* Profile template questions. * *(dict) --* A profile template question. * **QuestionId** *(string) --* The ID of the question. * **QuestionTitle** *(string) --* The title of the question. * **QuestionDescription** *(string) --* The description of the question. * **QuestionChoices** *(list) --* The question choices. * *(dict) --* A profile template choice. * **ChoiceId** *(string) --* The ID of a choice. * **ChoiceTitle** *(string) --* The title of a choice. * **ChoiceDescription** *(string) --* The description of a choice. * **MinSelectedChoices** *(integer) --* The minimum number of choices selected. * **MaxSelectedChoices** *(integer) --* The maximum number of choices selected. * **CreatedAt** *(datetime) --* The date and time recorded. * **UpdatedAt** *(datetime) --* The date and time recorded. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_paginator get_paginator ************* WellArchitected.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. WellArchitected / Client / list_profile_notifications list_profile_notifications ************************** WellArchitected.Client.list_profile_notifications(**kwargs) List profile notifications. See also: AWS API Documentation **Request Syntax** response = client.list_profile_notifications( WorkloadId='string', NextToken='string', MaxResults=123 ) Parameters: * **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. Return type: dict Returns: **Response Syntax** { 'NotificationSummaries': [ { 'CurrentProfileVersion': 'string', 'LatestProfileVersion': 'string', 'Type': 'PROFILE_ANSWERS_UPDATED'|'PROFILE_DELETED', 'ProfileArn': 'string', 'ProfileName': 'string', 'WorkloadId': 'string', 'WorkloadName': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **NotificationSummaries** *(list) --* Notification summaries. * *(dict) --* The profile notification summary. * **CurrentProfileVersion** *(string) --* The current profile version. * **LatestProfileVersion** *(string) --* The latest profile version. * **Type** *(string) --* Type of notification. * **ProfileArn** *(string) --* The profile ARN. * **ProfileName** *(string) --* The profile name. * **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. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / delete_profile_share delete_profile_share ******************** WellArchitected.Client.delete_profile_share(**kwargs) Delete a profile share. See also: AWS API Documentation **Request Syntax** response = client.delete_profile_share( ShareId='string', ProfileArn='string', ClientRequestToken='string' ) Parameters: * **ShareId** (*string*) -- **[REQUIRED]** The ID associated with the share. * **ProfileArn** (*string*) -- **[REQUIRED]** The profile ARN. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_integration update_integration ****************** WellArchitected.Client.update_integration(**kwargs) Update integration features. See also: AWS API Documentation **Request Syntax** response = client.update_integration( WorkloadId='string', ClientRequestToken='string', IntegratingService='JIRA' ) Parameters: * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. * **IntegratingService** (*string*) -- **[REQUIRED]** Which integrated service to update. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / can_paginate can_paginate ************ WellArchitected.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **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")". Returns: "True" if the operation can be paginated, "False" otherwise. WellArchitected / Client / import_lens import_lens *********** WellArchitected.Client.import_lens(**kwargs) Import a new custom lens or update an existing custom lens. To update an existing custom lens, specify its ARN as the "LensAlias". If no ARN is specified, a new custom lens is created. The new or updated lens will have a status of "DRAFT". 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' } ) Parameters: * **LensAlias** (*string*) -- The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. * **Tags** (*dict*) -- Tags to associate to a lens. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'LensArn': 'string', 'Status': 'IN_PROGRESS'|'COMPLETE'|'ERROR' } **Response Structure** * *(dict) --* * **LensArn** *(string) --* The ARN for the lens that was created or updated. * **Status** *(string) --* The status of the imported lens. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_milestone get_milestone ************* WellArchitected.Client.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 ) Parameters: * **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. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'Milestone': { 'MilestoneNumber': 123, 'MilestoneName': 'string', 'RecordedAt': datetime(2015, 1, 1), 'Workload': { 'WorkloadId': 'string', 'WorkloadArn': 'string', 'WorkloadName': 'string', 'Description': 'string', 'Environment': 'PRODUCTION'|'PREPRODUCTION', 'UpdatedAt': datetime(2015, 1, 1), 'AccountIds': [ 'string', ], 'AwsRegions': [ 'string', ], 'NonAwsRegions': [ 'string', ], 'ArchitecturalDesign': 'string', 'ReviewOwner': 'string', 'ReviewRestrictionDate': datetime(2015, 1, 1), 'IsReviewOwnerUpdateAcknowledged': True|False, 'IndustryType': 'string', 'Industry': 'string', 'Notes': 'string', 'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED', 'RiskCounts': { 'string': 123 }, 'PillarPriorities': [ 'string', ], 'Lenses': [ 'string', ], 'Owner': 'string', 'ShareInvitationId': 'string', 'Tags': { 'string': 'string' }, 'DiscoveryConfig': { 'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED', 'WorkloadResourceDefinition': [ 'WORKLOAD_METADATA'|'APP_REGISTRY', ] }, 'Applications': [ 'string', ], 'Profiles': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string' }, ], 'PrioritizedRiskCounts': { 'string': 123 }, 'JiraConfiguration': { 'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT', 'IssueManagementType': 'AUTO'|'MANUAL', 'JiraProjectKey': 'string', 'StatusMessage': 'string' } } } } **Response Structure** * *(dict) --* Output of a get milestone call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **Milestone** *(dict) --* A milestone return object. * **MilestoneNumber** *(integer) --* The milestone number. A workload can have a maximum of 100 milestones. * **MilestoneName** *(string) --* The name of the milestone in a workload. Milestone names must be unique within a workload. * **RecordedAt** *(datetime) --* The date and time recorded. * **Workload** *(dict) --* A workload return object. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **WorkloadArn** *(string) --* The ARN for the workload. * **WorkloadName** *(string) --* The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness. * **Description** *(string) --* The description for the workload. * **Environment** *(string) --* The environment for the workload. * **UpdatedAt** *(datetime) --* The date and time recorded. * **AccountIds** *(list) --* The list of Amazon Web Services account IDs associated with the workload. * *(string) --* An Amazon Web Services account ID. * **AwsRegions** *(list) --* The list of Amazon Web Services Regions associated with the workload, for example, "us-east-2", or "ca- central-1". * *(string) --* An Amazon Web Services Region, for example, "us- west-2" or "ap-northeast-1". * **NonAwsRegions** *(list) --* The list of non-Amazon Web Services Regions associated with the workload. * *(string) --* * **ArchitecturalDesign** *(string) --* The URL of the architectural design for the workload. * **ReviewOwner** *(string) --* The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process. * **ReviewRestrictionDate** *(datetime) --* The date and time recorded. * **IsReviewOwnerUpdateAcknowledged** *(boolean) --* Flag indicating whether the workload owner has acknowledged that the *Review owner* field is required. If a **Review owner** is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added. * **IndustryType** *(string) --* The industry type for the workload. If specified, must be one of the following: * "Agriculture" * "Automobile" * "Defense" * "Design and Engineering" * "Digital Advertising" * "Education" * "Environmental Protection" * "Financial Services" * "Gaming" * "General Public Services" * "Healthcare" * "Hospitality" * "InfoTech" * "Justice and Public Safety" * "Life Sciences" * "Manufacturing" * "Media & Entertainment" * "Mining & Resources" * "Oil & Gas" * "Power & Utilities" * "Professional Services" * "Real Estate & Construction" * "Retail & Wholesale" * "Social Protection" * "Telecommunications" * "Travel, Transportation & Logistics" * "Other" * **Industry** *(string) --* The industry for the workload. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **ImprovementStatus** *(string) --* The improvement status for a workload. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **PillarPriorities** *(list) --* The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId. * *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **Lenses** *(list) --* The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/ 0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Owner** *(string) --* An Amazon Web Services account ID. * **ShareInvitationId** *(string) --* The ID assigned to the share invitation. * **Tags** *(dict) --* The tags associated with the workload. * *(string) --* * *(string) --* * **DiscoveryConfig** *(dict) --* Discovery configuration associated to the workload. * **TrustedAdvisorIntegrationStatus** *(string) --* Discovery integration status in respect to Trusted Advisor for the workload. * **WorkloadResourceDefinition** *(list) --* The mode to use for identifying resources associated with the workload. You can specify "WORKLOAD_METADATA", "APP_REGISTRY", or both. * *(string) --* * **Applications** *(list) --* List of AppRegistry application ARNs associated to the workload. * *(string) --* * **Profiles** *(list) --* Profile associated with a workload. * *(dict) --* The profile associated with a workload. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **JiraConfiguration** *(dict) --* Jira configuration for a specific workload. * **IssueManagementStatus** *(string) --* Workload-level: Jira issue management status. * **IssueManagementType** *(string) --* Workload-level: Jira issue management type. * **JiraProjectKey** *(string) --* Workload-level: Jira project key to sync workloads to. * **StatusMessage** *(string) --* Workload-level: Status message on configuration of the Jira integration. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_lens_review update_lens_review ****************** WellArchitected.Client.update_lens_review(**kwargs) Update lens review for a particular workload. See also: AWS API Documentation **Request Syntax** response = client.update_lens_review( WorkloadId='string', LensAlias='string', LensNotes='string', PillarNotes={ 'string': 'string' }, JiraConfiguration={ 'SelectedPillars': [ { 'PillarId': 'string', 'SelectedQuestionIds': [ 'string', ] }, ] } ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensNotes** (*string*) -- The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **PillarNotes** (*dict*) -- List of pillar notes of a lens review in a workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **JiraConfiguration** (*dict*) -- Configuration of the Jira integration. * **SelectedPillars** *(list) --* Selected pillars in the workload. * *(dict) --* The selected pillar. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **SelectedQuestionIds** *(list) --* Selected question IDs in the selected pillar. * *(string) --* Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'LensReview': { 'LensAlias': 'string', 'LensArn': 'string', 'LensVersion': 'string', 'LensName': 'string', 'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED', 'PillarReviewSummaries': [ { 'PillarId': 'string', 'PillarName': 'string', 'Notes': 'string', 'RiskCounts': { 'string': 123 }, 'PrioritizedRiskCounts': { 'string': 123 } }, ], 'JiraConfiguration': { 'SelectedPillars': [ { 'PillarId': 'string', 'SelectedQuestionIds': [ 'string', ] }, ] }, 'UpdatedAt': datetime(2015, 1, 1), 'Notes': 'string', 'RiskCounts': { 'string': 123 }, 'NextToken': 'string', 'Profiles': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string' }, ], 'PrioritizedRiskCounts': { 'string': 123 } } } **Response Structure** * *(dict) --* Output of a update lens review call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **LensReview** *(dict) --* A lens review of a question. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/0123 456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **LensVersion** *(string) --* The version of the lens. * **LensName** *(string) --* The full name of the lens. * **LensStatus** *(string) --* The status of the lens. * **PillarReviewSummaries** *(list) --* List of pillar review summaries of lens review in a workload. * *(dict) --* A pillar review summary of a lens review. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **PillarName** *(string) --* The name of the pillar. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **JiraConfiguration** *(dict) --* Jira configuration status of the Lens review. * **SelectedPillars** *(list) --* Selected pillars in the workload. * *(dict) --* The selected pillar. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **SelectedQuestionIds** *(list) --* Selected question IDs in the selected pillar. * *(string) --* * **UpdatedAt** *(datetime) --* The date and time recorded. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **NextToken** *(string) --* The token to use to retrieve the next set of results. * **Profiles** *(list) --* The profiles associated with the workload. * *(dict) --* The profile associated with a workload. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_review_templates list_review_templates ********************* WellArchitected.Client.list_review_templates(**kwargs) List review templates. See also: AWS API Documentation **Request Syntax** response = client.list_review_templates( NextToken='string', MaxResults=123 ) Parameters: * **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. Return type: dict Returns: **Response Syntax** { 'ReviewTemplates': [ { 'Description': 'string', 'Lenses': [ 'string', ], 'Owner': 'string', 'UpdatedAt': datetime(2015, 1, 1), 'TemplateArn': 'string', 'TemplateName': 'string', 'UpdateStatus': 'CURRENT'|'LENS_NOT_CURRENT' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ReviewTemplates** *(list) --* List of review templates. * *(dict) --* Summary of a review template. * **Description** *(string) --* Description of the review template. * **Lenses** *(list) --* Lenses associated with the review template. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/ 0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Owner** *(string) --* An Amazon Web Services account ID. * **UpdatedAt** *(datetime) --* The date and time recorded. * **TemplateArn** *(string) --* The review template ARN. * **TemplateName** *(string) --* The name of the review template. * **UpdateStatus** *(string) --* The latest status of a review template. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / upgrade_profile_version upgrade_profile_version *********************** WellArchitected.Client.upgrade_profile_version(**kwargs) Upgrade a profile. See also: AWS API Documentation **Request Syntax** response = client.upgrade_profile_version( WorkloadId='string', ProfileArn='string', MilestoneName='string', ClientRequestToken='string' ) Parameters: * **WorkloadId** (*string*) -- **[REQUIRED]** The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **ProfileArn** (*string*) -- **[REQUIRED]** The profile ARN. * **MilestoneName** (*string*) -- 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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" WellArchitected / Client / delete_lens delete_lens *********** WellArchitected.Client.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 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' ) Parameters: * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. * **LensStatus** (*string*) -- **[REQUIRED]** The status of the lens to be deleted. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_answer get_answer ********** WellArchitected.Client.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 ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **QuestionId** (*string*) -- **[REQUIRED]** The ID of the question. * **MilestoneNumber** (*integer*) -- The milestone number. A workload can have a maximum of 100 milestones. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'MilestoneNumber': 123, 'LensAlias': 'string', 'LensArn': 'string', 'Answer': { 'QuestionId': 'string', 'PillarId': 'string', 'QuestionTitle': 'string', 'QuestionDescription': 'string', 'ImprovementPlanUrl': 'string', 'HelpfulResourceUrl': 'string', 'HelpfulResourceDisplayText': 'string', 'Choices': [ { 'ChoiceId': 'string', 'Title': 'string', 'Description': 'string', 'HelpfulResource': { 'DisplayText': 'string', 'Url': 'string' }, 'ImprovementPlan': { 'DisplayText': 'string', 'Url': 'string' }, 'AdditionalResources': [ { 'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN', 'Content': [ { 'DisplayText': 'string', 'Url': 'string' }, ] }, ] }, ], 'SelectedChoices': [ 'string', ], 'ChoiceAnswers': [ { 'ChoiceId': 'string', 'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE', 'Notes': 'string' }, ], 'IsApplicable': True|False, 'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE', 'Notes': 'string', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE', 'JiraConfiguration': { 'JiraIssueUrl': 'string', 'LastSyncedTime': datetime(2015, 1, 1) } } } **Response Structure** * *(dict) --* Output of a get answer call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **MilestoneNumber** *(integer) --* The milestone number. A workload can have a maximum of 100 milestones. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **Answer** *(dict) --* An answer of the question. * **QuestionId** *(string) --* The ID of the question. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionTitle** *(string) --* The title of the question. * **QuestionDescription** *(string) --* The description of the question. * **ImprovementPlanUrl** *(string) --* The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value does not apply to custom lenses. * **HelpfulResourceUrl** *(string) --* The helpful resource URL. For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the helpful resource URL for a question and is only provided if "HelpfulResourceDisplayText" was specified for the question. * **HelpfulResourceDisplayText** *(string) --* The helpful resource text to be displayed for a custom lens. This field does not apply to Amazon Web Services official lenses. * **Choices** *(list) --* List of choices available for a question. * *(dict) --* A choice available to answer question. * **ChoiceId** *(string) --* The ID of a choice. * **Title** *(string) --* The title of a choice. * **Description** *(string) --* The description of a choice. * **HelpfulResource** *(dict) --* The helpful resource (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one helpful resource. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **ImprovementPlan** *(dict) --* The improvement plan (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one improvement plan. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **AdditionalResources** *(list) --* The additional resources for a choice in a custom lens. A choice can have up to two additional resources: one of type "HELPFUL_RESOURCE", one of type "IMPROVEMENT_PLAN", or both. * *(dict) --* The choice level additional resources for a custom lens. This field does not apply to Amazon Web Services official lenses. * **Type** *(string) --* Type of additional resource for a custom lens. * **Content** *(list) --* The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified. * *(dict) --* The choice content. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **SelectedChoices** *(list) --* List of selected choice IDs in a question answer. The values entered replace the previously selected choices. * *(string) --* The ID of a choice. * **ChoiceAnswers** *(list) --* A list of selected choices to a question in your workload. * *(dict) --* A choice that has been answered on a question in your workload. * **ChoiceId** *(string) --* The ID of a choice. * **Status** *(string) --* The status of a choice. * **Reason** *(string) --* The reason why a choice is non-applicable to a question in your workload. * **Notes** *(string) --* The notes associated with a choice. * **IsApplicable** *(boolean) --* Defines whether this question is applicable to a lens review. * **Risk** *(string) --* The risk for a given workload, lens review, pillar, or question. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **Reason** *(string) --* The reason why the question is not applicable to your workload. * **JiraConfiguration** *(dict) --* Configuration of the Jira integration. * **JiraIssueUrl** *(string) --* The URL of the associated Jira issue. * **LastSyncedTime** *(datetime) --* The date and time recorded. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_workload_share update_workload_share ********************* WellArchitected.Client.update_workload_share(**kwargs) Update a workload share. See also: AWS API Documentation **Request Syntax** response = client.update_workload_share( ShareId='string', WorkloadId='string', PermissionType='READONLY'|'CONTRIBUTOR' ) Parameters: * **ShareId** (*string*) -- **[REQUIRED]** The ID associated with the 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 share request. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'WorkloadShare': { 'ShareId': 'string', 'SharedBy': 'string', 'SharedWith': 'string', 'PermissionType': 'READONLY'|'CONTRIBUTOR', 'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED', 'WorkloadName': 'string', 'WorkloadId': 'string' } } **Response Structure** * *(dict) --* Input for Update Workload Share * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **WorkloadShare** *(dict) --* A workload share return object. * **ShareId** *(string) --* The ID associated with the share. * **SharedBy** *(string) --* An Amazon Web Services account ID. * **SharedWith** *(string) --* The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. * **PermissionType** *(string) --* Permission granted on a share request. * **Status** *(string) --* The status of the share request. * **WorkloadName** *(string) --* The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_lens get_lens ******** WellArchitected.Client.get_lens(**kwargs) Get an existing lens. See also: AWS API Documentation **Request Syntax** response = client.get_lens( LensAlias='string', LensVersion='string' ) Parameters: * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensVersion** (*string*) -- The lens version to be retrieved. Return type: dict Returns: **Response Syntax** { 'Lens': { 'LensArn': 'string', 'LensVersion': 'string', 'Name': 'string', 'Description': 'string', 'Owner': 'string', 'ShareInvitationId': 'string', 'Tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **Lens** *(dict) --* A lens return object. * **LensArn** *(string) --* The ARN of a lens. * **LensVersion** *(string) --* The version of a lens. * **Name** *(string) --* The full name of the lens. * **Description** *(string) --* The description of the lens. * **Owner** *(string) --* The Amazon Web Services account ID that owns the lens. * **ShareInvitationId** *(string) --* The ID assigned to the share invitation. * **Tags** *(dict) --* The tags assigned to the lens. * *(string) --* * *(string) --* **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_share_invitation update_share_invitation *********************** WellArchitected.Client.update_share_invitation(**kwargs) Update a workload or custom lens share invitation. Note: This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified. See also: AWS API Documentation **Request Syntax** response = client.update_share_invitation( ShareInvitationId='string', ShareInvitationAction='ACCEPT'|'REJECT' ) Parameters: * **ShareInvitationId** (*string*) -- **[REQUIRED]** The ID assigned to the share invitation. * **ShareInvitationAction** (*string*) -- **[REQUIRED]** Share invitation action taken by contributor. Return type: dict Returns: **Response Syntax** { 'ShareInvitation': { 'ShareInvitationId': 'string', 'ShareResourceType': 'WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE', 'WorkloadId': 'string', 'LensAlias': 'string', 'LensArn': 'string', 'ProfileArn': 'string', 'TemplateArn': 'string' } } **Response Structure** * *(dict) --* * **ShareInvitation** *(dict) --* The updated workload or custom lens share invitation. * **ShareInvitationId** *(string) --* The ID assigned to the share invitation. * **ShareResourceType** *(string) --* The resource type of the share invitation. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/0123 456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **ProfileArn** *(string) --* The profile ARN. * **TemplateArn** *(string) --* The review template ARN. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_profile_shares list_profile_shares ******************* WellArchitected.Client.list_profile_shares(**kwargs) List profile shares. See also: AWS API Documentation **Request Syntax** response = client.list_profile_shares( ProfileArn='string', SharedWithPrefix='string', NextToken='string', MaxResults=123, Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED' ) Parameters: * **ProfileArn** (*string*) -- **[REQUIRED]** The profile ARN. * **SharedWithPrefix** (*string*) -- The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile 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. * **Status** (*string*) -- The status of the share request. Return type: dict Returns: **Response Syntax** { 'ProfileShareSummaries': [ { 'ShareId': 'string', 'SharedWith': 'string', 'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED', 'StatusMessage': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ProfileShareSummaries** *(list) --* Profile share summaries. * *(dict) --* Summary of a profile share. * **ShareId** *(string) --* The ID associated with the share. * **SharedWith** *(string) --* The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. * **Status** *(string) --* The status of the share request. * **StatusMessage** *(string) --* Profile share invitation status message. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_global_settings get_global_settings ******************* WellArchitected.Client.get_global_settings() Global settings for all workloads. See also: AWS API Documentation **Request Syntax** response = client.get_global_settings() Return type: dict Returns: **Response Syntax** { 'OrganizationSharingStatus': 'ENABLED'|'DISABLED', 'DiscoveryIntegrationStatus': 'ENABLED'|'DISABLED', 'JiraConfiguration': { 'IntegrationStatus': 'CONFIGURED'|'NOT_CONFIGURED', 'IssueManagementStatus': 'ENABLED'|'DISABLED', 'IssueManagementType': 'AUTO'|'MANUAL', 'Subdomain': 'string', 'JiraProjectKey': 'string', 'StatusMessage': 'string' } } **Response Structure** * *(dict) --* * **OrganizationSharingStatus** *(string) --* Amazon Web Services Organizations sharing status. * **DiscoveryIntegrationStatus** *(string) --* Discovery integration status. * **JiraConfiguration** *(dict) --* Jira configuration status. * **IntegrationStatus** *(string) --* Account-level: Configuration status of the Jira integration. * **IssueManagementStatus** *(string) --* Account-level: Jira issue management status. * **IssueManagementType** *(string) --* Account-level: Jira issue management type. * **Subdomain** *(string) --* Account-level: Jira subdomain URL. * **JiraProjectKey** *(string) --* Account-level: Jira project key to sync workloads to. * **StatusMessage** *(string) --* Account-level: Status message on configuration of the Jira integration. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_lens_review_improvements list_lens_review_improvements ***************************** WellArchitected.Client.list_lens_review_improvements(**kwargs) List the improvements of a particular lens review. 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, QuestionPriority='PRIORITIZED'|'NONE' ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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. * **QuestionPriority** (*string*) -- The priority of the question. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'MilestoneNumber': 123, 'LensAlias': 'string', 'LensArn': 'string', 'ImprovementSummaries': [ { 'QuestionId': 'string', 'PillarId': 'string', 'QuestionTitle': 'string', 'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE', 'ImprovementPlanUrl': 'string', 'ImprovementPlans': [ { 'ChoiceId': 'string', 'DisplayText': 'string', 'ImprovementPlanUrl': 'string' }, ], 'JiraConfiguration': { 'JiraIssueUrl': 'string', 'LastSyncedTime': datetime(2015, 1, 1) } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Output of a list lens review improvements call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **MilestoneNumber** *(integer) --* The milestone number. A workload can have a maximum of 100 milestones. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **ImprovementSummaries** *(list) --* List of improvement summaries of lens review in a workload. * *(dict) --* An improvement summary of a lens review in a workload. * **QuestionId** *(string) --* The ID of the question. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionTitle** *(string) --* The title of the question. * **Risk** *(string) --* The risk for a given workload, lens review, pillar, or question. * **ImprovementPlanUrl** *(string) --* The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value does not apply to custom lenses. * **ImprovementPlans** *(list) --* The improvement plan details. * *(dict) --* The choice level improvement plan. * **ChoiceId** *(string) --* The ID of a choice. * **DisplayText** *(string) --* The display text for the improvement plan. * **ImprovementPlanUrl** *(string) --* The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value does not apply to custom lenses. * **JiraConfiguration** *(dict) --* Configuration of the Jira integration. * **JiraIssueUrl** *(string) --* The URL of the associated Jira issue. * **LastSyncedTime** *(datetime) --* The date and time recorded. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_workload create_workload *************** WellArchitected.Client.create_workload(**kwargs) Create a new workload. The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it. For more information, see Defining a Workload in the *Well- Architected Tool User Guide*. Warning: Either "AwsRegions", "NonAwsRegions", or both must be specified when creating a workload.You also must specify "ReviewOwner", even though the parameter is listed as not being required in the following section. When creating a workload using a review template, you must have the following IAM permissions: * "wellarchitected:GetReviewTemplate" * "wellarchitected:GetReviewTemplateAnswer" * "wellarchitected:ListReviewTemplateAnswers" * "wellarchitected:GetReviewTemplateLensReview" See also: AWS API Documentation **Request Syntax** response = client.create_workload( WorkloadName='string', Description='string', Environment='PRODUCTION'|'PREPRODUCTION', AccountIds=[ 'string', ], AwsRegions=[ 'string', ], NonAwsRegions=[ 'string', ], PillarPriorities=[ 'string', ], ArchitecturalDesign='string', ReviewOwner='string', IndustryType='string', Industry='string', Lenses=[ 'string', ], Notes='string', ClientRequestToken='string', Tags={ 'string': 'string' }, DiscoveryConfig={ 'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED', 'WorkloadResourceDefinition': [ 'WORKLOAD_METADATA'|'APP_REGISTRY', ] }, Applications=[ 'string', ], ProfileArns=[ 'string', ], ReviewTemplateArns=[ 'string', ], JiraConfiguration={ 'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT', 'IssueManagementType': 'AUTO'|'MANUAL', 'JiraProjectKey': 'string' } ) Parameters: * **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*) -- 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. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Notes** (*string*) -- The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. * **Tags** (*dict*) -- The tags to be associated with the workload. * *(string) --* * *(string) --* * **DiscoveryConfig** (*dict*) -- Well-Architected discovery configuration settings associated to the workload. * **TrustedAdvisorIntegrationStatus** *(string) --* Discovery integration status in respect to Trusted Advisor for the workload. * **WorkloadResourceDefinition** *(list) --* The mode to use for identifying resources associated with the workload. You can specify "WORKLOAD_METADATA", "APP_REGISTRY", or both. * *(string) --* * **Applications** (*list*) -- List of AppRegistry application ARNs associated to the workload. * *(string) --* * **ProfileArns** (*list*) -- The list of profile ARNs associated with the workload. * *(string) --* * **ReviewTemplateArns** (*list*) -- The list of review template ARNs to associate with the workload. * *(string) --* * **JiraConfiguration** (*dict*) -- Jira configuration settings when creating a workload. * **IssueManagementStatus** *(string) --* Workload-level: Jira issue management status. * **IssueManagementType** *(string) --* Workload-level: Jira issue management type. * **JiraProjectKey** *(string) --* Workload-level: Jira project key to sync workloads to. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'WorkloadArn': 'string' } **Response Structure** * *(dict) --* Output of a create workload call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **WorkloadArn** *(string) --* The ARN for the workload. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_template_share create_template_share ********************* WellArchitected.Client.create_template_share(**kwargs) Create a review template share. The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a review template is not removed until the review template share invitation is deleted. If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template. Note: **Disclaimer**By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts. See also: AWS API Documentation **Request Syntax** response = client.create_template_share( TemplateArn='string', SharedWith='string', ClientRequestToken='string' ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **SharedWith** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template 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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'TemplateArn': 'string', 'ShareId': 'string' } **Response Structure** * *(dict) --* * **TemplateArn** *(string) --* The review template ARN. * **ShareId** *(string) --* The ID associated with the share. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_tags_for_resource list_tags_for_resource ********************** WellArchitected.Client.list_tags_for_resource(**kwargs) List the tags for a resource. Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( WorkloadArn='string' ) Parameters: **WorkloadArn** (*string*) -- **[REQUIRED]** The ARN for the workload. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Tags** *(dict) --* The tags for the resource. * *(string) --* * *(string) --* **Exceptions** * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" WellArchitected / Client / get_review_template_lens_review get_review_template_lens_review ******************************* WellArchitected.Client.get_review_template_lens_review(**kwargs) Get a lens review associated with a review template. See also: AWS API Documentation **Request Syntax** response = client.get_review_template_lens_review( TemplateArn='string', LensAlias='string' ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. Return type: dict Returns: **Response Syntax** { 'TemplateArn': 'string', 'LensReview': { 'LensAlias': 'string', 'LensArn': 'string', 'LensVersion': 'string', 'LensName': 'string', 'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED', 'PillarReviewSummaries': [ { 'PillarId': 'string', 'PillarName': 'string', 'Notes': 'string', 'QuestionCounts': { 'string': 123 } }, ], 'UpdatedAt': datetime(2015, 1, 1), 'Notes': 'string', 'QuestionCounts': { 'string': 123 }, 'NextToken': 'string' } } **Response Structure** * *(dict) --* * **TemplateArn** *(string) --* The review template ARN. * **LensReview** *(dict) --* A lens review of a question. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/0123 456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The lens ARN. * **LensVersion** *(string) --* The version of the lens. * **LensName** *(string) --* The full name of the lens. * **LensStatus** *(string) --* The status of the lens. * **PillarReviewSummaries** *(list) --* Pillar review summaries of a lens review. * *(dict) --* Summary of a review template. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **PillarName** *(string) --* The name of the pillar. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **QuestionCounts** *(dict) --* A count of how many questions are answered and unanswered in the requested pillar of the lens review. * *(string) --* * *(integer) --* A non-negative integer that denotes how many. * **UpdatedAt** *(datetime) --* The date and time recorded. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **QuestionCounts** *(dict) --* A count of how many questions are answered and unanswered in the lens review. * *(string) --* * *(integer) --* A non-negative integer that denotes how many. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / disassociate_profiles disassociate_profiles ********************* WellArchitected.Client.disassociate_profiles(**kwargs) Disassociate a profile from a workload. See also: AWS API Documentation **Request Syntax** response = client.disassociate_profiles( WorkloadId='string', ProfileArns=[ 'string', ] ) Parameters: * **WorkloadId** (*string*) -- **[REQUIRED]** The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **ProfileArns** (*list*) -- **[REQUIRED]** The list of profile ARNs to disassociate from the workload. * *(string) --* Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / delete_template_share delete_template_share ********************* WellArchitected.Client.delete_template_share(**kwargs) Delete a review template share. After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads. See also: AWS API Documentation **Request Syntax** response = client.delete_template_share( ShareId='string', TemplateArn='string', ClientRequestToken='string' ) Parameters: * **ShareId** (*string*) -- **[REQUIRED]** The ID associated with the share. * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / untag_resource untag_resource ************** WellArchitected.Client.untag_resource(**kwargs) Deletes specified tags from a resource. Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. To specify multiple tags, use separate **tagKeys** parameters, for example: "DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2" See also: AWS API Documentation **Request Syntax** response = client.untag_resource( WorkloadArn='string', TagKeys=[ 'string', ] ) Parameters: * **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) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" WellArchitected / Client / get_profile get_profile *********** WellArchitected.Client.get_profile(**kwargs) Get profile information. See also: AWS API Documentation **Request Syntax** response = client.get_profile( ProfileArn='string', ProfileVersion='string' ) Parameters: * **ProfileArn** (*string*) -- **[REQUIRED]** The profile ARN. * **ProfileVersion** (*string*) -- The profile version. Return type: dict Returns: **Response Syntax** { 'Profile': { 'ProfileArn': 'string', 'ProfileVersion': 'string', 'ProfileName': 'string', 'ProfileDescription': 'string', 'ProfileQuestions': [ { 'QuestionId': 'string', 'QuestionTitle': 'string', 'QuestionDescription': 'string', 'QuestionChoices': [ { 'ChoiceId': 'string', 'ChoiceTitle': 'string', 'ChoiceDescription': 'string' }, ], 'SelectedChoiceIds': [ 'string', ], 'MinSelectedChoices': 123, 'MaxSelectedChoices': 123 }, ], 'Owner': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'ShareInvitationId': 'string', 'Tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **Profile** *(dict) --* The profile. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **ProfileName** *(string) --* The profile name. * **ProfileDescription** *(string) --* The profile description. * **ProfileQuestions** *(list) --* Profile questions. * *(dict) --* A profile question. * **QuestionId** *(string) --* The ID of the question. * **QuestionTitle** *(string) --* The title of the question. * **QuestionDescription** *(string) --* The description of the question. * **QuestionChoices** *(list) --* The question choices. * *(dict) --* The profile choice. * **ChoiceId** *(string) --* The ID of a choice. * **ChoiceTitle** *(string) --* The title of a choice. * **ChoiceDescription** *(string) --* The description of a choice. * **SelectedChoiceIds** *(list) --* The selected choices. * *(string) --* The ID of a choice. * **MinSelectedChoices** *(integer) --* The minimum number of selected choices. * **MaxSelectedChoices** *(integer) --* The maximum number of selected choices. * **Owner** *(string) --* An Amazon Web Services account ID. * **CreatedAt** *(datetime) --* The date and time recorded. * **UpdatedAt** *(datetime) --* The date and time recorded. * **ShareInvitationId** *(string) --* The ID assigned to the share invitation. * **Tags** *(dict) --* The tags assigned to the profile. * *(string) --* * *(string) --* **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_lens_review_report get_lens_review_report ********************** WellArchitected.Client.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 ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **MilestoneNumber** (*integer*) -- The milestone number. A workload can have a maximum of 100 milestones. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'MilestoneNumber': 123, 'LensReviewReport': { 'LensAlias': 'string', 'LensArn': 'string', 'Base64String': 'string' } } **Response Structure** * *(dict) --* Output of a get lens review report call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **MilestoneNumber** *(integer) --* The milestone number. A workload can have a maximum of 100 milestones. * **LensReviewReport** *(dict) --* A report of a lens review. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/0123 456789abcdef01234567890abcdef". 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. Only returned by GetConsolidatedReport when "PDF" format is requested. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_global_settings update_global_settings ********************** WellArchitected.Client.update_global_settings(**kwargs) Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features. See also: AWS API Documentation **Request Syntax** response = client.update_global_settings( OrganizationSharingStatus='ENABLED'|'DISABLED', DiscoveryIntegrationStatus='ENABLED'|'DISABLED', JiraConfiguration={ 'IssueManagementStatus': 'ENABLED'|'DISABLED', 'IssueManagementType': 'AUTO'|'MANUAL', 'JiraProjectKey': 'string', 'IntegrationStatus': 'NOT_CONFIGURED' } ) Parameters: * **OrganizationSharingStatus** (*string*) -- The status of organization sharing settings. * **DiscoveryIntegrationStatus** (*string*) -- The status of discovery support settings. * **JiraConfiguration** (*dict*) -- The status of Jira integration settings. * **IssueManagementStatus** *(string) --* Account-level: Jira issue management status. * **IssueManagementType** *(string) --* Account-level: Jira issue management type. * **JiraProjectKey** *(string) --* Account-level: Jira project key to sync workloads to. * **IntegrationStatus** *(string) --* Account-level: Configuration status of the Jira integration. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / delete_lens_share delete_lens_share ***************** WellArchitected.Client.delete_lens_share(**kwargs) Delete a lens share. After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads. Note: **Disclaimer**By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.delete_lens_share( ShareId='string', LensAlias='string', ClientRequestToken='string' ) Parameters: * **ShareId** (*string*) -- **[REQUIRED]** The ID associated with the share. * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_waiter get_waiter ********** WellArchitected.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" WellArchitected / Client / list_lens_shares list_lens_shares **************** WellArchitected.Client.list_lens_shares(**kwargs) 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, Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED' ) Parameters: * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **SharedWithPrefix** (*string*) -- The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID 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. * **Status** (*string*) -- The status of the share request. Return type: dict Returns: **Response Syntax** { 'LensShareSummaries': [ { 'ShareId': 'string', 'SharedWith': 'string', 'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED', 'StatusMessage': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **LensShareSummaries** *(list) --* A list of lens share summaries. * *(dict) --* A lens share summary return object. * **ShareId** *(string) --* The ID associated with the share. * **SharedWith** *(string) --* The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. * **Status** *(string) --* The status of the share request. * **StatusMessage** *(string) --* Optional message to compliment the Status field. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_workload update_workload *************** WellArchitected.Client.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', DiscoveryConfig={ 'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED', 'WorkloadResourceDefinition': [ 'WORKLOAD_METADATA'|'APP_REGISTRY', ] }, Applications=[ 'string', ], JiraConfiguration={ 'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT', 'IssueManagementType': 'AUTO'|'MANUAL', 'JiraProjectKey': 'string' } ) Parameters: * **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. For a review template, these are the notes that will be associated with the workload when the template is applied. * **ImprovementStatus** (*string*) -- The improvement status for a workload. * **DiscoveryConfig** (*dict*) -- Well-Architected discovery configuration settings to associate to the workload. * **TrustedAdvisorIntegrationStatus** *(string) --* Discovery integration status in respect to Trusted Advisor for the workload. * **WorkloadResourceDefinition** *(list) --* The mode to use for identifying resources associated with the workload. You can specify "WORKLOAD_METADATA", "APP_REGISTRY", or both. * *(string) --* * **Applications** (*list*) -- List of AppRegistry application ARNs to associate to the workload. * *(string) --* * **JiraConfiguration** (*dict*) -- Configuration of the Jira integration. * **IssueManagementStatus** *(string) --* Workload-level: Jira issue management status. * **IssueManagementType** *(string) --* Workload-level: Jira issue management type. * **JiraProjectKey** *(string) --* Workload-level: Jira project key to sync workloads to. Return type: dict Returns: **Response Syntax** { 'Workload': { 'WorkloadId': 'string', 'WorkloadArn': 'string', 'WorkloadName': 'string', 'Description': 'string', 'Environment': 'PRODUCTION'|'PREPRODUCTION', 'UpdatedAt': datetime(2015, 1, 1), 'AccountIds': [ 'string', ], 'AwsRegions': [ 'string', ], 'NonAwsRegions': [ 'string', ], 'ArchitecturalDesign': 'string', 'ReviewOwner': 'string', 'ReviewRestrictionDate': datetime(2015, 1, 1), 'IsReviewOwnerUpdateAcknowledged': True|False, 'IndustryType': 'string', 'Industry': 'string', 'Notes': 'string', 'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED', 'RiskCounts': { 'string': 123 }, 'PillarPriorities': [ 'string', ], 'Lenses': [ 'string', ], 'Owner': 'string', 'ShareInvitationId': 'string', 'Tags': { 'string': 'string' }, 'DiscoveryConfig': { 'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED', 'WorkloadResourceDefinition': [ 'WORKLOAD_METADATA'|'APP_REGISTRY', ] }, 'Applications': [ 'string', ], 'Profiles': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string' }, ], 'PrioritizedRiskCounts': { 'string': 123 }, 'JiraConfiguration': { 'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT', 'IssueManagementType': 'AUTO'|'MANUAL', 'JiraProjectKey': 'string', 'StatusMessage': 'string' } } } **Response Structure** * *(dict) --* Output of an update workload call. * **Workload** *(dict) --* A workload return object. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **WorkloadArn** *(string) --* The ARN for the workload. * **WorkloadName** *(string) --* The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness. * **Description** *(string) --* The description for the workload. * **Environment** *(string) --* The environment for the workload. * **UpdatedAt** *(datetime) --* The date and time recorded. * **AccountIds** *(list) --* The list of Amazon Web Services account IDs associated with the workload. * *(string) --* An Amazon Web Services account ID. * **AwsRegions** *(list) --* The list of Amazon Web Services Regions associated with the workload, for example, "us-east-2", or "ca-central-1". * *(string) --* An Amazon Web Services Region, for example, "us-west-2" or "ap-northeast-1". * **NonAwsRegions** *(list) --* The list of non-Amazon Web Services Regions associated with the workload. * *(string) --* * **ArchitecturalDesign** *(string) --* The URL of the architectural design for the workload. * **ReviewOwner** *(string) --* The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process. * **ReviewRestrictionDate** *(datetime) --* The date and time recorded. * **IsReviewOwnerUpdateAcknowledged** *(boolean) --* Flag indicating whether the workload owner has acknowledged that the *Review owner* field is required. If a **Review owner** is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added. * **IndustryType** *(string) --* The industry type for the workload. If specified, must be one of the following: * "Agriculture" * "Automobile" * "Defense" * "Design and Engineering" * "Digital Advertising" * "Education" * "Environmental Protection" * "Financial Services" * "Gaming" * "General Public Services" * "Healthcare" * "Hospitality" * "InfoTech" * "Justice and Public Safety" * "Life Sciences" * "Manufacturing" * "Media & Entertainment" * "Mining & Resources" * "Oil & Gas" * "Power & Utilities" * "Professional Services" * "Real Estate & Construction" * "Retail & Wholesale" * "Social Protection" * "Telecommunications" * "Travel, Transportation & Logistics" * "Other" * **Industry** *(string) --* The industry for the workload. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **ImprovementStatus** *(string) --* The improvement status for a workload. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **PillarPriorities** *(list) --* The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId. * *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **Lenses** *(list) --* The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/01 23456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Owner** *(string) --* An Amazon Web Services account ID. * **ShareInvitationId** *(string) --* The ID assigned to the share invitation. * **Tags** *(dict) --* The tags associated with the workload. * *(string) --* * *(string) --* * **DiscoveryConfig** *(dict) --* Discovery configuration associated to the workload. * **TrustedAdvisorIntegrationStatus** *(string) --* Discovery integration status in respect to Trusted Advisor for the workload. * **WorkloadResourceDefinition** *(list) --* The mode to use for identifying resources associated with the workload. You can specify "WORKLOAD_METADATA", "APP_REGISTRY", or both. * *(string) --* * **Applications** *(list) --* List of AppRegistry application ARNs associated to the workload. * *(string) --* * **Profiles** *(list) --* Profile associated with a workload. * *(dict) --* The profile associated with a workload. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **JiraConfiguration** *(dict) --* Jira configuration for a specific workload. * **IssueManagementStatus** *(string) --* Workload-level: Jira issue management status. * **IssueManagementType** *(string) --* Workload-level: Jira issue management type. * **JiraProjectKey** *(string) --* Workload-level: Jira project key to sync workloads to. * **StatusMessage** *(string) --* Workload-level: Status message on configuration of the Jira integration. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / associate_profiles associate_profiles ****************** WellArchitected.Client.associate_profiles(**kwargs) Associate a profile with a workload. See also: AWS API Documentation **Request Syntax** response = client.associate_profiles( WorkloadId='string', ProfileArns=[ 'string', ] ) Parameters: * **WorkloadId** (*string*) -- **[REQUIRED]** The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **ProfileArns** (*list*) -- **[REQUIRED]** The list of profile ARNs to associate with the workload. * *(string) --* Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_lens_version_difference get_lens_version_difference *************************** WellArchitected.Client.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' ) Parameters: * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **BaseLensVersion** (*string*) -- The base version of the lens. * **TargetLensVersion** (*string*) -- The lens version to target a difference for. Return type: dict Returns: **Response Syntax** { 'LensAlias': 'string', 'LensArn': 'string', 'BaseLensVersion': 'string', 'TargetLensVersion': 'string', 'LatestLensVersion': 'string', 'VersionDifferences': { 'PillarDifferences': [ { 'PillarId': 'string', 'PillarName': 'string', 'DifferenceStatus': 'UPDATED'|'NEW'|'DELETED', 'QuestionDifferences': [ { 'QuestionId': 'string', 'QuestionTitle': 'string', 'DifferenceStatus': 'UPDATED'|'NEW'|'DELETED' }, ] }, ] } } **Response Structure** * *(dict) --* * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **BaseLensVersion** *(string) --* The base version of the lens. * **TargetLensVersion** *(string) --* The target lens version for the lens. * **LatestLensVersion** *(string) --* The latest version of the lens. * **VersionDifferences** *(dict) --* The differences between the base and latest versions of the lens. * **PillarDifferences** *(list) --* The differences between the base and latest versions of the lens. * *(dict) --* A pillar difference return object. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **PillarName** *(string) --* The name of the pillar. * **DifferenceStatus** *(string) --* Indicates the type of change to the pillar. * **QuestionDifferences** *(list) --* List of question differences. * *(dict) --* A question difference return object. * **QuestionId** *(string) --* The ID of the question. * **QuestionTitle** *(string) --* The title of the question. * **DifferenceStatus** *(string) --* Indicates the type of change to the question. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_lenses list_lenses *********** WellArchitected.Client.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' ) Parameters: * **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. Return type: dict Returns: **Response Syntax** { 'LensSummaries': [ { 'LensArn': 'string', 'LensAlias': 'string', 'LensName': 'string', 'LensType': 'AWS_OFFICIAL'|'CUSTOM_SHARED'|'CUSTOM_SELF', 'Description': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'LensVersion': 'string', 'Owner': 'string', 'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Output of a list lenses call. * **LensSummaries** *(list) --* List of lens summaries of available lenses. * *(dict) --* A lens summary of a lens. * **LensArn** *(string) --* The ARN of the lens. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/01 23456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensName** *(string) --* The full name of the lens. * **LensType** *(string) --* The type of the lens. * **Description** *(string) --* The description of the lens. * **CreatedAt** *(datetime) --* The date and time recorded. * **UpdatedAt** *(datetime) --* The date and time recorded. * **LensVersion** *(string) --* The version of the lens. * **Owner** *(string) --* An Amazon Web Services account ID. * **LensStatus** *(string) --* The status of the lens. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_lens_review get_lens_review *************** WellArchitected.Client.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 ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **MilestoneNumber** (*integer*) -- The milestone number. A workload can have a maximum of 100 milestones. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'MilestoneNumber': 123, 'LensReview': { 'LensAlias': 'string', 'LensArn': 'string', 'LensVersion': 'string', 'LensName': 'string', 'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED', 'PillarReviewSummaries': [ { 'PillarId': 'string', 'PillarName': 'string', 'Notes': 'string', 'RiskCounts': { 'string': 123 }, 'PrioritizedRiskCounts': { 'string': 123 } }, ], 'JiraConfiguration': { 'SelectedPillars': [ { 'PillarId': 'string', 'SelectedQuestionIds': [ 'string', ] }, ] }, 'UpdatedAt': datetime(2015, 1, 1), 'Notes': 'string', 'RiskCounts': { 'string': 123 }, 'NextToken': 'string', 'Profiles': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string' }, ], 'PrioritizedRiskCounts': { 'string': 123 } } } **Response Structure** * *(dict) --* Output of a get lens review call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **MilestoneNumber** *(integer) --* The milestone number. A workload can have a maximum of 100 milestones. * **LensReview** *(dict) --* A lens review of a question. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/0123 456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **LensVersion** *(string) --* The version of the lens. * **LensName** *(string) --* The full name of the lens. * **LensStatus** *(string) --* The status of the lens. * **PillarReviewSummaries** *(list) --* List of pillar review summaries of lens review in a workload. * *(dict) --* A pillar review summary of a lens review. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **PillarName** *(string) --* The name of the pillar. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **JiraConfiguration** *(dict) --* Jira configuration status of the Lens review. * **SelectedPillars** *(list) --* Selected pillars in the workload. * *(dict) --* The selected pillar. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **SelectedQuestionIds** *(list) --* Selected question IDs in the selected pillar. * *(string) --* * **UpdatedAt** *(datetime) --* The date and time recorded. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **NextToken** *(string) --* The token to use to retrieve the next set of results. * **Profiles** *(list) --* The profiles associated with the workload. * *(dict) --* The profile associated with a workload. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_review_template update_review_template ********************** WellArchitected.Client.update_review_template(**kwargs) Update a review template. See also: AWS API Documentation **Request Syntax** response = client.update_review_template( TemplateArn='string', TemplateName='string', Description='string', Notes='string', LensesToAssociate=[ 'string', ], LensesToDisassociate=[ 'string', ] ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **TemplateName** (*string*) -- The review template name. * **Description** (*string*) -- The review template description. * **Notes** (*string*) -- The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **LensesToAssociate** (*list*) -- A list of lens aliases or ARNs to apply to the review template. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensesToDisassociate** (*list*) -- A list of lens aliases or ARNs to unapply to the review template. The "wellarchitected" lens cannot be unapplied. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. Return type: dict Returns: **Response Syntax** { 'ReviewTemplate': { 'Description': 'string', 'Lenses': [ 'string', ], 'Notes': 'string', 'QuestionCounts': { 'string': 123 }, 'Owner': 'string', 'UpdatedAt': datetime(2015, 1, 1), 'TemplateArn': 'string', 'TemplateName': 'string', 'Tags': { 'string': 'string' }, 'UpdateStatus': 'CURRENT'|'LENS_NOT_CURRENT', 'ShareInvitationId': 'string' } } **Response Structure** * *(dict) --* * **ReviewTemplate** *(dict) --* A review template. * **Description** *(string) --* The review template description. * **Lenses** *(list) --* The lenses applied to the review template. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/01 23456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **QuestionCounts** *(dict) --* A count of how many total questions are answered and unanswered in the review template. * *(string) --* * *(integer) --* A non-negative integer that denotes how many. * **Owner** *(string) --* An Amazon Web Services account ID. * **UpdatedAt** *(datetime) --* The date and time recorded. * **TemplateArn** *(string) --* The review template ARN. * **TemplateName** *(string) --* The name of the review template. * **Tags** *(dict) --* The tags assigned to the review template. * *(string) --* * *(string) --* * **UpdateStatus** *(string) --* The latest status of a review template. * **ShareInvitationId** *(string) --* The ID assigned to the template share invitation. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_notifications list_notifications ****************** WellArchitected.Client.list_notifications(**kwargs) List lens notifications. See also: AWS API Documentation **Request Syntax** response = client.list_notifications( WorkloadId='string', NextToken='string', MaxResults=123, ResourceArn='string' ) Parameters: * **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. * **ResourceArn** (*string*) -- The ARN for the related resource for the notification. Note: Only one of "WorkloadID" or "ResourceARN" should be specified. Return type: dict Returns: **Response Syntax** { 'NotificationSummaries': [ { 'Type': 'LENS_VERSION_UPGRADED'|'LENS_VERSION_DEPRECATED', 'LensUpgradeSummary': { 'WorkloadId': 'string', 'WorkloadName': 'string', 'LensAlias': 'string', 'LensArn': 'string', 'CurrentLensVersion': 'string', 'LatestLensVersion': 'string', 'ResourceArn': 'string', 'ResourceName': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **NotificationSummaries** *(list) --* List of lens notification summaries in a workload. * *(dict) --* A notification summary return object. * **Type** *(string) --* The type of notification. * **LensUpgradeSummary** *(dict) --* Summary of lens upgrade. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **WorkloadName** *(string) --* The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/ 0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **CurrentLensVersion** *(string) --* The current version of the lens. * **LatestLensVersion** *(string) --* The latest version of the lens. * **ResourceArn** *(string) --* "ResourceArn" of the lens being upgraded * **ResourceName** *(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. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_template_shares list_template_shares ******************** WellArchitected.Client.list_template_shares(**kwargs) List review template shares. See also: AWS API Documentation **Request Syntax** response = client.list_template_shares( TemplateArn='string', SharedWithPrefix='string', NextToken='string', MaxResults=123, Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED' ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **SharedWithPrefix** (*string*) -- The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile 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. * **Status** (*string*) -- The status of the share request. Return type: dict Returns: **Response Syntax** { 'TemplateArn': 'string', 'TemplateShareSummaries': [ { 'ShareId': 'string', 'SharedWith': 'string', 'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED', 'StatusMessage': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TemplateArn** *(string) --* The review template ARN. * **TemplateShareSummaries** *(list) --* A review template share summary return object. * *(dict) --* Summary of a review template share. * **ShareId** *(string) --* The ID associated with the share. * **SharedWith** *(string) --* The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. * **Status** *(string) --* The status of the share request. * **StatusMessage** *(string) --* Review template share invitation status message. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_workloads list_workloads ************** WellArchitected.Client.list_workloads(**kwargs) Paginated list of workloads. See also: AWS API Documentation **Request Syntax** response = client.list_workloads( WorkloadNamePrefix='string', NextToken='string', MaxResults=123 ) Parameters: * **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. Return type: dict Returns: **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', 'Profiles': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string' }, ], 'PrioritizedRiskCounts': { 'string': 123 } }, ], '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. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/ 0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **ImprovementStatus** *(string) --* The improvement status for a workload. * **Profiles** *(list) --* Profile associated with a workload. * *(dict) --* The profile associated with a workload. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_profiles list_profiles ************* WellArchitected.Client.list_profiles(**kwargs) List profiles. See also: AWS API Documentation **Request Syntax** response = client.list_profiles( ProfileNamePrefix='string', ProfileOwnerType='SELF'|'SHARED', NextToken='string', MaxResults=123 ) Parameters: * **ProfileNamePrefix** (*string*) -- An optional string added to the beginning of each profile name returned in the results. * **ProfileOwnerType** (*string*) -- Profile owner type. * **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. Return type: dict Returns: **Response Syntax** { 'ProfileSummaries': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string', 'ProfileName': 'string', 'ProfileDescription': 'string', 'Owner': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ProfileSummaries** *(list) --* Profile summaries. * *(dict) --* Summary of a profile. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **ProfileName** *(string) --* The profile name. * **ProfileDescription** *(string) --* The profile description. * **Owner** *(string) --* An Amazon Web Services account ID. * **CreatedAt** *(datetime) --* The date and time recorded. * **UpdatedAt** *(datetime) --* The date and time recorded. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_lens_share create_lens_share ***************** WellArchitected.Client.create_lens_share(**kwargs) Create a lens share. The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared. Shared access to a lens is not removed until the lens invitation is deleted. If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens. For more information, see Sharing a custom lens in the *Well- Architected Tool User Guide*. 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' ) Parameters: * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **SharedWith** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template 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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ShareId': 'string' } **Response Structure** * *(dict) --* * **ShareId** *(string) --* The ID associated with the share. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / upgrade_review_template_lens_review upgrade_review_template_lens_review *********************************** WellArchitected.Client.upgrade_review_template_lens_review(**kwargs) Upgrade the lens review of a review template. See also: AWS API Documentation **Request Syntax** response = client.upgrade_review_template_lens_review( TemplateArn='string', LensAlias='string', ClientRequestToken='string' ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The ARN of the review template. * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / associate_lenses associate_lenses **************** WellArchitected.Client.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', ] ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_review_template get_review_template ******************* WellArchitected.Client.get_review_template(**kwargs) Get review template. See also: AWS API Documentation **Request Syntax** response = client.get_review_template( TemplateArn='string' ) Parameters: **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. Return type: dict Returns: **Response Syntax** { 'ReviewTemplate': { 'Description': 'string', 'Lenses': [ 'string', ], 'Notes': 'string', 'QuestionCounts': { 'string': 123 }, 'Owner': 'string', 'UpdatedAt': datetime(2015, 1, 1), 'TemplateArn': 'string', 'TemplateName': 'string', 'Tags': { 'string': 'string' }, 'UpdateStatus': 'CURRENT'|'LENS_NOT_CURRENT', 'ShareInvitationId': 'string' } } **Response Structure** * *(dict) --* * **ReviewTemplate** *(dict) --* The review template. * **Description** *(string) --* The review template description. * **Lenses** *(list) --* The lenses applied to the review template. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/01 23456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **QuestionCounts** *(dict) --* A count of how many total questions are answered and unanswered in the review template. * *(string) --* * *(integer) --* A non-negative integer that denotes how many. * **Owner** *(string) --* An Amazon Web Services account ID. * **UpdatedAt** *(datetime) --* The date and time recorded. * **TemplateArn** *(string) --* The review template ARN. * **TemplateName** *(string) --* The name of the review template. * **Tags** *(dict) --* The tags assigned to the review template. * *(string) --* * *(string) --* * **UpdateStatus** *(string) --* The latest status of a review template. * **ShareInvitationId** *(string) --* The ID assigned to the template share invitation. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_profile create_profile ************** WellArchitected.Client.create_profile(**kwargs) Create a profile. See also: AWS API Documentation **Request Syntax** response = client.create_profile( ProfileName='string', ProfileDescription='string', ProfileQuestions=[ { 'QuestionId': 'string', 'SelectedChoiceIds': [ 'string', ] }, ], ClientRequestToken='string', Tags={ 'string': 'string' } ) Parameters: * **ProfileName** (*string*) -- **[REQUIRED]** Name of the profile. * **ProfileDescription** (*string*) -- **[REQUIRED]** The profile description. * **ProfileQuestions** (*list*) -- **[REQUIRED]** The profile questions. * *(dict) --* An update to a profile question. * **QuestionId** *(string) --* The ID of the question. * **SelectedChoiceIds** *(list) --* The selected choices. * *(string) --* The ID of a choice. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. * **Tags** (*dict*) -- The tags assigned to the profile. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'ProfileArn': 'string', 'ProfileVersion': 'string' } **Response Structure** * *(dict) --* * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* Version of the profile. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_answer update_answer ************* WellArchitected.Client.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' ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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. For a review template, these are the notes that will be associated with the workload when the template is applied. * **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. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'LensAlias': 'string', 'LensArn': 'string', 'Answer': { 'QuestionId': 'string', 'PillarId': 'string', 'QuestionTitle': 'string', 'QuestionDescription': 'string', 'ImprovementPlanUrl': 'string', 'HelpfulResourceUrl': 'string', 'HelpfulResourceDisplayText': 'string', 'Choices': [ { 'ChoiceId': 'string', 'Title': 'string', 'Description': 'string', 'HelpfulResource': { 'DisplayText': 'string', 'Url': 'string' }, 'ImprovementPlan': { 'DisplayText': 'string', 'Url': 'string' }, 'AdditionalResources': [ { 'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN', 'Content': [ { 'DisplayText': 'string', 'Url': 'string' }, ] }, ] }, ], 'SelectedChoices': [ 'string', ], 'ChoiceAnswers': [ { 'ChoiceId': 'string', 'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE', 'Notes': 'string' }, ], 'IsApplicable': True|False, 'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE', 'Notes': 'string', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE', 'JiraConfiguration': { 'JiraIssueUrl': 'string', 'LastSyncedTime': datetime(2015, 1, 1) } } } **Response Structure** * *(dict) --* Output of a update answer call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **Answer** *(dict) --* An answer of the question. * **QuestionId** *(string) --* The ID of the question. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionTitle** *(string) --* The title of the question. * **QuestionDescription** *(string) --* The description of the question. * **ImprovementPlanUrl** *(string) --* The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value does not apply to custom lenses. * **HelpfulResourceUrl** *(string) --* The helpful resource URL. For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the helpful resource URL for a question and is only provided if "HelpfulResourceDisplayText" was specified for the question. * **HelpfulResourceDisplayText** *(string) --* The helpful resource text to be displayed for a custom lens. This field does not apply to Amazon Web Services official lenses. * **Choices** *(list) --* List of choices available for a question. * *(dict) --* A choice available to answer question. * **ChoiceId** *(string) --* The ID of a choice. * **Title** *(string) --* The title of a choice. * **Description** *(string) --* The description of a choice. * **HelpfulResource** *(dict) --* The helpful resource (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one helpful resource. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **ImprovementPlan** *(dict) --* The improvement plan (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one improvement plan. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **AdditionalResources** *(list) --* The additional resources for a choice in a custom lens. A choice can have up to two additional resources: one of type "HELPFUL_RESOURCE", one of type "IMPROVEMENT_PLAN", or both. * *(dict) --* The choice level additional resources for a custom lens. This field does not apply to Amazon Web Services official lenses. * **Type** *(string) --* Type of additional resource for a custom lens. * **Content** *(list) --* The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified. * *(dict) --* The choice content. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **SelectedChoices** *(list) --* List of selected choice IDs in a question answer. The values entered replace the previously selected choices. * *(string) --* The ID of a choice. * **ChoiceAnswers** *(list) --* A list of selected choices to a question in your workload. * *(dict) --* A choice that has been answered on a question in your workload. * **ChoiceId** *(string) --* The ID of a choice. * **Status** *(string) --* The status of a choice. * **Reason** *(string) --* The reason why a choice is non-applicable to a question in your workload. * **Notes** *(string) --* The notes associated with a choice. * **IsApplicable** *(boolean) --* Defines whether this question is applicable to a lens review. * **Risk** *(string) --* The risk for a given workload, lens review, pillar, or question. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **Reason** *(string) --* The reason why the question is not applicable to your workload. * **JiraConfiguration** *(dict) --* Configuration of the Jira integration. * **JiraIssueUrl** *(string) --* The URL of the associated Jira issue. * **LastSyncedTime** *(datetime) --* The date and time recorded. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_profile_share create_profile_share ******************** WellArchitected.Client.create_profile_share(**kwargs) Create a profile share. See also: AWS API Documentation **Request Syntax** response = client.create_profile_share( ProfileArn='string', SharedWith='string', ClientRequestToken='string' ) Parameters: * **ProfileArn** (*string*) -- **[REQUIRED]** The profile ARN. * **SharedWith** (*string*) -- **[REQUIRED]** The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template 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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'ShareId': 'string', 'ProfileArn': 'string' } **Response Structure** * *(dict) --* * **ShareId** *(string) --* The ID associated with the share. * **ProfileArn** *(string) --* The profile ARN. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / close close ***** WellArchitected.Client.close() Closes underlying endpoint connections. WellArchitected / Client / get_review_template_answer get_review_template_answer ************************** WellArchitected.Client.get_review_template_answer(**kwargs) Get review template answer. See also: AWS API Documentation **Request Syntax** response = client.get_review_template_answer( TemplateArn='string', LensAlias='string', QuestionId='string' ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **QuestionId** (*string*) -- **[REQUIRED]** The ID of the question. Return type: dict Returns: **Response Syntax** { 'TemplateArn': 'string', 'LensAlias': 'string', 'Answer': { 'QuestionId': 'string', 'PillarId': 'string', 'QuestionTitle': 'string', 'QuestionDescription': 'string', 'ImprovementPlanUrl': 'string', 'HelpfulResourceUrl': 'string', 'HelpfulResourceDisplayText': 'string', 'Choices': [ { 'ChoiceId': 'string', 'Title': 'string', 'Description': 'string', 'HelpfulResource': { 'DisplayText': 'string', 'Url': 'string' }, 'ImprovementPlan': { 'DisplayText': 'string', 'Url': 'string' }, 'AdditionalResources': [ { 'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN', 'Content': [ { 'DisplayText': 'string', 'Url': 'string' }, ] }, ] }, ], 'SelectedChoices': [ 'string', ], 'ChoiceAnswers': [ { 'ChoiceId': 'string', 'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE', 'Notes': 'string' }, ], 'IsApplicable': True|False, 'AnswerStatus': 'UNANSWERED'|'ANSWERED', 'Notes': 'string', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE' } } **Response Structure** * *(dict) --* * **TemplateArn** *(string) --* The review template ARN. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Answer** *(dict) --* An answer of the question. * **QuestionId** *(string) --* The ID of the question. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionTitle** *(string) --* The title of the question. * **QuestionDescription** *(string) --* The description of the question. * **ImprovementPlanUrl** *(string) --* The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value does not apply to custom lenses. * **HelpfulResourceUrl** *(string) --* The helpful resource URL. For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the helpful resource URL for a question and is only provided if "HelpfulResourceDisplayText" was specified for the question. * **HelpfulResourceDisplayText** *(string) --* The helpful resource text to be displayed for a custom lens. Note: This field does not apply to Amazon Web Services official lenses. * **Choices** *(list) --* List of choices available for a question. * *(dict) --* A choice available to answer question. * **ChoiceId** *(string) --* The ID of a choice. * **Title** *(string) --* The title of a choice. * **Description** *(string) --* The description of a choice. * **HelpfulResource** *(dict) --* The helpful resource (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one helpful resource. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **ImprovementPlan** *(dict) --* The improvement plan (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one improvement plan. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **AdditionalResources** *(list) --* The additional resources for a choice in a custom lens. A choice can have up to two additional resources: one of type "HELPFUL_RESOURCE", one of type "IMPROVEMENT_PLAN", or both. * *(dict) --* The choice level additional resources for a custom lens. This field does not apply to Amazon Web Services official lenses. * **Type** *(string) --* Type of additional resource for a custom lens. * **Content** *(list) --* The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified. * *(dict) --* The choice content. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **SelectedChoices** *(list) --* List of selected choice IDs in a question answer. The values entered replace the previously selected choices. * *(string) --* The ID of a choice. * **ChoiceAnswers** *(list) --* A list of selected choices to a question in your review template. * *(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. * **AnswerStatus** *(string) --* The status of whether or not this question has been answered. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **Reason** *(string) --* The reason why the question is not applicable to your review template. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_milestones list_milestones *************** WellArchitected.Client.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 ) Parameters: * **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. Return type: dict Returns: **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', 'Profiles': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string' }, ], 'PrioritizedRiskCounts': { 'string': 123 } } }, ], '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. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:len s/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **ImprovementStatus** *(string) --* The improvement status for a workload. * **Profiles** *(list) --* Profile associated with a workload. * *(dict) --* The profile associated with a workload. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_workload get_workload ************ WellArchitected.Client.get_workload(**kwargs) Get an existing workload. See also: AWS API Documentation **Request Syntax** response = client.get_workload( WorkloadId='string' ) Parameters: **WorkloadId** (*string*) -- **[REQUIRED]** The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. Return type: dict Returns: **Response Syntax** { 'Workload': { 'WorkloadId': 'string', 'WorkloadArn': 'string', 'WorkloadName': 'string', 'Description': 'string', 'Environment': 'PRODUCTION'|'PREPRODUCTION', 'UpdatedAt': datetime(2015, 1, 1), 'AccountIds': [ 'string', ], 'AwsRegions': [ 'string', ], 'NonAwsRegions': [ 'string', ], 'ArchitecturalDesign': 'string', 'ReviewOwner': 'string', 'ReviewRestrictionDate': datetime(2015, 1, 1), 'IsReviewOwnerUpdateAcknowledged': True|False, 'IndustryType': 'string', 'Industry': 'string', 'Notes': 'string', 'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED', 'RiskCounts': { 'string': 123 }, 'PillarPriorities': [ 'string', ], 'Lenses': [ 'string', ], 'Owner': 'string', 'ShareInvitationId': 'string', 'Tags': { 'string': 'string' }, 'DiscoveryConfig': { 'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED', 'WorkloadResourceDefinition': [ 'WORKLOAD_METADATA'|'APP_REGISTRY', ] }, 'Applications': [ 'string', ], 'Profiles': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string' }, ], 'PrioritizedRiskCounts': { 'string': 123 }, 'JiraConfiguration': { 'IssueManagementStatus': 'ENABLED'|'DISABLED'|'INHERIT', 'IssueManagementType': 'AUTO'|'MANUAL', 'JiraProjectKey': 'string', 'StatusMessage': 'string' } } } **Response Structure** * *(dict) --* Output of a get workload call. * **Workload** *(dict) --* A workload return object. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **WorkloadArn** *(string) --* The ARN for the workload. * **WorkloadName** *(string) --* The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness. * **Description** *(string) --* The description for the workload. * **Environment** *(string) --* The environment for the workload. * **UpdatedAt** *(datetime) --* The date and time recorded. * **AccountIds** *(list) --* The list of Amazon Web Services account IDs associated with the workload. * *(string) --* An Amazon Web Services account ID. * **AwsRegions** *(list) --* The list of Amazon Web Services Regions associated with the workload, for example, "us-east-2", or "ca-central-1". * *(string) --* An Amazon Web Services Region, for example, "us-west-2" or "ap-northeast-1". * **NonAwsRegions** *(list) --* The list of non-Amazon Web Services Regions associated with the workload. * *(string) --* * **ArchitecturalDesign** *(string) --* The URL of the architectural design for the workload. * **ReviewOwner** *(string) --* The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process. * **ReviewRestrictionDate** *(datetime) --* The date and time recorded. * **IsReviewOwnerUpdateAcknowledged** *(boolean) --* Flag indicating whether the workload owner has acknowledged that the *Review owner* field is required. If a **Review owner** is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added. * **IndustryType** *(string) --* The industry type for the workload. If specified, must be one of the following: * "Agriculture" * "Automobile" * "Defense" * "Design and Engineering" * "Digital Advertising" * "Education" * "Environmental Protection" * "Financial Services" * "Gaming" * "General Public Services" * "Healthcare" * "Hospitality" * "InfoTech" * "Justice and Public Safety" * "Life Sciences" * "Manufacturing" * "Media & Entertainment" * "Mining & Resources" * "Oil & Gas" * "Power & Utilities" * "Professional Services" * "Real Estate & Construction" * "Retail & Wholesale" * "Social Protection" * "Telecommunications" * "Travel, Transportation & Logistics" * "Other" * **Industry** *(string) --* The industry for the workload. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **ImprovementStatus** *(string) --* The improvement status for a workload. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **PillarPriorities** *(list) --* The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId. * *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **Lenses** *(list) --* The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/01 23456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Owner** *(string) --* An Amazon Web Services account ID. * **ShareInvitationId** *(string) --* The ID assigned to the share invitation. * **Tags** *(dict) --* The tags associated with the workload. * *(string) --* * *(string) --* * **DiscoveryConfig** *(dict) --* Discovery configuration associated to the workload. * **TrustedAdvisorIntegrationStatus** *(string) --* Discovery integration status in respect to Trusted Advisor for the workload. * **WorkloadResourceDefinition** *(list) --* The mode to use for identifying resources associated with the workload. You can specify "WORKLOAD_METADATA", "APP_REGISTRY", or both. * *(string) --* * **Applications** *(list) --* List of AppRegistry application ARNs associated to the workload. * *(string) --* * **Profiles** *(list) --* Profile associated with a workload. * *(dict) --* The profile associated with a workload. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **JiraConfiguration** *(dict) --* Jira configuration for a specific workload. * **IssueManagementStatus** *(string) --* Workload-level: Jira issue management status. * **IssueManagementType** *(string) --* Workload-level: Jira issue management type. * **JiraProjectKey** *(string) --* Workload-level: Jira project key to sync workloads to. * **StatusMessage** *(string) --* Workload-level: Status message on configuration of the Jira integration. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / delete_profile delete_profile ************** WellArchitected.Client.delete_profile(**kwargs) Delete a profile. Note: **Disclaimer**By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.delete_profile( ProfileArn='string', ClientRequestToken='string' ) Parameters: * **ProfileArn** (*string*) -- **[REQUIRED]** The profile ARN. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / disassociate_lenses disassociate_lenses ******************* WellArchitected.Client.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', ] ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_review_template create_review_template ********************** WellArchitected.Client.create_review_template(**kwargs) Create a review template. Note: **Disclaimer**Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template 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.create_review_template( TemplateName='string', Description='string', Lenses=[ 'string', ], Notes='string', Tags={ 'string': 'string' }, ClientRequestToken='string' ) Parameters: * **TemplateName** (*string*) -- **[REQUIRED]** Name of the review template. * **Description** (*string*) -- **[REQUIRED]** The review template description. * **Lenses** (*list*) -- **[REQUIRED]** Lenses applied to the review template. * *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Notes** (*string*) -- The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **Tags** (*dict*) -- The tags assigned to the review template. * *(string) --* * *(string) --* * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'TemplateArn': 'string' } **Response Structure** * *(dict) --* * **TemplateArn** *(string) --* The review template ARN. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_profile update_profile ************** WellArchitected.Client.update_profile(**kwargs) Update a profile. See also: AWS API Documentation **Request Syntax** response = client.update_profile( ProfileArn='string', ProfileDescription='string', ProfileQuestions=[ { 'QuestionId': 'string', 'SelectedChoiceIds': [ 'string', ] }, ] ) Parameters: * **ProfileArn** (*string*) -- **[REQUIRED]** The profile ARN. * **ProfileDescription** (*string*) -- The profile description. * **ProfileQuestions** (*list*) -- Profile questions. * *(dict) --* An update to a profile question. * **QuestionId** *(string) --* The ID of the question. * **SelectedChoiceIds** *(list) --* The selected choices. * *(string) --* The ID of a choice. Return type: dict Returns: **Response Syntax** { 'Profile': { 'ProfileArn': 'string', 'ProfileVersion': 'string', 'ProfileName': 'string', 'ProfileDescription': 'string', 'ProfileQuestions': [ { 'QuestionId': 'string', 'QuestionTitle': 'string', 'QuestionDescription': 'string', 'QuestionChoices': [ { 'ChoiceId': 'string', 'ChoiceTitle': 'string', 'ChoiceDescription': 'string' }, ], 'SelectedChoiceIds': [ 'string', ], 'MinSelectedChoices': 123, 'MaxSelectedChoices': 123 }, ], 'Owner': 'string', 'CreatedAt': datetime(2015, 1, 1), 'UpdatedAt': datetime(2015, 1, 1), 'ShareInvitationId': 'string', 'Tags': { 'string': 'string' } } } **Response Structure** * *(dict) --* * **Profile** *(dict) --* The profile. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **ProfileName** *(string) --* The profile name. * **ProfileDescription** *(string) --* The profile description. * **ProfileQuestions** *(list) --* Profile questions. * *(dict) --* A profile question. * **QuestionId** *(string) --* The ID of the question. * **QuestionTitle** *(string) --* The title of the question. * **QuestionDescription** *(string) --* The description of the question. * **QuestionChoices** *(list) --* The question choices. * *(dict) --* The profile choice. * **ChoiceId** *(string) --* The ID of a choice. * **ChoiceTitle** *(string) --* The title of a choice. * **ChoiceDescription** *(string) --* The description of a choice. * **SelectedChoiceIds** *(list) --* The selected choices. * *(string) --* The ID of a choice. * **MinSelectedChoices** *(integer) --* The minimum number of selected choices. * **MaxSelectedChoices** *(integer) --* The maximum number of selected choices. * **Owner** *(string) --* An Amazon Web Services account ID. * **CreatedAt** *(datetime) --* The date and time recorded. * **UpdatedAt** *(datetime) --* The date and time recorded. * **ShareInvitationId** *(string) --* The ID assigned to the share invitation. * **Tags** *(dict) --* The tags assigned to the profile. * *(string) --* * *(string) --* **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / delete_workload delete_workload *************** WellArchitected.Client.delete_workload(**kwargs) Delete an existing workload. See also: AWS API Documentation **Request Syntax** response = client.delete_workload( WorkloadId='string', ClientRequestToken='string' ) Parameters: * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / upgrade_lens_review upgrade_lens_review ******************* WellArchitected.Client.upgrade_lens_review(**kwargs) Upgrade lens review for a particular workload. See also: AWS API Documentation **Request Syntax** response = client.upgrade_lens_review( WorkloadId='string', LensAlias='string', MilestoneName='string', ClientRequestToken='string' ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" WellArchitected / Client / list_workload_shares list_workload_shares ******************** WellArchitected.Client.list_workload_shares(**kwargs) 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, Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED' ) Parameters: * **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, organization ID, or organizational unit (OU) ID 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. * **Status** (*string*) -- The status of the share request. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'WorkloadShareSummaries': [ { 'ShareId': 'string', 'SharedWith': 'string', 'PermissionType': 'READONLY'|'CONTRIBUTOR', 'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED', 'StatusMessage': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Input for List Workload Share * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **WorkloadShareSummaries** *(list) --* A list of workload share summaries. * *(dict) --* A workload share summary return object. * **ShareId** *(string) --* The ID associated with the share. * **SharedWith** *(string) --* The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. * **PermissionType** *(string) --* Permission granted on a share request. * **Status** *(string) --* The status of the share request. * **StatusMessage** *(string) --* Optional message to compliment the Status field. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_workload_share create_workload_share ********************* WellArchitected.Client.create_workload_share(**kwargs) Create a workload share. The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted. If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload. 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' ) Parameters: * **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, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. * **PermissionType** (*string*) -- **[REQUIRED]** Permission granted on a share request. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Return type: dict Returns: **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 share. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / delete_workload_share delete_workload_share ********************* WellArchitected.Client.delete_workload_share(**kwargs) Delete a workload share. See also: AWS API Documentation **Request Syntax** response = client.delete_workload_share( ShareId='string', WorkloadId='string', ClientRequestToken='string' ) Parameters: * **ShareId** (*string*) -- **[REQUIRED]** The ID associated with the 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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_review_template_lens_review update_review_template_lens_review ********************************** WellArchitected.Client.update_review_template_lens_review(**kwargs) Update a lens review associated with a review template. See also: AWS API Documentation **Request Syntax** response = client.update_review_template_lens_review( TemplateArn='string', LensAlias='string', LensNotes='string', PillarNotes={ 'string': 'string' } ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensNotes** (*string*) -- The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **PillarNotes** (*dict*) -- List of pillar notes of a lens review in a workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Return type: dict Returns: **Response Syntax** { 'TemplateArn': 'string', 'LensReview': { 'LensAlias': 'string', 'LensArn': 'string', 'LensVersion': 'string', 'LensName': 'string', 'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED', 'PillarReviewSummaries': [ { 'PillarId': 'string', 'PillarName': 'string', 'Notes': 'string', 'QuestionCounts': { 'string': 123 } }, ], 'UpdatedAt': datetime(2015, 1, 1), 'Notes': 'string', 'QuestionCounts': { 'string': 123 }, 'NextToken': 'string' } } **Response Structure** * *(dict) --* * **TemplateArn** *(string) --* The review template ARN. * **LensReview** *(dict) --* A lens review of a question. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/0123 456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The lens ARN. * **LensVersion** *(string) --* The version of the lens. * **LensName** *(string) --* The full name of the lens. * **LensStatus** *(string) --* The status of the lens. * **PillarReviewSummaries** *(list) --* Pillar review summaries of a lens review. * *(dict) --* Summary of a review template. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **PillarName** *(string) --* The name of the pillar. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **QuestionCounts** *(dict) --* A count of how many questions are answered and unanswered in the requested pillar of the lens review. * *(string) --* * *(integer) --* A non-negative integer that denotes how many. * **UpdatedAt** *(datetime) --* The date and time recorded. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **QuestionCounts** *(dict) --* A count of how many questions are answered and unanswered in the lens review. * *(string) --* * *(integer) --* A non-negative integer that denotes how many. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_lens_version create_lens_version ******************* WellArchitected.Client.create_lens_version(**kwargs) Create a new lens version. A lens can have up to 100 versions. Use this operation to publish a new lens version after you have imported a lens. The "LensAlias" is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and 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' ) Parameters: * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'LensArn': 'string', 'LensVersion': 'string' } **Response Structure** * *(dict) --* * **LensArn** *(string) --* The ARN for the lens. * **LensVersion** *(string) --* The version of the lens. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / get_consolidated_report get_consolidated_report *********************** WellArchitected.Client.get_consolidated_report(**kwargs) Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you. See also: AWS API Documentation **Request Syntax** response = client.get_consolidated_report( Format='PDF'|'JSON', IncludeSharedResources=True|False, NextToken='string', MaxResults=123 ) Parameters: * **Format** (*string*) -- **[REQUIRED]** The format of the consolidated report. For "PDF", "Base64String" is returned. For "JSON", "Metrics" is returned. * **IncludeSharedResources** (*boolean*) -- Set to "true" to have shared resources included in the report. * **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. Return type: dict Returns: **Response Syntax** { 'Metrics': [ { 'MetricType': 'WORKLOAD', 'RiskCounts': { 'string': 123 }, 'WorkloadId': 'string', 'WorkloadName': 'string', 'WorkloadArn': 'string', 'UpdatedAt': datetime(2015, 1, 1), 'Lenses': [ { 'LensArn': 'string', 'Pillars': [ { 'PillarId': 'string', 'RiskCounts': { 'string': 123 }, 'Questions': [ { 'QuestionId': 'string', 'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE', 'BestPractices': [ { 'ChoiceId': 'string', 'ChoiceTitle': 'string' }, ] }, ] }, ], 'RiskCounts': { 'string': 123 } }, ], 'LensesAppliedCount': 123 }, ], 'NextToken': 'string', 'Base64String': 'string' } **Response Structure** * *(dict) --* * **Metrics** *(list) --* The metrics that make up the consolidated report. Only returned when "JSON" format is requested. * *(dict) --* A metric that contributes to the consolidated report. * **MetricType** *(string) --* The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **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. * **WorkloadArn** *(string) --* The ARN for the workload. * **UpdatedAt** *(datetime) --* The date and time recorded. * **Lenses** *(list) --* The metrics for the lenses in the workload. * *(dict) --* A metric for a particular lens in a workload. * **LensArn** *(string) --* The lens ARN. * **Pillars** *(list) --* The metrics for the pillars in a lens. * *(dict) --* A metric for a particular pillar in a lens. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **Questions** *(list) --* The questions that have been identified as risks in the pillar. * *(dict) --* A metric for a particular question in the pillar. * **QuestionId** *(string) --* The ID of the question. * **Risk** *(string) --* The risk for a given workload, lens review, pillar, or question. * **BestPractices** *(list) --* The best practices, or choices, that have been identified as contributing to risk in a question. * *(dict) --* A best practice, or question choice, that has been identified as a risk in this question. * **ChoiceId** *(string) --* The ID of a choice. * **ChoiceTitle** *(string) --* The title of a choice. * **RiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **LensesAppliedCount** *(integer) --* The total number of lenses applied to the workload. * **NextToken** *(string) --* The token to use to retrieve the next set of results. * **Base64String** *(string) --* The Base64-encoded string representation of a lens review report. This data can be used to create a PDF file. Only returned by GetConsolidatedReport when "PDF" format is requested. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" * "WellArchitected.Client.exceptions.ConflictException" WellArchitected / Client / tag_resource tag_resource ************ WellArchitected.Client.tag_resource(**kwargs) Adds one or more tags to the specified resource. Note: The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( WorkloadArn='string', Tags={ 'string': 'string' } ) Parameters: * **WorkloadArn** (*string*) -- **[REQUIRED]** The ARN for the workload. * **Tags** (*dict*) -- **[REQUIRED]** The tags for the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" WellArchitected / Client / list_share_invitations list_share_invitations ********************** WellArchitected.Client.list_share_invitations(**kwargs) List the share invitations. "WorkloadNamePrefix", "LensNamePrefix", "ProfileNamePrefix", and "TemplateNamePrefix" are mutually exclusive. Use the parameter that matches your "ShareResourceType". See also: AWS API Documentation **Request Syntax** response = client.list_share_invitations( WorkloadNamePrefix='string', LensNamePrefix='string', ShareResourceType='WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE', NextToken='string', MaxResults=123, ProfileNamePrefix='string', TemplateNamePrefix='string' ) Parameters: * **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. * **ProfileNamePrefix** (*string*) -- An optional string added to the beginning of each profile name returned in the results. * **TemplateNamePrefix** (*string*) -- An optional string added to the beginning of each review template name returned in the results. Return type: dict Returns: **Response Syntax** { 'ShareInvitationSummaries': [ { 'ShareInvitationId': 'string', 'SharedBy': 'string', 'SharedWith': 'string', 'PermissionType': 'READONLY'|'CONTRIBUTOR', 'ShareResourceType': 'WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE', 'WorkloadName': 'string', 'WorkloadId': 'string', 'LensName': 'string', 'LensArn': 'string', 'ProfileName': 'string', 'ProfileArn': 'string', 'TemplateName': 'string', 'TemplateArn': '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, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. * **PermissionType** *(string) --* Permission granted on a share request. * **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. * **ProfileName** *(string) --* The profile name. * **ProfileArn** *(string) --* The profile ARN. * **TemplateName** *(string) --* The name of the review template. * **TemplateArn** *(string) --* The review template ARN. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / export_lens export_lens *********** WellArchitected.Client.export_lens(**kwargs) Export an existing lens. Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported. Lenses are defined in JSON. For more information, see JSON format specification in the *Well-Architected Tool User Guide*. 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' ) Parameters: * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensVersion** (*string*) -- The lens version to be exported. Return type: dict Returns: **Response Syntax** { 'LensJSON': 'string' } **Response Structure** * *(dict) --* * **LensJSON** *(string) --* The JSON representation of a lens. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_lens_reviews list_lens_reviews ***************** WellArchitected.Client.list_lens_reviews(**kwargs) List lens reviews for a particular workload. See also: AWS API Documentation **Request Syntax** response = client.list_lens_reviews( WorkloadId='string', MilestoneNumber=123, NextToken='string', MaxResults=123 ) Parameters: * **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. Return type: dict Returns: **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 }, 'Profiles': [ { 'ProfileArn': 'string', 'ProfileVersion': 'string' }, ], 'PrioritizedRiskCounts': { 'string': 123 } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Output of a list lens reviews call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **MilestoneNumber** *(integer) --* The milestone number. A workload can have a maximum of 100 milestones. * **LensReviewSummaries** *(list) --* List of lens summaries of lens reviews of a workload. * *(dict) --* A lens review summary of a workload. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us- east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us-west-2:123456789012:lens/01 23456789abcdef01234567890abcdef". 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 many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **Profiles** *(list) --* The profiles associated with the workload. * *(dict) --* The profile associated with a workload. * **ProfileArn** *(string) --* The profile ARN. * **ProfileVersion** *(string) --* The profile version. * **PrioritizedRiskCounts** *(dict) --* A map from risk names to the count of how many questions have that rating. * *(string) --* The risk for a given workload, lens review, pillar, or question. * *(integer) --* A non-negative integer that denotes how many. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / delete_review_template delete_review_template ********************** WellArchitected.Client.delete_review_template(**kwargs) Delete a review template. Only the owner of a review template can delete it. After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads. See also: AWS API Documentation **Request Syntax** response = client.delete_review_template( TemplateArn='string', ClientRequestToken='string' ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Returns: None **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / update_review_template_answer update_review_template_answer ***************************** WellArchitected.Client.update_review_template_answer(**kwargs) Update a review template answer. See also: AWS API Documentation **Request Syntax** response = client.update_review_template_answer( TemplateArn='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' ) Parameters: * **TemplateArn** (*string*) -- **[REQUIRED]** The review template ARN. * **LensAlias** (*string*) -- **[REQUIRED]** The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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 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. For a review template, these are the notes that will be associated with the workload when the template is applied. * **IsApplicable** (*boolean*) -- Defines whether this question is applicable to a lens review. * **Reason** (*string*) -- The update reason. Return type: dict Returns: **Response Syntax** { 'TemplateArn': 'string', 'LensAlias': 'string', 'Answer': { 'QuestionId': 'string', 'PillarId': 'string', 'QuestionTitle': 'string', 'QuestionDescription': 'string', 'ImprovementPlanUrl': 'string', 'HelpfulResourceUrl': 'string', 'HelpfulResourceDisplayText': 'string', 'Choices': [ { 'ChoiceId': 'string', 'Title': 'string', 'Description': 'string', 'HelpfulResource': { 'DisplayText': 'string', 'Url': 'string' }, 'ImprovementPlan': { 'DisplayText': 'string', 'Url': 'string' }, 'AdditionalResources': [ { 'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN', 'Content': [ { 'DisplayText': 'string', 'Url': 'string' }, ] }, ] }, ], 'SelectedChoices': [ 'string', ], 'ChoiceAnswers': [ { 'ChoiceId': 'string', 'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE', 'Notes': 'string' }, ], 'IsApplicable': True|False, 'AnswerStatus': 'UNANSWERED'|'ANSWERED', 'Notes': 'string', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE' } } **Response Structure** * *(dict) --* * **TemplateArn** *(string) --* The review template ARN. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **Answer** *(dict) --* An answer of the question. * **QuestionId** *(string) --* The ID of the question. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionTitle** *(string) --* The title of the question. * **QuestionDescription** *(string) --* The description of the question. * **ImprovementPlanUrl** *(string) --* The improvement plan URL for a question in an Amazon Web Services official lenses. This value is only available if the question has been answered. This value does not apply to custom lenses. * **HelpfulResourceUrl** *(string) --* The helpful resource URL. For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the helpful resource URL for a question and is only provided if "HelpfulResourceDisplayText" was specified for the question. * **HelpfulResourceDisplayText** *(string) --* The helpful resource text to be displayed for a custom lens. Note: This field does not apply to Amazon Web Services official lenses. * **Choices** *(list) --* List of choices available for a question. * *(dict) --* A choice available to answer question. * **ChoiceId** *(string) --* The ID of a choice. * **Title** *(string) --* The title of a choice. * **Description** *(string) --* The description of a choice. * **HelpfulResource** *(dict) --* The helpful resource (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one helpful resource. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **ImprovementPlan** *(dict) --* The improvement plan (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one improvement plan. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **AdditionalResources** *(list) --* The additional resources for a choice in a custom lens. A choice can have up to two additional resources: one of type "HELPFUL_RESOURCE", one of type "IMPROVEMENT_PLAN", or both. * *(dict) --* The choice level additional resources for a custom lens. This field does not apply to Amazon Web Services official lenses. * **Type** *(string) --* Type of additional resource for a custom lens. * **Content** *(list) --* The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified. * *(dict) --* The choice content. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **SelectedChoices** *(list) --* List of selected choice IDs in a question answer. The values entered replace the previously selected choices. * *(string) --* The ID of a choice. * **ChoiceAnswers** *(list) --* A list of selected choices to a question in your review template. * *(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. * **AnswerStatus** *(string) --* The status of whether or not this question has been answered. * **Notes** *(string) --* The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. * **Reason** *(string) --* The reason why the question is not applicable to your review template. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_answers list_answers ************ WellArchitected.Client.list_answers(**kwargs) List of answers for a particular workload and lens. See also: AWS API Documentation **Request Syntax** response = client.list_answers( WorkloadId='string', LensAlias='string', PillarId='string', MilestoneNumber=123, NextToken='string', MaxResults=123, QuestionPriority='PRIORITIZED'|'NONE' ) Parameters: * **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 Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **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. * **QuestionPriority** (*string*) -- The priority of the question. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'MilestoneNumber': 123, 'LensAlias': 'string', 'LensArn': 'string', 'AnswerSummaries': [ { 'QuestionId': 'string', 'PillarId': 'string', 'QuestionTitle': 'string', 'Choices': [ { 'ChoiceId': 'string', 'Title': 'string', 'Description': 'string', 'HelpfulResource': { 'DisplayText': 'string', 'Url': 'string' }, 'ImprovementPlan': { 'DisplayText': 'string', 'Url': 'string' }, 'AdditionalResources': [ { 'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN', 'Content': [ { 'DisplayText': 'string', 'Url': 'string' }, ] }, ] }, ], 'SelectedChoices': [ 'string', ], 'ChoiceAnswerSummaries': [ { 'ChoiceId': 'string', 'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE' }, ], 'IsApplicable': True|False, 'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE', 'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE', 'QuestionType': 'PRIORITIZED'|'NON_PRIORITIZED', 'JiraConfiguration': { 'JiraIssueUrl': 'string', 'LastSyncedTime': datetime(2015, 1, 1) } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Output of a list answers call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **MilestoneNumber** *(integer) --* The milestone number. A workload can have a maximum of 100 milestones. * **LensAlias** *(string) --* The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as "serverless", or the lens ARN, such as "arn:aws:wellarchitected:us-east-1::lens/serverless". Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as "arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef". Each lens is identified by its LensSummary$LensAlias. * **LensArn** *(string) --* The ARN for the lens. * **AnswerSummaries** *(list) --* List of answer summaries of lens review in a workload. * *(dict) --* An answer summary of a lens review in a workload. * **QuestionId** *(string) --* The ID of the question. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionTitle** *(string) --* The title of the question. * **Choices** *(list) --* List of choices available for a question. * *(dict) --* A choice available to answer question. * **ChoiceId** *(string) --* The ID of a choice. * **Title** *(string) --* The title of a choice. * **Description** *(string) --* The description of a choice. * **HelpfulResource** *(dict) --* The helpful resource (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one helpful resource. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **ImprovementPlan** *(dict) --* The improvement plan (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one improvement plan. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **AdditionalResources** *(list) --* The additional resources for a choice in a custom lens. A choice can have up to two additional resources: one of type "HELPFUL_RESOURCE", one of type "IMPROVEMENT_PLAN", or both. * *(dict) --* The choice level additional resources for a custom lens. This field does not apply to Amazon Web Services official lenses. * **Type** *(string) --* Type of additional resource for a custom lens. * **Content** *(list) --* The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified. * *(dict) --* The choice content. * **DisplayText** *(string) --* The display text for the choice content. * **Url** *(string) --* The URL for the choice content. * **SelectedChoices** *(list) --* List of selected choice IDs in a question answer. The values entered replace the previously selected choices. * *(string) --* The ID of a choice. * **ChoiceAnswerSummaries** *(list) --* A list of selected choices to a question in your workload. * *(dict) --* A choice summary that has been answered on a question in your workload. * **ChoiceId** *(string) --* The ID of a choice. * **Status** *(string) --* The status of a choice. * **Reason** *(string) --* The reason why a choice is non-applicable to a question in your workload. * **IsApplicable** *(boolean) --* Defines whether this question is applicable to a lens review. * **Risk** *(string) --* The risk for a given workload, lens review, pillar, or question. * **Reason** *(string) --* The reason why a choice is non-applicable to a question in your workload. * **QuestionType** *(string) --* The type of the question. * **JiraConfiguration** *(dict) --* Configuration of the Jira integration. * **JiraIssueUrl** *(string) --* The URL of the associated Jira issue. * **LastSyncedTime** *(datetime) --* The date and time recorded. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / create_milestone create_milestone **************** WellArchitected.Client.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' ) Parameters: * **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 the original request has completed successfully, the result of the original request is returned. Warning: This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'WorkloadId': 'string', 'MilestoneNumber': 123 } **Response Structure** * *(dict) --* Output of a create milestone call. * **WorkloadId** *(string) --* The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. * **MilestoneNumber** *(integer) --* The milestone number. A workload can have a maximum of 100 milestones. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ConflictException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.ServiceQuotaExceededException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_check_summaries list_check_summaries ******************** WellArchitected.Client.list_check_summaries(**kwargs) List of Trusted Advisor checks summarized for all accounts related to the workload. See also: AWS API Documentation **Request Syntax** response = client.list_check_summaries( WorkloadId='string', NextToken='string', MaxResults=123, LensArn='string', PillarId='string', QuestionId='string', ChoiceId='string' ) Parameters: * **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. * **LensArn** (*string*) -- **[REQUIRED]** Well-Architected Lens ARN. * **PillarId** (*string*) -- **[REQUIRED]** The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionId** (*string*) -- **[REQUIRED]** The ID of the question. * **ChoiceId** (*string*) -- **[REQUIRED]** The ID of a choice. Return type: dict Returns: **Response Syntax** { 'CheckSummaries': [ { 'Id': 'string', 'Name': 'string', 'Provider': 'TRUSTED_ADVISOR', 'Description': 'string', 'UpdatedAt': datetime(2015, 1, 1), 'LensArn': 'string', 'PillarId': 'string', 'QuestionId': 'string', 'ChoiceId': 'string', 'Status': 'OKAY'|'WARNING'|'ERROR'|'NOT_AVAILABLE'|'FETCH_FAILED', 'AccountSummary': { 'string': 123 } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CheckSummaries** *(list) --* List of Trusted Advisor summaries related to the Well- Architected best practice. * *(dict) --* Trusted Advisor check summary. * **Id** *(string) --* Trusted Advisor check ID. * **Name** *(string) --* Trusted Advisor check name. * **Provider** *(string) --* Provider of the check related to the best practice. * **Description** *(string) --* Trusted Advisor check description. * **UpdatedAt** *(datetime) --* The date and time recorded. * **LensArn** *(string) --* Well-Architected Lens ARN associated to the check. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionId** *(string) --* The ID of the question. * **ChoiceId** *(string) --* The ID of a choice. * **Status** *(string) --* Status associated to the check. * **AccountSummary** *(dict) --* Account summary associated to the check. * *(string) --* * *(integer) --* * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException" WellArchitected / Client / list_check_details list_check_details ****************** WellArchitected.Client.list_check_details(**kwargs) List of Trusted Advisor check details by account related to the workload. See also: AWS API Documentation **Request Syntax** response = client.list_check_details( WorkloadId='string', NextToken='string', MaxResults=123, LensArn='string', PillarId='string', QuestionId='string', ChoiceId='string' ) Parameters: * **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. * **LensArn** (*string*) -- **[REQUIRED]** Well-Architected Lens ARN. * **PillarId** (*string*) -- **[REQUIRED]** The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionId** (*string*) -- **[REQUIRED]** The ID of the question. * **ChoiceId** (*string*) -- **[REQUIRED]** The ID of a choice. Return type: dict Returns: **Response Syntax** { 'CheckDetails': [ { 'Id': 'string', 'Name': 'string', 'Description': 'string', 'Provider': 'TRUSTED_ADVISOR', 'LensArn': 'string', 'PillarId': 'string', 'QuestionId': 'string', 'ChoiceId': 'string', 'Status': 'OKAY'|'WARNING'|'ERROR'|'NOT_AVAILABLE'|'FETCH_FAILED', 'AccountId': 'string', 'FlaggedResources': 123, 'Reason': 'ASSUME_ROLE_ERROR'|'ACCESS_DENIED'|'UNKNOWN_ERROR'|'PREMIUM_SUPPORT_REQUIRED', 'UpdatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **CheckDetails** *(list) --* The details about the Trusted Advisor checks related to the Well-Architected best practice. * *(dict) --* Account details for a Well-Architected best practice in relation to Trusted Advisor checks. * **Id** *(string) --* Trusted Advisor check ID. * **Name** *(string) --* Trusted Advisor check name. * **Description** *(string) --* Trusted Advisor check description. * **Provider** *(string) --* Provider of the check related to the best practice. * **LensArn** *(string) --* Well-Architected Lens ARN associated to the check. * **PillarId** *(string) --* The ID used to identify a pillar, for example, "security". A pillar is identified by its PillarReviewSummary$PillarId. * **QuestionId** *(string) --* The ID of the question. * **ChoiceId** *(string) --* The ID of a choice. * **Status** *(string) --* Status associated to the check. * **AccountId** *(string) --* An Amazon Web Services account ID. * **FlaggedResources** *(integer) --* Count of flagged resources associated to the check. * **Reason** *(string) --* Reason associated to the check. * **UpdatedAt** *(datetime) --* The date and time recorded. * **NextToken** *(string) --* The token to use to retrieve the next set of results. **Exceptions** * "WellArchitected.Client.exceptions.ValidationException" * "WellArchitected.Client.exceptions.ResourceNotFoundException" * "WellArchitected.Client.exceptions.InternalServerException" * "WellArchitected.Client.exceptions.AccessDeniedException" * "WellArchitected.Client.exceptions.ThrottlingException"