WellArchitected / Client / update_lens_review

update_lens_review#

WellArchitected.Client.update_lens_review(**kwargs)#

Update lens review for a particular workload.

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/0123456789abcdef01234567890abcdef.
    
    Each lens is identified by its LensSummary$LensAlias.
  - LensArn (string) –
    
    The ARN for the lens.
  - LensVersion (string) –
    
    The version of the lens.
  - LensName (string) –
    
    The full name of the lens.
  - LensStatus (string) –
    
    The status of the lens.
  - PillarReviewSummaries (list) –
    
    List of pillar review summaries of lens review in a workload.
    - (dict) –
      
      A pillar review summary of a lens review.
      - PillarId (string) –
        
        The ID used to identify a pillar, for example, security.
        
        A pillar is identified by its PillarReviewSummary$PillarId.
      - PillarName (string) –
        
        The name of the pillar.
      - Notes (string) –
        
        The notes associated with the workload.
        
        For a review template, these are the notes that will be associated with the workload when the template is applied.
      - RiskCounts (dict) –
        
        A map from risk names to the count of how many questions have that rating.
        
        (string) –
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) –
        
        A non-negative integer that denotes how many.
      - PrioritizedRiskCounts (dict) –
        
        A map from risk names to the count of how many questions have that rating.
        
        (string) –
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) –
        
        A non-negative integer that denotes how many.
  - JiraConfiguration (dict) –
    
    Jira configuration status of the Lens review.
    - SelectedPillars (list) –
      
      Selected pillars in the workload.
      - (dict) –
        
        The selected pillar.
        
        PillarId (string) –
        
        The ID used to identify a pillar, for example, security.
        
        A pillar is identified by its PillarReviewSummary$PillarId.
        
        SelectedQuestionIds (list) –
        
        Selected question IDs in the selected pillar.
        
        (string) –
  - UpdatedAt (datetime) –
    
    The date and time recorded.
  - Notes (string) –
    
    The notes associated with the workload.
    
    For a review template, these are the notes that will be associated with the workload when the template is applied.
  - RiskCounts (dict) –
    
    A map from risk names to the count of how many questions have that rating.
    - (string) –
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) –
        
        A non-negative integer that denotes how many.
  - NextToken (string) –
    
    The token to use to retrieve the next set of results.
  - Profiles (list) –
    
    The profiles associated with the workload.
    - (dict) –
      
      The profile associated with a workload.
      - ProfileArn (string) –
        
        The profile ARN.
      - ProfileVersion (string) –
        
        The profile version.
  - PrioritizedRiskCounts (dict) –
    
    A map from risk names to the count of how many questions have that rating.
    - (string) –
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) –
        
        A non-negative integer that denotes how many.

update_lens_review#

Request Syntax

Response Syntax

Response Structure

Exceptions