Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Workload

A workload return object.

Hierarchy

  • Workload

Index

Properties

Optional AccountIds

AccountIds: string[]

The list of Amazon Web Services account IDs associated with the workload.

Optional ArchitecturalDesign

ArchitecturalDesign: undefined | string

The URL of the architectural design for the workload.

Optional AwsRegions

AwsRegions: string[]

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

Optional Description

Description: undefined | string

The description for the workload.

Optional Environment

Environment: WorkloadEnvironment | string

The environment for the workload.

Optional ImprovementStatus

ImprovementStatus: WorkloadImprovementStatus | string

The improvement status for a workload.

Optional Industry

Industry: undefined | string

The industry for the workload.

Optional IndustryType

IndustryType: undefined | string

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

Optional IsReviewOwnerUpdateAcknowledged

IsReviewOwnerUpdateAcknowledged: undefined | false | true

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.

Optional Lenses

Lenses: string[]

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

Optional NonAwsRegions

NonAwsRegions: string[]

The list of non-Amazon Web Services Regions associated with the workload.

Optional Notes

Notes: undefined | string

The notes associated with the workload.

Optional Owner

Owner: undefined | string

An Amazon Web Services account ID.

Optional PillarPriorities

PillarPriorities: string[]

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

Optional ReviewOwner

ReviewOwner: undefined | string

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

Optional ReviewRestrictionDate

ReviewRestrictionDate: Date

The date and time recorded.

Optional RiskCounts

RiskCounts: Record<string, number>

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

Optional ShareInvitationId

ShareInvitationId: undefined | string

The ID assigned to the share invitation.

Optional Tags

Tags: Record<string, string>

The tags associated with the workload.

Optional UpdatedAt

UpdatedAt: Date

The date and time recorded.

Optional WorkloadArn

WorkloadArn: undefined | string

The ARN for the workload.

Optional WorkloadId

WorkloadId: undefined | string

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

Optional WorkloadName

WorkloadName: undefined | 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.