Get a consolidated report of your workloads¶

Description¶

Get a consolidated report of your workloads.

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

Usage¶

wellarchitected_get_consolidated_report(Format, IncludeSharedResources,
  NextToken, MaxResults)

Arguments¶

Format

[required] The format of the consolidated report.

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

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

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

The maximum number of results to return for this request.

Value¶

A list with the following syntax:

list(
  Metrics = list(
    list(
      MetricType = "WORKLOAD",
      RiskCounts = list(
        123
      ),
      WorkloadId = "string",
      WorkloadName = "string",
      WorkloadArn = "string",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Lenses = list(
        list(
          LensArn = "string",
          Pillars = list(
            list(
              PillarId = "string",
              RiskCounts = list(
                123
              ),
              Questions = list(
                list(
                  QuestionId = "string",
                  Risk = "UNANSWERED"|"HIGH"|"MEDIUM"|"NONE"|"NOT_APPLICABLE",
                  BestPractices = list(
                    list(
                      ChoiceId = "string",
                      ChoiceTitle = "string"
                    )
                  )
                )
              )
            )
          ),
          RiskCounts = list(
            123
          )
        )
      ),
      LensesAppliedCount = 123
    )
  ),
  NextToken = "string",
  Base64String = "string"
)

Request syntax¶

svc$get_consolidated_report(
  Format = "PDF"|"JSON",
  IncludeSharedResources = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)