Class: Aws::WellArchitected::Types::Workload

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

Overview

A workload return object.

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>)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#architectural_designString

The URL of the architectural design for the workload.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  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>)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the workload.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#environmentString

The environment for the workload.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#improvement_statusString

The improvement status for a workload.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#industryString

The industry for the workload.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  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)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  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)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#lensesArray<String>

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

Returns:

  • (Array<String>)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#non_aws_regionsArray<String>

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

Returns:

  • (Array<String>)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#notesString

The notes associated with the workload.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ownerString

An AWS account ID.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  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>)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  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)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#review_restriction_dateTime

The date and time recorded.

Returns:

  • (Time)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#risk_countsHash<String,Integer>

A map from risk names to the count of how questions have that rating.

Returns:

  • (Hash<String,Integer>)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#share_invitation_idString

The ID assigned to the share invitation.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags associated with the workload.

Returns:

  • (Hash<String,String>)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

The date and time recorded.

Returns:

  • (Time)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#workload_arnString

The ARN for the workload.

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#workload_idString

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

Returns:

  • (String)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  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)


3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 3125

class Workload < Struct.new(
  :workload_id,
  :workload_arn,
  :workload_name,
  :description,
  :environment,
  :updated_at,
  :account_ids,
  :aws_regions,
  :non_aws_regions,
  :architectural_design,
  :review_owner,
  :review_restriction_date,
  :is_review_owner_update_acknowledged,
  :industry_type,
  :industry,
  :notes,
  :improvement_status,
  :risk_counts,
  :pillar_priorities,
  :lenses,
  :owner,
  :share_invitation_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end