AWS API Changes

2023/10/03 - AWS Well-Architected Tool - 14 new 4 updated api methods

Changes AWS Well-Architected now supports Review Templates that allows you to create templates with pre-filled answers for Well-Architected and Custom Lens best practices.

UpdateReviewTemplateLensReview (new)

Link ¶

Update a lens review associated with a review template.

See also: AWS API Documentation

Request Syntax

client.update_review_template_lens_review(
    TemplateArn='string',
    LensAlias='string',
    LensNotes='string',
    PillarNotes={
        'string': 'string'
    }
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template ARN.

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 LensNotes

string

param LensNotes

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

type PillarNotes

dict

param PillarNotes

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

For a review template, these are the notes that will be associated with the workload when the template is applied.

(string) --

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

A pillar is identified by its PillarReviewSummary$PillarId.
- (string) --
  
  The notes associated with the workload.
  
  For a review template, these are the notes that will be associated with the workload when the template is applied.

rtype

dict

returns

Response Syntax

{
    'TemplateArn': 'string',
    'LensReview': {
        'LensAlias': 'string',
        'LensArn': 'string',
        'LensVersion': 'string',
        'LensName': 'string',
        'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED',
        'PillarReviewSummaries': [
            {
                'PillarId': 'string',
                'PillarName': 'string',
                'Notes': 'string',
                'QuestionCounts': {
                    'string': 123
                }
            },
        ],
        'UpdatedAt': datetime(2015, 1, 1),
        'Notes': 'string',
        'QuestionCounts': {
            'string': 123
        },
        'NextToken': 'string'
    }
}

Response Structure

(dict) --
- TemplateArn (string) --
  
  The review template ARN.
- 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 lens ARN.
  - LensVersion (string) --
    
    The version of the lens.
  - LensName (string) --
    
    The full name of the lens.
  - LensStatus (string) --
    
    The status of the lens.
  - PillarReviewSummaries (list) --
    
    Pillar review summaries of a lens review.
    - (dict) --
      
      Summary of a review template.
      - PillarId (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId.
      - PillarName (string) --
        
        The name of the pillar.
      - Notes (string) --
        
        The notes associated with the workload.
        
        For a review template, these are the notes that will be associated with the workload when the template is applied.
      - QuestionCounts (dict) --
        
        A count of how many questions are answered and unanswered in the requested pillar of the lens review.
        
        (string) --
        
        (integer) --
        
        A non-negative integer that denotes how many.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - Notes (string) --
    
    The notes associated with the workload.
    
    For a review template, these are the notes that will be associated with the workload when the template is applied.
  - QuestionCounts (dict) --
    
    A count of how many questions are answered and unanswered in the lens review.
    - (string) --
      - (integer) --
        
        A non-negative integer that denotes how many.
  - NextToken (string) --
    
    The token to use to retrieve the next set of results.

GetReviewTemplateAnswer (new)

Link ¶

Get review template answer.

See also: AWS API Documentation

Request Syntax

client.get_review_template_answer(
    TemplateArn='string',
    LensAlias='string',
    QuestionId='string'
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template ARN.

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 QuestionId

string

param QuestionId

[REQUIRED]

The ID of the question.

rtype

dict

returns

Response Syntax

{
    'TemplateArn': 'string',
    'LensAlias': 'string',
    'Answer': {
        'QuestionId': 'string',
        'PillarId': 'string',
        'QuestionTitle': 'string',
        'QuestionDescription': 'string',
        'ImprovementPlanUrl': 'string',
        'HelpfulResourceUrl': 'string',
        'HelpfulResourceDisplayText': 'string',
        'Choices': [
            {
                'ChoiceId': 'string',
                'Title': 'string',
                'Description': 'string',
                'HelpfulResource': {
                    'DisplayText': 'string',
                    'Url': 'string'
                },
                'ImprovementPlan': {
                    'DisplayText': 'string',
                    'Url': 'string'
                },
                'AdditionalResources': [
                    {
                        'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN',
                        'Content': [
                            {
                                'DisplayText': 'string',
                                'Url': 'string'
                            },
                        ]
                    },
                ]
            },
        ],
        'SelectedChoices': [
            'string',
        ],
        'ChoiceAnswers': [
            {
                'ChoiceId': 'string',
                'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
                'Notes': 'string'
            },
        ],
        'IsApplicable': True|False,
        'AnswerStatus': 'UNANSWERED'|'ANSWERED',
        'Notes': 'string',
        'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
    }
}

Response Structure

(dict) --
- TemplateArn (string) --
  
  The review template ARN.
- 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.
- Answer (dict) --
  
  An answer of the question.
  - QuestionId (string) --
    
    The ID of the question.
  - PillarId (string) --
    
    The ID used to identify a pillar, for example, security .
    
    A pillar is identified by its PillarReviewSummary$PillarId.
  - QuestionTitle (string) --
    
    The title of the question.
  - QuestionDescription (string) --
    
    The description of the question.
  - ImprovementPlanUrl (string) --
    
    The improvement plan URL for a question 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.
  - HelpfulResourceUrl (string) --
    
    The helpful resource URL.
    
    For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.
    
    For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.
  - HelpfulResourceDisplayText (string) --
    
    The helpful resource text to be displayed for a custom lens.
    
    Note
    
    This field does not apply to Amazon Web Services official lenses.
  - 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.
  - ChoiceAnswers (list) --
    
    A list of selected choices to a question in your review template.
    - (dict) --
      
      A choice that has been answered on a question in your workload.
      - ChoiceId (string) --
        
        The ID of a choice.
      - Status (string) --
        
        The status of a choice.
      - Reason (string) --
        
        The reason why a choice is non-applicable to a question in your workload.
      - Notes (string) --
        
        The notes associated with a choice.
  - IsApplicable (boolean) --
    
    Defines whether this question is applicable to a lens review.
  - AnswerStatus (string) --
    
    The status of whether or not this question has been answered.
  - Notes (string) --
    
    The notes associated with the workload.
    
    For a review template, these are the notes that will be associated with the workload when the template is applied.
  - Reason (string) --
    
    The reason why the question is not applicable to your review template.

ListReviewTemplates (new)

Link ¶

List review templates.

See also: AWS API Documentation

Request Syntax

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

type NextToken

string

param NextToken

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

type MaxResults

integer

param MaxResults

The maximum number of results to return for this request.

rtype

dict

returns

Response Syntax

{
    'ReviewTemplates': [
        {
            'Description': 'string',
            'Lenses': [
                'string',
            ],
            'Owner': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'TemplateArn': 'string',
            'TemplateName': 'string',
            'UpdateStatus': 'CURRENT'|'LENS_NOT_CURRENT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ReviewTemplates (list) --
  
  List of review templates.
  - (dict) --
    
    Summary of a review template.
    - Description (string) --
      
      Description of the review template.
    - Lenses (list) --
      
      Lenses associated with the review template.
      - (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.
    - UpdatedAt (datetime) --
      
      The date and time recorded.
    - TemplateArn (string) --
      
      The review template ARN.
    - TemplateName (string) --
      
      The name of the review template.
    - UpdateStatus (string) --
      
      The latest status of a review template.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

UpdateReviewTemplateAnswer (new)

Link ¶

Update a review template answer.

See also: AWS API Documentation

Request Syntax

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

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template ARN.

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 QuestionId

string

param QuestionId

[REQUIRED]

The ID of the question.

type SelectedChoices

list

param SelectedChoices

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

(string) --

The ID of a choice.

type ChoiceUpdates

dict

param ChoiceUpdates

A list of choices to be updated.

(string) --

The ID of a choice.
- (dict) --
  
  A list of choices to be updated.
  - Status (string) -- [REQUIRED]
    
    The status of a choice.
  - Reason (string) --
    
    The reason why a choice is non-applicable to a question in your workload.
  - Notes (string) --
    
    The notes associated with a choice.

type Notes

string

param Notes

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

type IsApplicable

boolean

param IsApplicable

Defines whether this question is applicable to a lens review.

type Reason

string

param Reason

The update reason.

rtype

dict

returns

Response Syntax

{
    'TemplateArn': 'string',
    'LensAlias': 'string',
    'Answer': {
        'QuestionId': 'string',
        'PillarId': 'string',
        'QuestionTitle': 'string',
        'QuestionDescription': 'string',
        'ImprovementPlanUrl': 'string',
        'HelpfulResourceUrl': 'string',
        'HelpfulResourceDisplayText': 'string',
        'Choices': [
            {
                'ChoiceId': 'string',
                'Title': 'string',
                'Description': 'string',
                'HelpfulResource': {
                    'DisplayText': 'string',
                    'Url': 'string'
                },
                'ImprovementPlan': {
                    'DisplayText': 'string',
                    'Url': 'string'
                },
                'AdditionalResources': [
                    {
                        'Type': 'HELPFUL_RESOURCE'|'IMPROVEMENT_PLAN',
                        'Content': [
                            {
                                'DisplayText': 'string',
                                'Url': 'string'
                            },
                        ]
                    },
                ]
            },
        ],
        'SelectedChoices': [
            'string',
        ],
        'ChoiceAnswers': [
            {
                'ChoiceId': 'string',
                'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
                'Notes': 'string'
            },
        ],
        'IsApplicable': True|False,
        'AnswerStatus': 'UNANSWERED'|'ANSWERED',
        'Notes': 'string',
        'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
    }
}

Response Structure

(dict) --
- TemplateArn (string) --
  
  The review template ARN.
- 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.
- Answer (dict) --
  
  An answer of the question.
  - QuestionId (string) --
    
    The ID of the question.
  - PillarId (string) --
    
    The ID used to identify a pillar, for example, security .
    
    A pillar is identified by its PillarReviewSummary$PillarId.
  - QuestionTitle (string) --
    
    The title of the question.
  - QuestionDescription (string) --
    
    The description of the question.
  - ImprovementPlanUrl (string) --
    
    The improvement plan URL for a question 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.
  - HelpfulResourceUrl (string) --
    
    The helpful resource URL.
    
    For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.
    
    For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.
  - HelpfulResourceDisplayText (string) --
    
    The helpful resource text to be displayed for a custom lens.
    
    Note
    
    This field does not apply to Amazon Web Services official lenses.
  - 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.
  - ChoiceAnswers (list) --
    
    A list of selected choices to a question in your review template.
    - (dict) --
      
      A choice that has been answered on a question in your workload.
      - ChoiceId (string) --
        
        The ID of a choice.
      - Status (string) --
        
        The status of a choice.
      - Reason (string) --
        
        The reason why a choice is non-applicable to a question in your workload.
      - Notes (string) --
        
        The notes associated with a choice.
  - IsApplicable (boolean) --
    
    Defines whether this question is applicable to a lens review.
  - AnswerStatus (string) --
    
    The status of whether or not this question has been answered.
  - Notes (string) --
    
    The notes associated with the workload.
    
    For a review template, these are the notes that will be associated with the workload when the template is applied.
  - Reason (string) --
    
    The reason why the question is not applicable to your review template.

GetReviewTemplate (new)

Link ¶

Get review template.

See also: AWS API Documentation

Request Syntax

client.get_review_template(
    TemplateArn='string'
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template ARN.

rtype

dict

returns

Response Syntax

{
    'ReviewTemplate': {
        'Description': 'string',
        'Lenses': [
            'string',
        ],
        'Notes': 'string',
        'QuestionCounts': {
            'string': 123
        },
        'Owner': 'string',
        'UpdatedAt': datetime(2015, 1, 1),
        'TemplateArn': 'string',
        'TemplateName': 'string',
        'Tags': {
            'string': 'string'
        },
        'UpdateStatus': 'CURRENT'|'LENS_NOT_CURRENT',
        'ShareInvitationId': 'string'
    }
}

Response Structure

(dict) --
- ReviewTemplate (dict) --
  
  The review template.
  - Description (string) --
    
    The review template description.
  - Lenses (list) --
    
    The lenses applied to the review template.
    - (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.
  - Notes (string) --
    
    The notes associated with the workload.
    
    For a review template, these are the notes that will be associated with the workload when the template is applied.
  - QuestionCounts (dict) --
    
    A count of how many total questions are answered and unanswered in the review template.
    - (string) --
      - (integer) --
        
        A non-negative integer that denotes how many.
  - Owner (string) --
    
    An Amazon Web Services account ID.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - TemplateArn (string) --
    
    The review template ARN.
  - TemplateName (string) --
    
    The name of the review template.
  - Tags (dict) --
    
    The tags assigned to the review template.
    - (string) --
      - (string) --
  - UpdateStatus (string) --
    
    The latest status of a review template.
  - ShareInvitationId (string) --
    
    The ID assigned to the template share invitation.

UpgradeReviewTemplateLensReview (new)

Link ¶

Upgrade the lens review of a review template.

See also: AWS API Documentation

Request Syntax

client.upgrade_review_template_lens_review(
    TemplateArn='string',
    LensAlias='string',
    ClientRequestToken='string'
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The ARN of the review template.

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

returns

None

CreateReviewTemplate (new)

Link ¶

Create a review template.

Note

Disclaimer

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

See also: AWS API Documentation

Request Syntax

client.create_review_template(
    TemplateName='string',
    Description='string',
    Lenses=[
        'string',
    ],
    Notes='string',
    Tags={
        'string': 'string'
    },
    ClientRequestToken='string'
)

type TemplateName

string

param TemplateName

[REQUIRED]

Name of the review template.

type Description

string

param Description

[REQUIRED]

The review template description.

type Lenses

list

param Lenses

[REQUIRED]

Lenses applied to the review template.

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

For a review template, these are the notes that will be associated with the workload when the template is applied.

type Tags

dict

param Tags

The tags assigned to the review template.

(string) --
- (string) --

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

{
    'TemplateArn': 'string'
}

Response Structure

(dict) --
- TemplateArn (string) --
  
  The review template ARN.

UpdateReviewTemplate (new)

Link ¶

Update a review template.

See also: AWS API Documentation

Request Syntax

client.update_review_template(
    TemplateArn='string',
    TemplateName='string',
    Description='string',
    Notes='string',
    LensesToAssociate=[
        'string',
    ],
    LensesToDisassociate=[
        'string',
    ]
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template ARN.

type TemplateName

string

param TemplateName

The review template name.

type Description

string

param Description

The review template description.

type Notes

string

param Notes

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

type LensesToAssociate

list

param LensesToAssociate

A list of lens aliases or ARNs to apply to the review template.

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

list

param LensesToDisassociate

A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.

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

rtype

dict

returns

Response Syntax

{
    'ReviewTemplate': {
        'Description': 'string',
        'Lenses': [
            'string',
        ],
        'Notes': 'string',
        'QuestionCounts': {
            'string': 123
        },
        'Owner': 'string',
        'UpdatedAt': datetime(2015, 1, 1),
        'TemplateArn': 'string',
        'TemplateName': 'string',
        'Tags': {
            'string': 'string'
        },
        'UpdateStatus': 'CURRENT'|'LENS_NOT_CURRENT',
        'ShareInvitationId': 'string'
    }
}

Response Structure

(dict) --
- ReviewTemplate (dict) --
  
  A review template.
  - Description (string) --
    
    The review template description.
  - Lenses (list) --
    
    The lenses applied to the review template.
    - (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.
  - Notes (string) --
    
    The notes associated with the workload.
    
    For a review template, these are the notes that will be associated with the workload when the template is applied.
  - QuestionCounts (dict) --
    
    A count of how many total questions are answered and unanswered in the review template.
    - (string) --
      - (integer) --
        
        A non-negative integer that denotes how many.
  - Owner (string) --
    
    An Amazon Web Services account ID.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - TemplateArn (string) --
    
    The review template ARN.
  - TemplateName (string) --
    
    The name of the review template.
  - Tags (dict) --
    
    The tags assigned to the review template.
    - (string) --
      - (string) --
  - UpdateStatus (string) --
    
    The latest status of a review template.
  - ShareInvitationId (string) --
    
    The ID assigned to the template share invitation.

ListTemplateShares (new)

Link ¶

List review template shares.

See also: AWS API Documentation

Request Syntax

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

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template ARN.

type SharedWithPrefix

string

param SharedWithPrefix

The Amazon Web Services account ID, 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

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

Response Structure

(dict) --
- TemplateArn (string) --
  
  The review template ARN.
- TemplateShareSummaries (list) --
  
  A review template share summary return object.
  - (dict) --
    
    Summary of a review template share.
    - ShareId (string) --
      
      The ID associated with the share.
    - SharedWith (string) --
      
      The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.
    - Status (string) --
      
      The status of the share request.
    - StatusMessage (string) --
      
      Review template share invitation status message.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

ListReviewTemplateAnswers (new)

Link ¶

List the answers of a review template.

See also: AWS API Documentation

Request Syntax

client.list_review_template_answers(
    TemplateArn='string',
    LensAlias='string',
    PillarId='string',
    NextToken='string',
    MaxResults=123
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The ARN of the review template.

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

{
    'TemplateArn': 'string',
    'LensAlias': '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,
            'AnswerStatus': 'UNANSWERED'|'ANSWERED',
            'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
            'QuestionType': 'PRIORITIZED'|'NON_PRIORITIZED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TemplateArn (string) --
  
  The ARN of the review template.
- 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.
- AnswerSummaries (list) --
  
  List of answer summaries of a lens review in a review template.
  - (dict) --
    
    The summary of review template answers.
    - 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 the review template.
      - (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.
    - AnswerStatus (string) --
      
      The status of whether or not this question has been answered.
    - Reason (string) --
      
      The reason why a choice is not-applicable to a question in the review template.
    - QuestionType (string) --
      
      The type of question.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

DeleteReviewTemplate (new)

Link ¶

Delete a review template.

Only the owner of a review template can delete it.

After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

See also: AWS API Documentation

Request Syntax

client.delete_review_template(
    TemplateArn='string',
    ClientRequestToken='string'
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template 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

CreateTemplateShare (new)

Link ¶

Create a review template share.

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

Shared access to a review template is not removed until the review template share invitation is deleted.

If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.

Note

Disclaimer

By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.

See also: AWS API Documentation

Request Syntax

client.create_template_share(
    TemplateArn='string',
    SharedWith='string',
    ClientRequestToken='string'
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template ARN.

type SharedWith

string

param SharedWith

[REQUIRED]

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template 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

{
    'TemplateArn': 'string',
    'ShareId': 'string'
}

Response Structure

(dict) --
- TemplateArn (string) --
  
  The review template ARN.
- ShareId (string) --
  
  The ID associated with the share.

DeleteTemplateShare (new)

Link ¶

Delete a review template share.

After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

See also: AWS API Documentation

Request Syntax

client.delete_template_share(
    ShareId='string',
    TemplateArn='string',
    ClientRequestToken='string'
)

type ShareId

string

param ShareId

[REQUIRED]

The ID associated with the share.

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template 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

GetReviewTemplateLensReview (new)

Link ¶

Get a lens review associated with a review template.

See also: AWS API Documentation

Request Syntax

client.get_review_template_lens_review(
    TemplateArn='string',
    LensAlias='string'
)

type TemplateArn

string

param TemplateArn

[REQUIRED]

The review template ARN.

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.

rtype

dict

returns

Response Syntax

{
    'TemplateArn': 'string',
    'LensReview': {
        'LensAlias': 'string',
        'LensArn': 'string',
        'LensVersion': 'string',
        'LensName': 'string',
        'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED',
        'PillarReviewSummaries': [
            {
                'PillarId': 'string',
                'PillarName': 'string',
                'Notes': 'string',
                'QuestionCounts': {
                    'string': 123
                }
            },
        ],
        'UpdatedAt': datetime(2015, 1, 1),
        'Notes': 'string',
        'QuestionCounts': {
            'string': 123
        },
        'NextToken': 'string'
    }
}

Response Structure

(dict) --
- TemplateArn (string) --
  
  The review template ARN.
- 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 lens ARN.
  - LensVersion (string) --
    
    The version of the lens.
  - LensName (string) --
    
    The full name of the lens.
  - LensStatus (string) --
    
    The status of the lens.
  - PillarReviewSummaries (list) --
    
    Pillar review summaries of a lens review.
    - (dict) --
      
      Summary of a review template.
      - PillarId (string) --
        
        The ID used to identify a pillar, for example, security .
        
        A pillar is identified by its PillarReviewSummary$PillarId.
      - PillarName (string) --
        
        The name of the pillar.
      - Notes (string) --
        
        The notes associated with the workload.
        
        For a review template, these are the notes that will be associated with the workload when the template is applied.
      - QuestionCounts (dict) --
        
        A count of how many questions are answered and unanswered in the requested pillar of the lens review.
        
        (string) --
        
        (integer) --
        
        A non-negative integer that denotes how many.
  - UpdatedAt (datetime) --
    
    The date and time recorded.
  - Notes (string) --
    
    The notes associated with the workload.
    
    For a review template, these are the notes that will be associated with the workload when the template is applied.
  - QuestionCounts (dict) --
    
    A count of how many questions are answered and unanswered in the lens review.
    - (string) --
      - (integer) --
        
        A non-negative integer that denotes how many.
  - NextToken (string) --
    
    The token to use to retrieve the next set of results.

CreateWorkload (updated)

Link ¶
Changes (request)

{'ReviewTemplateArns': ['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.

When creating a workload using a review template, you must have the following IAM permissions:

wellarchitected:GetReviewTemplate
wellarchitected:GetReviewTemplateAnswer
wellarchitected:ListReviewTemplateAnswers
wellarchitected:GetReviewTemplateLensReview

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',
    ],
    ReviewTemplateArns=[
        '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.

If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

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

For a review template, these are the notes that will be associated with the workload when the template is applied.

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

type ReviewTemplateArns

list

param ReviewTemplateArns

The list of review template ARNs to associate 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.

ListNotifications (updated)

Link ¶
Changes (request, response)
Request

{'ResourceArn': 'string'}

Response

{'NotificationSummaries': {'LensUpgradeSummary': {'ResourceArn': 'string',
                                                  'ResourceName': 'string'}}}

List lens notifications.

See also: AWS API Documentation

Request Syntax

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

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.

type ResourceArn

string

param ResourceArn

The ARN for the related resource for the notification.

Note

Only one of WorkloadID or ResourceARN should be specified.

rtype

dict

returns

Response Syntax

{
    'NotificationSummaries': [
        {
            'Type': 'LENS_VERSION_UPGRADED'|'LENS_VERSION_DEPRECATED',
            'LensUpgradeSummary': {
                'WorkloadId': 'string',
                'WorkloadName': 'string',
                'LensAlias': 'string',
                'LensArn': 'string',
                'CurrentLensVersion': 'string',
                'LatestLensVersion': 'string',
                'ResourceArn': 'string',
                'ResourceName': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- NotificationSummaries (list) --
  
  List of lens notification summaries in a workload.
  - (dict) --
    
    A notification summary return object.
    - Type (string) --
      
      The type of notification.
    - LensUpgradeSummary (dict) --
      
      Summary of lens upgrade.
      - WorkloadId (string) --
        
        The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
      - WorkloadName (string) --
        
        The name of the workload.
        
        The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
      - LensAlias (string) --
        
        The alias of the lens.
        
        For 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.
      - CurrentLensVersion (string) --
        
        The current version of the lens.
      - LatestLensVersion (string) --
        
        The latest version of the lens.
      - ResourceArn (string) --
        
        ResourceArn of the lens being upgraded
      - ResourceName (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.

ListShareInvitations (updated)

Link ¶
Changes (request, response)
Request

{'ShareResourceType': {'TEMPLATE'}, 'TemplateNamePrefix': 'string'}

Response

{'ShareInvitationSummaries': {'ShareResourceType': {'TEMPLATE'},
                              'TemplateArn': 'string',
                              'TemplateName': 'string'}}

List the share invitations.

WorkloadNamePrefix , LensNamePrefix , ProfileNamePrefix , and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType .

See also: AWS API Documentation

Request Syntax

client.list_share_invitations(
    WorkloadNamePrefix='string',
    LensNamePrefix='string',
    ShareResourceType='WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE',
    NextToken='string',
    MaxResults=123,
    ProfileNamePrefix='string',
    TemplateNamePrefix='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

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

type TemplateNamePrefix

string

param TemplateNamePrefix

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

rtype

dict

returns

Response Syntax

{
    'ShareInvitationSummaries': [
        {
            'ShareInvitationId': 'string',
            'SharedBy': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'ShareResourceType': 'WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE',
            'WorkloadName': 'string',
            'WorkloadId': 'string',
            'LensName': 'string',
            'LensArn': 'string',
            'ProfileName': 'string',
            'ProfileArn': 'string',
            'TemplateName': 'string',
            'TemplateArn': '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, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template 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.
    - TemplateName (string) --
      
      The name of the review template.
    - TemplateArn (string) --
      
      The review template ARN.
- NextToken (string) --
  
  The token to use to retrieve the next set of results.

UpdateShareInvitation (updated)

Link ¶
Changes (response)

{'ShareInvitation': {'ShareResourceType': {'TEMPLATE'},
                     'TemplateArn': 'string'}}

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'|'TEMPLATE',
        'WorkloadId': 'string',
        'LensAlias': 'string',
        'LensArn': 'string',
        'ProfileArn': 'string',
        'TemplateArn': '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.
  - TemplateArn (string) --
    
    The review template ARN.