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

Inherits:

Struct

• Object
• Struct
• Aws::WellArchitected::Types::Workload

Defined in:

gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb

Overview

A workload return object.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_ids ⇒ Array<String>

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

• #applications ⇒ Array<String>

  List of AppRegistry application ARNs associated to the workload.

• #architectural_design ⇒ String

  The URL of the architectural design for the workload.

• #aws_regions ⇒ Array<String>

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

• #description ⇒ String

  The description for the workload.

• #discovery_config ⇒ Types::WorkloadDiscoveryConfig

  Discovery configuration associated to the workload.

• #environment ⇒ String

  The environment for the workload.

• #improvement_status ⇒ String

  The improvement status for a workload.

• #industry ⇒ String

  The industry for the workload.

• #industry_type ⇒ String

  The industry type for the workload.

• #is_review_owner_update_acknowledged ⇒ Boolean

  Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

• #lenses ⇒ Array<String>

  The list of lenses associated with the workload.

• #non_aws_regions ⇒ Array<String>

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

• #notes ⇒ String

  The notes associated with the workload.

• #owner ⇒ String

  An Amazon Web Services account ID.

• #pillar_priorities ⇒ Array<String>

  The priorities of the pillars, which are used to order items in the improvement plan.

• #review_owner ⇒ String

  The review owner of the workload.

• #review_restriction_date ⇒ Time

  The date and time recorded.

• #risk_counts ⇒ Hash<String,Integer>

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

• #share_invitation_id ⇒ String

  The ID assigned to the share invitation.

• #tags ⇒ Hash<String,String>

  The tags associated with the workload.

• #updated_at ⇒ Time

  The date and time recorded.

• #workload_arn ⇒ String

  The ARN for the workload.

• #workload_id ⇒ String

  The ID assigned to the workload.

• #workload_name ⇒ String

  The name of the workload.

Instance Attribute Details

#account_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#applications ⇒ Array<String>

List of AppRegistry application ARNs associated to the workload.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#architectural_design ⇒ String

The URL of the architectural design for the workload.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#aws_regions ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the workload.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#discovery_config ⇒ Types::WorkloadDiscoveryConfig

Discovery configuration associated to the workload.

Returns:

• (Types::WorkloadDiscoveryConfig)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ String

The environment for the workload.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#improvement_status ⇒ String

The improvement status for a workload.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#industry ⇒ String

The industry for the workload.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#industry_type ⇒ String

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)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#is_review_owner_update_acknowledged ⇒ Boolean

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)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#lenses ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#non_aws_regions ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#notes ⇒ String

The notes associated with the workload.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

An Amazon Web Services account ID.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#pillar_priorities ⇒ Array<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>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#review_owner ⇒ String

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)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#review_restriction_date ⇒ Time

The date and time recorded.

Returns:

• (Time)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#risk_counts ⇒ Hash<String,Integer>

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

Returns:

• (Hash<String,Integer>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#share_invitation_id ⇒ String

The ID assigned to the share invitation.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags associated with the workload.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The date and time recorded.

Returns:

• (Time)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#workload_arn ⇒ String

The ARN for the workload.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#workload_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end

#workload_name ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-wellarchitected/lib/aws-sdk-wellarchitected/types.rb', line 4000

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,
  :discovery_config,
  :applications)
  SENSITIVE = []
  include Aws::Structure
end