AWS CLI Command Reference

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 ]

get-consolidated-report

Description

Get a consolidated report of your workloads.

You can optionally choose to include workloads that have been shared with you.

See also: AWS API Documentation

Synopsis

  get-consolidated-report
--format <value>
[--include-shared-resources | --no-include-shared-resources]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--format (string)

The format of the consolidated report.

For PDF , Base64String is returned. For JSON , Metrics is returned.

Possible values:

  • PDF
  • JSON

--include-shared-resources | --no-include-shared-resources (boolean)

Set to true to have shared resources included in the report.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

Metrics -> (list)

The metrics that make up the consolidated report.

Only returned when JSON format is requested.

(structure)

A metric that contributes to the consolidated report.

MetricType -> (string)

The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.

RiskCounts -> (map)

A map from risk names to the count of how many 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.

WorkloadId -> (string)

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

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.

WorkloadArn -> (string)

The ARN for the workload.

UpdatedAt -> (timestamp)

The date and time recorded.

Lenses -> (list)

The metrics for the lenses in the workload.

(structure)

A metric for a particular lens in a workload.

LensArn -> (string)

The lens ARN.

Pillars -> (list)

The metrics for the pillars in a lens.

(structure)

A metric for a particular pillar in a lens.

PillarId -> (string)

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

A pillar is identified by its PillarReviewSummary$PillarId .

RiskCounts -> (map)

A map from risk names to the count of how many 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.

Questions -> (list)

The questions that have been identified as risks in the pillar.

(structure)

A metric for a particular question in the pillar.

QuestionId -> (string)

The ID of the question.

Risk -> (string)

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

BestPractices -> (list)

The best practices, or choices, that have been identified as contributing to risk in a question.

(structure)

A best practice, or question choice, that has been identified as a risk in this question.

ChoiceId -> (string)

The ID of a choice.

ChoiceTitle -> (string)

The title of a choice.

RiskCounts -> (map)

A map from risk names to the count of how many 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.

LensesAppliedCount -> (integer)

The total number of lenses applied to the workload.

NextToken -> (string)

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

Base64String -> (string)

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

This data can be used to create a PDF file.

Only returned by GetConsolidatedReport when PDF format is requested.