Group
A group object that contains the metadata and attributes for a specified group.
Contents
- GroupId
-
The identifier for a group in the identity store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 47.
Pattern:
([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
- IdentityStoreId
-
The globally unique identifier for the identity store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
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
- Description
-
A string containing a description of the specified group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- DisplayName
-
The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
Prefix search supports a maximum of 1,000 characters for the string.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+
Required: No
- ExternalIds
-
A list of
ExternalId
objects that contains the identifiers issued to this resource by an external identity provider.Type: Array of ExternalId objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: