share_invitations

Creates, updates, deletes, gets or lists a share_invitations resource.

Overview

Name	share_invitations
Type	Resource
Id	aws.wellarchitected.share_invitations

Fields

The following fields are returned by SELECT queries:

list_share_invitations

Name	Datatype	Description
next_token	string	The token to use to retrieve the next set of results. (pattern: <code>[A-Za-z0-9+/=_-]+</code>)
share_invitation_summaries	array	List of share invitation summaries in a workload.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_share_invitations	select	region	WorkloadNamePrefix, LensNamePrefix, ShareResourceType, NextToken, MaxResults, ProfileNamePrefix, TemplateNamePrefix	List the share invitations. WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.
update_share_invitation	update	share_invitation_id, region, ShareInvitationAction		Update a workload or custom lens share invitation. This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
share_invitation_id	string	The ID assigned to the share invitation.
LensNamePrefix	string	An optional string added to the beginning of each lens name returned in the results.
MaxResults	integer	The maximum number of results to return for this request.
NextToken	string
ProfileNamePrefix	string	An optional string added to the beginning of each profile name returned in the results.
ShareResourceType	string	The type of share invitations to be returned.
TemplateNamePrefix	string	An optional string added to the beginning of each review template name returned in the results.
WorkloadNamePrefix	string

SELECT examples

list_share_invitations

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

SELECT
next_token,
share_invitation_summaries
FROM aws.wellarchitected.share_invitations
WHERE region = '{{ region }}' -- required
AND WorkloadNamePrefix = '{{ WorkloadNamePrefix }}'
AND LensNamePrefix = '{{ LensNamePrefix }}'
AND ShareResourceType = '{{ ShareResourceType }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND ProfileNamePrefix = '{{ ProfileNamePrefix }}'
AND TemplateNamePrefix = '{{ TemplateNamePrefix }}'
;

UPDATE examples

update_share_invitation

Update a workload or custom lens share invitation. This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

UPDATE aws.wellarchitected.share_invitations
SET 
ShareInvitationAction = '{{ ShareInvitationAction }}'
WHERE 
share_invitation_id = '{{ share_invitation_id }}' --required
AND region = '{{ region }}' --required
AND ShareInvitationAction = '{{ ShareInvitationAction }}' --required
RETURNING
share_invitation;