Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wellarchitected ]



List workloads. Paginated.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--workload-name-prefix <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--workload-name-prefix (string)

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

--next-token (string)

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

--max-results (integer)

The maximum number of results to return for this request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


WorkloadSummaries -> (list)

A list of workload summaries.


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

The date and time recorded.

Lenses -> (list)

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


The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias .

RiskCounts -> (map)

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

key -> (string)

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

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