WorkloadShare - AWS Well-Architected Tool

WorkloadShare

A workload share return object.

Contents

PermissionType

Permission granted on a share request.

Type: String

Valid Values: READONLY | CONTRIBUTOR

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

ShareId

The ID associated with the share.

Type: String

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

Required: No

Status

The status of the share request.

Type: String

Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED

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: