Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface CreateWorkloadCommandInputProtected

The input for CreateWorkloadCommand.



AccountIds?: string[]

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

Applications?: string[]

List of AppRegistry application ARNs associated to the workload.

ArchitecturalDesign?: string

The URL of the architectural design for the workload.

AwsRegions?: string[]

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

ClientRequestToken?: 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 the original request 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: undefined | string

The description for the workload.

DiscoveryConfig?: WorkloadDiscoveryConfig

Well-Architected discovery configuration settings associated to the workload.

Environment: undefined | WorkloadEnvironment

The environment for the workload.

Industry?: string

The industry for the workload.

IndustryType?: 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: undefined | string[]

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.

NonAwsRegions?: string[]

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

Notes?: string

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

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.

ProfileArns?: string[]

The list of profile ARNs associated with the workload.

ReviewOwner?: 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.

ReviewTemplateArns?: string[]

The list of review template ARNs to associate with the workload.

Tags?: Record<string, string>

The tags to be associated with the workload.

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.