Workload - AWS Well-Architected Tool

Workload

A workload return object.

Contents

AccountIds

The list of AWS account IDs associated with the workload.

Type: Array of strings

Array Members: Maximum number of 100 items.

Pattern: [0-9]{12}

Required: No

ArchitecturalDesign

The URL of the architectural design for the workload.

Type: String

Length Constraints: Maximum length of 2048.

Required: No

AwsRegions

The list of AWS Regions associated with the workload, for example, us-east-2, or ca-central-1.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Maximum length of 100.

Required: No

Description

The description for the workload.

Type: String

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

Required: No

Environment

The environment for the workload.

Type: String

Valid Values: PRODUCTION | PREPRODUCTION

Required: No

ImprovementStatus

The improvement status for a workload.

Type: String

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

Required: No

Industry

The industry for the workload.

Type: String

Length Constraints: Maximum length of 100.

Required: No

IndustryType

The industry type for the workload.

If specified, must be one of the following:

  • Agriculture

  • Automobile

  • Defense

  • Design and Engineering

  • Digital Advertising

  • Education

  • Environmental Protection

  • Financial Services

  • Gaming

  • General Public Services

  • Healthcare

  • Hospitality

  • InfoTech

  • Justice and Public Safety

  • Life Sciences

  • Manufacturing

  • Media & Entertainment

  • Mining & Resources

  • Oil & Gas

  • Power & Utilities

  • Professional Services

  • Real Estate & Construction

  • Retail & Wholesale

  • Social Protection

  • Telecommunications

  • Travel, Transportation & Logistics

  • Other

Type: String

Length Constraints: Maximum length of 100.

Required: No

IsReviewOwnerUpdateAcknowledged

Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

Type: Boolean

Required: No

Lenses

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

Type: Array of strings

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

Required: No

NonAwsRegions

The list of non-AWS Regions associated with the workload.

Type: Array of strings

Array Members: Maximum number of 5 items.

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

Required: No

Notes

The notes associated with the workload.

Type: String

Length Constraints: Maximum length of 2084.

Required: No

Owner

An AWS account ID.

Type: String

Pattern: [0-9]{12}

Required: No

PillarPriorities

The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary:PillarId.

Type: Array of strings

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

Required: No

ReviewOwner

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

Type: String

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

Required: No

ReviewRestrictionDate

The date and time recorded.

Type: Timestamp

Required: No

RiskCounts

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

ShareInvitationId

The ID assigned to the share invitation.

Type: String

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

Required: No

Tags

The tags associated with the workload.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

UpdatedAt

The date and time recorded.

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

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: