AWS API Changes

2022/11/07 - AWS Well-Architected Tool - 2 new 4 updated api methods

Changes This release adds support for integrations with AWS Trusted Advisor and AWS Service Catalog AppRegistry to improve workload discovery and speed up your workload reviews.

ListCheckSummaries (new)

Link ¶

List of Trusted Advisor checks summarized for all accounts related to the workload.

See also: AWS API Documentation

Request Syntax

client.list_check_summaries(
    WorkloadId='string',
    NextToken='string',
    MaxResults=123,
    LensArn='string',
    PillarId='string',
    QuestionId='string',
    ChoiceId='string'
)

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.

type LensArn

string

param LensArn

[REQUIRED]

Well-Architected Lens ARN.

type PillarId

string

param PillarId

[REQUIRED]

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

A pillar is identified by its PillarReviewSummary$PillarId .

type QuestionId

string

param QuestionId

[REQUIRED]

The ID of the question.

type ChoiceId

string

param ChoiceId

[REQUIRED]

The ID of a choice.

rtype

dict

returns

Response Syntax

{
    'CheckSummaries': [
        {
            'Id': 'string',
            'Name': 'string',
            'Provider': 'TRUSTED_ADVISOR',
            'Description': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'LensArn': 'string',
            'PillarId': 'string',
            'QuestionId': 'string',
            'ChoiceId': 'string',
            'Status': 'OKAY'|'WARNING'|'ERROR'|'NOT_AVAILABLE'|'FETCH_FAILED',
            'AccountSummary': {
                'string': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- CheckSummaries (list) --
  
  List of Trusted Advisor summaries related to the Well-Architected best practice.
  - (dict) --
    
    Trusted Advisor check summary.
    - Id (string) --
      
      Trusted Advisor check ID.
    - Name (string) --
      
      Trusted Advisor check name.
    - Provider (string) --
      
      Provider of the check related to the best practice.
    - Description (string) --
      
      Trusted Advisor check description.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
    - LensArn (string) --
      
      Well-Architected Lens ARN associated to the check.
    - PillarId (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId .
    - QuestionId (string) --
      
      The ID of the question.
    - ChoiceId (string) --
      
      The ID of a choice.
    - Status (string) --
      
      Status associated to the check.
    - AccountSummary (dict) --
      
      Account summary associated to the check.
      - (string) --
        
        (integer) --
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListCheckDetails (new)

Link ¶

List of Trusted Advisor check details by account related to the workload.

See also: AWS API Documentation

Request Syntax

client.list_check_details(
    WorkloadId='string',
    NextToken='string',
    MaxResults=123,
    LensArn='string',
    PillarId='string',
    QuestionId='string',
    ChoiceId='string'
)

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.

type LensArn

string

param LensArn

[REQUIRED]

Well-Architected Lens ARN.

type PillarId

string

param PillarId

[REQUIRED]

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

A pillar is identified by its PillarReviewSummary$PillarId .

type QuestionId

string

param QuestionId

[REQUIRED]

The ID of the question.

type ChoiceId

string

param ChoiceId

[REQUIRED]

The ID of a choice.

rtype

dict

returns

Response Syntax

{
    'CheckDetails': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'Provider': 'TRUSTED_ADVISOR',
            'LensArn': 'string',
            'PillarId': 'string',
            'QuestionId': 'string',
            'ChoiceId': 'string',
            'Status': 'OKAY'|'WARNING'|'ERROR'|'NOT_AVAILABLE'|'FETCH_FAILED',
            'AccountId': 'string',
            'FlaggedResources': 123,
            'Reason': 'ASSUME_ROLE_ERROR'|'ACCESS_DENIED'|'UNKNOWN_ERROR'|'PREMIUM_SUPPORT_REQUIRED',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- CheckDetails (list) --
  
  The details about the Trusted Advisor checks related to the Well-Architected best practice.
  - (dict) --
    
    Account details for a Well-Architected best practice in relation to Trusted Advisor checks.
    - Id (string) --
      
      Trusted Advisor check ID.
    - Name (string) --
      
      Trusted Advisor check name.
    - Description (string) --
      
      Trusted Advisor check description.
    - Provider (string) --
      
      Provider of the check related to the best practice.
    - LensArn (string) --
      
      Well-Architected Lens ARN associated to the check.
    - PillarId (string) --
      
      The ID used to identify a pillar, for example, security .
      
      A pillar is identified by its PillarReviewSummary$PillarId .
    - QuestionId (string) --
      
      The ID of the question.
    - ChoiceId (string) --
      
      The ID of a choice.
    - Status (string) --
      
      Status associated to the check.
    - AccountId (string) --
      
      An Amazon Web Services account ID.
    - FlaggedResources (integer) --
      
      Count of flagged resources associated to the check.
    - Reason (string) --
      
      Reason associated to the check.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

CreateWorkload (updated)

Link ¶
Changes (request)

{'Applications': ['string'],
 'DiscoveryConfig': {'TrustedAdvisorIntegrationStatus': 'ENABLED | DISABLED'}}

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts, IAM 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 .

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'
    },
    Applications=[
        '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-west-2::lens/serverless .

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .

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

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

Warning

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

This field is autopopulated if not provided.

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

type Applications

list

param Applications

List of AppRegistry application ARNs associated to 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.

GetMilestone (updated)

Link ¶
Changes (response)

{'Milestone': {'Workload': {'Applications': ['string'],
                            'DiscoveryConfig': {'TrustedAdvisorIntegrationStatus': 'ENABLED '
                                                                                   '| '
                                                                                   'DISABLED'}}}}

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

Response Structure

(dict) --

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

GetWorkload (updated)

Link ¶
Changes (response)

{'Workload': {'Applications': ['string'],
              'DiscoveryConfig': {'TrustedAdvisorIntegrationStatus': 'ENABLED '
                                                                     '| '
                                                                     'DISABLED'}}}

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

Response Structure

(dict) --

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

UpdateWorkload (updated)

Link ¶
Changes (request, response)
Request

{'Applications': ['string'],
 'DiscoveryConfig': {'TrustedAdvisorIntegrationStatus': 'ENABLED | DISABLED'}}

Response

{'Workload': {'Applications': ['string'],
              'DiscoveryConfig': {'TrustedAdvisorIntegrationStatus': 'ENABLED '
                                                                     '| '
                                                                     'DISABLED'}}}

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

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

Response Structure

(dict) --

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