WellArchitected / Client / create_milestone

create_milestone#

WellArchitected.Client.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 Amazon Web Services 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 the original request has completed successfully, the result of the original request is returned.

    Warning

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

    This field is autopopulated if not provided.

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 Amazon Web Services Region.

    • MilestoneNumber (integer) –

      The milestone number.

      A workload can have a maximum of 100 milestones.

Exceptions