[ aws . wellarchitected ]
Get an existing workload.
See also: AWS API Documentation
get-workload --workload-id <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with
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. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
Workload -> (structure)
A workload return object.
WorkloadId -> (string)The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadArn -> (string)The ARN for the workload.
WorkloadName -> (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.
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 Amazon Web Services account IDs associated with the workload.
(string)An Amazon Web Services account ID.
AwsRegions -> (list)
The list of Amazon Web Services Regions associated with the workload, for example,
(string)An Amazon Web Services Region, for example,
NonAwsRegions -> (list)
The list of non-Amazon Web Services Regions associated with the workload.
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:
Design and Engineering
General Public Services
Justice and Public Safety
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Real Estate & Construction
Retail & Wholesale
Travel, Transportation & Logistics
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 many 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 .
The ID used to identify a pillar, for example,
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 .
The alias of the lens.
For Amazon Web Services official lenses, this is either the lens alias, such as
serverless, or the lens ARN, such as
arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.
For custom lenses, this is the lens ARN, such as
Each lens is identified by its LensSummary$LensAlias .
Owner -> (string)An Amazon Web Services account ID.
ShareInvitationId -> (string)The ID assigned to the share invitation.
Tags -> (map)
The tags associated with the workload.
key -> (string)
value -> (string)
DiscoveryConfig -> (structure)
Discovery configuration associated to the workload.
TrustedAdvisorIntegrationStatus -> (string)Discovery integration status in respect to Trusted Advisor for the workload.
WorkloadResourceDefinition -> (list)
The mode to use for identifying resources associated with the workload.
You can specify
APP_REGISTRY, or both.
Applications -> (list)
List of AppRegistry application ARNs associated to the workload.