Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListShareInvitations

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

Request Syntax


GET /shareInvitations?LensNamePrefix=LensNamePrefix&MaxResults=MaxResults&NextToken=NextToken&ProfileNamePrefix=ProfileNamePrefix&ShareResourceType=ShareResourceType&TemplateNamePrefix=TemplateNamePrefix&WorkloadNamePrefix=WorkloadNamePrefix HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

LensNamePrefix

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

Length Constraints: Maximum length of 100.

MaxResults

The maximum number of results to return for this request.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken

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

ProfileNamePrefix

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

Length Constraints: Maximum length of 100.

ShareResourceType

The type of share invitations to be returned.

Valid Values: WORKLOAD | LENS | PROFILE | TEMPLATE

TemplateNamePrefix

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

Length Constraints: Maximum length of 100.

Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$

WorkloadNamePrefix

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

Length Constraints: Maximum length of 100.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ShareInvitationSummaries": [ 
      { 
         "LensArn": "string",
         "LensName": "string",
         "PermissionType": "string",
         "ProfileArn": "string",
         "ProfileName": "string",
         "SharedBy": "string",
         "SharedWith": "string",
         "ShareInvitationId": "string",
         "ShareResourceType": "string",
         "TemplateArn": "string",
         "TemplateName": "string",
         "WorkloadId": "string",
         "WorkloadName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

ShareInvitationSummaries

List of share invitation summaries in a workload.

Type: Array of ShareInvitationSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

There is a problem with the AWS Well-Architected Tool API service.

HTTP Status Code: 500

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400