GroupMembership
Contains the identifiers for a group, a group member, and a GroupMembership
object in the identity store.
Contents
- IdentityStoreId
-
The globally unique identifier for the identity store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 93.
Pattern:
(arn:aws[a-z-]*:identitystore::\d{12}:identitystore/)?(d-[0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})Required: Yes
- MembershipArn
-
The Amazon Resource Name (ARN) of the group membership in the identity store. For example,
arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333.Type: String
Length Constraints: Minimum length of 60. Maximum length of 100.
Pattern:
arn:aws[a-z-]*:identitystore:::(user|group|membership)/([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}Required: Yes
- MembershipId
-
The identifier for a
GroupMembershipobject in an identity store.Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
(arn:aws[a-z-]*:identitystore:::(user|group|membership)/)?([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}Required: Yes
- CreatedAt
-
The date and time the group membership was created.
Type: Timestamp
Required: No
- CreatedBy
-
The identifier of the user or system that created the group membership.
Type: String
Required: No
- GroupId
-
The identifier for a group in the identity store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
(arn:aws[a-z-]*:identitystore:::(user|group|membership)/)?([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}Required: No
- MemberId
-
An object that contains the identifier of a group member. Setting the
UserIdfield to the specific identifier for a user indicates that the user is a member of the group.Type: MemberId object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- UpdatedAt
-
The date and time the group membership was last updated.
Type: Timestamp
Required: No
- UpdatedBy
-
The identifier of the user or system that last updated the group membership.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: