AWS API Changes

2020/12/16 - AWS Well-Architected Tool - 28 new api methods

Changes This is the first release of AWS Well-Architected Tool API support, use to review your workload and compare against the latest AWS architectural best practices.

CreateMilestone (new)

Link ¶

Create a milestone for an existing workload.

See also: AWS API Documentation

Request Syntax

client.create_milestone(
    WorkloadId='string',
    MilestoneName='string',
    ClientRequestToken='string'
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type MilestoneName

string

param MilestoneName

[REQUIRED]

The name of the milestone in a workload.

Milestone names must be unique within a workload.

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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

This field is autopopulated if not provided.

rtype

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 AWS Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.

UpdateShareInvitation (new)

Link ¶

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

Response Structure

(dict) --
- ShareInvitation (dict) --
  
  The updated workload share invitation.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.
  - WorkloadId (string) --
    
    The ID assigned to the workload. This ID is unique within an AWS Region.

CreateWorkload (new)

Link ¶

Create a new workload.

The owner of a workload can share the workload with other AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the AWS Well-Architected Tool User Guide .

See also: AWS API Documentation

Request Syntax

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'
)

type WorkloadName

string

param WorkloadName

[REQUIRED]

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

type Description

string

param Description

[REQUIRED]

The description for the workload.

type Environment

string

param Environment

[REQUIRED]

The environment for the workload.

type AccountIds

list

param AccountIds

The list of AWS account IDs associated with the workload.

(string) --

An AWS account ID.

type AwsRegions

list

param AwsRegions

The list of AWS Regions associated with the workload, for example, us-east-2 , or ca-central-1 .

(string) --

An AWS Region, for example, us-west-2 or ap-northeast-1 .

type NonAwsRegions

list

param NonAwsRegions

The list of non-AWS Regions associated with the workload.

(string) --

type PillarPriorities

list

param PillarPriorities

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.

type ArchitecturalDesign

string

param ArchitecturalDesign

The URL of the architectural design for the workload.

type ReviewOwner

string

param ReviewOwner

[REQUIRED]

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

type IndustryType

string

param IndustryType

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

type Industry

string

param Industry

The industry for the workload.

type Lenses

list

param Lenses

[REQUIRED]

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

(string) --

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type Notes

string

param Notes

The notes associated with the workload.

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

{
    '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 AWS Region.
- WorkloadArn (string) --
  
  The ARN for the workload.

ListMilestones (new)

Link ¶

List all milestones for an existing workload.

See also: AWS API Documentation

Request Syntax

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

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS 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

{
    'WorkloadId': 'string',
    'MilestoneSummaries': [
        {
            'MilestoneNumber': 123,
            'MilestoneName': 'string',
            'RecordedAt': datetime(2015, 1, 1),
            'WorkloadSummary': {
                'WorkloadId': 'string',
                'WorkloadArn': 'string',
                'WorkloadName': 'string',
                'Owner': 'string',
                'UpdatedAt': datetime(2015, 1, 1),
                'Lenses': [
                    'string',
                ],
                'RiskCounts': {
                    'string': 123
                },
                'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Output of a list milestones call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an AWS 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 AWS Region.
      - WorkloadArn (string) --
        
        The ARN for the workload.
      - WorkloadName (string) --
        
        The name of the workload.
        
        The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
      - Owner (string) --
        
        An AWS account ID.
      - UpdatedAt (datetime) --
        
        The date and time recorded.
      - Lenses (list) --
        
        The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
        
        (string) --
        
        The alias of the lens, for example, serverless .
        
        Each lens is identified by its LensSummary$LensAlias.
      - RiskCounts (dict) --
        
        A map from risk names to the count of how questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
      - ImprovementStatus (string) --
        
        The improvement status for a workload.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

UpdateAnswer (new)

Link ¶

Update the answer.

See also: AWS API Documentation

Request Syntax

client.update_answer(
    WorkloadId='string',
    LensAlias='string',
    QuestionId='string',
    SelectedChoices=[
        'string',
    ],
    Notes='string',
    IsApplicable=True|False
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS 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.

(string) --

The ID of 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.

rtype

dict

returns

Response Syntax

{
    'WorkloadId': 'string',
    'LensAlias': 'string',
    'Answer': {
        'QuestionId': 'string',
        'PillarId': 'string',
        'QuestionTitle': 'string',
        'QuestionDescription': 'string',
        'ImprovementPlanUrl': 'string',
        'HelpfulResourceUrl': 'string',
        'Choices': [
            {
                'ChoiceId': 'string',
                'Title': 'string',
                'Description': 'string'
            },
        ],
        'SelectedChoices': [
            'string',
        ],
        'IsApplicable': True|False,
        'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
        'Notes': 'string'
    }
}

Response Structure

(dict) --

Output of a update answer call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an AWS Region.
- LensAlias (string) --
  
  The alias of the lens, for example, serverless .
  
  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.
  - HelpfulResourceUrl (string) --
    
    The helpful resource URL for a 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.
  - SelectedChoices (list) --
    
    List of selected choice IDs in a question answer.
    - (string) --
      
      The ID of 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.

ListAnswers (new)

Link ¶

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 AWS 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',
    'AnswerSummaries': [
        {
            'QuestionId': 'string',
            'PillarId': 'string',
            'QuestionTitle': 'string',
            'Choices': [
                {
                    'ChoiceId': 'string',
                    'Title': 'string',
                    'Description': 'string'
                },
            ],
            'SelectedChoices': [
                'string',
            ],
            'IsApplicable': True|False,
            'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE'
        },
    ],
    '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 AWS 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.
- 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.
    - SelectedChoices (list) --
      
      List of selected choice IDs in a question answer.
      - (string) --
        
        The ID of 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.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListNotifications (new)

Link ¶

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 AWS 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',
                '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 AWS Region.
      - WorkloadName (string) --
        
        The name of the workload.
        
        The name must be unique within an account within a 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.
      - 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.

GetLensReviewReport (new)

Link ¶

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 AWS 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',
        '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 AWS 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.
  - Base64String (string) --
    
    The Base64-encoded string representation of a lens review report.
    
    This data can be used to create a PDF file.

ListLenses (new)

Link ¶

List the available lenses.

See also: AWS API Documentation

Request Syntax

client.list_lenses(
    NextToken='string',
    MaxResults=123
)

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

{
    'LensSummaries': [
        {
            'LensAlias': 'string',
            'LensVersion': 'string',
            'LensName': 'string',
            'Description': 'string'
        },
    ],
    '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.
    - LensAlias (string) --
      
      The alias of the lens, for example, serverless .
      
      Each lens is identified by its LensSummary$LensAlias.
    - LensVersion (string) --
      
      The version of the lens.
    - LensName (string) --
      
      The full name of the lens.
    - Description (string) --
      
      The description of the lens.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

GetMilestone (new)

Link ¶

Get a milestone for an existing workload.

See also: AWS API Documentation

Request Syntax

client.get_milestone(
    WorkloadId='string',
    MilestoneNumber=123
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type MilestoneNumber

integer

param MilestoneNumber

[REQUIRED]

The milestone number.

A workload can have a maximum of 100 milestones.

rtype

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'
        }
    }
}

Response Structure

(dict) --

Output of a get milestone call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an AWS 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 AWS Region.
    - WorkloadArn (string) --
      
      The ARN for the workload.
    - WorkloadName (string) --
      
      The name of the workload.
      
      The name must be unique within an account within a 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 AWS account IDs associated with the workload.
      - (string) --
        
        An AWS account ID.
    - AwsRegions (list) --
      
      The list of AWS Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
      - (string) --
        
        An AWS Region, for example, us-west-2 or ap-northeast-1 .
    - NonAwsRegions (list) --
      
      The list of non-AWS Regions associated with the workload.
      - (string) --
    - ArchitecturalDesign (string) --
      
      The URL of the architectural design for the workload.
    - ReviewOwner (string) --
      
      The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
    - ReviewRestrictionDate (datetime) --
      
      The date and time recorded.
    - IsReviewOwnerUpdateAcknowledged (boolean) --
      
      Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
      
      If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
    - IndustryType (string) --
      
      The industry type for the workload.
      
      If specified, must be one of the following:
      - Agriculture
      - Automobile
      - Defense
      - Design and Engineering
      - Digital Advertising
      - Education
      - Environmental Protection
      - Financial Services
      - Gaming
      - General Public Services
      - Healthcare
      - Hospitality
      - InfoTech
      - Justice and Public Safety
      - Life Sciences
      - Manufacturing
      - Media & Entertainment
      - Mining & Resources
      - Oil & Gas
      - Power & Utilities
      - Professional Services
      - Real Estate & Construction
      - Retail & Wholesale
      - Social Protection
      - Telecommunications
      - Travel, Transportation & Logistics
      - Other
    - Industry (string) --
      
      The industry for the workload.
    - Notes (string) --
      
      The notes associated with the workload.
    - ImprovementStatus (string) --
      
      The improvement status for a workload.
    - RiskCounts (dict) --
      
      A map from risk names to the count of how questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
    - PillarPriorities (list) --
      
      The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
      - (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId.
    - Lenses (list) --
      
      The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
      - (string) --
        
        The alias of the lens, for example, serverless .
        
        Each lens is identified by its LensSummary$LensAlias.
    - Owner (string) --
      
      An AWS account ID.
    - ShareInvitationId (string) --
      
      The ID assigned to the share invitation.

DeleteWorkloadShare (new)

Link ¶

Delete a workload share.

See also: AWS API Documentation

Request Syntax

client.delete_workload_share(
    ShareId='string',
    WorkloadId='string',
    ClientRequestToken='string'
)

type ShareId

string

param ShareId

[REQUIRED]

The ID associated with the workload share.

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

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

ListShareInvitations (new)

Link ¶

List the workload invitations.

See also: AWS API Documentation

Request Syntax

client.list_share_invitations(
    WorkloadNamePrefix='string',
    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 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',
            'WorkloadName': 'string',
            'WorkloadId': '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 AWS account ID.
    - SharedWith (string) --
      
      The AWS account ID or IAM role with which the workload is shared.
    - PermissionType (string) --
      
      Permission granted on a workload share.
    - WorkloadName (string) --
      
      The name of the workload.
      
      The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
    - WorkloadId (string) --
      
      The ID assigned to the workload. This ID is unique within an AWS Region.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListWorkloads (new)

Link ¶

List workloads. Paginated.

See also: AWS API Documentation

Request Syntax

client.list_workloads(
    WorkloadNamePrefix='string',
    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 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

{
    'WorkloadSummaries': [
        {
            'WorkloadId': 'string',
            'WorkloadArn': 'string',
            'WorkloadName': 'string',
            'Owner': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'Lenses': [
                'string',
            ],
            'RiskCounts': {
                'string': 123
            },
            'ImprovementStatus': 'NOT_APPLICABLE'|'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'RISK_ACKNOWLEDGED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Output of a list workloads call.
- WorkloadSummaries (list) --
  
  A list of workload summaries.
  - (dict) --
    
    A workload summary return object.
    - WorkloadId (string) --
      
      The ID assigned to the workload. This ID is unique within an AWS Region.
    - WorkloadArn (string) --
      
      The ARN for the workload.
    - WorkloadName (string) --
      
      The name of the workload.
      
      The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
    - Owner (string) --
      
      An AWS account ID.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
    - Lenses (list) --
      
      The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
      - (string) --
        
        The alias of the lens, for example, serverless .
        
        Each lens is identified by its LensSummary$LensAlias.
    - RiskCounts (dict) --
      
      A map from risk names to the count of how questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
    - ImprovementStatus (string) --
      
      The improvement status for a workload.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

UpdateWorkload (new)

Link ¶

Update an existing workload.

See also: AWS API Documentation

Request Syntax

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'
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type WorkloadName

string

param WorkloadName

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

type Description

string

param Description

The description for the workload.

type Environment

string

param Environment

The environment for the workload.

type AccountIds

list

param AccountIds

The list of AWS account IDs associated with the workload.

(string) --

An AWS account ID.

type AwsRegions

list

param AwsRegions

The list of AWS Regions associated with the workload, for example, us-east-2 , or ca-central-1 .

(string) --

An AWS Region, for example, us-west-2 or ap-northeast-1 .

type NonAwsRegions

list

param NonAwsRegions

The list of non-AWS Regions associated with the workload.

(string) --

type PillarPriorities

list

param PillarPriorities

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.

type ArchitecturalDesign

string

param ArchitecturalDesign

The URL of the architectural design for the workload.

type ReviewOwner

string

param ReviewOwner

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

type IsReviewOwnerUpdateAcknowledged

boolean

param IsReviewOwnerUpdateAcknowledged

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.

type IndustryType

string

param IndustryType

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

type Industry

string

param Industry

The industry for the workload.

type Notes

string

param Notes

The notes associated with the workload.

type ImprovementStatus

string

param ImprovementStatus

The improvement status for a workload.

rtype

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'
    }
}

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 AWS Region.
  - WorkloadArn (string) --
    
    The ARN for the workload.
  - WorkloadName (string) --
    
    The name of the workload.
    
    The name must be unique within an account within a 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 AWS account IDs associated with the workload.
    - (string) --
      
      An AWS account ID.
  - AwsRegions (list) --
    
    The list of AWS Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
    - (string) --
      
      An AWS Region, for example, us-west-2 or ap-northeast-1 .
  - NonAwsRegions (list) --
    
    The list of non-AWS Regions associated with the workload.
    - (string) --
  - ArchitecturalDesign (string) --
    
    The URL of the architectural design for the workload.
  - ReviewOwner (string) --
    
    The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
  - ReviewRestrictionDate (datetime) --
    
    The date and time recorded.
  - IsReviewOwnerUpdateAcknowledged (boolean) --
    
    Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
    
    If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
  - IndustryType (string) --
    
    The industry type for the workload.
    
    If specified, must be one of the following:
    - Agriculture
    - Automobile
    - Defense
    - Design and Engineering
    - Digital Advertising
    - Education
    - Environmental Protection
    - Financial Services
    - Gaming
    - General Public Services
    - Healthcare
    - Hospitality
    - InfoTech
    - Justice and Public Safety
    - Life Sciences
    - Manufacturing
    - Media & Entertainment
    - Mining & Resources
    - Oil & Gas
    - Power & Utilities
    - Professional Services
    - Real Estate & Construction
    - Retail & Wholesale
    - Social Protection
    - Telecommunications
    - Travel, Transportation & Logistics
    - Other
  - Industry (string) --
    
    The industry for the workload.
  - Notes (string) --
    
    The notes associated with the workload.
  - ImprovementStatus (string) --
    
    The improvement status for a workload.
  - RiskCounts (dict) --
    
    A map from risk names to the count of how questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.
  - PillarPriorities (list) --
    
    The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
    - (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId.
  - Lenses (list) --
    
    The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
    - (string) --
      
      The alias of the lens, for example, serverless .
      
      Each lens is identified by its LensSummary$LensAlias.
  - Owner (string) --
    
    An AWS account ID.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.

ListWorkloadShares (new)

Link ¶

List the workload shares associated with the workload.

See also: AWS API Documentation

Request Syntax

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

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type SharedWithPrefix

string

param SharedWithPrefix

The AWS account ID or IAM role with which the workload 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

{
    'WorkloadId': 'string',
    'WorkloadShareSummaries': [
        {
            'ShareId': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Input for List Workload Share
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an AWS Region.
- WorkloadShareSummaries (list) --
  
  A list of workload share summaries.
  - (dict) --
    
    A workload share summary return object.
    - ShareId (string) --
      
      The ID associated with the workload share.
    - SharedWith (string) --
      
      The AWS account ID or IAM role with which the workload is shared.
    - PermissionType (string) --
      
      Permission granted on a workload share.
    - Status (string) --
      
      The status of a workload share.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

GetAnswer (new)

Link ¶

Get lens 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 AWS 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',
    'Answer': {
        'QuestionId': 'string',
        'PillarId': 'string',
        'QuestionTitle': 'string',
        'QuestionDescription': 'string',
        'ImprovementPlanUrl': 'string',
        'HelpfulResourceUrl': 'string',
        'Choices': [
            {
                'ChoiceId': 'string',
                'Title': 'string',
                'Description': 'string'
            },
        ],
        'SelectedChoices': [
            'string',
        ],
        'IsApplicable': True|False,
        'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
        'Notes': 'string'
    }
}

Response Structure

(dict) --

Output of a get answer call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an AWS 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.
- 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.
  - HelpfulResourceUrl (string) --
    
    The helpful resource URL for a 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.
  - SelectedChoices (list) --
    
    List of selected choice IDs in a question answer.
    - (string) --
      
      The ID of 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.

GetLensVersionDifference (new)

Link ¶

Get lens version differences.

See also: AWS API Documentation

Request Syntax

client.get_lens_version_difference(
    LensAlias='string',
    BaseLensVersion='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

[REQUIRED]

The base version of the lens.

rtype

dict

returns

Response Syntax

{
    'LensAlias': 'string',
    'BaseLensVersion': 'string',
    'LatestLensVersion': 'string',
    'VersionDifferences': {
        'PillarDifferences': [
            {
                'PillarId': '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.
- BaseLensVersion (string) --
  
  The base version of 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.
      - 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.

AssociateLenses (new)

Link ¶

Associate a lens to a workload.

See also: AWS API Documentation

Request Syntax

client.associate_lenses(
    WorkloadId='string',
    LensAliases=[
        'string',
    ]
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type LensAliases

list

param LensAliases

[REQUIRED]

List of lens aliases to associate or disassociate with a workload.

Identify a lens using its LensSummary$LensAlias.

(string) --

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

returns

None

ListLensReviewImprovements (new)

Link ¶

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 AWS 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',
    'ImprovementSummaries': [
        {
            'QuestionId': 'string',
            'PillarId': 'string',
            'QuestionTitle': 'string',
            'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
            '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 AWS 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.
- 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.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

UpgradeLensReview (new)

Link ¶

Upgrade lens review.

See also: AWS API Documentation

Request Syntax

client.upgrade_lens_review(
    WorkloadId='string',
    LensAlias='string',
    MilestoneName='string',
    ClientRequestToken='string'
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type LensAlias

string

param LensAlias

[REQUIRED]

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

type MilestoneName

string

param MilestoneName

[REQUIRED]

The name of the milestone in a workload.

Milestone names must be unique within a workload.

type ClientRequestToken

string

param ClientRequestToken

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

Warning

returns

None

CreateWorkloadShare (new)

Link ¶

Create a workload share.

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

For more information, see Sharing a Workload in the AWS Well-Architected Tool User Guide .

See also: AWS API Documentation

Request Syntax

client.create_workload_share(
    WorkloadId='string',
    SharedWith='string',
    PermissionType='READONLY'|'CONTRIBUTOR',
    ClientRequestToken='string'
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type SharedWith

string

param SharedWith

[REQUIRED]

The AWS account ID or IAM role with which the workload is shared.

type PermissionType

string

param PermissionType

[REQUIRED]

Permission granted on a workload share.

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

{
    '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 AWS Region.
- ShareId (string) --
  
  The ID associated with the workload share.

GetLensReview (new)

Link ¶

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 AWS 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',
        'LensVersion': 'string',
        'LensName': 'string',
        'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED',
        '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 AWS 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.
  - 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.

UpdateLensReview (new)

Link ¶

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 AWS 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',
        'LensVersion': 'string',
        'LensName': 'string',
        'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED',
        '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 AWS 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.
  - 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.

DisassociateLenses (new)

Link ¶

Disassociate a lens from a workload.

Note

The AWS Well-Architected Framework lens ( wellarchitected ) cannot be removed from a workload.

See also: AWS API Documentation

Request Syntax

client.disassociate_lenses(
    WorkloadId='string',
    LensAliases=[
        'string',
    ]
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type LensAliases

list

param LensAliases

[REQUIRED]

List of lens aliases to associate or disassociate with a workload.

Identify a lens using its LensSummary$LensAlias.

(string) --

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias.

returns

None

GetWorkload (new)

Link ¶

Get an existing workload.

See also: AWS API Documentation

Request Syntax

client.get_workload(
    WorkloadId='string'
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

rtype

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'
    }
}

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 AWS Region.
  - WorkloadArn (string) --
    
    The ARN for the workload.
  - WorkloadName (string) --
    
    The name of the workload.
    
    The name must be unique within an account within a 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 AWS account IDs associated with the workload.
    - (string) --
      
      An AWS account ID.
  - AwsRegions (list) --
    
    The list of AWS Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
    - (string) --
      
      An AWS Region, for example, us-west-2 or ap-northeast-1 .
  - NonAwsRegions (list) --
    
    The list of non-AWS Regions associated with the workload.
    - (string) --
  - ArchitecturalDesign (string) --
    
    The URL of the architectural design for the workload.
  - ReviewOwner (string) --
    
    The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
  - ReviewRestrictionDate (datetime) --
    
    The date and time recorded.
  - IsReviewOwnerUpdateAcknowledged (boolean) --
    
    Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
    
    If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
  - IndustryType (string) --
    
    The industry type for the workload.
    
    If specified, must be one of the following:
    - Agriculture
    - Automobile
    - Defense
    - Design and Engineering
    - Digital Advertising
    - Education
    - Environmental Protection
    - Financial Services
    - Gaming
    - General Public Services
    - Healthcare
    - Hospitality
    - InfoTech
    - Justice and Public Safety
    - Life Sciences
    - Manufacturing
    - Media & Entertainment
    - Mining & Resources
    - Oil & Gas
    - Power & Utilities
    - Professional Services
    - Real Estate & Construction
    - Retail & Wholesale
    - Social Protection
    - Telecommunications
    - Travel, Transportation & Logistics
    - Other
  - Industry (string) --
    
    The industry for the workload.
  - Notes (string) --
    
    The notes associated with the workload.
  - ImprovementStatus (string) --
    
    The improvement status for a workload.
  - RiskCounts (dict) --
    
    A map from risk names to the count of how questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.
  - PillarPriorities (list) --
    
    The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.
    - (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId.
  - Lenses (list) --
    
    The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.
    - (string) --
      
      The alias of the lens, for example, serverless .
      
      Each lens is identified by its LensSummary$LensAlias.
  - Owner (string) --
    
    An AWS account ID.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.

UpdateWorkloadShare (new)

Link ¶

Update a workload share.

See also: AWS API Documentation

Request Syntax

client.update_workload_share(
    ShareId='string',
    WorkloadId='string',
    PermissionType='READONLY'|'CONTRIBUTOR'
)

type ShareId

string

param ShareId

[REQUIRED]

The ID associated with the workload share.

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

type PermissionType

string

param PermissionType

[REQUIRED]

Permission granted on a workload share.

rtype

dict

returns

Response Syntax

{
    'WorkloadId': 'string',
    'WorkloadShare': {
        'ShareId': 'string',
        'SharedBy': 'string',
        'SharedWith': 'string',
        'PermissionType': 'READONLY'|'CONTRIBUTOR',
        'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED',
        'WorkloadName': 'string',
        'WorkloadId': 'string'
    }
}

Response Structure

(dict) --

Input for Update Workload Share
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an AWS Region.
- WorkloadShare (dict) --
  
  A workload share return object.
  - ShareId (string) --
    
    The ID associated with the workload share.
  - SharedBy (string) --
    
    An AWS account ID.
  - SharedWith (string) --
    
    The AWS account ID or IAM role with which the workload is shared.
  - PermissionType (string) --
    
    Permission granted on a workload share.
  - Status (string) --
    
    The status of a workload share.
  - WorkloadName (string) --
    
    The name of the workload.
    
    The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.
  - WorkloadId (string) --
    
    The ID assigned to the workload. This ID is unique within an AWS Region.

ListLensReviews (new)

Link ¶

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 AWS 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',
            'LensVersion': 'string',
            'LensName': 'string',
            'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED',
            '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 AWS 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.
    - 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.

DeleteWorkload (new)

Link ¶

Delete an existing workload.

See also: AWS API Documentation

Request Syntax

client.delete_workload(
    WorkloadId='string',
    ClientRequestToken='string'
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

The ID assigned to the workload. This ID is unique within an AWS Region.

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