AWS API Changes

2021/11/29 - AWS Well-Architected Tool - 8 new 13 updated api methods

Changes This update provides support for Well-Architected API users to use custom lens features.

DeleteLens (new)

Delete an existing lens.

Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

Note

Disclaimer

By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.delete_lens(
    LensAlias='string',
    ClientRequestToken='string',
    LensStatus='ALL'|'DRAFT'|'PUBLISHED'
)

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

Warning

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

This field is autopopulated if not provided.

type LensStatus

string

param LensStatus

[REQUIRED]

The status of the lens to be deleted.

returns

None

DeleteLensShare (new)

Link ¶

Delete a lens share.

After the lens share is deleted, Amazon Web Services accounts and IAM users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

Note

Disclaimer

See also: AWS API Documentation

Request Syntax

client.delete_lens_share(
    ShareId='string',
    LensAlias='string',
    ClientRequestToken='string'
)

type ShareId

string

param ShareId

[REQUIRED]

The ID associated with the workload share.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

Warning

This field is autopopulated if not provided.

returns

None

CreateLensShare (new)

Link ¶

Create a lens share.

The owner of a lens can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted.

Note

Disclaimer

See also: AWS API Documentation

Request Syntax

client.create_lens_share(
    LensAlias='string',
    SharedWith='string',
    ClientRequestToken='string'
)

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type SharedWith

string

param SharedWith

[REQUIRED]

The Amazon Web Services account ID or IAM role with which the workload is shared.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

Warning

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'ShareId': 'string'
}

Response Structure

(dict) --
- ShareId (string) --
  
  The ID associated with the workload share.

CreateLensVersion (new)

Link ¶

Create a new lens version.

A lens can have up to 100 versions.

After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.

See also: AWS API Documentation

Request Syntax

client.create_lens_version(
    LensAlias='string',
    LensVersion='string',
    IsMajorVersion=True|False,
    ClientRequestToken='string'
)

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type LensVersion

string

param LensVersion

[REQUIRED]

The version of the lens being created.

type IsMajorVersion

boolean

param IsMajorVersion

Set to true if this new major lens version.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

Warning

This field is autopopulated if not provided.

rtype

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.

ImportLens (new)

Link ¶

Import a new lens.

The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide .

A custom lens cannot exceed 500 KB in size.

Note

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

See also: AWS API Documentation

Request Syntax

client.import_lens(
    LensAlias='string',
    JSONString='string',
    ClientRequestToken='string',
    Tags={
        'string': 'string'
    }
)

type LensAlias

string

param LensAlias

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type JSONString

string

param JSONString

[REQUIRED]

The JSON representation of a lens.

type ClientRequestToken

string

param ClientRequestToken

[REQUIRED]

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

Warning

This field is autopopulated if not provided.

type Tags

dict

param Tags

Tags to associate to a lens.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'LensArn': 'string',
    'Status': 'IN_PROGRESS'|'COMPLETE'|'ERROR'
}

Response Structure

(dict) --
- LensArn (string) --
  
  The ARN for the lens.
- Status (string) --
  
  The status of the imported lens.

GetLens (new)

Link ¶

Get an existing lens.

See also: AWS API Documentation

Request Syntax

client.get_lens(
    LensAlias='string',
    LensVersion='string'
)

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type LensVersion

string

param LensVersion

The lens version to be retrieved.

rtype

dict

returns

Response Syntax

{
    'Lens': {
        'LensArn': 'string',
        'LensVersion': 'string',
        'Name': 'string',
        'Description': 'string',
        'Owner': 'string',
        'ShareInvitationId': 'string'
    }
}

Response Structure

(dict) --
- Lens (dict) --
  
  A lens return object.
  - LensArn (string) --
    
    The ARN of a lens.
  - LensVersion (string) --
    
    The version of a lens.
  - Name (string) --
    
    The full name of the lens.
  - Description (string) --
    
    The description of the lens.
  - Owner (string) --
    
    The Amazon Web Services account ID that owns the lens.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.

ListLensShares (new)

Link ¶

List the lens shares associated with the lens.

See also: AWS API Documentation

Request Syntax

client.list_lens_shares(
    LensAlias='string',
    SharedWithPrefix='string',
    NextToken='string',
    MaxResults=123
)

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type SharedWithPrefix

string

param SharedWithPrefix

The Amazon Web Services account ID or IAM role with which the lens is shared.

type NextToken

string

param NextToken

The token to use to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for this request.

rtype

dict

returns

Response Syntax

{
    'LensShareSummaries': [
        {
            'ShareId': 'string',
            'SharedWith': 'string',
            'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LensShareSummaries (list) --
  
  A list of lens share summaries.
  - (dict) --
    
    A lens share summary return object.
    - ShareId (string) --
      
      The ID associated with the workload share.
    - SharedWith (string) --
      
      The Amazon Web Services account ID or IAM role with which the workload is shared.
    - Status (string) --
      
      The status of a workload share.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ExportLens (new)

Link ¶

Export an existing lens.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide . Only the owner of a lens can export it.

Note

Disclaimer

See also: AWS API Documentation

Request Syntax

client.export_lens(
    LensAlias='string',
    LensVersion='string'
)

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type LensVersion

string

param LensVersion

The lens version to be exported.

rtype

dict

returns

Response Syntax

{
    'LensJSON': 'string'
}

Response Structure

(dict) --
- LensJSON (string) --
  
  The JSON for the lens.

GetAnswer (updated)

Link ¶
Changes (response)

{'Answer': {'Choices': {'HelpfulResource': {'DisplayText': 'string',
                                            'Url': 'string'},
                        'ImprovementPlan': {'DisplayText': 'string',
                                            'Url': 'string'}},
            'HelpfulResourceDisplayText': 'string'},
 'LensArn': 'string'}

Get the answer to a specific question in a workload review.

See also: AWS API Documentation

Request Syntax

client.get_answer(
    WorkloadId='string',
    LensAlias='string',
    QuestionId='string',
    MilestoneNumber=123
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type QuestionId

string

param QuestionId

[REQUIRED]

The ID of the question.

type MilestoneNumber

integer

param MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.

rtype

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'
                }
            },
        ],
        'SelectedChoices': [
            'string',
        ],
        'ChoiceAnswers': [
            {
                'ChoiceId': 'string',
                'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
                'Notes': 'string'
            },
        ],
        'IsApplicable': True|False,
        'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
        'Notes': 'string',
        'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
    }
}

Response Structure

(dict) --

Output of a get answer call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.
- LensAlias (string) --
  
  The alias of the lens, for example, serverless .
  
  Each lens is identified by its LensSummary$LensAlias.
- LensArn (string) --
  
  The ARN for the lens.
- Answer (dict) --
  
  An answer of the question.
  - QuestionId (string) --
    
    The ID of the question.
  - PillarId (string) --
    
    The ID used to identify a pillar, for example, security .
    
    A pillar is identified by its PillarReviewSummary$PillarId.
  - QuestionTitle (string) --
    
    The title of the question.
  - QuestionDescription (string) --
    
    The description of the question.
  - ImprovementPlanUrl (string) --
    
    The improvement plan URL for a question.
    
    This value is only available if the question has been answered.
  - HelpfulResourceUrl (string) --
    
    The helpful resource URL for a question.
  - HelpfulResourceDisplayText (string) --
    
    The helpful resource text to be displayed.
  - Choices (list) --
    
    List of choices available for a question.
    - (dict) --
      
      A choice available to answer question.
      - ChoiceId (string) --
        
        The ID of a choice.
      - Title (string) --
        
        The title of a choice.
      - Description (string) --
        
        The description of a choice.
      - HelpfulResource (dict) --
        
        The choice level helpful resource.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
      - ImprovementPlan (dict) --
        
        The choice level improvement plan.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
  - SelectedChoices (list) --
    
    List of selected choice IDs in a question answer.
    
    The values entered replace the previously selected choices.
    - (string) --
      
      The ID of a choice.
  - ChoiceAnswers (list) --
    
    A list of selected choices to a question in your workload.
    - (dict) --
      
      A choice that has been answered on a question in your workload.
      - ChoiceId (string) --
        
        The ID of a choice.
      - Status (string) --
        
        The status of a choice.
      - Reason (string) --
        
        The reason why a choice is non-applicable to a question in your workload.
      - Notes (string) --
        
        The notes associated with a choice.
  - IsApplicable (boolean) --
    
    Defines whether this question is applicable to a lens review.
  - Risk (string) --
    
    The risk for a given workload, lens review, pillar, or question.
  - Notes (string) --
    
    The notes associated with the workload.
  - Reason (string) --
    
    The reason why the question is not applicable to your workload.

GetLensReview (updated)

Link ¶
Changes (response)

{'LensReview': {'LensArn': 'string', 'LensStatus': {'UNSHARED', 'DELETED'}}}

Get lens review.

See also: AWS API Documentation

Request Syntax

client.get_lens_review(
    WorkloadId='string',
    LensAlias='string',
    MilestoneNumber=123
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type MilestoneNumber

integer

param MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.

rtype

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
                }
            },
        ],
        'UpdatedAt': datetime(2015, 1, 1),
        'Notes': 'string',
        'RiskCounts': {
            'string': 123
        },
        'NextToken': 'string'
    }
}

Response Structure

(dict) --

Output of a get lens review call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.
- LensReview (dict) --
  
  A lens review of a question.
  - LensAlias (string) --
    
    The alias of the lens, for example, serverless .
    
    Each lens is identified by its LensSummary$LensAlias.
  - LensArn (string) --
    
    The ARN for the lens.
  - LensVersion (string) --
    
    The version of the lens.
  - LensName (string) --
    
    The full name of the lens.
  - LensStatus (string) --
    
    The status of the lens.
  - PillarReviewSummaries (list) --
    
    List of pillar review summaries of lens review in a workload.
    - (dict) --
      
      A pillar review summary of a lens review.
      - PillarId (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId.
      - PillarName (string) --
        
        The name of the pillar.
      - Notes (string) --
        
        The notes associated with the workload.
      - RiskCounts (dict) --
        
        A map from risk names to the count of how questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - Notes (string) --
    
    The notes associated with the workload.
  - RiskCounts (dict) --
    
    A map from risk names to the count of how questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.
  - NextToken (string) --
    
    The token to use to retrieve the next set of results.

GetLensReviewReport (updated)

Link ¶
Changes (response)

{'LensReviewReport': {'LensArn': 'string'}}

Get lens review report.

See also: AWS API Documentation

Request Syntax

client.get_lens_review_report(
    WorkloadId='string',
    LensAlias='string',
    MilestoneNumber=123
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type MilestoneNumber

integer

param MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.

rtype

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 example, serverless .
    
    Each lens is identified by its LensSummary$LensAlias.
  - LensArn (string) --
    
    The ARN for the lens.
  - Base64String (string) --
    
    The Base64-encoded string representation of a lens review report.
    
    This data can be used to create a PDF file.

GetLensVersionDifference (updated)

Link ¶
Changes (request, response)
Request

{'TargetLensVersion': 'string'}

Response

{'LensArn': 'string',
 'TargetLensVersion': 'string',
 'VersionDifferences': {'PillarDifferences': {'PillarName': 'string'}}}

Get lens version differences.

See also: AWS API Documentation

Request Syntax

client.get_lens_version_difference(
    LensAlias='string',
    BaseLensVersion='string',
    TargetLensVersion='string'
)

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type BaseLensVersion

string

param BaseLensVersion

The base version of the lens.

type TargetLensVersion

string

param TargetLensVersion

The lens version to target a difference for.

rtype

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 example, serverless .
  
  Each lens is identified by its LensSummary$LensAlias.
- LensArn (string) --
  
  The ARN for the lens.
- BaseLensVersion (string) --
  
  The base version of the lens.
- TargetLensVersion (string) --
  
  The target lens version for the lens.
- LatestLensVersion (string) --
  
  The latest version of the lens.
- VersionDifferences (dict) --
  
  The differences between the base and latest versions of the lens.
  - PillarDifferences (list) --
    
    The differences between the base and latest versions of the lens.
    - (dict) --
      
      A pillar difference return object.
      - PillarId (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId.
      - PillarName (string) --
        
        The name of the pillar.
      - DifferenceStatus (string) --
        
        Indicates the type of change to the pillar.
      - QuestionDifferences (list) --
        
        List of question differences.
        
        (dict) --
        
        A question difference return object.
        
        QuestionId (string) --
        
        The ID of the question.
        
        QuestionTitle (string) --
        
        The title of the question.
        
        DifferenceStatus (string) --
        
        Indicates the type of change to the question.

ListAnswers (updated)

Link ¶
Changes (response)

{'AnswerSummaries': {'Choices': {'HelpfulResource': {'DisplayText': 'string',
                                                     'Url': 'string'},
                                 'ImprovementPlan': {'DisplayText': 'string',
                                                     'Url': 'string'}}},
 'LensArn': 'string'}

List of answers.

See also: AWS API Documentation

Request Syntax

client.list_answers(
    WorkloadId='string',
    LensAlias='string',
    PillarId='string',
    MilestoneNumber=123,
    NextToken='string',
    MaxResults=123
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type PillarId

string

param PillarId

The ID used to identify a pillar, for example, security .

A pillar is identified by its PillarReviewSummary$PillarId.

type MilestoneNumber

integer

param MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.

type NextToken

string

param NextToken

The token to use to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for this request.

rtype

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'
                    }
                },
            ],
            'SelectedChoices': [
                'string',
            ],
            'ChoiceAnswerSummaries': [
                {
                    'ChoiceId': 'string',
                    'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                    'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
                },
            ],
            'IsApplicable': True|False,
            'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
            'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Output of a list answers call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.
- LensAlias (string) --
  
  The alias of the lens, for example, serverless .
  
  Each lens is identified by its LensSummary$LensAlias.
- LensArn (string) --
  
  The ARN for the lens.
- AnswerSummaries (list) --
  
  List of answer summaries of lens review in a workload.
  - (dict) --
    
    An answer summary of a lens review in a workload.
    - QuestionId (string) --
      
      The ID of the question.
    - PillarId (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId.
    - QuestionTitle (string) --
      
      The title of the question.
    - Choices (list) --
      
      List of choices available for a question.
      - (dict) --
        
        A choice available to answer question.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        Title (string) --
        
        The title of a choice.
        
        Description (string) --
        
        The description of a choice.
        
        HelpfulResource (dict) --
        
        The choice level helpful resource.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
        
        ImprovementPlan (dict) --
        
        The choice level improvement plan.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
    - SelectedChoices (list) --
      
      List of selected choice IDs in a question answer.
      
      The values entered replace the previously selected choices.
      - (string) --
        
        The ID of a choice.
    - ChoiceAnswerSummaries (list) --
      
      A list of selected choices to a question in your workload.
      - (dict) --
        
        A choice summary that has been answered on a question in your workload.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        Status (string) --
        
        The status of a choice.
        
        Reason (string) --
        
        The reason why a choice is non-applicable to a question in your workload.
    - IsApplicable (boolean) --
      
      Defines whether this question is applicable to a lens review.
    - Risk (string) --
      
      The risk for a given workload, lens review, pillar, or question.
    - Reason (string) --
      
      The reason why a choice is non-applicable to a question in your workload.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListLensReviewImprovements (updated)

Link ¶
Changes (response)

{'ImprovementSummaries': {'ImprovementPlans': [{'ChoiceId': 'string',
                                                'DisplayText': 'string',
                                                'ImprovementPlanUrl': 'string'}]},
 'LensArn': 'string'}

List lens review improvements.

See also: AWS API Documentation

Request Syntax

client.list_lens_review_improvements(
    WorkloadId='string',
    LensAlias='string',
    PillarId='string',
    MilestoneNumber=123,
    NextToken='string',
    MaxResults=123
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type PillarId

string

param PillarId

The ID used to identify a pillar, for example, security .

A pillar is identified by its PillarReviewSummary$PillarId.

type MilestoneNumber

integer

param MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.

type NextToken

string

param NextToken

The token to use to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for this request.

rtype

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'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Output of a list lens review improvements call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.
- LensAlias (string) --
  
  The alias of the lens, for example, serverless .
  
  Each lens is identified by its LensSummary$LensAlias.
- LensArn (string) --
  
  The ARN for the lens.
- ImprovementSummaries (list) --
  
  List of improvement summaries of lens review in a workload.
  - (dict) --
    
    An improvement summary of a lens review in a workload.
    - QuestionId (string) --
      
      The ID of the question.
    - PillarId (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId.
    - QuestionTitle (string) --
      
      The title of the question.
    - Risk (string) --
      
      The risk for a given workload, lens review, pillar, or question.
    - ImprovementPlanUrl (string) --
      
      The improvement plan URL for a question.
      
      This value is only available if the question has been answered.
    - ImprovementPlans (list) --
      
      The improvement plan details.
      - (dict) --
        
        The choice level improvement plan.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        DisplayText (string) --
        
        The display text for the improvement plan.
        
        ImprovementPlanUrl (string) --
        
        The improvement plan URL for a question.
        
        This value is only available if the question has been answered.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListLensReviews (updated)

Link ¶
Changes (response)

{'LensReviewSummaries': {'LensArn': 'string',
                         'LensStatus': {'UNSHARED', 'DELETED'}}}

List lens reviews.

See also: AWS API Documentation

Request Syntax

client.list_lens_reviews(
    WorkloadId='string',
    MilestoneNumber=123,
    NextToken='string',
    MaxResults=123
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type MilestoneNumber

integer

param MilestoneNumber

The milestone number.

A workload can have a maximum of 100 milestones.

type NextToken

string

param NextToken

The token to use to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for this request.

rtype

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
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Output of a list lens reviews call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.
- LensReviewSummaries (list) --
  
  List of lens summaries of lens reviews of a workload.
  - (dict) --
    
    A lens review summary of a workload.
    - LensAlias (string) --
      
      The alias of the lens, for example, serverless .
      
      Each lens is identified by its LensSummary$LensAlias.
    - LensArn (string) --
      
      The ARN for the lens.
    - LensVersion (string) --
      
      The version of the lens.
    - LensName (string) --
      
      The full name of the lens.
    - LensStatus (string) --
      
      The status of the lens.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
    - RiskCounts (dict) --
      
      A map from risk names to the count of how questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListLenses (updated)

Link ¶
Changes (request, response)
Request

{'LensName': 'string',
 'LensStatus': 'ALL | DRAFT | PUBLISHED',
 'LensType': 'AWS_OFFICIAL | CUSTOM_SHARED | CUSTOM_SELF'}

Response

{'LensSummaries': {'CreatedAt': 'timestamp',
                   'LensArn': 'string',
                   'LensStatus': 'CURRENT | NOT_CURRENT | DEPRECATED | DELETED '
                                 '| UNSHARED',
                   'LensType': 'AWS_OFFICIAL | CUSTOM_SHARED | CUSTOM_SELF',
                   'Owner': 'string',
                   'UpdatedAt': 'timestamp'}}

List the available lenses.

See also: AWS API Documentation

Request Syntax

client.list_lenses(
    NextToken='string',
    MaxResults=123,
    LensType='AWS_OFFICIAL'|'CUSTOM_SHARED'|'CUSTOM_SELF',
    LensStatus='ALL'|'DRAFT'|'PUBLISHED',
    LensName='string'
)

type NextToken

string

param NextToken

The token to use to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for this request.

type LensType

string

param LensType

The type of lenses to be returned.

type LensStatus

string

param LensStatus

The status of lenses to be returned.

type LensName

string

param LensName

The full name of the lens.

rtype

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 example, serverless .
      
      Each lens is identified by its LensSummary$LensAlias.
    - LensName (string) --
      
      The full name of the lens.
    - LensType (string) --
      
      The type of the lens.
    - Description (string) --
      
      The description of the lens.
    - CreatedAt (datetime) --
      
      The date and time recorded.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
    - LensVersion (string) --
      
      The version of the lens.
    - Owner (string) --
      
      An Amazon Web Services account ID.
    - LensStatus (string) --
      
      The status of the lens.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListNotifications (updated)

Link ¶
Changes (response)

{'NotificationSummaries': {'LensUpgradeSummary': {'LensArn': 'string'}}}

List lens notifications.

See also: AWS API Documentation

Request Syntax

client.list_notifications(
    WorkloadId='string',
    NextToken='string',
    MaxResults=123
)

type WorkloadId

string

param WorkloadId

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type NextToken

string

param NextToken

The token to use to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for this request.

rtype

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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NotificationSummaries (list) --
  
  List of lens notification summaries in a workload.
  - (dict) --
    
    A notification summary return object.
    - Type (string) --
      
      The type of notification.
    - LensUpgradeSummary (dict) --
      
      Summary of lens upgrade.
      - WorkloadId (string) --
        
        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
      - WorkloadName (string) --
        
        The name of the workload.
        
        The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
      - LensAlias (string) --
        
        The alias of the lens, for example, serverless .
        
        Each lens is identified by its LensSummary$LensAlias.
      - LensArn (string) --
        
        The ARN for the lens.
      - CurrentLensVersion (string) --
        
        The current version of the lens.
      - LatestLensVersion (string) --
        
        The latest version of the lens.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListShareInvitations (updated)

Link ¶
Changes (request, response)
Request

{'LensNamePrefix': 'string', 'ShareResourceType': 'WORKLOAD | LENS'}

Response

{'ShareInvitationSummaries': {'LensArn': 'string',
                              'LensName': 'string',
                              'ShareResourceType': 'WORKLOAD | LENS'}}

List the workload invitations.

See also: AWS API Documentation

Request Syntax

client.list_share_invitations(
    WorkloadNamePrefix='string',
    LensNamePrefix='string',
    ShareResourceType='WORKLOAD'|'LENS',
    NextToken='string',
    MaxResults=123
)

type WorkloadNamePrefix

string

param WorkloadNamePrefix

An optional string added to the beginning of each workload name returned in the results.

type LensNamePrefix

string

param LensNamePrefix

An optional string added to the beginning of each lens name returned in the results.

type ShareResourceType

string

param ShareResourceType

The type of share invitations to be returned.

type NextToken

string

param NextToken

The token to use to retrieve the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for this request.

rtype

dict

returns

Response Syntax

{
    'ShareInvitationSummaries': [
        {
            'ShareInvitationId': 'string',
            'SharedBy': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'ShareResourceType': 'WORKLOAD'|'LENS',
            'WorkloadName': 'string',
            'WorkloadId': 'string',
            'LensName': 'string',
            'LensArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Input for List Share Invitations
- ShareInvitationSummaries (list) --
  
  List of share invitation summaries in a workload.
  - (dict) --
    
    A share invitation summary return object.
    - ShareInvitationId (string) --
      
      The ID assigned to the share invitation.
    - SharedBy (string) --
      
      An Amazon Web Services account ID.
    - SharedWith (string) --
      
      The Amazon Web Services account ID or IAM role with which the workload is shared.
    - PermissionType (string) --
      
      Permission granted on a workload share.
    - ShareResourceType (string) --
      
      The resource type of the share invitation.
    - WorkloadName (string) --
      
      The name of the workload.
      
      The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
    - WorkloadId (string) --
      
      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
    - LensName (string) --
      
      The full name of the lens.
    - LensArn (string) --
      
      The ARN for the lens.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

UpdateAnswer (updated)

Link ¶
Changes (response)

{'Answer': {'Choices': {'HelpfulResource': {'DisplayText': 'string',
                                            'Url': 'string'},
                        'ImprovementPlan': {'DisplayText': 'string',
                                            'Url': 'string'}},
            'HelpfulResourceDisplayText': 'string'},
 'LensArn': 'string'}

Update the answer to a specific question in a workload review.

See also: AWS API Documentation

Request Syntax

client.update_answer(
    WorkloadId='string',
    LensAlias='string',
    QuestionId='string',
    SelectedChoices=[
        'string',
    ],
    ChoiceUpdates={
        'string': {
            'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
            'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
            'Notes': 'string'
        }
    },
    Notes='string',
    IsApplicable=True|False,
    Reason='OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type QuestionId

string

param QuestionId

[REQUIRED]

The ID of the question.

type SelectedChoices

list

param SelectedChoices

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

(string) --

The ID of a choice.

type ChoiceUpdates

dict

param ChoiceUpdates

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.

type Notes

string

param Notes

The notes associated with the workload.

type IsApplicable

boolean

param IsApplicable

Defines whether this question is applicable to a lens review.

type Reason

string

param Reason

The reason why a question is not applicable to your workload.

rtype

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'
                }
            },
        ],
        'SelectedChoices': [
            'string',
        ],
        'ChoiceAnswers': [
            {
                'ChoiceId': 'string',
                'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
                'Notes': 'string'
            },
        ],
        'IsApplicable': True|False,
        'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
        'Notes': 'string',
        'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
    }
}

Response Structure

(dict) --

Output of a update answer call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- LensAlias (string) --
  
  The alias of the lens, for example, serverless .
  
  Each lens is identified by its LensSummary$LensAlias.
- LensArn (string) --
  
  The ARN for the lens.
- Answer (dict) --
  
  An answer of the question.
  - QuestionId (string) --
    
    The ID of the question.
  - PillarId (string) --
    
    The ID used to identify a pillar, for example, security .
    
    A pillar is identified by its PillarReviewSummary$PillarId.
  - QuestionTitle (string) --
    
    The title of the question.
  - QuestionDescription (string) --
    
    The description of the question.
  - ImprovementPlanUrl (string) --
    
    The improvement plan URL for a question.
    
    This value is only available if the question has been answered.
  - HelpfulResourceUrl (string) --
    
    The helpful resource URL for a question.
  - HelpfulResourceDisplayText (string) --
    
    The helpful resource text to be displayed.
  - Choices (list) --
    
    List of choices available for a question.
    - (dict) --
      
      A choice available to answer question.
      - ChoiceId (string) --
        
        The ID of a choice.
      - Title (string) --
        
        The title of a choice.
      - Description (string) --
        
        The description of a choice.
      - HelpfulResource (dict) --
        
        The choice level helpful resource.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
      - ImprovementPlan (dict) --
        
        The choice level improvement plan.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
  - SelectedChoices (list) --
    
    List of selected choice IDs in a question answer.
    
    The values entered replace the previously selected choices.
    - (string) --
      
      The ID of a choice.
  - ChoiceAnswers (list) --
    
    A list of selected choices to a question in your workload.
    - (dict) --
      
      A choice that has been answered on a question in your workload.
      - ChoiceId (string) --
        
        The ID of a choice.
      - Status (string) --
        
        The status of a choice.
      - Reason (string) --
        
        The reason why a choice is non-applicable to a question in your workload.
      - Notes (string) --
        
        The notes associated with a choice.
  - IsApplicable (boolean) --
    
    Defines whether this question is applicable to a lens review.
  - Risk (string) --
    
    The risk for a given workload, lens review, pillar, or question.
  - Notes (string) --
    
    The notes associated with the workload.
  - Reason (string) --
    
    The reason why the question is not applicable to your workload.

UpdateLensReview (updated)

Link ¶
Changes (response)

{'LensReview': {'LensArn': 'string', 'LensStatus': {'UNSHARED', 'DELETED'}}}

Update lens review.

See also: AWS API Documentation

Request Syntax

client.update_lens_review(
    WorkloadId='string',
    LensAlias='string',
    LensNotes='string',
    PillarNotes={
        'string': 'string'
    }
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type LensNotes

string

param LensNotes

The notes associated with the workload.

type PillarNotes

dict

param PillarNotes

List of pillar notes of a lens review in a workload.

(string) --

The ID used to identify a pillar, for example, security .

A pillar is identified by its PillarReviewSummary$PillarId.
- (string) --
  
  The notes associated with the workload.

rtype

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
                }
            },
        ],
        'UpdatedAt': datetime(2015, 1, 1),
        'Notes': 'string',
        'RiskCounts': {
            'string': 123
        },
        'NextToken': 'string'
    }
}

Response Structure

(dict) --

Output of a update lens review call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- LensReview (dict) --
  
  A lens review of a question.
  - LensAlias (string) --
    
    The alias of the lens, for example, serverless .
    
    Each lens is identified by its LensSummary$LensAlias.
  - LensArn (string) --
    
    The ARN for the lens.
  - LensVersion (string) --
    
    The version of the lens.
  - LensName (string) --
    
    The full name of the lens.
  - LensStatus (string) --
    
    The status of the lens.
  - PillarReviewSummaries (list) --
    
    List of pillar review summaries of lens review in a workload.
    - (dict) --
      
      A pillar review summary of a lens review.
      - PillarId (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId.
      - PillarName (string) --
        
        The name of the pillar.
      - Notes (string) --
        
        The notes associated with the workload.
      - RiskCounts (dict) --
        
        A map from risk names to the count of how questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - Notes (string) --
    
    The notes associated with the workload.
  - RiskCounts (dict) --
    
    A map from risk names to the count of how questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.
  - NextToken (string) --
    
    The token to use to retrieve the next set of results.

UpdateShareInvitation (updated)

Link ¶
Changes (response)

{'ShareInvitation': {'LensAlias': 'string',
                     'LensArn': 'string',
                     'ShareResourceType': 'WORKLOAD | LENS'}}

Update a workload invitation.

See also: AWS API Documentation

Request Syntax

client.update_share_invitation(
    ShareInvitationId='string',
    ShareInvitationAction='ACCEPT'|'REJECT'
)

type ShareInvitationId

string

param ShareInvitationId

[REQUIRED]

The ID assigned to the share invitation.

type ShareInvitationAction

string

param ShareInvitationAction

[REQUIRED]

Share invitation action taken by contributor.

rtype

dict

returns

Response Syntax

{
    'ShareInvitation': {
        'ShareInvitationId': 'string',
        'ShareResourceType': 'WORKLOAD'|'LENS',
        'WorkloadId': 'string',
        'LensAlias': 'string',
        'LensArn': 'string'
    }
}

Response Structure

(dict) --
- ShareInvitation (dict) --
  
  The updated workload share invitation.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.
  - ShareResourceType (string) --
    
    The resource type of the share invitation.
  - WorkloadId (string) --
    
    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
  - LensAlias (string) --
    
    The alias of the lens, for example, serverless .
    
    Each lens is identified by its LensSummary$LensAlias.
  - LensArn (string) --
    
    The ARN for the lens.