Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wellarchitected ]

get-workload

Description

Get an existing workload.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-workload
--workload-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--workload-id (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Workload -> (structure)

A workload return object.

WorkloadId -> (string)

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

WorkloadArn -> (string)

The ARN for the workload.

WorkloadName -> (string)

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.

Description -> (string)

The description for the workload.

Environment -> (string)

The environment for the workload.

UpdatedAt -> (timestamp)

The date and time recorded.

AccountIds -> (list)

The list of AWS account IDs associated with the workload.

(string)

An AWS account ID.

AwsRegions -> (list)

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

(string)

An AWS Region, for example, us-west-2 or ap-northeast-1 .

NonAwsRegions -> (list)

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

(string)

ArchitecturalDesign -> (string)

The URL of the architectural design for the workload.

ReviewOwner -> (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.

ReviewRestrictionDate -> (timestamp)

The date and time recorded.

IsReviewOwnerUpdateAcknowledged -> (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.

IndustryType -> (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

Industry -> (string)

The industry for the workload.

Notes -> (string)

The notes associated with the workload.

ImprovementStatus -> (string)

The improvement status for a workload.

RiskCounts -> (map)

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

key -> (string)

The risk for a given workload, lens review, pillar, or question.

value -> (integer)

A non-negative integer that denotes how many.

PillarPriorities -> (list)

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

(string)

The ID used to identify a pillar, for example, security .

A pillar is identified by its PillarReviewSummary$PillarId .

Lenses -> (list)

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

(string)

The alias of the lens, for example, serverless .

Each lens is identified by its LensSummary$LensAlias .

Owner -> (string)

An AWS account ID.

ShareInvitationId -> (string)

The ID assigned to the share invitation.

Tags -> (map)

The tags associated with the workload.

key -> (string)

value -> (string)