AWS API Changes

2023/06/13 - AWS Well-Architected Tool - 13 new 13 updated api methods

Changes AWS Well-Architected now supports Profiles that help customers prioritize which questions to focus on first by providing a list of prioritized questions that are better aligned with their business goals and outcomes.

ListProfiles (new)

Link ¶

List profiles.

See also: AWS API Documentation

Request Syntax

client.list_profiles(
    ProfileNamePrefix='string',
    ProfileOwnerType='SELF'|'SHARED',
    NextToken='string',
    MaxResults=123
)

type ProfileNamePrefix

string

param ProfileNamePrefix

Prefix for profile name.

type ProfileOwnerType

string

param ProfileOwnerType

Profile owner type.

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

{
    'ProfileSummaries': [
        {
            'ProfileArn': 'string',
            'ProfileVersion': 'string',
            'ProfileName': 'string',
            'ProfileDescription': 'string',
            'Owner': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ProfileSummaries (list) --
  
  Profile summaries.
  - (dict) --
    
    Summary of a profile.
    - ProfileArn (string) --
      
      The profile ARN.
    - ProfileVersion (string) --
      
      The profile version.
    - ProfileName (string) --
      
      The profile name.
    - ProfileDescription (string) --
      
      The profile description.
    - Owner (string) --
      
      An Amazon Web Services account ID.
    - CreatedAt (datetime) --
      
      The date and time recorded.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

UpgradeProfileVersion (new)

Link ¶

Upgrade a profile.

See also: AWS API Documentation

Request Syntax

client.upgrade_profile_version(
    WorkloadId='string',
    ProfileArn='string',
    MilestoneName='string',
    ClientRequestToken='string'
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

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

type ProfileArn

string

param ProfileArn

[REQUIRED]

The profile ARN.

type MilestoneName

string

param MilestoneName

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

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

Warning

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

This field is autopopulated if not provided.

returns

None

ListProfileNotifications (new)

Link ¶

List profile notifications.

See also: AWS API Documentation

Request Syntax

client.list_profile_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': [
        {
            'CurrentProfileVersion': 'string',
            'LatestProfileVersion': 'string',
            'Type': 'PROFILE_ANSWERS_UPDATED'|'PROFILE_DELETED',
            'ProfileArn': 'string',
            'ProfileName': 'string',
            'WorkloadId': 'string',
            'WorkloadName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NotificationSummaries (list) --
  
  Notification summaries.
  - (dict) --
    
    The profile notification summary.
    - CurrentProfileVersion (string) --
      
      The current profile version.
    - LatestProfileVersion (string) --
      
      The latest profile version.
    - Type (string) --
      
      Type of notification.
    - ProfileArn (string) --
      
      The profile ARN.
    - ProfileName (string) --
      
      The profile name.
    - WorkloadId (string) --
      
      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
    - WorkloadName (string) --
      
      The name of the workload.
      
      The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

DisassociateProfiles (new)

Link ¶

Disassociate a profile from a workload.

See also: AWS API Documentation

Request Syntax

client.disassociate_profiles(
    WorkloadId='string',
    ProfileArns=[
        'string',
    ]
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

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

type ProfileArns

list

param ProfileArns

[REQUIRED]

The list of profile ARNs to disassociate from the workload.

(string) --

returns

None

DeleteProfile (new)

Link ¶

Delete a profile.

Note

Disclaimer

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

See also: AWS API Documentation

Request Syntax

client.delete_profile(
    ProfileArn='string',
    ClientRequestToken='string'
)

type ProfileArn

string

param ProfileArn

[REQUIRED]

The profile ARN.

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

UpdateProfile (new)

Link ¶

Update a profile.

See also: AWS API Documentation

Request Syntax

client.update_profile(
    ProfileArn='string',
    ProfileDescription='string',
    ProfileQuestions=[
        {
            'QuestionId': 'string',
            'SelectedChoiceIds': [
                'string',
            ]
        },
    ]
)

type ProfileArn

string

param ProfileArn

[REQUIRED]

The profile ARN.

type ProfileDescription

string

param ProfileDescription

The profile description.

type ProfileQuestions

list

param ProfileQuestions

Profile questions.

(dict) --

An update to a profile question.
- QuestionId (string) --
  
  The ID of the question.
- SelectedChoiceIds (list) --
  
  The selected choices.
  - (string) --
    
    The ID of a choice.

rtype

dict

returns

Response Syntax

{
    'Profile': {
        'ProfileArn': 'string',
        'ProfileVersion': 'string',
        'ProfileName': 'string',
        'ProfileDescription': 'string',
        'ProfileQuestions': [
            {
                'QuestionId': 'string',
                'QuestionTitle': 'string',
                'QuestionDescription': 'string',
                'QuestionChoices': [
                    {
                        'ChoiceId': 'string',
                        'ChoiceTitle': 'string',
                        'ChoiceDescription': 'string'
                    },
                ],
                'SelectedChoiceIds': [
                    'string',
                ],
                'MinSelectedChoices': 123,
                'MaxSelectedChoices': 123
            },
        ],
        'Owner': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'ShareInvitationId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- Profile (dict) --
  
  The profile.
  - ProfileArn (string) --
    
    The profile ARN.
  - ProfileVersion (string) --
    
    The profile version.
  - ProfileName (string) --
    
    The profile name.
  - ProfileDescription (string) --
    
    The profile description.
  - ProfileQuestions (list) --
    
    Profile questions.
    - (dict) --
      
      A profile question.
      - QuestionId (string) --
        
        The ID of the question.
      - QuestionTitle (string) --
        
        The title of the question.
      - QuestionDescription (string) --
        
        The description of the question.
      - QuestionChoices (list) --
        
        The question choices.
        
        (dict) --
        
        The profile choice.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        ChoiceTitle (string) --
        
        The title of a choice.
        
        ChoiceDescription (string) --
        
        The description of a choice.
      - SelectedChoiceIds (list) --
        
        The selected choices.
        
        (string) --
        
        The ID of a choice.
      - MinSelectedChoices (integer) --
        
        The minimum number of selected choices.
      - MaxSelectedChoices (integer) --
        
        The maximum number of selected choices.
  - Owner (string) --
    
    An Amazon Web Services account ID.
  - CreatedAt (datetime) --
    
    The date and time recorded.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.
  - Tags (dict) --
    
    The tags assigned to the profile.
    - (string) --
      - (string) --

CreateProfileShare (new)

Link ¶

Create a profile share.

See also: AWS API Documentation

Request Syntax

client.create_profile_share(
    ProfileArn='string',
    SharedWith='string',
    ClientRequestToken='string'
)

type ProfileArn

string

param ProfileArn

[REQUIRED]

The profile ARN.

type SharedWith

string

param SharedWith

[REQUIRED]

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile 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',
    'ProfileArn': 'string'
}

Response Structure

(dict) --
- ShareId (string) --
  
  The ID associated with the share.
- ProfileArn (string) --
  
  The profile ARN.

DeleteProfileShare (new)

Link ¶

Delete a profile share.

See also: AWS API Documentation

Request Syntax

client.delete_profile_share(
    ShareId='string',
    ProfileArn='string',
    ClientRequestToken='string'
)

type ShareId

string

param ShareId

[REQUIRED]

The ID associated with the share.

type ProfileArn

string

param ProfileArn

[REQUIRED]

The profile ARN.

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

GetProfile (new)

Link ¶

Get profile information.

See also: AWS API Documentation

Request Syntax

client.get_profile(
    ProfileArn='string',
    ProfileVersion='string'
)

type ProfileArn

string

param ProfileArn

[REQUIRED]

The profile ARN.

type ProfileVersion

string

param ProfileVersion

The profile version.

rtype

dict

returns

Response Syntax

{
    'Profile': {
        'ProfileArn': 'string',
        'ProfileVersion': 'string',
        'ProfileName': 'string',
        'ProfileDescription': 'string',
        'ProfileQuestions': [
            {
                'QuestionId': 'string',
                'QuestionTitle': 'string',
                'QuestionDescription': 'string',
                'QuestionChoices': [
                    {
                        'ChoiceId': 'string',
                        'ChoiceTitle': 'string',
                        'ChoiceDescription': 'string'
                    },
                ],
                'SelectedChoiceIds': [
                    'string',
                ],
                'MinSelectedChoices': 123,
                'MaxSelectedChoices': 123
            },
        ],
        'Owner': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'ShareInvitationId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- Profile (dict) --
  
  The profile.
  - ProfileArn (string) --
    
    The profile ARN.
  - ProfileVersion (string) --
    
    The profile version.
  - ProfileName (string) --
    
    The profile name.
  - ProfileDescription (string) --
    
    The profile description.
  - ProfileQuestions (list) --
    
    Profile questions.
    - (dict) --
      
      A profile question.
      - QuestionId (string) --
        
        The ID of the question.
      - QuestionTitle (string) --
        
        The title of the question.
      - QuestionDescription (string) --
        
        The description of the question.
      - QuestionChoices (list) --
        
        The question choices.
        
        (dict) --
        
        The profile choice.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        ChoiceTitle (string) --
        
        The title of a choice.
        
        ChoiceDescription (string) --
        
        The description of a choice.
      - SelectedChoiceIds (list) --
        
        The selected choices.
        
        (string) --
        
        The ID of a choice.
      - MinSelectedChoices (integer) --
        
        The minimum number of selected choices.
      - MaxSelectedChoices (integer) --
        
        The maximum number of selected choices.
  - Owner (string) --
    
    An Amazon Web Services account ID.
  - CreatedAt (datetime) --
    
    The date and time recorded.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.
  - Tags (dict) --
    
    The tags assigned to the profile.
    - (string) --
      - (string) --

ListProfileShares (new)

Link ¶

List profile shares.

See also: AWS API Documentation

Request Syntax

client.list_profile_shares(
    ProfileArn='string',
    SharedWithPrefix='string',
    NextToken='string',
    MaxResults=123,
    Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED'
)

type ProfileArn

string

param ProfileArn

[REQUIRED]

The profile ARN.

type SharedWithPrefix

string

param SharedWithPrefix

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the profile 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.

type Status

string

param Status

The status of the share request.

rtype

dict

returns

Response Syntax

{
    'ProfileShareSummaries': [
        {
            'ShareId': 'string',
            'SharedWith': 'string',
            'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ProfileShareSummaries (list) --
  
  Profile share summaries.
  - (dict) --
    
    Summary of a profile share.
    - ShareId (string) --
      
      The ID associated with the share.
    - SharedWith (string) --
      
      The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
    - Status (string) --
      
      The status of the share request.
    - StatusMessage (string) --
      
      Profile share invitation status message.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

CreateProfile (new)

Link ¶

Create a profile.

See also: AWS API Documentation

Request Syntax

client.create_profile(
    ProfileName='string',
    ProfileDescription='string',
    ProfileQuestions=[
        {
            'QuestionId': 'string',
            'SelectedChoiceIds': [
                'string',
            ]
        },
    ],
    ClientRequestToken='string',
    Tags={
        'string': 'string'
    }
)

type ProfileName

string

param ProfileName

[REQUIRED]

Name of the profile.

type ProfileDescription

string

param ProfileDescription

[REQUIRED]

The profile description.

type ProfileQuestions

list

param ProfileQuestions

[REQUIRED]

The profile questions.

(dict) --

An update to a profile question.
- QuestionId (string) --
  
  The ID of the question.
- SelectedChoiceIds (list) --
  
  The selected choices.
  - (string) --
    
    The ID of a choice.

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

The tags assigned to the profile.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'ProfileArn': 'string',
    'ProfileVersion': 'string'
}

Response Structure

(dict) --
- ProfileArn (string) --
  
  The profile ARN.
- ProfileVersion (string) --
  
  Version of the profile.

GetProfileTemplate (new)

Link ¶

Get profile template.

See also: AWS API Documentation

Request Syntax

client.get_profile_template()

rtype

dict

returns

Response Syntax

{
    'ProfileTemplate': {
        'TemplateName': 'string',
        'TemplateQuestions': [
            {
                'QuestionId': 'string',
                'QuestionTitle': 'string',
                'QuestionDescription': 'string',
                'QuestionChoices': [
                    {
                        'ChoiceId': 'string',
                        'ChoiceTitle': 'string',
                        'ChoiceDescription': 'string'
                    },
                ],
                'MinSelectedChoices': 123,
                'MaxSelectedChoices': 123
            },
        ],
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- ProfileTemplate (dict) --
  
  The profile template.
  - TemplateName (string) --
    
    The name of the profile template.
  - TemplateQuestions (list) --
    
    Profile template questions.
    - (dict) --
      
      A profile template question.
      - QuestionId (string) --
        
        The ID of the question.
      - QuestionTitle (string) --
        
        The title of the question.
      - QuestionDescription (string) --
        
        The description of the question.
      - QuestionChoices (list) --
        
        The question choices.
        
        (dict) --
        
        A profile template choice.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        ChoiceTitle (string) --
        
        The title of a choice.
        
        ChoiceDescription (string) --
        
        The description of a choice.
      - MinSelectedChoices (integer) --
        
        The minimum number of choices selected.
      - MaxSelectedChoices (integer) --
        
        The maximum number of choices selected.
  - CreatedAt (datetime) --
    
    The date and time recorded.
  - UpdatedAt (datetime) --
    
    The date and time recorded.

AssociateProfiles (new)

Link ¶

Associate a profile with a workload.

See also: AWS API Documentation

Request Syntax

client.associate_profiles(
    WorkloadId='string',
    ProfileArns=[
        'string',
    ]
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

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

type ProfileArns

list

param ProfileArns

[REQUIRED]

The list of profile ARNs to associate with the workload.

(string) --

returns

None

CreateWorkload (updated)

Link ¶
Changes (request)

{'ProfileArns': ['string']}

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.

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

Warning

Either AwsRegions , NonAwsRegions , or both must be specified when creating a workload.

You also must specify ReviewOwner , even though the parameter is listed as not being required in the following section.

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',
    Tags={
        'string': 'string'
    },
    DiscoveryConfig={
        'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
        'WorkloadResourceDefinition': [
            'WORKLOAD_METADATA'|'APP_REGISTRY',
        ]
    },
    Applications=[
        'string',
    ],
    ProfileArns=[
        'string',
    ]
)

type WorkloadName

string

param WorkloadName

[REQUIRED]

The name of the workload.

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

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 Amazon Web Services account IDs associated with the workload.

(string) --

An Amazon Web Services account ID.

type AwsRegions

list

param AwsRegions

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

(string) --

An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .

type NonAwsRegions

list

param NonAwsRegions

The list of non-Amazon Web Services 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 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 Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .

Each lens is identified by its LensSummary$LensAlias .

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.

type Tags

dict

param Tags

The tags to be associated with the workload.

(string) --
- (string) --

type DiscoveryConfig

dict

param DiscoveryConfig

Well-Architected discovery configuration settings associated to the workload.

TrustedAdvisorIntegrationStatus (string) --

Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition (list) --

The mode to use for identifying resources associated with the workload.

You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
- (string) --

type Applications

list

param Applications

List of AppRegistry application ARNs associated to the workload.

(string) --

type ProfileArns

list

param ProfileArns

The list of profile ARNs associated with the workload.

(string) --

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 Amazon Web Services Region.
- WorkloadArn (string) --
  
  The ARN for the workload.

GetLensReview (updated)

Link ¶
Changes (response)

{'LensReview': {'PillarReviewSummaries': {'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'}},
                'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'},
                'Profiles': [{'ProfileArn': 'string',
                              'ProfileVersion': 'string'}]}}

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 Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .

Each lens is identified by its LensSummary$LensAlias .

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

Response Structure

(dict) --

Output of a get lens review call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.
- LensReview (dict) --
  
  A lens review of a question.
  - LensAlias (string) --
    
    The alias of the lens.
    
    For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
    
    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
    
    Each lens is identified by its LensSummary$LensAlias .
  - LensArn (string) --
    
    The ARN for the lens.
  - LensVersion (string) --
    
    The version of the lens.
  - LensName (string) --
    
    The full name of the lens.
  - LensStatus (string) --
    
    The status of the lens.
  - PillarReviewSummaries (list) --
    
    List of pillar review summaries of lens review in a workload.
    - (dict) --
      
      A pillar review summary of a lens review.
      - PillarId (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId .
      - PillarName (string) --
        
        The name of the pillar.
      - Notes (string) --
        
        The notes associated with the workload.
      - RiskCounts (dict) --
        
        A map from risk names to the count of how many questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
      - PrioritizedRiskCounts (dict) --
        
        A map from risk names to the count of how many questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
  - 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 many questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.
  - NextToken (string) --
    
    The token to use to retrieve the next set of results.
  - Profiles (list) --
    
    The profiles associated with the workload.
    - (dict) --
      
      The profile associated with a workload.
      - ProfileArn (string) --
        
        The profile ARN.
      - ProfileVersion (string) --
        
        The profile version.
  - PrioritizedRiskCounts (dict) --
    
    A map from risk names to the count of how many questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.

GetMilestone (updated)

Link ¶
Changes (response)

{'Milestone': {'Workload': {'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'},
                            'Profiles': [{'ProfileArn': 'string',
                                          'ProfileVersion': 'string'}]}}}

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 Amazon Web Services 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',
            'Tags': {
                'string': 'string'
            },
            'DiscoveryConfig': {
                'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
                'WorkloadResourceDefinition': [
                    'WORKLOAD_METADATA'|'APP_REGISTRY',
                ]
            },
            'Applications': [
                'string',
            ],
            'Profiles': [
                {
                    'ProfileArn': 'string',
                    'ProfileVersion': 'string'
                },
            ],
            'PrioritizedRiskCounts': {
                'string': 123
            }
        }
    }
}

Response Structure

(dict) --

Output of a get milestone call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- Milestone (dict) --
  
  A milestone return object.
  - MilestoneNumber (integer) --
    
    The milestone number.
    
    A workload can have a maximum of 100 milestones.
  - MilestoneName (string) --
    
    The name of the milestone in a workload.
    
    Milestone names must be unique within a workload.
  - RecordedAt (datetime) --
    
    The date and time recorded.
  - Workload (dict) --
    
    A workload return object.
    - WorkloadId (string) --
      
      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
    - WorkloadArn (string) --
      
      The ARN for the workload.
    - WorkloadName (string) --
      
      The name of the workload.
      
      The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
    - Description (string) --
      
      The description for the workload.
    - Environment (string) --
      
      The environment for the workload.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
    - AccountIds (list) --
      
      The list of Amazon Web Services account IDs associated with the workload.
      - (string) --
        
        An Amazon Web Services account ID.
    - AwsRegions (list) --
      
      The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
      - (string) --
        
        An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
    - NonAwsRegions (list) --
      
      The list of non-Amazon Web Services Regions associated with the workload.
      - (string) --
    - ArchitecturalDesign (string) --
      
      The URL of the architectural design for the workload.
    - ReviewOwner (string) --
      
      The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
    - ReviewRestrictionDate (datetime) --
      
      The date and time recorded.
    - IsReviewOwnerUpdateAcknowledged (boolean) --
      
      Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
      
      If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
    - IndustryType (string) --
      
      The industry type for the workload.
      
      If specified, must be one of the following:
      - Agriculture
      - Automobile
      - Defense
      - Design and Engineering
      - Digital Advertising
      - Education
      - Environmental Protection
      - Financial Services
      - Gaming
      - General Public Services
      - Healthcare
      - Hospitality
      - InfoTech
      - Justice and Public Safety
      - Life Sciences
      - Manufacturing
      - Media & Entertainment
      - Mining & Resources
      - Oil & Gas
      - Power & Utilities
      - Professional Services
      - Real Estate & Construction
      - Retail & Wholesale
      - Social Protection
      - Telecommunications
      - Travel, Transportation & Logistics
      - Other
    - Industry (string) --
      
      The industry for the workload.
    - Notes (string) --
      
      The notes associated with the workload.
    - ImprovementStatus (string) --
      
      The improvement status for a workload.
    - RiskCounts (dict) --
      
      A map from risk names to the count of how many questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
    - PillarPriorities (list) --
      
      The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId .
      - (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId .
    - Lenses (list) --
      
      The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias .
      - (string) --
        
        The alias of the lens.
        
        For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
        
        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
        
        Each lens is identified by its LensSummary$LensAlias .
    - Owner (string) --
      
      An Amazon Web Services account ID.
    - ShareInvitationId (string) --
      
      The ID assigned to the share invitation.
    - Tags (dict) --
      
      The tags associated with the workload.
      - (string) --
        
        (string) --
    - DiscoveryConfig (dict) --
      
      Discovery configuration associated to the workload.
      - TrustedAdvisorIntegrationStatus (string) --
        
        Discovery integration status in respect to Trusted Advisor for the workload.
      - WorkloadResourceDefinition (list) --
        
        The mode to use for identifying resources associated with the workload.
        
        You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
        
        (string) --
    - Applications (list) --
      
      List of AppRegistry application ARNs associated to the workload.
      - (string) --
    - Profiles (list) --
      
      Profile associated with a workload.
      - (dict) --
        
        The profile associated with a workload.
        
        ProfileArn (string) --
        
        The profile ARN.
        
        ProfileVersion (string) --
        
        The profile version.
    - PrioritizedRiskCounts (dict) --
      
      A map from risk names to the count of how many questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.

GetWorkload (updated)

Link ¶
Changes (response)

{'Workload': {'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'},
              'Profiles': [{'ProfileArn': 'string',
                            'ProfileVersion': 'string'}]}}

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 Amazon Web Services 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',
        'Tags': {
            'string': 'string'
        },
        'DiscoveryConfig': {
            'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
            'WorkloadResourceDefinition': [
                'WORKLOAD_METADATA'|'APP_REGISTRY',
            ]
        },
        'Applications': [
            'string',
        ],
        'Profiles': [
            {
                'ProfileArn': 'string',
                'ProfileVersion': 'string'
            },
        ],
        'PrioritizedRiskCounts': {
            'string': 123
        }
    }
}

Response Structure

(dict) --

Output of a get workload call.
- Workload (dict) --
  
  A workload return object.
  - WorkloadId (string) --
    
    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
  - WorkloadArn (string) --
    
    The ARN for the workload.
  - WorkloadName (string) --
    
    The name of the workload.
    
    The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
  - Description (string) --
    
    The description for the workload.
  - Environment (string) --
    
    The environment for the workload.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - AccountIds (list) --
    
    The list of Amazon Web Services account IDs associated with the workload.
    - (string) --
      
      An Amazon Web Services account ID.
  - AwsRegions (list) --
    
    The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
    - (string) --
      
      An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
  - NonAwsRegions (list) --
    
    The list of non-Amazon Web Services Regions associated with the workload.
    - (string) --
  - ArchitecturalDesign (string) --
    
    The URL of the architectural design for the workload.
  - ReviewOwner (string) --
    
    The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
  - ReviewRestrictionDate (datetime) --
    
    The date and time recorded.
  - IsReviewOwnerUpdateAcknowledged (boolean) --
    
    Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
    
    If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
  - IndustryType (string) --
    
    The industry type for the workload.
    
    If specified, must be one of the following:
    - Agriculture
    - Automobile
    - Defense
    - Design and Engineering
    - Digital Advertising
    - Education
    - Environmental Protection
    - Financial Services
    - Gaming
    - General Public Services
    - Healthcare
    - Hospitality
    - InfoTech
    - Justice and Public Safety
    - Life Sciences
    - Manufacturing
    - Media & Entertainment
    - Mining & Resources
    - Oil & Gas
    - Power & Utilities
    - Professional Services
    - Real Estate & Construction
    - Retail & Wholesale
    - Social Protection
    - Telecommunications
    - Travel, Transportation & Logistics
    - Other
  - Industry (string) --
    
    The industry for the workload.
  - Notes (string) --
    
    The notes associated with the workload.
  - ImprovementStatus (string) --
    
    The improvement status for a workload.
  - RiskCounts (dict) --
    
    A map from risk names to the count of how many questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.
  - PillarPriorities (list) --
    
    The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId .
    - (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId .
  - Lenses (list) --
    
    The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias .
    - (string) --
      
      The alias of the lens.
      
      For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
      
      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
      
      Each lens is identified by its LensSummary$LensAlias .
  - Owner (string) --
    
    An Amazon Web Services account ID.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.
  - Tags (dict) --
    
    The tags associated with the workload.
    - (string) --
      - (string) --
  - DiscoveryConfig (dict) --
    
    Discovery configuration associated to the workload.
    - TrustedAdvisorIntegrationStatus (string) --
      
      Discovery integration status in respect to Trusted Advisor for the workload.
    - WorkloadResourceDefinition (list) --
      
      The mode to use for identifying resources associated with the workload.
      
      You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
      - (string) --
  - Applications (list) --
    
    List of AppRegistry application ARNs associated to the workload.
    - (string) --
  - Profiles (list) --
    
    Profile associated with a workload.
    - (dict) --
      
      The profile associated with a workload.
      - ProfileArn (string) --
        
        The profile ARN.
      - ProfileVersion (string) --
        
        The profile version.
  - PrioritizedRiskCounts (dict) --
    
    A map from risk names to the count of how many questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.

ListAnswers (updated)

Link ¶
Changes (request, response)
Request

{'QuestionPriority': 'PRIORITIZED | NONE'}

Response

{'AnswerSummaries': {'QuestionType': 'PRIORITIZED | NON_PRIORITIZED'}}

List of answers for a particular workload and lens.

See also: AWS API Documentation

Request Syntax

client.list_answers(
    WorkloadId='string',
    LensAlias='string',
    PillarId='string',
    MilestoneNumber=123,
    NextToken='string',
    MaxResults=123,
    QuestionPriority='PRIORITIZED'|'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 custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .

Each lens is identified by its LensSummary$LensAlias .

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.

type QuestionPriority

string

param QuestionPriority

The priority of the question.

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'
                    },
                    'AdditionalResources': [
                        {
                            'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN',
                            'Content': [
                                {
                                    'DisplayText': 'string',
                                    'Url': 'string'
                                },
                            ]
                        },
                    ]
                },
            ],
            'SelectedChoices': [
                'string',
            ],
            'ChoiceAnswerSummaries': [
                {
                    'ChoiceId': 'string',
                    'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                    'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
                },
            ],
            'IsApplicable': True|False,
            'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
            'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
            'QuestionType': 'PRIORITIZED'|'NON_PRIORITIZED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Output of a list answers call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.
- LensAlias (string) --
  
  The alias of the lens.
  
  For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
  
  For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
  
  Each lens is identified by its LensSummary$LensAlias .
- LensArn (string) --
  
  The ARN for the lens.
- AnswerSummaries (list) --
  
  List of answer summaries of lens review in a workload.
  - (dict) --
    
    An answer summary of a lens review in a workload.
    - QuestionId (string) --
      
      The ID of the question.
    - PillarId (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId .
    - QuestionTitle (string) --
      
      The title of the question.
    - Choices (list) --
      
      List of choices available for a question.
      - (dict) --
        
        A choice available to answer question.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        Title (string) --
        
        The title of a choice.
        
        Description (string) --
        
        The description of a choice.
        
        HelpfulResource (dict) --
        
        The helpful resource (both text and URL) for a particular choice.
        
        This field only applies to custom lenses. Each choice can have only one helpful resource.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
        
        ImprovementPlan (dict) --
        
        The improvement plan (both text and URL) for a particular choice.
        
        This field only applies to custom lenses. Each choice can have only one improvement plan.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
        
        AdditionalResources (list) --
        
        The additional resources for a choice in a custom lens.
        
        A choice can have up to two additional resources: one of type HELPFUL_RESOURCE , one of type IMPROVEMENT_PLAN , or both.
        
        (dict) --
        
        The choice level additional resources for a custom lens.
        
        This field does not apply to Amazon Web Services official lenses.
        
        Type (string) --
        
        Type of additional resource for a custom lens.
        
        Content (list) --
        
        The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
        
        (dict) --
        
        The choice content.
        
        DisplayText (string) --
        
        The display text for the choice content.
        
        Url (string) --
        
        The URL for the choice content.
    - SelectedChoices (list) --
      
      List of selected choice IDs in a question answer.
      
      The values entered replace the previously selected choices.
      - (string) --
        
        The ID of a choice.
    - ChoiceAnswerSummaries (list) --
      
      A list of selected choices to a question in your workload.
      - (dict) --
        
        A choice summary that has been answered on a question in your workload.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        Status (string) --
        
        The status of a choice.
        
        Reason (string) --
        
        The reason why a choice is non-applicable to a question in your workload.
    - IsApplicable (boolean) --
      
      Defines whether this question is applicable to a lens review.
    - Risk (string) --
      
      The risk for a given workload, lens review, pillar, or question.
    - Reason (string) --
      
      The reason why a choice is non-applicable to a question in your workload.
    - QuestionType (string) --
      
      The type of the question.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListLensReviewImprovements (updated)

Link ¶
Changes (request)

{'QuestionPriority': 'PRIORITIZED | NONE'}

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,
    QuestionPriority='PRIORITIZED'|'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 custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .

Each lens is identified by its LensSummary$LensAlias .

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.

type QuestionPriority

string

param QuestionPriority

The priority of the question.

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 Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
  
  For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
  
  Each lens is identified by its LensSummary$LensAlias .
- LensArn (string) --
  
  The ARN for the lens.
- ImprovementSummaries (list) --
  
  List of improvement summaries of lens review in a workload.
  - (dict) --
    
    An improvement summary of a lens review in a workload.
    - QuestionId (string) --
      
      The ID of the question.
    - PillarId (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId .
    - QuestionTitle (string) --
      
      The title of the question.
    - Risk (string) --
      
      The risk for a given workload, lens review, pillar, or question.
    - ImprovementPlanUrl (string) --
      
      The improvement plan URL for a question in an Amazon Web Services official lenses.
      
      This value is only available if the question has been answered.
      
      This value does not apply to custom lenses.
    - ImprovementPlans (list) --
      
      The improvement plan details.
      - (dict) --
        
        The choice level improvement plan.
        
        ChoiceId (string) --
        
        The ID of a choice.
        
        DisplayText (string) --
        
        The display text for the improvement plan.
        
        ImprovementPlanUrl (string) --
        
        The improvement plan URL for a question in an Amazon Web Services official lenses.
        
        This value is only available if the question has been answered.
        
        This value does not apply to custom lenses.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListLensReviews (updated)

Link ¶
Changes (response)

{'LensReviewSummaries': {'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'},
                         'Profiles': [{'ProfileArn': 'string',
                                       'ProfileVersion': 'string'}]}}

List lens reviews for a particular workload.

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
            },
            'Profiles': [
                {
                    'ProfileArn': 'string',
                    'ProfileVersion': 'string'
                },
            ],
            'PrioritizedRiskCounts': {
                'string': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Output of a list lens reviews call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneNumber (integer) --
  
  The milestone number.
  
  A workload can have a maximum of 100 milestones.
- LensReviewSummaries (list) --
  
  List of lens summaries of lens reviews of a workload.
  - (dict) --
    
    A lens review summary of a workload.
    - LensAlias (string) --
      
      The alias of the lens.
      
      For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
      
      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
      
      Each lens is identified by its LensSummary$LensAlias .
    - LensArn (string) --
      
      The ARN for the lens.
    - LensVersion (string) --
      
      The version of the lens.
    - LensName (string) --
      
      The full name of the lens.
    - LensStatus (string) --
      
      The status of the lens.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
    - RiskCounts (dict) --
      
      A map from risk names to the count of how many questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
    - Profiles (list) --
      
      The profiles associated with the workload.
      - (dict) --
        
        The profile associated with a workload.
        
        ProfileArn (string) --
        
        The profile ARN.
        
        ProfileVersion (string) --
        
        The profile version.
    - PrioritizedRiskCounts (dict) --
      
      A map from risk names to the count of how many questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListMilestones (updated)

Link ¶
Changes (response)

{'MilestoneSummaries': {'WorkloadSummary': {'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'},
                                            'Profiles': [{'ProfileArn': 'string',
                                                          'ProfileVersion': 'string'}]}}}

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

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

Response Structure

(dict) --

Output of a list milestones call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- MilestoneSummaries (list) --
  
  A list of milestone summaries.
  - (dict) --
    
    A milestone summary return object.
    - MilestoneNumber (integer) --
      
      The milestone number.
      
      A workload can have a maximum of 100 milestones.
    - MilestoneName (string) --
      
      The name of the milestone in a workload.
      
      Milestone names must be unique within a workload.
    - RecordedAt (datetime) --
      
      The date and time recorded.
    - WorkloadSummary (dict) --
      
      A workload summary return object.
      - WorkloadId (string) --
        
        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
      - WorkloadArn (string) --
        
        The ARN for the workload.
      - WorkloadName (string) --
        
        The name of the workload.
        
        The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
      - Owner (string) --
        
        An Amazon Web Services account ID.
      - UpdatedAt (datetime) --
        
        The date and time recorded.
      - Lenses (list) --
        
        The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias .
        
        (string) --
        
        The alias of the lens.
        
        For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
        
        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
        
        Each lens is identified by its LensSummary$LensAlias .
      - RiskCounts (dict) --
        
        A map from risk names to the count of how many questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
      - ImprovementStatus (string) --
        
        The improvement status for a workload.
      - Profiles (list) --
        
        Profile associated with a workload.
        
        (dict) --
        
        The profile associated with a workload.
        
        ProfileArn (string) --
        
        The profile ARN.
        
        ProfileVersion (string) --
        
        The profile version.
      - PrioritizedRiskCounts (dict) --
        
        A map from risk names to the count of how many questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListShareInvitations (updated)

Link ¶
Changes (request, response)
Request

{'ProfileNamePrefix': 'string', 'ShareResourceType': {'PROFILE'}}

Response

{'ShareInvitationSummaries': {'ProfileArn': 'string',
                              'ProfileName': 'string',
                              'ShareResourceType': {'PROFILE'}}}

List the workload invitations.

See also: AWS API Documentation

Request Syntax

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

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.

type ProfileNamePrefix

string

param ProfileNamePrefix

Profile name prefix.

rtype

dict

returns

Response Syntax

{
    'ShareInvitationSummaries': [
        {
            'ShareInvitationId': 'string',
            'SharedBy': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'ShareResourceType': 'WORKLOAD'|'LENS'|'PROFILE',
            'WorkloadName': 'string',
            'WorkloadId': 'string',
            'LensName': 'string',
            'LensArn': 'string',
            'ProfileName': 'string',
            'ProfileArn': '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, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
    - PermissionType (string) --
      
      Permission granted on a share request.
    - ShareResourceType (string) --
      
      The resource type of the share invitation.
    - WorkloadName (string) --
      
      The name of the workload.
      
      The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
    - WorkloadId (string) --
      
      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
    - LensName (string) --
      
      The full name of the lens.
    - LensArn (string) --
      
      The ARN for the lens.
    - ProfileName (string) --
      
      The profile name.
    - ProfileArn (string) --
      
      The profile ARN.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListWorkloads (updated)

Link ¶
Changes (response)

{'WorkloadSummaries': {'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'},
                       'Profiles': [{'ProfileArn': 'string',
                                     'ProfileVersion': 'string'}]}}

Paginated list of workloads.

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',
            'Profiles': [
                {
                    'ProfileArn': 'string',
                    'ProfileVersion': 'string'
                },
            ],
            'PrioritizedRiskCounts': {
                'string': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Output of a list workloads call.
- WorkloadSummaries (list) --
  
  A list of workload summaries.
  - (dict) --
    
    A workload summary return object.
    - WorkloadId (string) --
      
      The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
    - WorkloadArn (string) --
      
      The ARN for the workload.
    - WorkloadName (string) --
      
      The name of the workload.
      
      The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
    - Owner (string) --
      
      An Amazon Web Services account ID.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
    - Lenses (list) --
      
      The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias .
      - (string) --
        
        The alias of the lens.
        
        For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
        
        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
        
        Each lens is identified by its LensSummary$LensAlias .
    - RiskCounts (dict) --
      
      A map from risk names to the count of how many questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
    - ImprovementStatus (string) --
      
      The improvement status for a workload.
    - Profiles (list) --
      
      Profile associated with a workload.
      - (dict) --
        
        The profile associated with a workload.
        
        ProfileArn (string) --
        
        The profile ARN.
        
        ProfileVersion (string) --
        
        The profile version.
    - PrioritizedRiskCounts (dict) --
      
      A map from risk names to the count of how many questions have that rating.
      - (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

UpdateLensReview (updated)

Link ¶
Changes (response)

{'LensReview': {'PillarReviewSummaries': {'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'}},
                'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'},
                'Profiles': [{'ProfileArn': 'string',
                              'ProfileVersion': 'string'}]}}

Update lens review for a particular workload.

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 custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .

Each lens is identified by its LensSummary$LensAlias .

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

Response Structure

(dict) --

Output of a update lens review call.
- WorkloadId (string) --
  
  The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
- LensReview (dict) --
  
  A lens review of a question.
  - LensAlias (string) --
    
    The alias of the lens.
    
    For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
    
    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
    
    Each lens is identified by its LensSummary$LensAlias .
  - LensArn (string) --
    
    The ARN for the lens.
  - LensVersion (string) --
    
    The version of the lens.
  - LensName (string) --
    
    The full name of the lens.
  - LensStatus (string) --
    
    The status of the lens.
  - PillarReviewSummaries (list) --
    
    List of pillar review summaries of lens review in a workload.
    - (dict) --
      
      A pillar review summary of a lens review.
      - PillarId (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId .
      - PillarName (string) --
        
        The name of the pillar.
      - Notes (string) --
        
        The notes associated with the workload.
      - RiskCounts (dict) --
        
        A map from risk names to the count of how many questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
      - PrioritizedRiskCounts (dict) --
        
        A map from risk names to the count of how many questions have that rating.
        
        (string) --
        
        The risk for a given workload, lens review, pillar, or question.
        
        (integer) --
        
        A non-negative integer that denotes how many.
  - 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 many questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.
  - NextToken (string) --
    
    The token to use to retrieve the next set of results.
  - Profiles (list) --
    
    The profiles associated with the workload.
    - (dict) --
      
      The profile associated with a workload.
      - ProfileArn (string) --
        
        The profile ARN.
      - ProfileVersion (string) --
        
        The profile version.
  - PrioritizedRiskCounts (dict) --
    
    A map from risk names to the count of how many questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.

UpdateShareInvitation (updated)

Link ¶
Changes (response)

{'ShareInvitation': {'ProfileArn': 'string', 'ShareResourceType': {'PROFILE'}}}

Update a workload or custom lens share invitation.

Note

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

See also: AWS API Documentation

Request Syntax

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'|'PROFILE',
        'WorkloadId': 'string',
        'LensAlias': 'string',
        'LensArn': 'string',
        'ProfileArn': 'string'
    }
}

Response Structure

(dict) --
- ShareInvitation (dict) --
  
  The updated workload or custom lens share invitation.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.
  - ShareResourceType (string) --
    
    The resource type of the share invitation.
  - WorkloadId (string) --
    
    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
  - LensAlias (string) --
    
    The alias of the lens.
    
    For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
    
    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
    
    Each lens is identified by its LensSummary$LensAlias .
  - LensArn (string) --
    
    The ARN for the lens.
  - ProfileArn (string) --
    
    The profile ARN.

UpdateWorkload (updated)

Link ¶
Changes (response)

{'Workload': {'PrioritizedRiskCounts': {'UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE': 'integer'},
              'Profiles': [{'ProfileArn': 'string',
                            'ProfileVersion': 'string'}]}}

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',
    DiscoveryConfig={
        'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
        'WorkloadResourceDefinition': [
            'WORKLOAD_METADATA'|'APP_REGISTRY',
        ]
    },
    Applications=[
        'string',
    ]
)

type WorkloadId

string

param WorkloadId

[REQUIRED]

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

type WorkloadName

string

param WorkloadName

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.

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 Amazon Web Services account IDs associated with the workload.

(string) --

An Amazon Web Services account ID.

type AwsRegions

list

param AwsRegions

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

(string) --

An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .

type NonAwsRegions

list

param NonAwsRegions

The list of non-Amazon Web Services 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.

type DiscoveryConfig

dict

param DiscoveryConfig

Well-Architected discovery configuration settings to associate to the workload.

TrustedAdvisorIntegrationStatus (string) --

Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition (list) --

The mode to use for identifying resources associated with the workload.

You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
- (string) --

type Applications

list

param Applications

List of AppRegistry application ARNs to associate to the workload.

(string) --

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',
        'Tags': {
            'string': 'string'
        },
        'DiscoveryConfig': {
            'TrustedAdvisorIntegrationStatus': 'ENABLED'|'DISABLED',
            'WorkloadResourceDefinition': [
                'WORKLOAD_METADATA'|'APP_REGISTRY',
            ]
        },
        'Applications': [
            'string',
        ],
        'Profiles': [
            {
                'ProfileArn': 'string',
                'ProfileVersion': 'string'
            },
        ],
        'PrioritizedRiskCounts': {
            'string': 123
        }
    }
}

Response Structure

(dict) --

Output of an update workload call.
- Workload (dict) --
  
  A workload return object.
  - WorkloadId (string) --
    
    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
  - WorkloadArn (string) --
    
    The ARN for the workload.
  - WorkloadName (string) --
    
    The name of the workload.
    
    The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
  - Description (string) --
    
    The description for the workload.
  - Environment (string) --
    
    The environment for the workload.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - AccountIds (list) --
    
    The list of Amazon Web Services account IDs associated with the workload.
    - (string) --
      
      An Amazon Web Services account ID.
  - AwsRegions (list) --
    
    The list of Amazon Web Services Regions associated with the workload, for example, us-east-2 , or ca-central-1 .
    - (string) --
      
      An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1 .
  - NonAwsRegions (list) --
    
    The list of non-Amazon Web Services Regions associated with the workload.
    - (string) --
  - ArchitecturalDesign (string) --
    
    The URL of the architectural design for the workload.
  - ReviewOwner (string) --
    
    The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.
  - ReviewRestrictionDate (datetime) --
    
    The date and time recorded.
  - IsReviewOwnerUpdateAcknowledged (boolean) --
    
    Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
    
    If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
  - IndustryType (string) --
    
    The industry type for the workload.
    
    If specified, must be one of the following:
    - Agriculture
    - Automobile
    - Defense
    - Design and Engineering
    - Digital Advertising
    - Education
    - Environmental Protection
    - Financial Services
    - Gaming
    - General Public Services
    - Healthcare
    - Hospitality
    - InfoTech
    - Justice and Public Safety
    - Life Sciences
    - Manufacturing
    - Media & Entertainment
    - Mining & Resources
    - Oil & Gas
    - Power & Utilities
    - Professional Services
    - Real Estate & Construction
    - Retail & Wholesale
    - Social Protection
    - Telecommunications
    - Travel, Transportation & Logistics
    - Other
  - Industry (string) --
    
    The industry for the workload.
  - Notes (string) --
    
    The notes associated with the workload.
  - ImprovementStatus (string) --
    
    The improvement status for a workload.
  - RiskCounts (dict) --
    
    A map from risk names to the count of how many questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.
  - PillarPriorities (list) --
    
    The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId .
    - (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId .
  - Lenses (list) --
    
    The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias .
    - (string) --
      
      The alias of the lens.
      
      For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
      
      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef .
      
      Each lens is identified by its LensSummary$LensAlias .
  - Owner (string) --
    
    An Amazon Web Services account ID.
  - ShareInvitationId (string) --
    
    The ID assigned to the share invitation.
  - Tags (dict) --
    
    The tags associated with the workload.
    - (string) --
      - (string) --
  - DiscoveryConfig (dict) --
    
    Discovery configuration associated to the workload.
    - TrustedAdvisorIntegrationStatus (string) --
      
      Discovery integration status in respect to Trusted Advisor for the workload.
    - WorkloadResourceDefinition (list) --
      
      The mode to use for identifying resources associated with the workload.
      
      You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
      - (string) --
  - Applications (list) --
    
    List of AppRegistry application ARNs associated to the workload.
    - (string) --
  - Profiles (list) --
    
    Profile associated with a workload.
    - (dict) --
      
      The profile associated with a workload.
      - ProfileArn (string) --
        
        The profile ARN.
      - ProfileVersion (string) --
        
        The profile version.
  - PrioritizedRiskCounts (dict) --
    
    A map from risk names to the count of how many questions have that rating.
    - (string) --
      
      The risk for a given workload, lens review, pillar, or question.
      - (integer) --
        
        A non-negative integer that denotes how many.