[ aws . wellarchitected ]

list-share-invitations

Description

List the workload invitations.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-share-invitations
[--workload-name-prefix <value>]
[--lens-name-prefix <value>]
[--share-resource-type <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--workload-name-prefix (string)

An optional string added to the beginning of each workload name returned in the results.

--lens-name-prefix (string)

An optional string added to the beginning of each lens name returned in the results.

--share-resource-type (string)

The type of share invitations to be returned.

Possible values:

• WORKLOAD

• LENS

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

ShareInvitationSummaries -> (list)

List of share invitation summaries in a workload.

(structure)

A share invitation summary return object.

ShareInvitationId -> (string)

The ID assigned to the share invitation.

SharedBy -> (string)

An Amazon Web Services account ID.

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.

ShareResourceType -> (string)

The resource type of the share invitation.

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.

WorkloadId -> (string)

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

LensName -> (string)

The full name of the lens.

LensArn -> (string)

The ARN for the lens.

NextToken -> (string)

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