Create a new workload¶

Description¶

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the Well-Architected Tool User Guide.

Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.

You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.

When creating a workload using a review template, you must have the following IAM permissions:

• wellarchitected:GetReviewTemplate
• wellarchitected:GetReviewTemplateAnswer
• wellarchitected:ListReviewTemplateAnswers
• wellarchitected:GetReviewTemplateLensReview

Usage¶

wellarchitected_create_workload(WorkloadName, Description, Environment,
  AccountIds, AwsRegions, NonAwsRegions, PillarPriorities,
  ArchitecturalDesign, ReviewOwner, IndustryType, Industry, Lenses, Notes,
  ClientRequestToken, Tags, DiscoveryConfig, Applications, ProfileArns,
  ReviewTemplateArns, JiraConfiguration)

Arguments¶

• WorkloadName

  [required] 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.

• Description

  [required] The description for the workload.

• Environment

  [required] The environment for the workload.

• AccountIds

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

• AwsRegions

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

• NonAwsRegions

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

• PillarPriorities

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

• ArchitecturalDesign

  The URL of the architectural design for the workload.

• 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.

• 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

• Industry

  The industry for the workload.

• Lenses

  [required] 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.

• Notes

  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.

• ClientRequestToken

  [required] 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.

• Tags

  The tags to be associated with the workload.

• DiscoveryConfig

  Well-Architected discovery configuration settings associated to the workload.

• Applications

  List of AppRegistry application ARNs associated to the workload.

• ProfileArns

  The list of profile ARNs associated with the workload.

• ReviewTemplateArns

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

• JiraConfiguration

  Jira configuration settings when creating a workload.

Value¶

A list with the following syntax:

list(
  WorkloadId = "string",
  WorkloadArn = "string"
)

Request syntax¶

svc$create_workload(
  WorkloadName = "string",
  Description = "string",
  Environment = "PRODUCTION"|"PREPRODUCTION",
  AccountIds = list(
    "string"
  ),
  AwsRegions = list(
    "string"
  ),
  NonAwsRegions = list(
    "string"
  ),
  PillarPriorities = list(
    "string"
  ),
  ArchitecturalDesign = "string",
  ReviewOwner = "string",
  IndustryType = "string",
  Industry = "string",
  Lenses = list(
    "string"
  ),
  Notes = "string",
  ClientRequestToken = "string",
  Tags = list(
    "string"
  ),
  DiscoveryConfig = list(
    TrustedAdvisorIntegrationStatus = "ENABLED"|"DISABLED",
    WorkloadResourceDefinition = list(
      "WORKLOAD_METADATA"|"APP_REGISTRY"
    )
  ),
  Applications = list(
    "string"
  ),
  ProfileArns = list(
    "string"
  ),
  ReviewTemplateArns = list(
    "string"
  ),
  JiraConfiguration = list(
    IssueManagementStatus = "ENABLED"|"DISABLED"|"INHERIT",
    IssueManagementType = "AUTO"|"MANUAL",
    JiraProjectKey = "string"
  )
)