milestones

Creates, updates, deletes, gets or lists a milestones resource.

Overview

Name	milestones
Type	Resource
Id	aws.wellarchitected.milestones

Fields

The following fields are returned by SELECT queries:

get_milestone

Name	Datatype	Description
milestone	object	A milestone return object.
workload_id	string	The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. (pattern: <code>[0-9a-f]{32}</code>)

list_milestones

Name	Datatype	Description
milestone_summaries	array	A list of milestone summaries.
next_token	string	The token to use to retrieve the next set of results. (pattern: <code>[A-Za-z0-9+/=_-]+</code>)
workload_id	string	The ID assigned to the workload. This ID is unique within an Amazon Web Services Region. (pattern: <code>[0-9a-f]{32}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_milestone	select	workload_id, milestone_number, region		Get a milestone for an existing workload.
list_milestones	select	workload_id, region		List all milestones for an existing workload.
create_milestone	insert	workload_id, region, MilestoneName, ClientRequestToken		Create a milestone for an existing workload.
upgrade_lens_review	exec	workload_id, lens_alias, region, MilestoneName		Upgrade lens review for a particular workload.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
lens_alias	string
milestone_number	integer
region	string	AWS region (default: us-east-1)
workload_id	string

SELECT examples

get_milestone

Get a milestone for an existing workload.

SELECT
milestone,
workload_id
FROM aws.wellarchitected.milestones
WHERE workload_id = '{{ workload_id }}' -- required
AND milestone_number = '{{ milestone_number }}' -- required
AND region = '{{ region }}' -- required
;

list_milestones

List all milestones for an existing workload.

SELECT
milestone_summaries,
next_token,
workload_id
FROM aws.wellarchitected.milestones
WHERE workload_id = '{{ workload_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_milestone

Create a milestone for an existing workload.

INSERT INTO aws.wellarchitected.milestones (
MilestoneName,
ClientRequestToken,
workload_id,
region
)
SELECT 
'{{ MilestoneName }}' /* required */,
'{{ ClientRequestToken }}' /* required */,
'{{ workload_id }}',
'{{ region }}'
RETURNING
milestone_number,
workload_id
;

Manifest

# Description fields are for documentation purposes
- name: milestones
props:
  - name: workload_id
    value: "{{ workload_id }}"
    description: Required parameter for the milestones resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the milestones resource.
  - name: MilestoneName
    value: "{{ MilestoneName }}"
    description: |
      The name of the milestone in a workload. Milestone names must be unique within a workload.
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      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. 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.

Lifecycle Methods

upgrade_lens_review

Upgrade lens review for a particular workload.

EXEC aws.wellarchitected.milestones.upgrade_lens_review 
@workload_id='{{ workload_id }}' --required, 
@lens_alias='{{ lens_alias }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"MilestoneName": "{{ MilestoneName }}", 
"ClientRequestToken": "{{ ClientRequestToken }}"
}'
;