Membership

The membership object.

arn

The unique ARN for the membership.

Type: String

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

Pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+

Required: Yes

collaborationArn

The unique ARN for the membership's associated collaboration.

Type: String

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

Pattern: arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+

Required: Yes

collaborationCreatorAccountId

The identifier used to reference members of the collaboration. Currently only supports AWS account ID.

Type: String

Length Constraints: Fixed length of 12.

Pattern: \d+

Required: Yes

collaborationCreatorDisplayName

The display name of the collaboration creator.

Type: String

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

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

Required: Yes

collaborationId

The unique ID for the membership's collaboration.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

collaborationName

The name of the membership's collaboration.

Type: String

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

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*

Required: Yes

createTime

The time when the membership was created.

Type: Timestamp

Required: Yes

id

The unique ID of the membership.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

memberAbilities

The abilities granted to the collaboration member.

Type: Array of strings

Valid Values: CAN_QUERY | CAN_RECEIVE_RESULTS

Required: Yes

paymentConfiguration

The payment responsibilities accepted by the collaboration member.

Type: MembershipPaymentConfiguration object

Required: Yes

queryLogStatus

An indicator as to whether query logging has been enabled or disabled for the membership.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

status

The status of the membership.

Type: String

Valid Values: ACTIVE | REMOVED | COLLABORATION_DELETED

Required: Yes

updateTime

The time the membership metadata was last updated.

Type: Timestamp

Required: Yes

defaultResultConfiguration

The default protected query result configuration as specified by the member who can receive results.

Type: MembershipProtectedQueryResultConfiguration object

Required: No

Membership

Contents

See Also