Update an existing workload¶

Description¶

Update an existing workload.

Usage¶

wellarchitected_update_workload(WorkloadId, WorkloadName, Description,
  Environment, AccountIds, AwsRegions, NonAwsRegions, PillarPriorities,
  ArchitecturalDesign, ReviewOwner, IsReviewOwnerUpdateAcknowledged,
  IndustryType, Industry, Notes, ImprovementStatus, DiscoveryConfig,
  Applications, JiraConfiguration)

Arguments¶

WorkloadId

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

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

The description for the workload.
Environment

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

The improvement status for a workload.
DiscoveryConfig

Well-Architected discovery configuration settings to associate to the workload.
Applications

List of AppRegistry application ARNs to associate to the workload.
JiraConfiguration

Configuration of the Jira integration.

Value¶

A list with the following syntax:

list(
  Workload = list(
    WorkloadId = "string",
    WorkloadArn = "string",
    WorkloadName = "string",
    Description = "string",
    Environment = "PRODUCTION"|"PREPRODUCTION",
    UpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    AccountIds = list(
      "string"
    ),
    AwsRegions = list(
      "string"
    ),
    NonAwsRegions = list(
      "string"
    ),
    ArchitecturalDesign = "string",
    ReviewOwner = "string",
    ReviewRestrictionDate = as.POSIXct(
      "2015-01-01"
    ),
    IsReviewOwnerUpdateAcknowledged = TRUE|FALSE,
    IndustryType = "string",
    Industry = "string",
    Notes = "string",
    ImprovementStatus = "NOT_APPLICABLE"|"NOT_STARTED"|"IN_PROGRESS"|"COMPLETE"|"RISK_ACKNOWLEDGED",
    RiskCounts = list(
      123
    ),
    PillarPriorities = list(
      "string"
    ),
    Lenses = list(
      "string"
    ),
    Owner = "string",
    ShareInvitationId = "string",
    Tags = list(
      "string"
    ),
    DiscoveryConfig = list(
      TrustedAdvisorIntegrationStatus = "ENABLED"|"DISABLED",
      WorkloadResourceDefinition = list(
        "WORKLOAD_METADATA"|"APP_REGISTRY"
      )
    ),
    Applications = list(
      "string"
    ),
    Profiles = list(
      list(
        ProfileArn = "string",
        ProfileVersion = "string"
      )
    ),
    PrioritizedRiskCounts = list(
      123
    ),
    JiraConfiguration = list(
      IssueManagementStatus = "ENABLED"|"DISABLED"|"INHERIT",
      IssueManagementType = "AUTO"|"MANUAL",
      JiraProjectKey = "string",
      StatusMessage = "string"
    )
  )
)

Request syntax¶

svc$update_workload(
  WorkloadId = "string",
  WorkloadName = "string",
  Description = "string",
  Environment = "PRODUCTION"|"PREPRODUCTION",
  AccountIds = list(
    "string"
  ),
  AwsRegions = list(
    "string"
  ),
  NonAwsRegions = list(
    "string"
  ),
  PillarPriorities = list(
    "string"
  ),
  ArchitecturalDesign = "string",
  ReviewOwner = "string",
  IsReviewOwnerUpdateAcknowledged = TRUE|FALSE,
  IndustryType = "string",
  Industry = "string",
  Notes = "string",
  ImprovementStatus = "NOT_APPLICABLE"|"NOT_STARTED"|"IN_PROGRESS"|"COMPLETE"|"RISK_ACKNOWLEDGED",
  DiscoveryConfig = list(
    TrustedAdvisorIntegrationStatus = "ENABLED"|"DISABLED",
    WorkloadResourceDefinition = list(
      "WORKLOAD_METADATA"|"APP_REGISTRY"
    )
  ),
  Applications = list(
    "string"
  ),
  JiraConfiguration = list(
    IssueManagementStatus = "ENABLED"|"DISABLED"|"INHERIT",
    IssueManagementType = "AUTO"|"MANUAL",
    JiraProjectKey = "string"
  )
)