• Public
  • Public/Protected
  • All

Interface CreateWorkloadInput

Input for workload creation.




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 ClientRequestToken

ClientRequestToken: undefined | string

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.


Description: string | undefined

The description for the workload.


Environment: WorkloadEnvironment | string | undefined

The environment for the 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


Lenses: string[] | undefined

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

Tags: Record<string, string>

The tags to be associated with the workload.


WorkloadName: string | undefined

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.