Type definitions#
Index > IdentityStore > Type definitions
Auto-generated documentation for IdentityStore type annotations stubs module mypy-boto3-identitystore.
AddressTypeDef#
# AddressTypeDef definition
class AddressTypeDef(TypedDict):
StreetAddress: NotRequired[str],
Locality: NotRequired[str],
Region: NotRequired[str],
PostalCode: NotRequired[str],
Country: NotRequired[str],
Formatted: NotRequired[str],
Type: NotRequired[str],
Primary: NotRequired[bool],
ExternalIdTypeDef#
# ExternalIdTypeDef definition
class ExternalIdTypeDef(TypedDict):
Issuer: str,
Id: str,
UniqueAttributeTypeDef#
# UniqueAttributeTypeDef definition
class UniqueAttributeTypeDef(TypedDict):
AttributePath: str,
AttributeValue: Mapping[str, Any],
AttributeOperationTypeDef#
# AttributeOperationTypeDef definition
class AttributeOperationTypeDef(TypedDict):
AttributePath: str,
AttributeValue: NotRequired[Mapping[str, Any]],
MemberIdTypeDef#
# MemberIdTypeDef definition
class MemberIdTypeDef(TypedDict):
UserId: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
CreateGroupRequestRequestTypeDef#
# CreateGroupRequestRequestTypeDef definition
class CreateGroupRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
DisplayName: NotRequired[str],
Description: NotRequired[str],
EmailTypeDef#
# EmailTypeDef definition
class EmailTypeDef(TypedDict):
Value: NotRequired[str],
Type: NotRequired[str],
Primary: NotRequired[bool],
NameTypeDef#
# NameTypeDef definition
class NameTypeDef(TypedDict):
Formatted: NotRequired[str],
FamilyName: NotRequired[str],
GivenName: NotRequired[str],
MiddleName: NotRequired[str],
HonorificPrefix: NotRequired[str],
HonorificSuffix: NotRequired[str],
PhoneNumberTypeDef#
# PhoneNumberTypeDef definition
class PhoneNumberTypeDef(TypedDict):
Value: NotRequired[str],
Type: NotRequired[str],
Primary: NotRequired[bool],
DeleteGroupMembershipRequestRequestTypeDef#
# DeleteGroupMembershipRequestRequestTypeDef definition
class DeleteGroupMembershipRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
MembershipId: str,
DeleteGroupRequestRequestTypeDef#
# DeleteGroupRequestRequestTypeDef definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
GroupId: str,
DeleteUserRequestRequestTypeDef#
# DeleteUserRequestRequestTypeDef definition
class DeleteUserRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
UserId: str,
DescribeGroupMembershipRequestRequestTypeDef#
# DescribeGroupMembershipRequestRequestTypeDef definition
class DescribeGroupMembershipRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
MembershipId: str,
DescribeGroupRequestRequestTypeDef#
# DescribeGroupRequestRequestTypeDef definition
class DescribeGroupRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
GroupId: str,
DescribeUserRequestRequestTypeDef#
# DescribeUserRequestRequestTypeDef definition
class DescribeUserRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
UserId: str,
FilterTypeDef#
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
AttributePath: str,
AttributeValue: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListGroupMembershipsRequestRequestTypeDef#
# ListGroupMembershipsRequestRequestTypeDef definition
class ListGroupMembershipsRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
GroupId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GroupTypeDef#
# GroupTypeDef definition
class GroupTypeDef(TypedDict):
GroupId: str,
IdentityStoreId: str,
DisplayName: NotRequired[str],
ExternalIds: NotRequired[List[ExternalIdTypeDef]], # (1)
Description: NotRequired[str],
AlternateIdentifierTypeDef#
# AlternateIdentifierTypeDef definition
class AlternateIdentifierTypeDef(TypedDict):
ExternalId: NotRequired[ExternalIdTypeDef], # (1)
UniqueAttribute: NotRequired[UniqueAttributeTypeDef], # (2)
UpdateGroupRequestRequestTypeDef#
# UpdateGroupRequestRequestTypeDef definition
class UpdateGroupRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
GroupId: str,
Operations: Sequence[AttributeOperationTypeDef], # (1)
UpdateUserRequestRequestTypeDef#
# UpdateUserRequestRequestTypeDef definition
class UpdateUserRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
UserId: str,
Operations: Sequence[AttributeOperationTypeDef], # (1)
CreateGroupMembershipRequestRequestTypeDef#
# CreateGroupMembershipRequestRequestTypeDef definition
class CreateGroupMembershipRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
GroupId: str,
MemberId: MemberIdTypeDef, # (1)
- See MemberIdTypeDef
GetGroupMembershipIdRequestRequestTypeDef#
# GetGroupMembershipIdRequestRequestTypeDef definition
class GetGroupMembershipIdRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
GroupId: str,
MemberId: MemberIdTypeDef, # (1)
- See MemberIdTypeDef
GroupMembershipExistenceResultTypeDef#
# GroupMembershipExistenceResultTypeDef definition
class GroupMembershipExistenceResultTypeDef(TypedDict):
GroupId: NotRequired[str],
MemberId: NotRequired[MemberIdTypeDef], # (1)
MembershipExists: NotRequired[bool],
- See MemberIdTypeDef
GroupMembershipTypeDef#
# GroupMembershipTypeDef definition
class GroupMembershipTypeDef(TypedDict):
IdentityStoreId: str,
MembershipId: NotRequired[str],
GroupId: NotRequired[str],
MemberId: NotRequired[MemberIdTypeDef], # (1)
- See MemberIdTypeDef
IsMemberInGroupsRequestRequestTypeDef#
# IsMemberInGroupsRequestRequestTypeDef definition
class IsMemberInGroupsRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
MemberId: MemberIdTypeDef, # (1)
GroupIds: Sequence[str],
- See MemberIdTypeDef
ListGroupMembershipsForMemberRequestRequestTypeDef#
# ListGroupMembershipsForMemberRequestRequestTypeDef definition
class ListGroupMembershipsForMemberRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
MemberId: MemberIdTypeDef, # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See MemberIdTypeDef
CreateGroupMembershipResponseTypeDef#
# CreateGroupMembershipResponseTypeDef definition
class CreateGroupMembershipResponseTypeDef(TypedDict):
MembershipId: str,
IdentityStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGroupResponseTypeDef#
# CreateGroupResponseTypeDef definition
class CreateGroupResponseTypeDef(TypedDict):
GroupId: str,
IdentityStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserResponseTypeDef#
# CreateUserResponseTypeDef definition
class CreateUserResponseTypeDef(TypedDict):
UserId: str,
IdentityStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeGroupMembershipResponseTypeDef#
# DescribeGroupMembershipResponseTypeDef definition
class DescribeGroupMembershipResponseTypeDef(TypedDict):
IdentityStoreId: str,
MembershipId: str,
GroupId: str,
MemberId: MemberIdTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeGroupResponseTypeDef#
# DescribeGroupResponseTypeDef definition
class DescribeGroupResponseTypeDef(TypedDict):
GroupId: str,
DisplayName: str,
ExternalIds: List[ExternalIdTypeDef], # (1)
Description: str,
IdentityStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetGroupIdResponseTypeDef#
# GetGroupIdResponseTypeDef definition
class GetGroupIdResponseTypeDef(TypedDict):
GroupId: str,
IdentityStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetGroupMembershipIdResponseTypeDef#
# GetGroupMembershipIdResponseTypeDef definition
class GetGroupMembershipIdResponseTypeDef(TypedDict):
MembershipId: str,
IdentityStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetUserIdResponseTypeDef#
# GetUserIdResponseTypeDef definition
class GetUserIdResponseTypeDef(TypedDict):
UserId: str,
IdentityStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserRequestRequestTypeDef#
# CreateUserRequestRequestTypeDef definition
class CreateUserRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
UserName: NotRequired[str],
Name: NotRequired[NameTypeDef], # (1)
DisplayName: NotRequired[str],
NickName: NotRequired[str],
ProfileUrl: NotRequired[str],
Emails: NotRequired[Sequence[EmailTypeDef]], # (2)
Addresses: NotRequired[Sequence[AddressTypeDef]], # (3)
PhoneNumbers: NotRequired[Sequence[PhoneNumberTypeDef]], # (4)
UserType: NotRequired[str],
Title: NotRequired[str],
PreferredLanguage: NotRequired[str],
Locale: NotRequired[str],
Timezone: NotRequired[str],
- See NameTypeDef
- See EmailTypeDef
- See AddressTypeDef
- See PhoneNumberTypeDef
DescribeUserResponseTypeDef#
# DescribeUserResponseTypeDef definition
class DescribeUserResponseTypeDef(TypedDict):
UserName: str,
UserId: str,
ExternalIds: List[ExternalIdTypeDef], # (1)
Name: NameTypeDef, # (2)
DisplayName: str,
NickName: str,
ProfileUrl: str,
Emails: List[EmailTypeDef], # (3)
Addresses: List[AddressTypeDef], # (4)
PhoneNumbers: List[PhoneNumberTypeDef], # (5)
UserType: str,
Title: str,
PreferredLanguage: str,
Locale: str,
Timezone: str,
IdentityStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See ExternalIdTypeDef
- See NameTypeDef
- See EmailTypeDef
- See AddressTypeDef
- See PhoneNumberTypeDef
- See ResponseMetadataTypeDef
UserTypeDef#
# UserTypeDef definition
class UserTypeDef(TypedDict):
UserId: str,
IdentityStoreId: str,
UserName: NotRequired[str],
ExternalIds: NotRequired[List[ExternalIdTypeDef]], # (1)
Name: NotRequired[NameTypeDef], # (2)
DisplayName: NotRequired[str],
NickName: NotRequired[str],
ProfileUrl: NotRequired[str],
Emails: NotRequired[List[EmailTypeDef]], # (3)
Addresses: NotRequired[List[AddressTypeDef]], # (4)
PhoneNumbers: NotRequired[List[PhoneNumberTypeDef]], # (5)
UserType: NotRequired[str],
Title: NotRequired[str],
PreferredLanguage: NotRequired[str],
Locale: NotRequired[str],
Timezone: NotRequired[str],
- See ExternalIdTypeDef
- See NameTypeDef
- See EmailTypeDef
- See AddressTypeDef
- See PhoneNumberTypeDef
ListGroupsRequestRequestTypeDef#
# ListGroupsRequestRequestTypeDef definition
class ListGroupsRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListUsersRequestRequestTypeDef#
# ListUsersRequestRequestTypeDef definition
class ListUsersRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
- See FilterTypeDef
ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef#
# ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef definition
class ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef(TypedDict):
IdentityStoreId: str,
MemberId: MemberIdTypeDef, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef#
# ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef definition
class ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef(TypedDict):
IdentityStoreId: str,
GroupId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGroupsRequestListGroupsPaginateTypeDef#
# ListGroupsRequestListGroupsPaginateTypeDef definition
class ListGroupsRequestListGroupsPaginateTypeDef(TypedDict):
IdentityStoreId: str,
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
ListUsersRequestListUsersPaginateTypeDef#
# ListUsersRequestListUsersPaginateTypeDef definition
class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
IdentityStoreId: str,
Filters: NotRequired[Sequence[FilterTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See FilterTypeDef
- See PaginatorConfigTypeDef
ListGroupsResponseTypeDef#
# ListGroupsResponseTypeDef definition
class ListGroupsResponseTypeDef(TypedDict):
Groups: List[GroupTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
GetGroupIdRequestRequestTypeDef#
# GetGroupIdRequestRequestTypeDef definition
class GetGroupIdRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
AlternateIdentifier: AlternateIdentifierTypeDef, # (1)
GetUserIdRequestRequestTypeDef#
# GetUserIdRequestRequestTypeDef definition
class GetUserIdRequestRequestTypeDef(TypedDict):
IdentityStoreId: str,
AlternateIdentifier: AlternateIdentifierTypeDef, # (1)
IsMemberInGroupsResponseTypeDef#
# IsMemberInGroupsResponseTypeDef definition
class IsMemberInGroupsResponseTypeDef(TypedDict):
Results: List[GroupMembershipExistenceResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListGroupMembershipsForMemberResponseTypeDef#
# ListGroupMembershipsForMemberResponseTypeDef definition
class ListGroupMembershipsForMemberResponseTypeDef(TypedDict):
GroupMemberships: List[GroupMembershipTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListGroupMembershipsResponseTypeDef#
# ListGroupMembershipsResponseTypeDef definition
class ListGroupMembershipsResponseTypeDef(TypedDict):
GroupMemberships: List[GroupMembershipTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUsersResponseTypeDef#
# ListUsersResponseTypeDef definition
class ListUsersResponseTypeDef(TypedDict):
Users: List[UserTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef