WellArchitected / Client / update_share_invitation

update_share_invitation#

WellArchitected.Client.update_share_invitation(**kwargs)#

Update a workload or custom lens share invitation.

Note

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

See also: AWS API Documentation

Request Syntax

response = client.update_share_invitation(
    ShareInvitationId='string',
    ShareInvitationAction='ACCEPT'|'REJECT'
)
Parameters:

  • ShareInvitationId (string) –

    [REQUIRED]

    The ID assigned to the share invitation.

  • ShareInvitationAction (string) –

    [REQUIRED]

    Share invitation action taken by contributor.

Return type:

dict

Returns:

Response Syntax

{
    'ShareInvitation': {
        'ShareInvitationId': 'string',
        'ShareResourceType': 'WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE',
        'WorkloadId': 'string',
        'LensAlias': 'string',
        'LensArn': 'string',
        'ProfileArn': 'string',
        'TemplateArn': 'string'
    }
}

Response Structure

  • (dict) –

    • ShareInvitation (dict) –

      The updated workload or custom lens share invitation.

      • ShareInvitationId (string) –

        The ID assigned to the share invitation.

      • ShareResourceType (string) –

        The resource type of the share invitation.

      • WorkloadId (string) –

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

      • LensAlias (string) –

        The alias of the lens.

        For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

        For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

        Each lens is identified by its LensSummary$LensAlias.

      • LensArn (string) –

        The ARN for the lens.

      • ProfileArn (string) –

        The profile ARN.

      • TemplateArn (string) –

        The review template ARN.

Exceptions