[ 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>]
[--status <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 Amazon Web Services Region.

--shared-with-prefix (string)

The Amazon Web Services 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.

--status (string)

The status of a workload share.

Possible values:

• ACCEPTED

• REJECTED

• PENDING

• REVOKED

• EXPIRED

• ASSOCIATING

• ASSOCIATED

• FAILED

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

See ‘aws help’ for descriptions of global parameters.

Output

WorkloadId -> (string)

The ID assigned to the workload. This ID is unique within an Amazon Web Services 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 Amazon Web Services 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.

StatusMessage -> (string)

Optional message to compliment the Status field.

NextToken -> (string)

The token to use to retrieve the next set of results.