Class: Aws::WellArchitected::Types::UpdateWorkloadInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb

Overview

Note:

When making an API call, you may pass UpdateWorkloadInput data as a hash:

{
  workload_id: "WorkloadId", # required
  workload_name: "WorkloadName",
  description: "WorkloadDescription",
  environment: "PRODUCTION", # accepts PRODUCTION, PREPRODUCTION
  account_ids: ["AwsAccountId"],
  aws_regions: ["AwsRegion"],
  non_aws_regions: ["WorkloadNonAwsRegion"],
  pillar_priorities: ["PillarId"],
  architectural_design: "WorkloadArchitecturalDesign",
  review_owner: "WorkloadReviewOwner",
  is_review_owner_update_acknowledged: false,
  industry_type: "WorkloadIndustryType",
  industry: "WorkloadIndustry",
  notes: "Notes",
  improvement_status: "NOT_APPLICABLE", # accepts NOT_APPLICABLE, NOT_STARTED, IN_PROGRESS, COMPLETE, RISK_ACKNOWLEDGED
}

Input to update a workload.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idsArray<String>

The list of AWS account IDs associated with the workload.

Returns:

  • (Array<String>)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#architectural_designString

The URL of the architectural design for the workload.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#aws_regionsArray<String>

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

Returns:

  • (Array<String>)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the workload.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#environmentString

The environment for the workload.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#improvement_statusString

The improvement status for a workload.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#industryString

The industry for the workload.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#industry_typeString

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

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#is_review_owner_update_acknowledgedBoolean

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.

Returns:

  • (Boolean)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#non_aws_regionsArray<String>

The list of non-AWS Regions associated with the workload.

Returns:

  • (Array<String>)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#notesString

The notes associated with the workload.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#pillar_prioritiesArray<String>

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

Returns:

  • (Array<String>)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#review_ownerString

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#workload_idString

The ID assigned to the workload. This ID is unique within an AWS Region.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end

#workload_nameString

The name of the workload.

The name must be unique within an account within a Region. Spaces and capitalization are ignored when checking for uniqueness.

Returns:

  • (String)


2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 2758

class UpdateWorkloadInput < Struct.new(
  :workload_id,
  :workload_name,
  :description,
  :environment,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :pillar_priorities,
  :architectural_design,
  :review_owner,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status)
  SENSITIVE = []
  include Aws::Structure
end