Did you find this page useful? Do you have a suggestion to improve the documentation? Give us feedback.
If you would like to suggest an improvement or fix for the AWS CLI, check out our contributing guide on GitHub.
First time using the AWS CLI? See the User Guide for help getting started.
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 ]
List the share invitations.
WorkloadNamePrefix
,LensNamePrefix
,ProfileNamePrefix
, andTemplateNamePrefix
are mutually exclusive. Use the parameter that matches yourShareResourceType
.
See also: AWS API Documentation
list-share-invitations
[--workload-name-prefix <value>]
[--lens-name-prefix <value>]
[--share-resource-type <value>]
[--next-token <value>]
[--max-results <value>]
[--profile-name-prefix <value>]
[--template-name-prefix <value>]
[--cli-input-json <value>]
[--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>]
--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
PROFILE
TEMPLATE
--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.
--profile-name-prefix
(string)
An optional string added to the beginning of each profile name returned in the results.
--template-name-prefix
(string)
An optional string added to the beginning of each review template name returned in the results.
--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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
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.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
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.
--cli-connect-timeout
(int)
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.
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, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.PermissionType -> (string)
Permission granted on a share request.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.ProfileName -> (string)
The profile name.ProfileArn -> (string)
The profile ARN.TemplateName -> (string)
The name of the review template.TemplateArn -> (string)
The review template ARN.
NextToken -> (string)
The token to use to retrieve the next set of results.