updateWorkload method

Future<UpdateWorkloadOutput> updateWorkload({
  1. required String workloadId,
  2. List<String>? accountIds,
  3. List<String>? applications,
  4. String? architecturalDesign,
  5. List<String>? awsRegions,
  6. String? description,
  7. WorkloadDiscoveryConfig? discoveryConfig,
  8. WorkloadEnvironment? environment,
  9. WorkloadImprovementStatus? improvementStatus,
  10. String? industry,
  11. String? industryType,
  12. bool? isReviewOwnerUpdateAcknowledged,
  13. WorkloadJiraConfigurationInput? jiraConfiguration,
  14. List<String>? nonAwsRegions,
  15. String? notes,
  16. List<String>? pillarPriorities,
  17. String? reviewOwner,
  18. String? workloadName,
})

Update an existing workload.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter applications : List of AppRegistry application ARNs to associate to the workload.

Parameter discoveryConfig : Well-Architected discovery configuration settings to associate to the workload.

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

Parameter jiraConfiguration : Configuration of the Jira integration.

Implementation

Future<UpdateWorkloadOutput> updateWorkload({
  required String workloadId,
  List<String>? accountIds,
  List<String>? applications,
  String? architecturalDesign,
  List<String>? awsRegions,
  String? description,
  WorkloadDiscoveryConfig? discoveryConfig,
  WorkloadEnvironment? environment,
  WorkloadImprovementStatus? improvementStatus,
  String? industry,
  String? industryType,
  bool? isReviewOwnerUpdateAcknowledged,
  WorkloadJiraConfigurationInput? jiraConfiguration,
  List<String>? nonAwsRegions,
  String? notes,
  List<String>? pillarPriorities,
  String? reviewOwner,
  String? workloadName,
}) async {
  final $payload = <String, dynamic>{
    if (accountIds != null) 'AccountIds': accountIds,
    if (applications != null) 'Applications': applications,
    if (architecturalDesign != null)
      'ArchitecturalDesign': architecturalDesign,
    if (awsRegions != null) 'AwsRegions': awsRegions,
    if (description != null) 'Description': description,
    if (discoveryConfig != null) 'DiscoveryConfig': discoveryConfig,
    if (environment != null) 'Environment': environment.value,
    if (improvementStatus != null)
      'ImprovementStatus': improvementStatus.value,
    if (industry != null) 'Industry': industry,
    if (industryType != null) 'IndustryType': industryType,
    if (isReviewOwnerUpdateAcknowledged != null)
      'IsReviewOwnerUpdateAcknowledged': isReviewOwnerUpdateAcknowledged,
    if (jiraConfiguration != null) 'JiraConfiguration': jiraConfiguration,
    if (nonAwsRegions != null) 'NonAwsRegions': nonAwsRegions,
    if (notes != null) 'Notes': notes,
    if (pillarPriorities != null) 'PillarPriorities': pillarPriorities,
    if (reviewOwner != null) 'ReviewOwner': reviewOwner,
    if (workloadName != null) 'WorkloadName': workloadName,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PATCH',
    requestUri: '/workloads/${Uri.encodeComponent(workloadId)}',
    exceptionFnMap: _exceptionFns,
  );
  return UpdateWorkloadOutput.fromJson(response);
}