WellArchitected / Client / list_milestones

list_milestones#

WellArchitected.Client.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 Amazon Web Services 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',
                'Profiles': [
                    {
                        'ProfileArn': 'string',
                        'ProfileVersion': 'string'
                    },
                ],
                'PrioritizedRiskCounts': {
                    'string': 123
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Output of a list milestones call.

    • WorkloadId (string) –

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

    • MilestoneSummaries (list) –

      A list of milestone summaries.

      • (dict) –

        A milestone summary return object.

        • MilestoneNumber (integer) –

          The milestone number.

          A workload can have a maximum of 100 milestones.

        • MilestoneName (string) –

          The name of the milestone in a workload.

          Milestone names must be unique within a workload.

        • RecordedAt (datetime) –

          The date and time recorded.

        • WorkloadSummary (dict) –

          A workload summary return object.

          • WorkloadId (string) –

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

          • WorkloadArn (string) –

            The ARN for the workload.

          • WorkloadName (string) –

            The name of the workload.

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

          • Owner (string) –

            An Amazon Web Services account ID.

          • UpdatedAt (datetime) –

            The date and time recorded.

          • Lenses (list) –

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

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

            • (string) –

              The alias of the lens.

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

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

              Each lens is identified by its LensSummary$LensAlias.

          • RiskCounts (dict) –

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

            • (string) –

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

              • (integer) –

                A non-negative integer that denotes how many.

          • ImprovementStatus (string) –

            The improvement status for a workload.

          • Profiles (list) –

            Profile associated with a workload.

            • (dict) –

              The profile associated with a workload.

              • ProfileArn (string) –

                The profile ARN.

              • ProfileVersion (string) –

                The profile version.

          • PrioritizedRiskCounts (dict) –

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

            • (string) –

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

              • (integer) –

                A non-negative integer that denotes how many.

    • NextToken (string) –

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

Exceptions