Table of Contents
Quick search
Feedback
Did you find this page useful? Do you have a suggestion? Give us feedback or send us a pull request on GitHub.
User Guide
First time using the AWS CLI? See the User Guide for help getting started.
[ aws . wellarchitected ]
list-workload-shares¶
Description¶
List the workload shares associated with the workload.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
list-workload-shares
--workload-id <value>
[--shared-with-prefix <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--workload-id (string)
The ID assigned to the workload. This ID is unique within an AWS Region.
--shared-with-prefix (string)
The AWS account ID or IAM role with which the workload is shared.
--next-token (string)
The token to use to retrieve the next set of results.
--max-results (integer)
The maximum number of results to return for this request.
--cli-input-json | --cli-input-yaml (string)
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 --cli-input-yaml.
--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. 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.
See ‘aws help’ for descriptions of global parameters.
Output¶
WorkloadId -> (string)
The ID assigned to the workload. This ID is unique within an AWS Region.
WorkloadShareSummaries -> (list)
A list of workload share summaries.
(structure)
A workload share summary return object.
ShareId -> (string)
The ID associated with the workload share.
SharedWith -> (string)
The AWS account ID or IAM role with which the workload is shared.
PermissionType -> (string)
Permission granted on a workload share.
Status -> (string)
The status of a workload share.
NextToken -> (string)
The token to use to retrieve the next set of results.