WorkloadSummary - AWS Well-Architected Tool

WorkloadSummary

A workload summary return object.

Contents

ImprovementStatus

The improvement status for a workload.

Type: String

Valid Values: NOT_APPLICABLE | NOT_STARTED | IN_PROGRESS | COMPLETE | RISK_ACKNOWLEDGED

Required: No

Lenses

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

If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

Owner

An AWS account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

PrioritizedRiskCounts

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

Type: String to integer map

Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE

Valid Range: Minimum value of 0.

Required: No

Profiles

Profile associated with a workload.

Type: Array of WorkloadProfile objects

Array Members: Maximum number of 1 item.

Required: No

RiskCounts

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

Type: String to integer map

Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE

Valid Range: Minimum value of 0.

Required: No

UpdatedAt

The date and time recorded in Unix format (seconds).

Type: Timestamp

Required: No

WorkloadArn

The ARN for the workload.

Type: String

Required: No

WorkloadId

The ID assigned to the workload. This ID is unique within an AWS Region.

Type: String

Length Constraints: Fixed length of 32.

Pattern: [0-9a-f]{32}

Required: No

WorkloadName

The name of the workload.

The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: