ShareInvitation - AWS Well-Architected Tool

ShareInvitation

The share invitation.

Contents

LensAlias

The alias of the lens.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

LensArn

The ARN for the lens.

Type: String

Required: No

ProfileArn

The profile ARN.

Type: String

Length Constraints: Maximum length of 2084.

Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:profile/[a-z0-9]+

Required: No

ShareInvitationId

The ID assigned to the share invitation.

Type: String

Pattern: [0-9a-f]{32}

Required: No

ShareResourceType

The resource type of the share invitation.

Type: String

Valid Values: WORKLOAD | LENS | PROFILE | TEMPLATE

Required: No

TemplateArn

The review template ARN.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 250.

Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32}

Required: No

WorkloadId

The ID assigned to the workload. This ID is unique within an AWS Region.

Type: String

Length Constraints: Fixed length of 32.

Pattern: [0-9a-f]{32}

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: