[ 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 | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

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.