WellArchitected

Table of Contents

Client

class WellArchitected.Client

A low-level client representing AWS Well-Architected Tool

This is the AWS Well-Architected Tool API Reference . The AWS Well-Architected Tool API provides programmatic access to the AWS Well-Architected Tool in the AWS Management Console . For information about the AWS Well-Architected Tool, see the AWS Well-Architected Tool User Guide .

import boto3

client = boto3.client('wellarchitected')

These are the available methods:

associate_lenses(**kwargs)

Associate a lens to a workload.

See also: AWS API Documentation

Request Syntax

response = client.associate_lenses(
    WorkloadId='string',
    LensAliases=[
        'string',
    ]
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • LensAliases (list) --

    [REQUIRED]

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

    Identify a lens using its LensSummary$LensAlias .

    • (string) --

      The alias of the lens, for example, serverless .

      Each lens is identified by its LensSummary$LensAlias .

Returns

None

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_milestone(**kwargs)

Create a milestone for an existing workload.

See also: AWS API Documentation

Request Syntax

response = client.create_milestone(
    WorkloadId='string',
    MilestoneName='string',
    ClientRequestToken='string'
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • MilestoneName (string) --

    [REQUIRED]

    The name of the milestone in a workload.

    Milestone names must be unique within a workload.

  • ClientRequestToken (string) --

    [REQUIRED]

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

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

    Warning

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123
}

Response Structure

  • (dict) --

    Output of a create milestone call.

    • WorkloadId (string) --

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

    • MilestoneNumber (integer) --

      The milestone number.

      A workload can have a maximum of 100 milestones.

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ServiceQuotaExceededException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
create_workload(**kwargs)

Create a new workload.

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

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

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)
Parameters
  • WorkloadName (string) --

    [REQUIRED]

    The name of the workload.

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

  • Description (string) --

    [REQUIRED]

    The description for the workload.

  • Environment (string) --

    [REQUIRED]

    The environment for the workload.

  • AccountIds (list) --

    The list of AWS account IDs associated with the workload.

    • (string) --

      An AWS account ID.

  • AwsRegions (list) --

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

    • (string) --

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

  • NonAwsRegions (list) --

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

    • (string) --
  • 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 .

  • ArchitecturalDesign (string) -- The URL of the architectural design for the workload.
  • ReviewOwner (string) --

    [REQUIRED]

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

  • 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.
  • Lenses (list) --

    [REQUIRED]

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

    • (string) --

      The alias of the lens, for example, serverless .

      Each lens is identified by its LensSummary$LensAlias .

  • Notes (string) -- The notes associated with the workload.
  • ClientRequestToken (string) --

    [REQUIRED]

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

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

    Warning

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

    This field is autopopulated if not provided.

  • Tags (dict) --

    The tags to be associated with the workload.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'WorkloadArn': 'string'
}

Response Structure

  • (dict) --

    Output of a create workload call.

    • WorkloadId (string) --

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

    • WorkloadArn (string) --

      The ARN for the workload.

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.ServiceQuotaExceededException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
create_workload_share(**kwargs)

Create a workload share.

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

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • SharedWith (string) --

    [REQUIRED]

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

  • PermissionType (string) --

    [REQUIRED]

    Permission granted on a workload share.

  • ClientRequestToken (string) --

    [REQUIRED]

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

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

    Warning

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

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'ShareId': 'string'
}

Response Structure

  • (dict) --

    Input for Create Workload Share

    • WorkloadId (string) --

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

    • ShareId (string) --

      The ID associated with the workload share.

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ServiceQuotaExceededException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
delete_workload(**kwargs)

Delete an existing workload.

See also: AWS API Documentation

Request Syntax

response = client.delete_workload(
    WorkloadId='string',
    ClientRequestToken='string'
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • ClientRequestToken (string) --

    [REQUIRED]

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

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

    Warning

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

    This field is autopopulated if not provided.

Returns

None

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
delete_workload_share(**kwargs)

Delete a workload share.

See also: AWS API Documentation

Request Syntax

response = client.delete_workload_share(
    ShareId='string',
    WorkloadId='string',
    ClientRequestToken='string'
)
Parameters
  • ShareId (string) --

    [REQUIRED]

    The ID associated with the workload share.

  • WorkloadId (string) --

    [REQUIRED]

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

  • ClientRequestToken (string) --

    [REQUIRED]

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

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

    Warning

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

    This field is autopopulated if not provided.

Returns

None

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
disassociate_lenses(**kwargs)

Disassociate a lens from a workload.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.disassociate_lenses(
    WorkloadId='string',
    LensAliases=[
        'string',
    ]
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • LensAliases (list) --

    [REQUIRED]

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

    Identify a lens using its LensSummary$LensAlias .

    • (string) --

      The alias of the lens, for example, serverless .

      Each lens is identified by its LensSummary$LensAlias .

Returns

None

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
get_answer(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_answer(
    WorkloadId='string',
    LensAlias='string',
    QuestionId='string',
    MilestoneNumber=123
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • QuestionId (string) --

    [REQUIRED]

    The ID of the question.

  • MilestoneNumber (integer) --

    The milestone number.

    A workload can have a maximum of 100 milestones.

Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensAlias': 'string',
    'Answer': {
        'QuestionId': 'string',
        'PillarId': 'string',
        'QuestionTitle': 'string',
        'QuestionDescription': 'string',
        'ImprovementPlanUrl': 'string',
        'HelpfulResourceUrl': 'string',
        'Choices': [
            {
                'ChoiceId': 'string',
                'Title': 'string',
                'Description': 'string'
            },
        ],
        'SelectedChoices': [
            'string',
        ],
        'ChoiceAnswers': [
            {
                'ChoiceId': 'string',
                'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
                'Notes': 'string'
            },
        ],
        'IsApplicable': True|False,
        'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
        'Notes': 'string',
        'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
    }
}

Response Structure

  • (dict) --

    Output of a get answer call.

    • WorkloadId (string) --

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

    • MilestoneNumber (integer) --

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensAlias (string) --

      The alias of the lens, for example, serverless .

      Each lens is identified by its LensSummary$LensAlias .

    • Answer (dict) --

      An answer of the question.

      • QuestionId (string) --

        The ID of the question.

      • PillarId (string) --

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

        A pillar is identified by its PillarReviewSummary$PillarId .

      • QuestionTitle (string) --

        The title of the question.

      • QuestionDescription (string) --

        The description of the question.

      • ImprovementPlanUrl (string) --

        The improvement plan URL for a question.

        This value is only available if the question has been answered.

      • HelpfulResourceUrl (string) --

        The helpful resource URL for a question.

      • Choices (list) --

        List of choices available for a question.

        • (dict) --

          A choice available to answer question.

          • ChoiceId (string) --

            The ID of a choice.

          • Title (string) --

            The title of a choice.

          • Description (string) --

            The description of a choice.

      • SelectedChoices (list) --

        List of selected choice IDs in a question answer.

        The values entered replace the previously selected choices.

        • (string) --

          The ID of a choice.

      • ChoiceAnswers (list) --

        A list of selected choices to a question in your workload.

        • (dict) --

          A choice that has been answered on a question in your workload.

          • ChoiceId (string) --

            The ID of a choice.

          • Status (string) --

            The status of a choice.

          • Reason (string) --

            The reason why a choice is non-applicable to a question in your workload.

          • Notes (string) --

            The notes associated with a choice.

      • IsApplicable (boolean) --

        Defines whether this question is applicable to a lens review.

      • Risk (string) --

        The risk for a given workload, lens review, pillar, or question.

      • Notes (string) --

        The notes associated with the workload.

      • Reason (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
get_lens_review(**kwargs)

Get lens review.

See also: AWS API Documentation

Request Syntax

response = client.get_lens_review(
    WorkloadId='string',
    LensAlias='string',
    MilestoneNumber=123
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • MilestoneNumber (integer) --

    The milestone number.

    A workload can have a maximum of 100 milestones.

Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensReview': {
        'LensAlias': 'string',
        'LensVersion': 'string',
        'LensName': 'string',
        'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED',
        'PillarReviewSummaries': [
            {
                'PillarId': 'string',
                'PillarName': 'string',
                'Notes': 'string',
                'RiskCounts': {
                    'string': 123
                }
            },
        ],
        'UpdatedAt': datetime(2015, 1, 1),
        'Notes': 'string',
        'RiskCounts': {
            'string': 123
        },
        'NextToken': 'string'
    }
}

Response Structure

  • (dict) --

    Output of a get lens review call.

    • WorkloadId (string) --

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

    • MilestoneNumber (integer) --

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensReview (dict) --

      A lens review of a question.

      • LensAlias (string) --

        The alias of the lens, for example, serverless .

        Each lens is identified by its LensSummary$LensAlias .

      • LensVersion (string) --

        The version of the lens.

      • LensName (string) --

        The full name of the lens.

      • LensStatus (string) --

        The status of the lens.

      • PillarReviewSummaries (list) --

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

        • (dict) --

          A pillar review summary of a lens review.

          • PillarId (string) --

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

            A pillar is identified by its PillarReviewSummary$PillarId .

          • PillarName (string) --

            The name of the pillar.

          • Notes (string) --

            The notes associated with the workload.

          • RiskCounts (dict) --

            A map from risk names to the count of how questions have that rating.

            • (string) --

              The risk for a given workload, lens review, pillar, or question.

              • (integer) --

                A non-negative integer that denotes how many.

      • UpdatedAt (datetime) --

        The date and time recorded.

      • Notes (string) --

        The notes associated with the workload.

      • RiskCounts (dict) --

        A map from risk names to the count of how questions have that rating.

        • (string) --

          The risk for a given workload, lens review, pillar, or question.

          • (integer) --

            A non-negative integer that denotes how many.

      • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
get_lens_review_report(**kwargs)

Get lens review report.

See also: AWS API Documentation

Request Syntax

response = client.get_lens_review_report(
    WorkloadId='string',
    LensAlias='string',
    MilestoneNumber=123
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • MilestoneNumber (integer) --

    The milestone number.

    A workload can have a maximum of 100 milestones.

Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensReviewReport': {
        'LensAlias': 'string',
        'Base64String': 'string'
    }
}

Response Structure

  • (dict) --

    Output of a get lens review report call.

    • WorkloadId (string) --

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

    • MilestoneNumber (integer) --

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensReviewReport (dict) --

      A report of a lens review.

      • LensAlias (string) --

        The alias of the lens, for example, serverless .

        Each lens is identified by its LensSummary$LensAlias .

      • Base64String (string) --

        The Base64-encoded string representation of a lens review report.

        This data can be used to create a PDF file.

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
get_lens_version_difference(**kwargs)

Get lens version differences.

See also: AWS API Documentation

Request Syntax

response = client.get_lens_version_difference(
    LensAlias='string',
    BaseLensVersion='string'
)
Parameters
  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • BaseLensVersion (string) --

    [REQUIRED]

    The base version of the lens.

Return type

dict

Returns

Response Syntax

{
    'LensAlias': 'string',
    'BaseLensVersion': 'string',
    'LatestLensVersion': 'string',
    'VersionDifferences': {
        'PillarDifferences': [
            {
                'PillarId': 'string',
                'DifferenceStatus': 'UPDATED'|'NEW'|'DELETED',
                'QuestionDifferences': [
                    {
                        'QuestionId': 'string',
                        'QuestionTitle': 'string',
                        'DifferenceStatus': 'UPDATED'|'NEW'|'DELETED'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • LensAlias (string) --

      The alias of the lens, for example, serverless .

      Each lens is identified by its LensSummary$LensAlias .

    • BaseLensVersion (string) --

      The base version of the lens.

    • LatestLensVersion (string) --

      The latest version of the lens.

    • VersionDifferences (dict) --

      The differences between the base and latest versions of the lens.

      • PillarDifferences (list) --

        The differences between the base and latest versions of the lens.

        • (dict) --

          A pillar difference return object.

          • PillarId (string) --

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

            A pillar is identified by its PillarReviewSummary$PillarId .

          • DifferenceStatus (string) --

            Indicates the type of change to the pillar.

          • QuestionDifferences (list) --

            List of question differences.

            • (dict) --

              A question difference return object.

              • QuestionId (string) --

                The ID of the question.

              • QuestionTitle (string) --

                The title of the question.

              • DifferenceStatus (string) --

                Indicates the type of change to the question.

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
get_milestone(**kwargs)

Get a milestone for an existing workload.

See also: AWS API Documentation

Request Syntax

response = client.get_milestone(
    WorkloadId='string',
    MilestoneNumber=123
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • MilestoneNumber (integer) --

    [REQUIRED]

    The milestone number.

    A workload can have a maximum of 100 milestones.

Return type

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

Response Structure

  • (dict) --

    Output of a get milestone call.

    • WorkloadId (string) --

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

    • Milestone (dict) --

      A milestone return object.

      • MilestoneNumber (integer) --

        The milestone number.

        A workload can have a maximum of 100 milestones.

      • MilestoneName (string) --

        The name of the milestone in a workload.

        Milestone names must be unique within a workload.

      • RecordedAt (datetime) --

        The date and time recorded.

      • Workload (dict) --

        A workload return object.

        • WorkloadId (string) --

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

        • WorkloadArn (string) --

          The ARN for the workload.

        • WorkloadName (string) --

          The name of the workload.

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

        • Description (string) --

          The description for the workload.

        • Environment (string) --

          The environment for the workload.

        • UpdatedAt (datetime) --

          The date and time recorded.

        • AccountIds (list) --

          The list of AWS account IDs associated with the workload.

          • (string) --

            An AWS account ID.

        • AwsRegions (list) --

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

          • (string) --

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

        • NonAwsRegions (list) --

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

          • (string) --
        • ArchitecturalDesign (string) --

          The URL of the architectural design for the workload.

        • ReviewOwner (string) --

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

        • ReviewRestrictionDate (datetime) --

          The date and time recorded.

        • IsReviewOwnerUpdateAcknowledged (boolean) --

          Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

          If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

        • IndustryType (string) --

          The industry type for the workload.

          If specified, must be one of the following:

          • Agriculture
          • Automobile
          • Defense
          • Design and Engineering
          • Digital Advertising
          • Education
          • Environmental Protection
          • Financial Services
          • Gaming
          • General Public Services
          • Healthcare
          • Hospitality
          • InfoTech
          • Justice and Public Safety
          • Life Sciences
          • Manufacturing
          • Media & Entertainment
          • Mining & Resources
          • Oil & Gas
          • Power & Utilities
          • Professional Services
          • Real Estate & Construction
          • Retail & Wholesale
          • Social Protection
          • Telecommunications
          • Travel, Transportation & Logistics
          • Other
        • Industry (string) --

          The industry for the workload.

        • Notes (string) --

          The notes associated with the workload.

        • ImprovementStatus (string) --

          The improvement status for a workload.

        • RiskCounts (dict) --

          A map from risk names to the count of how questions have that rating.

          • (string) --

            The risk for a given workload, lens review, pillar, or question.

            • (integer) --

              A non-negative integer that denotes how many.

        • PillarPriorities (list) --

          The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId .

          • (string) --

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

            A pillar is identified by its PillarReviewSummary$PillarId .

        • Lenses (list) --

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

          • (string) --

            The alias of the lens, for example, serverless .

            Each lens is identified by its LensSummary$LensAlias .

        • Owner (string) --

          An AWS account ID.

        • ShareInvitationId (string) --

          The ID assigned to the share invitation.

        • Tags (dict) --

          The tags associated with the workload.

          • (string) --
            • (string) --

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
get_workload(**kwargs)

Get an existing workload.

See also: AWS API Documentation

Request Syntax

response = client.get_workload(
    WorkloadId='string'
)
Parameters
WorkloadId (string) --

[REQUIRED]

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

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

Response Structure

  • (dict) --

    Output of a get workload call.

    • Workload (dict) --

      A workload return object.

      • WorkloadId (string) --

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

      • WorkloadArn (string) --

        The ARN for the workload.

      • WorkloadName (string) --

        The name of the workload.

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

      • Description (string) --

        The description for the workload.

      • Environment (string) --

        The environment for the workload.

      • UpdatedAt (datetime) --

        The date and time recorded.

      • AccountIds (list) --

        The list of AWS account IDs associated with the workload.

        • (string) --

          An AWS account ID.

      • AwsRegions (list) --

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

        • (string) --

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

      • NonAwsRegions (list) --

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

        • (string) --
      • ArchitecturalDesign (string) --

        The URL of the architectural design for the workload.

      • ReviewOwner (string) --

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

      • ReviewRestrictionDate (datetime) --

        The date and time recorded.

      • IsReviewOwnerUpdateAcknowledged (boolean) --

        Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

        If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

      • IndustryType (string) --

        The industry type for the workload.

        If specified, must be one of the following:

        • Agriculture
        • Automobile
        • Defense
        • Design and Engineering
        • Digital Advertising
        • Education
        • Environmental Protection
        • Financial Services
        • Gaming
        • General Public Services
        • Healthcare
        • Hospitality
        • InfoTech
        • Justice and Public Safety
        • Life Sciences
        • Manufacturing
        • Media & Entertainment
        • Mining & Resources
        • Oil & Gas
        • Power & Utilities
        • Professional Services
        • Real Estate & Construction
        • Retail & Wholesale
        • Social Protection
        • Telecommunications
        • Travel, Transportation & Logistics
        • Other
      • Industry (string) --

        The industry for the workload.

      • Notes (string) --

        The notes associated with the workload.

      • ImprovementStatus (string) --

        The improvement status for a workload.

      • RiskCounts (dict) --

        A map from risk names to the count of how questions have that rating.

        • (string) --

          The risk for a given workload, lens review, pillar, or question.

          • (integer) --

            A non-negative integer that denotes how many.

      • PillarPriorities (list) --

        The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId .

        • (string) --

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

          A pillar is identified by its PillarReviewSummary$PillarId .

      • Lenses (list) --

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

        • (string) --

          The alias of the lens, for example, serverless .

          Each lens is identified by its LensSummary$LensAlias .

      • Owner (string) --

        An AWS account ID.

      • ShareInvitationId (string) --

        The ID assigned to the share invitation.

      • Tags (dict) --

        The tags associated with the workload.

        • (string) --
          • (string) --

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_answers(**kwargs)

List of answers.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • PillarId (string) --

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

    A pillar is identified by its PillarReviewSummary$PillarId .

  • MilestoneNumber (integer) --

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensAlias': 'string',
    'AnswerSummaries': [
        {
            'QuestionId': 'string',
            'PillarId': 'string',
            'QuestionTitle': 'string',
            'Choices': [
                {
                    'ChoiceId': 'string',
                    'Title': 'string',
                    'Description': 'string'
                },
            ],
            'SelectedChoices': [
                'string',
            ],
            'ChoiceAnswerSummaries': [
                {
                    'ChoiceId': 'string',
                    'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                    'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
                },
            ],
            'IsApplicable': True|False,
            'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
            'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Output of a list answers call.

    • WorkloadId (string) --

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

    • MilestoneNumber (integer) --

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensAlias (string) --

      The alias of the lens, for example, serverless .

      Each lens is identified by its LensSummary$LensAlias .

    • AnswerSummaries (list) --

      List of answer summaries of lens review in a workload.

      • (dict) --

        An answer summary of a lens review in a workload.

        • QuestionId (string) --

          The ID of the question.

        • PillarId (string) --

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

          A pillar is identified by its PillarReviewSummary$PillarId .

        • QuestionTitle (string) --

          The title of the question.

        • Choices (list) --

          List of choices available for a question.

          • (dict) --

            A choice available to answer question.

            • ChoiceId (string) --

              The ID of a choice.

            • Title (string) --

              The title of a choice.

            • Description (string) --

              The description of a choice.

        • SelectedChoices (list) --

          List of selected choice IDs in a question answer.

          The values entered replace the previously selected choices.

          • (string) --

            The ID of a choice.

        • ChoiceAnswerSummaries (list) --

          A list of selected choices to a question in your workload.

          • (dict) --

            A choice summary that has been answered on a question in your workload.

            • ChoiceId (string) --

              The ID of a choice.

            • Status (string) --

              The status of a choice.

            • Reason (string) --

              The reason why a choice is non-applicable to a question in your workload.

        • IsApplicable (boolean) --

          Defines whether this question is applicable to a lens review.

        • Risk (string) --

          The risk for a given workload, lens review, pillar, or question.

        • Reason (string) --

          The reason why a choice is non-applicable to a question in your workload.

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_lens_review_improvements(**kwargs)

List lens review improvements.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • PillarId (string) --

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

    A pillar is identified by its PillarReviewSummary$PillarId .

  • MilestoneNumber (integer) --

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensAlias': 'string',
    'ImprovementSummaries': [
        {
            'QuestionId': 'string',
            'PillarId': 'string',
            'QuestionTitle': 'string',
            'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
            'ImprovementPlanUrl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Output of a list lens review improvements call.

    • WorkloadId (string) --

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

    • MilestoneNumber (integer) --

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensAlias (string) --

      The alias of the lens, for example, serverless .

      Each lens is identified by its LensSummary$LensAlias .

    • ImprovementSummaries (list) --

      List of improvement summaries of lens review in a workload.

      • (dict) --

        An improvement summary of a lens review in a workload.

        • QuestionId (string) --

          The ID of the question.

        • PillarId (string) --

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

          A pillar is identified by its PillarReviewSummary$PillarId .

        • QuestionTitle (string) --

          The title of the question.

        • Risk (string) --

          The risk for a given workload, lens review, pillar, or question.

        • ImprovementPlanUrl (string) --

          The improvement plan URL for a question.

          This value is only available if the question has been answered.

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_lens_reviews(**kwargs)

List lens reviews.

See also: AWS API Documentation

Request Syntax

response = client.list_lens_reviews(
    WorkloadId='string',
    MilestoneNumber=123,
    NextToken='string',
    MaxResults=123
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • MilestoneNumber (integer) --

    The milestone number.

    A workload can have a maximum of 100 milestones.

  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'MilestoneNumber': 123,
    'LensReviewSummaries': [
        {
            'LensAlias': 'string',
            'LensVersion': 'string',
            'LensName': 'string',
            'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED',
            'UpdatedAt': datetime(2015, 1, 1),
            'RiskCounts': {
                'string': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Output of a list lens reviews call.

    • WorkloadId (string) --

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

    • MilestoneNumber (integer) --

      The milestone number.

      A workload can have a maximum of 100 milestones.

    • LensReviewSummaries (list) --

      List of lens summaries of lens reviews of a workload.

      • (dict) --

        A lens review summary of a workload.

        • LensAlias (string) --

          The alias of the lens, for example, serverless .

          Each lens is identified by its LensSummary$LensAlias .

        • LensVersion (string) --

          The version of the lens.

        • LensName (string) --

          The full name of the lens.

        • LensStatus (string) --

          The status of the lens.

        • UpdatedAt (datetime) --

          The date and time recorded.

        • RiskCounts (dict) --

          A map from risk names to the count of how questions have that rating.

          • (string) --

            The risk for a given workload, lens review, pillar, or question.

            • (integer) --

              A non-negative integer that denotes how many.

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_lenses(**kwargs)

List the available lenses.

See also: AWS API Documentation

Request Syntax

response = client.list_lenses(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

{
    'LensSummaries': [
        {
            'LensAlias': 'string',
            'LensVersion': 'string',
            'LensName': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Output of a list lenses call.

    • LensSummaries (list) --

      List of lens summaries of available lenses.

      • (dict) --

        A lens summary of a lens.

        • LensAlias (string) --

          The alias of the lens, for example, serverless .

          Each lens is identified by its LensSummary$LensAlias .

        • LensVersion (string) --

          The version of the lens.

        • LensName (string) --

          The full name of the lens.

        • Description (string) --

          The description of the lens.

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_milestones(**kwargs)

List all milestones for an existing workload.

See also: AWS API Documentation

Request Syntax

response = client.list_milestones(
    WorkloadId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Output of a list milestones call.

    • WorkloadId (string) --

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

    • MilestoneSummaries (list) --

      A list of milestone summaries.

      • (dict) --

        A milestone summary return object.

        • MilestoneNumber (integer) --

          The milestone number.

          A workload can have a maximum of 100 milestones.

        • MilestoneName (string) --

          The name of the milestone in a workload.

          Milestone names must be unique within a workload.

        • RecordedAt (datetime) --

          The date and time recorded.

        • WorkloadSummary (dict) --

          A workload summary return object.

          • WorkloadId (string) --

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

          • WorkloadArn (string) --

            The ARN for the workload.

          • WorkloadName (string) --

            The name of the workload.

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

          • Owner (string) --

            An AWS account ID.

          • UpdatedAt (datetime) --

            The date and time recorded.

          • Lenses (list) --

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

            • (string) --

              The alias of the lens, for example, serverless .

              Each lens is identified by its LensSummary$LensAlias .

          • RiskCounts (dict) --

            A map from risk names to the count of how questions have that rating.

            • (string) --

              The risk for a given workload, lens review, pillar, or question.

              • (integer) --

                A non-negative integer that denotes how many.

          • ImprovementStatus (string) --

            The improvement status for a workload.

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_notifications(**kwargs)

List lens notifications.

See also: AWS API Documentation

Request Syntax

response = client.list_notifications(
    WorkloadId='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • WorkloadId (string) -- The ID assigned to the workload. This ID is unique within an AWS Region.
  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • NotificationSummaries (list) --

      List of lens notification summaries in a workload.

      • (dict) --

        A notification summary return object.

        • Type (string) --

          The type of notification.

        • LensUpgradeSummary (dict) --

          Summary of lens upgrade.

          • WorkloadId (string) --

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

          • WorkloadName (string) --

            The name of the workload.

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

          • LensAlias (string) --

            The alias of the lens, for example, serverless .

            Each lens is identified by its LensSummary$LensAlias .

          • CurrentLensVersion (string) --

            The current version of the lens.

          • LatestLensVersion (string) --

            The latest version of the lens.

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_share_invitations(**kwargs)

List the workload invitations.

See also: AWS API Documentation

Request Syntax

response = client.list_share_invitations(
    WorkloadNamePrefix='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • WorkloadNamePrefix (string) -- An optional string added to the beginning of each workload name returned in the results.
  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

{
    'ShareInvitationSummaries': [
        {
            'ShareInvitationId': 'string',
            'SharedBy': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'WorkloadName': 'string',
            'WorkloadId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Input for List Share Invitations

    • ShareInvitationSummaries (list) --

      List of share invitation summaries in a workload.

      • (dict) --

        A share invitation summary return object.

        • ShareInvitationId (string) --

          The ID assigned to the share invitation.

        • SharedBy (string) --

          An AWS account ID.

        • SharedWith (string) --

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

        • PermissionType (string) --

          Permission granted on a workload share.

        • WorkloadName (string) --

          The name of the workload.

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

        • WorkloadId (string) --

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

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_tags_for_resource(**kwargs)

List the tags for a resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    WorkloadArn='string'
)
Parameters
WorkloadArn (string) --

[REQUIRED]

The ARN for the workload.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The tags for the resource.

      • (string) --
        • (string) --

Exceptions

  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
list_workload_shares(**kwargs)

List the workload shares associated with the workload.

See also: AWS API Documentation

Request Syntax

response = client.list_workload_shares(
    WorkloadId='string',
    SharedWithPrefix='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • SharedWithPrefix (string) -- The AWS account ID or IAM role with which the workload is shared.
  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Input for List Workload Share

    • WorkloadId (string) --

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

    • WorkloadShareSummaries (list) --

      A list of workload share summaries.

      • (dict) --

        A workload share summary return object.

        • ShareId (string) --

          The ID associated with the workload share.

        • SharedWith (string) --

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

        • PermissionType (string) --

          Permission granted on a workload share.

        • Status (string) --

          The status of a workload share.

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
list_workloads(**kwargs)

List workloads. Paginated.

See also: AWS API Documentation

Request Syntax

response = client.list_workloads(
    WorkloadNamePrefix='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • WorkloadNamePrefix (string) -- An optional string added to the beginning of each workload name returned in the results.
  • NextToken (string) -- The token to use to retrieve the next set of results.
  • MaxResults (integer) -- The maximum number of results to return for this request.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Output of a list workloads call.

    • WorkloadSummaries (list) --

      A list of workload summaries.

      • (dict) --

        A workload summary return object.

        • WorkloadId (string) --

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

        • WorkloadArn (string) --

          The ARN for the workload.

        • WorkloadName (string) --

          The name of the workload.

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

        • Owner (string) --

          An AWS account ID.

        • UpdatedAt (datetime) --

          The date and time recorded.

        • Lenses (list) --

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

          • (string) --

            The alias of the lens, for example, serverless .

            Each lens is identified by its LensSummary$LensAlias .

        • RiskCounts (dict) --

          A map from risk names to the count of how questions have that rating.

          • (string) --

            The risk for a given workload, lens review, pillar, or question.

            • (integer) --

              A non-negative integer that denotes how many.

        • ImprovementStatus (string) --

          The improvement status for a workload.

    • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
tag_resource(**kwargs)

Adds one or more tags to the specified resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    WorkloadArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • WorkloadArn (string) --

    [REQUIRED]

    The ARN for the workload.

  • Tags (dict) --

    [REQUIRED]

    The tags for the resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
untag_resource(**kwargs)

Deletes specified tags from a resource.

To specify multiple tags, use separate tagKeys parameters, for example:

DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    WorkloadArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • WorkloadArn (string) --

    [REQUIRED]

    The ARN for the workload.

  • TagKeys (list) --

    [REQUIRED]

    A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
update_answer(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • QuestionId (string) --

    [REQUIRED]

    The ID of the question.

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

  • ChoiceUpdates (dict) --

    A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.

    • (string) --

      The ID of a choice.

      • (dict) --

        A list of choices to be updated.

        • Status (string) -- [REQUIRED]

          The status of a choice.

        • Reason (string) --

          The reason why a choice is non-applicable to a question in your workload.

        • Notes (string) --

          The notes associated with a choice.

  • Notes (string) -- The notes associated with the workload.
  • IsApplicable (boolean) -- Defines whether this question is applicable to a lens review.
  • Reason (string) -- The reason why a question is not applicable to your workload.
Return type

dict

Returns

Response Syntax

{
    'WorkloadId': 'string',
    'LensAlias': 'string',
    'Answer': {
        'QuestionId': 'string',
        'PillarId': 'string',
        'QuestionTitle': 'string',
        'QuestionDescription': 'string',
        'ImprovementPlanUrl': 'string',
        'HelpfulResourceUrl': 'string',
        'Choices': [
            {
                'ChoiceId': 'string',
                'Title': 'string',
                'Description': 'string'
            },
        ],
        'SelectedChoices': [
            'string',
        ],
        'ChoiceAnswers': [
            {
                'ChoiceId': 'string',
                'Status': 'SELECTED'|'NOT_APPLICABLE'|'UNSELECTED',
                'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE',
                'Notes': 'string'
            },
        ],
        'IsApplicable': True|False,
        'Risk': 'UNANSWERED'|'HIGH'|'MEDIUM'|'NONE'|'NOT_APPLICABLE',
        'Notes': 'string',
        'Reason': 'OUT_OF_SCOPE'|'BUSINESS_PRIORITIES'|'ARCHITECTURE_CONSTRAINTS'|'OTHER'|'NONE'
    }
}

Response Structure

  • (dict) --

    Output of a update answer call.

    • WorkloadId (string) --

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

    • LensAlias (string) --

      The alias of the lens, for example, serverless .

      Each lens is identified by its LensSummary$LensAlias .

    • Answer (dict) --

      An answer of the question.

      • QuestionId (string) --

        The ID of the question.

      • PillarId (string) --

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

        A pillar is identified by its PillarReviewSummary$PillarId .

      • QuestionTitle (string) --

        The title of the question.

      • QuestionDescription (string) --

        The description of the question.

      • ImprovementPlanUrl (string) --

        The improvement plan URL for a question.

        This value is only available if the question has been answered.

      • HelpfulResourceUrl (string) --

        The helpful resource URL for a question.

      • Choices (list) --

        List of choices available for a question.

        • (dict) --

          A choice available to answer question.

          • ChoiceId (string) --

            The ID of a choice.

          • Title (string) --

            The title of a choice.

          • Description (string) --

            The description of a choice.

      • SelectedChoices (list) --

        List of selected choice IDs in a question answer.

        The values entered replace the previously selected choices.

        • (string) --

          The ID of a choice.

      • ChoiceAnswers (list) --

        A list of selected choices to a question in your workload.

        • (dict) --

          A choice that has been answered on a question in your workload.

          • ChoiceId (string) --

            The ID of a choice.

          • Status (string) --

            The status of a choice.

          • Reason (string) --

            The reason why a choice is non-applicable to a question in your workload.

          • Notes (string) --

            The notes associated with a choice.

      • IsApplicable (boolean) --

        Defines whether this question is applicable to a lens review.

      • Risk (string) --

        The risk for a given workload, lens review, pillar, or question.

      • Notes (string) --

        The notes associated with the workload.

      • Reason (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
update_lens_review(**kwargs)

Update lens review.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

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

  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • LensNotes (string) -- The notes associated with the workload.
  • PillarNotes (dict) --

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

    • (string) --

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

      A pillar is identified by its PillarReviewSummary$PillarId .

      • (string) --

        The notes associated with the workload.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Output of a update lens review call.

    • WorkloadId (string) --

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

    • LensReview (dict) --

      A lens review of a question.

      • LensAlias (string) --

        The alias of the lens, for example, serverless .

        Each lens is identified by its LensSummary$LensAlias .

      • LensVersion (string) --

        The version of the lens.

      • LensName (string) --

        The full name of the lens.

      • LensStatus (string) --

        The status of the lens.

      • PillarReviewSummaries (list) --

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

        • (dict) --

          A pillar review summary of a lens review.

          • PillarId (string) --

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

            A pillar is identified by its PillarReviewSummary$PillarId .

          • PillarName (string) --

            The name of the pillar.

          • Notes (string) --

            The notes associated with the workload.

          • RiskCounts (dict) --

            A map from risk names to the count of how questions have that rating.

            • (string) --

              The risk for a given workload, lens review, pillar, or question.

              • (integer) --

                A non-negative integer that denotes how many.

      • UpdatedAt (datetime) --

        The date and time recorded.

      • Notes (string) --

        The notes associated with the workload.

      • RiskCounts (dict) --

        A map from risk names to the count of how questions have that rating.

        • (string) --

          The risk for a given workload, lens review, pillar, or question.

          • (integer) --

            A non-negative integer that denotes how many.

      • NextToken (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
update_share_invitation(**kwargs)

Update a workload invitation.

See also: AWS API Documentation

Request Syntax

response = client.update_share_invitation(
    ShareInvitationId='string',
    ShareInvitationAction='ACCEPT'|'REJECT'
)
Parameters
  • ShareInvitationId (string) --

    [REQUIRED]

    The ID assigned to the share invitation.

  • ShareInvitationAction (string) --

    [REQUIRED]

    Share invitation action taken by contributor.

Return type

dict

Returns

Response Syntax

{
    'ShareInvitation': {
        'ShareInvitationId': 'string',
        'WorkloadId': 'string'
    }
}

Response Structure

  • (dict) --

    • ShareInvitation (dict) --

      The updated workload share invitation.

      • ShareInvitationId (string) --

        The ID assigned to the share invitation.

      • WorkloadId (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
update_workload(**kwargs)

Update an existing workload.

See also: AWS API Documentation

Request Syntax

response = 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'
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • WorkloadName (string) --

    The name of the workload.

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

  • Description (string) -- The description for the workload.
  • Environment (string) -- The environment for the workload.
  • AccountIds (list) --

    The list of AWS account IDs associated with the workload.

    • (string) --

      An AWS account ID.

  • AwsRegions (list) --

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

    • (string) --

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

  • NonAwsRegions (list) --

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

    • (string) --
  • 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 .

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

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

Response Structure

  • (dict) --

    Output of an update workload call.

    • Workload (dict) --

      A workload return object.

      • WorkloadId (string) --

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

      • WorkloadArn (string) --

        The ARN for the workload.

      • WorkloadName (string) --

        The name of the workload.

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

      • Description (string) --

        The description for the workload.

      • Environment (string) --

        The environment for the workload.

      • UpdatedAt (datetime) --

        The date and time recorded.

      • AccountIds (list) --

        The list of AWS account IDs associated with the workload.

        • (string) --

          An AWS account ID.

      • AwsRegions (list) --

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

        • (string) --

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

      • NonAwsRegions (list) --

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

        • (string) --
      • ArchitecturalDesign (string) --

        The URL of the architectural design for the workload.

      • ReviewOwner (string) --

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

      • ReviewRestrictionDate (datetime) --

        The date and time recorded.

      • IsReviewOwnerUpdateAcknowledged (boolean) --

        Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

        If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

      • IndustryType (string) --

        The industry type for the workload.

        If specified, must be one of the following:

        • Agriculture
        • Automobile
        • Defense
        • Design and Engineering
        • Digital Advertising
        • Education
        • Environmental Protection
        • Financial Services
        • Gaming
        • General Public Services
        • Healthcare
        • Hospitality
        • InfoTech
        • Justice and Public Safety
        • Life Sciences
        • Manufacturing
        • Media & Entertainment
        • Mining & Resources
        • Oil & Gas
        • Power & Utilities
        • Professional Services
        • Real Estate & Construction
        • Retail & Wholesale
        • Social Protection
        • Telecommunications
        • Travel, Transportation & Logistics
        • Other
      • Industry (string) --

        The industry for the workload.

      • Notes (string) --

        The notes associated with the workload.

      • ImprovementStatus (string) --

        The improvement status for a workload.

      • RiskCounts (dict) --

        A map from risk names to the count of how questions have that rating.

        • (string) --

          The risk for a given workload, lens review, pillar, or question.

          • (integer) --

            A non-negative integer that denotes how many.

      • PillarPriorities (list) --

        The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId .

        • (string) --

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

          A pillar is identified by its PillarReviewSummary$PillarId .

      • Lenses (list) --

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

        • (string) --

          The alias of the lens, for example, serverless .

          Each lens is identified by its LensSummary$LensAlias .

      • Owner (string) --

        An AWS account ID.

      • ShareInvitationId (string) --

        The ID assigned to the share invitation.

      • Tags (dict) --

        The tags associated with the workload.

        • (string) --
          • (string) --

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
update_workload_share(**kwargs)

Update a workload share.

See also: AWS API Documentation

Request Syntax

response = client.update_workload_share(
    ShareId='string',
    WorkloadId='string',
    PermissionType='READONLY'|'CONTRIBUTOR'
)
Parameters
  • ShareId (string) --

    [REQUIRED]

    The ID associated with the workload share.

  • WorkloadId (string) --

    [REQUIRED]

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

  • PermissionType (string) --

    [REQUIRED]

    Permission granted on a workload share.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    Input for Update Workload Share

    • WorkloadId (string) --

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

    • WorkloadShare (dict) --

      A workload share return object.

      • ShareId (string) --

        The ID associated with the workload share.

      • SharedBy (string) --

        An AWS account ID.

      • SharedWith (string) --

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

      • PermissionType (string) --

        Permission granted on a workload share.

      • Status (string) --

        The status of a workload share.

      • WorkloadName (string) --

        The name of the workload.

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

      • WorkloadId (string) --

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

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException
upgrade_lens_review(**kwargs)

Upgrade lens review.

See also: AWS API Documentation

Request Syntax

response = client.upgrade_lens_review(
    WorkloadId='string',
    LensAlias='string',
    MilestoneName='string',
    ClientRequestToken='string'
)
Parameters
  • WorkloadId (string) --

    [REQUIRED]

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

  • LensAlias (string) --

    [REQUIRED]

    The alias of the lens, for example, serverless .

    Each lens is identified by its LensSummary$LensAlias .

  • MilestoneName (string) --

    [REQUIRED]

    The name of the milestone in a workload.

    Milestone names must be unique within a workload.

  • ClientRequestToken (string) --

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

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

    Warning

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

Returns

None

Exceptions

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.ConflictException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException

Paginators

The available paginators are: