ShareInvitationSummary - AWS Well-Architected Tool

ShareInvitationSummary

A share invitation summary return object.

Contents

LensArn

The ARN for the lens.

Type: String

Required: No

LensName

The full name of the lens.

Type: String

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

Required: No

PermissionType

Permission granted on a share request.

Type: String

Valid Values: READONLY | CONTRIBUTOR

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

ProfileName

The profile name.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

Required: No

SharedBy

An AWS account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

SharedWith

The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 2048.

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

TemplateName

The name of the review template.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

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

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

WorkloadName

The name of the workload.

The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 100.

Required: No

See Also

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