Skip to content

Typed dictionaries#

Index > IdentityStore > Typed dictionaries

Auto-generated documentation for IdentityStore type annotations stubs module mypy-boto3-identitystore.

AddressTypeDef#

# AddressTypeDef usage example

from mypy_boto3_identitystore.type_defs import AddressTypeDef

def get_value() -> AddressTypeDef:
    return {
        "StreetAddress": ...,
    }
# 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 usage example

from mypy_boto3_identitystore.type_defs import ExternalIdTypeDef

def get_value() -> ExternalIdTypeDef:
    return {
        "Issuer": ...,
        "Id": ...,
    }
# ExternalIdTypeDef definition

class ExternalIdTypeDef(TypedDict):
    Issuer: str,
    Id: str,

UniqueAttributeTypeDef#

# UniqueAttributeTypeDef usage example

from mypy_boto3_identitystore.type_defs import UniqueAttributeTypeDef

def get_value() -> UniqueAttributeTypeDef:
    return {
        "AttributePath": ...,
        "AttributeValue": ...,
    }
# UniqueAttributeTypeDef definition

class UniqueAttributeTypeDef(TypedDict):
    AttributePath: str,
    AttributeValue: Mapping[str, Any],

AttributeOperationTypeDef#

# AttributeOperationTypeDef usage example

from mypy_boto3_identitystore.type_defs import AttributeOperationTypeDef

def get_value() -> AttributeOperationTypeDef:
    return {
        "AttributePath": ...,
    }
# AttributeOperationTypeDef definition

class AttributeOperationTypeDef(TypedDict):
    AttributePath: str,
    AttributeValue: NotRequired[Mapping[str, Any]],

MemberIdTypeDef#

# MemberIdTypeDef usage example

from mypy_boto3_identitystore.type_defs import MemberIdTypeDef

def get_value() -> MemberIdTypeDef:
    return {
        "UserId": ...,
    }
# MemberIdTypeDef definition

class MemberIdTypeDef(TypedDict):
    UserId: NotRequired[str],

CreateGroupMembershipResponseTypeDef#

# CreateGroupMembershipResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import CreateGroupMembershipResponseTypeDef

def get_value() -> CreateGroupMembershipResponseTypeDef:
    return {
        "MembershipId": ...,
        "IdentityStoreId": ...,
        "ResponseMetadata": ...,
    }
# CreateGroupMembershipResponseTypeDef definition

class CreateGroupMembershipResponseTypeDef(TypedDict):
    MembershipId: str,
    IdentityStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateGroupRequestRequestTypeDef#

# CreateGroupRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import CreateGroupRequestRequestTypeDef

def get_value() -> CreateGroupRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
    }
# CreateGroupRequestRequestTypeDef definition

class CreateGroupRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    DisplayName: NotRequired[str],
    Description: NotRequired[str],

CreateGroupResponseTypeDef#

# CreateGroupResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import CreateGroupResponseTypeDef

def get_value() -> CreateGroupResponseTypeDef:
    return {
        "GroupId": ...,
        "IdentityStoreId": ...,
        "ResponseMetadata": ...,
    }
# CreateGroupResponseTypeDef definition

class CreateGroupResponseTypeDef(TypedDict):
    GroupId: str,
    IdentityStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmailTypeDef#

# EmailTypeDef usage example

from mypy_boto3_identitystore.type_defs import EmailTypeDef

def get_value() -> EmailTypeDef:
    return {
        "Value": ...,
    }
# EmailTypeDef definition

class EmailTypeDef(TypedDict):
    Value: NotRequired[str],
    Type: NotRequired[str],
    Primary: NotRequired[bool],

NameTypeDef#

# NameTypeDef usage example

from mypy_boto3_identitystore.type_defs import NameTypeDef

def get_value() -> NameTypeDef:
    return {
        "Formatted": ...,
    }
# 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 usage example

from mypy_boto3_identitystore.type_defs import PhoneNumberTypeDef

def get_value() -> PhoneNumberTypeDef:
    return {
        "Value": ...,
    }
# PhoneNumberTypeDef definition

class PhoneNumberTypeDef(TypedDict):
    Value: NotRequired[str],
    Type: NotRequired[str],
    Primary: NotRequired[bool],

CreateUserResponseTypeDef#

# CreateUserResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import CreateUserResponseTypeDef

def get_value() -> CreateUserResponseTypeDef:
    return {
        "UserId": ...,
        "IdentityStoreId": ...,
        "ResponseMetadata": ...,
    }
# CreateUserResponseTypeDef definition

class CreateUserResponseTypeDef(TypedDict):
    UserId: str,
    IdentityStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteGroupMembershipRequestRequestTypeDef#

# DeleteGroupMembershipRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import DeleteGroupMembershipRequestRequestTypeDef

def get_value() -> DeleteGroupMembershipRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "MembershipId": ...,
    }
# DeleteGroupMembershipRequestRequestTypeDef definition

class DeleteGroupMembershipRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    MembershipId: str,

DeleteGroupRequestRequestTypeDef#

# DeleteGroupRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import DeleteGroupRequestRequestTypeDef

def get_value() -> DeleteGroupRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "GroupId": ...,
    }
# DeleteGroupRequestRequestTypeDef definition

class DeleteGroupRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    GroupId: str,

DeleteUserRequestRequestTypeDef#

# DeleteUserRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import DeleteUserRequestRequestTypeDef

def get_value() -> DeleteUserRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "UserId": ...,
    }
# DeleteUserRequestRequestTypeDef definition

class DeleteUserRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    UserId: str,

DescribeGroupMembershipRequestRequestTypeDef#

# DescribeGroupMembershipRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import DescribeGroupMembershipRequestRequestTypeDef

def get_value() -> DescribeGroupMembershipRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "MembershipId": ...,
    }
# DescribeGroupMembershipRequestRequestTypeDef definition

class DescribeGroupMembershipRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    MembershipId: str,

DescribeGroupRequestRequestTypeDef#

# DescribeGroupRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import DescribeGroupRequestRequestTypeDef

def get_value() -> DescribeGroupRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "GroupId": ...,
    }
# DescribeGroupRequestRequestTypeDef definition

class DescribeGroupRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    GroupId: str,

DescribeUserRequestRequestTypeDef#

# DescribeUserRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import DescribeUserRequestRequestTypeDef

def get_value() -> DescribeUserRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "UserId": ...,
    }
# DescribeUserRequestRequestTypeDef definition

class DescribeUserRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    UserId: str,

FilterTypeDef#

# FilterTypeDef usage example

from mypy_boto3_identitystore.type_defs import FilterTypeDef

def get_value() -> FilterTypeDef:
    return {
        "AttributePath": ...,
        "AttributeValue": ...,
    }
# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    AttributePath: str,
    AttributeValue: str,

GetGroupIdResponseTypeDef#

# GetGroupIdResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import GetGroupIdResponseTypeDef

def get_value() -> GetGroupIdResponseTypeDef:
    return {
        "GroupId": ...,
        "IdentityStoreId": ...,
        "ResponseMetadata": ...,
    }
# GetGroupIdResponseTypeDef definition

class GetGroupIdResponseTypeDef(TypedDict):
    GroupId: str,
    IdentityStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetGroupMembershipIdResponseTypeDef#

# GetGroupMembershipIdResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import GetGroupMembershipIdResponseTypeDef

def get_value() -> GetGroupMembershipIdResponseTypeDef:
    return {
        "MembershipId": ...,
        "IdentityStoreId": ...,
        "ResponseMetadata": ...,
    }
# GetGroupMembershipIdResponseTypeDef definition

class GetGroupMembershipIdResponseTypeDef(TypedDict):
    MembershipId: str,
    IdentityStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetUserIdResponseTypeDef#

# GetUserIdResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import GetUserIdResponseTypeDef

def get_value() -> GetUserIdResponseTypeDef:
    return {
        "UserId": ...,
        "IdentityStoreId": ...,
        "ResponseMetadata": ...,
    }
# GetUserIdResponseTypeDef definition

class GetUserIdResponseTypeDef(TypedDict):
    UserId: str,
    IdentityStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef#

# ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef

def get_value() -> ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef:
    return {
        "IdentityStoreId": ...,
        "GroupId": ...,
    }
# ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef definition

class ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef(TypedDict):
    IdentityStoreId: str,
    GroupId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListGroupMembershipsRequestRequestTypeDef#

# ListGroupMembershipsRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupMembershipsRequestRequestTypeDef

def get_value() -> ListGroupMembershipsRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "GroupId": ...,
    }
# ListGroupMembershipsRequestRequestTypeDef definition

class ListGroupMembershipsRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    GroupId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_identitystore.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_identitystore.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DescribeGroupResponseTypeDef#

# DescribeGroupResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import DescribeGroupResponseTypeDef

def get_value() -> DescribeGroupResponseTypeDef:
    return {
        "GroupId": ...,
        "DisplayName": ...,
        "ExternalIds": ...,
        "Description": ...,
        "IdentityStoreId": ...,
        "ResponseMetadata": ...,
    }
# DescribeGroupResponseTypeDef definition

class DescribeGroupResponseTypeDef(TypedDict):
    GroupId: str,
    DisplayName: str,
    ExternalIds: List[ExternalIdTypeDef],  # (1)
    Description: str,
    IdentityStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExternalIdTypeDef
  2. See ResponseMetadataTypeDef

GroupTypeDef#

# GroupTypeDef usage example

from mypy_boto3_identitystore.type_defs import GroupTypeDef

def get_value() -> GroupTypeDef:
    return {
        "GroupId": ...,
        "IdentityStoreId": ...,
    }
# GroupTypeDef definition

class GroupTypeDef(TypedDict):
    GroupId: str,
    IdentityStoreId: str,
    DisplayName: NotRequired[str],
    ExternalIds: NotRequired[List[ExternalIdTypeDef]],  # (1)
    Description: NotRequired[str],
  1. See ExternalIdTypeDef

AlternateIdentifierTypeDef#

# AlternateIdentifierTypeDef usage example

from mypy_boto3_identitystore.type_defs import AlternateIdentifierTypeDef

def get_value() -> AlternateIdentifierTypeDef:
    return {
        "ExternalId": ...,
    }
# AlternateIdentifierTypeDef definition

class AlternateIdentifierTypeDef(TypedDict):
    ExternalId: NotRequired[ExternalIdTypeDef],  # (1)
    UniqueAttribute: NotRequired[UniqueAttributeTypeDef],  # (2)
  1. See ExternalIdTypeDef
  2. See UniqueAttributeTypeDef

UpdateGroupRequestRequestTypeDef#

# UpdateGroupRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import UpdateGroupRequestRequestTypeDef

def get_value() -> UpdateGroupRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "GroupId": ...,
        "Operations": ...,
    }
# UpdateGroupRequestRequestTypeDef definition

class UpdateGroupRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    GroupId: str,
    Operations: Sequence[AttributeOperationTypeDef],  # (1)
  1. See AttributeOperationTypeDef

UpdateUserRequestRequestTypeDef#

# UpdateUserRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import UpdateUserRequestRequestTypeDef

def get_value() -> UpdateUserRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "UserId": ...,
        "Operations": ...,
    }
# UpdateUserRequestRequestTypeDef definition

class UpdateUserRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    UserId: str,
    Operations: Sequence[AttributeOperationTypeDef],  # (1)
  1. See AttributeOperationTypeDef

CreateGroupMembershipRequestRequestTypeDef#

# CreateGroupMembershipRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import CreateGroupMembershipRequestRequestTypeDef

def get_value() -> CreateGroupMembershipRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "GroupId": ...,
        "MemberId": ...,
    }
# CreateGroupMembershipRequestRequestTypeDef definition

class CreateGroupMembershipRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    GroupId: str,
    MemberId: MemberIdTypeDef,  # (1)
  1. See MemberIdTypeDef

DescribeGroupMembershipResponseTypeDef#

# DescribeGroupMembershipResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import DescribeGroupMembershipResponseTypeDef

def get_value() -> DescribeGroupMembershipResponseTypeDef:
    return {
        "IdentityStoreId": ...,
        "MembershipId": ...,
        "GroupId": ...,
        "MemberId": ...,
        "ResponseMetadata": ...,
    }
# DescribeGroupMembershipResponseTypeDef definition

class DescribeGroupMembershipResponseTypeDef(TypedDict):
    IdentityStoreId: str,
    MembershipId: str,
    GroupId: str,
    MemberId: MemberIdTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MemberIdTypeDef
  2. See ResponseMetadataTypeDef

GetGroupMembershipIdRequestRequestTypeDef#

# GetGroupMembershipIdRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import GetGroupMembershipIdRequestRequestTypeDef

def get_value() -> GetGroupMembershipIdRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "GroupId": ...,
        "MemberId": ...,
    }
# GetGroupMembershipIdRequestRequestTypeDef definition

class GetGroupMembershipIdRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    GroupId: str,
    MemberId: MemberIdTypeDef,  # (1)
  1. See MemberIdTypeDef

GroupMembershipExistenceResultTypeDef#

# GroupMembershipExistenceResultTypeDef usage example

from mypy_boto3_identitystore.type_defs import GroupMembershipExistenceResultTypeDef

def get_value() -> GroupMembershipExistenceResultTypeDef:
    return {
        "GroupId": ...,
    }
# GroupMembershipExistenceResultTypeDef definition

class GroupMembershipExistenceResultTypeDef(TypedDict):
    GroupId: NotRequired[str],
    MemberId: NotRequired[MemberIdTypeDef],  # (1)
    MembershipExists: NotRequired[bool],
  1. See MemberIdTypeDef

GroupMembershipTypeDef#

# GroupMembershipTypeDef usage example

from mypy_boto3_identitystore.type_defs import GroupMembershipTypeDef

def get_value() -> GroupMembershipTypeDef:
    return {
        "IdentityStoreId": ...,
    }
# GroupMembershipTypeDef definition

class GroupMembershipTypeDef(TypedDict):
    IdentityStoreId: str,
    MembershipId: NotRequired[str],
    GroupId: NotRequired[str],
    MemberId: NotRequired[MemberIdTypeDef],  # (1)
  1. See MemberIdTypeDef

IsMemberInGroupsRequestRequestTypeDef#

# IsMemberInGroupsRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import IsMemberInGroupsRequestRequestTypeDef

def get_value() -> IsMemberInGroupsRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "MemberId": ...,
        "GroupIds": ...,
    }
# IsMemberInGroupsRequestRequestTypeDef definition

class IsMemberInGroupsRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    MemberId: MemberIdTypeDef,  # (1)
    GroupIds: Sequence[str],
  1. See MemberIdTypeDef

ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef#

# ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef

def get_value() -> ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef:
    return {
        "IdentityStoreId": ...,
        "MemberId": ...,
    }
# ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef definition

class ListGroupMembershipsForMemberRequestListGroupMembershipsForMemberPaginateTypeDef(TypedDict):
    IdentityStoreId: str,
    MemberId: MemberIdTypeDef,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See MemberIdTypeDef
  2. See PaginatorConfigTypeDef

ListGroupMembershipsForMemberRequestRequestTypeDef#

# ListGroupMembershipsForMemberRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupMembershipsForMemberRequestRequestTypeDef

def get_value() -> ListGroupMembershipsForMemberRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "MemberId": ...,
    }
# ListGroupMembershipsForMemberRequestRequestTypeDef definition

class ListGroupMembershipsForMemberRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    MemberId: MemberIdTypeDef,  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See MemberIdTypeDef

CreateUserRequestRequestTypeDef#

# CreateUserRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import CreateUserRequestRequestTypeDef

def get_value() -> CreateUserRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
    }
# 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],
  1. See NameTypeDef
  2. See EmailTypeDef
  3. See AddressTypeDef
  4. See PhoneNumberTypeDef

DescribeUserResponseTypeDef#

# DescribeUserResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import DescribeUserResponseTypeDef

def get_value() -> DescribeUserResponseTypeDef:
    return {
        "UserName": ...,
        "UserId": ...,
        "ExternalIds": ...,
        "Name": ...,
        "DisplayName": ...,
        "NickName": ...,
        "ProfileUrl": ...,
        "Emails": ...,
        "Addresses": ...,
        "PhoneNumbers": ...,
        "UserType": ...,
        "Title": ...,
        "PreferredLanguage": ...,
        "Locale": ...,
        "Timezone": ...,
        "IdentityStoreId": ...,
        "ResponseMetadata": ...,
    }
# 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)
  1. See ExternalIdTypeDef
  2. See NameTypeDef
  3. See EmailTypeDef
  4. See AddressTypeDef
  5. See PhoneNumberTypeDef
  6. See ResponseMetadataTypeDef

UserTypeDef#

# UserTypeDef usage example

from mypy_boto3_identitystore.type_defs import UserTypeDef

def get_value() -> UserTypeDef:
    return {
        "UserId": ...,
        "IdentityStoreId": ...,
    }
# 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],
  1. See ExternalIdTypeDef
  2. See NameTypeDef
  3. See EmailTypeDef
  4. See AddressTypeDef
  5. See PhoneNumberTypeDef

ListGroupsRequestListGroupsPaginateTypeDef#

# ListGroupsRequestListGroupsPaginateTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupsRequestListGroupsPaginateTypeDef

def get_value() -> ListGroupsRequestListGroupsPaginateTypeDef:
    return {
        "IdentityStoreId": ...,
    }
# ListGroupsRequestListGroupsPaginateTypeDef definition

class ListGroupsRequestListGroupsPaginateTypeDef(TypedDict):
    IdentityStoreId: str,
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListGroupsRequestRequestTypeDef#

# ListGroupsRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupsRequestRequestTypeDef

def get_value() -> ListGroupsRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
    }
# ListGroupsRequestRequestTypeDef definition

class ListGroupsRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListUsersRequestListUsersPaginateTypeDef#

# ListUsersRequestListUsersPaginateTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListUsersRequestListUsersPaginateTypeDef

def get_value() -> ListUsersRequestListUsersPaginateTypeDef:
    return {
        "IdentityStoreId": ...,
    }
# ListUsersRequestListUsersPaginateTypeDef definition

class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
    IdentityStoreId: str,
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

ListUsersRequestRequestTypeDef#

# ListUsersRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListUsersRequestRequestTypeDef

def get_value() -> ListUsersRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
    }
# ListUsersRequestRequestTypeDef definition

class ListUsersRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
  1. See FilterTypeDef

ListGroupsResponseTypeDef#

# ListGroupsResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupsResponseTypeDef

def get_value() -> ListGroupsResponseTypeDef:
    return {
        "Groups": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListGroupsResponseTypeDef definition

class ListGroupsResponseTypeDef(TypedDict):
    Groups: List[GroupTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupTypeDef
  2. See ResponseMetadataTypeDef

GetGroupIdRequestRequestTypeDef#

# GetGroupIdRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import GetGroupIdRequestRequestTypeDef

def get_value() -> GetGroupIdRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "AlternateIdentifier": ...,
    }
# GetGroupIdRequestRequestTypeDef definition

class GetGroupIdRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    AlternateIdentifier: AlternateIdentifierTypeDef,  # (1)
  1. See AlternateIdentifierTypeDef

GetUserIdRequestRequestTypeDef#

# GetUserIdRequestRequestTypeDef usage example

from mypy_boto3_identitystore.type_defs import GetUserIdRequestRequestTypeDef

def get_value() -> GetUserIdRequestRequestTypeDef:
    return {
        "IdentityStoreId": ...,
        "AlternateIdentifier": ...,
    }
# GetUserIdRequestRequestTypeDef definition

class GetUserIdRequestRequestTypeDef(TypedDict):
    IdentityStoreId: str,
    AlternateIdentifier: AlternateIdentifierTypeDef,  # (1)
  1. See AlternateIdentifierTypeDef

IsMemberInGroupsResponseTypeDef#

# IsMemberInGroupsResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import IsMemberInGroupsResponseTypeDef

def get_value() -> IsMemberInGroupsResponseTypeDef:
    return {
        "Results": ...,
        "ResponseMetadata": ...,
    }
# IsMemberInGroupsResponseTypeDef definition

class IsMemberInGroupsResponseTypeDef(TypedDict):
    Results: List[GroupMembershipExistenceResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupMembershipExistenceResultTypeDef
  2. See ResponseMetadataTypeDef

ListGroupMembershipsForMemberResponseTypeDef#

# ListGroupMembershipsForMemberResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupMembershipsForMemberResponseTypeDef

def get_value() -> ListGroupMembershipsForMemberResponseTypeDef:
    return {
        "GroupMemberships": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListGroupMembershipsForMemberResponseTypeDef definition

class ListGroupMembershipsForMemberResponseTypeDef(TypedDict):
    GroupMemberships: List[GroupMembershipTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupMembershipTypeDef
  2. See ResponseMetadataTypeDef

ListGroupMembershipsResponseTypeDef#

# ListGroupMembershipsResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListGroupMembershipsResponseTypeDef

def get_value() -> ListGroupMembershipsResponseTypeDef:
    return {
        "GroupMemberships": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListGroupMembershipsResponseTypeDef definition

class ListGroupMembershipsResponseTypeDef(TypedDict):
    GroupMemberships: List[GroupMembershipTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupMembershipTypeDef
  2. See ResponseMetadataTypeDef

ListUsersResponseTypeDef#

# ListUsersResponseTypeDef usage example

from mypy_boto3_identitystore.type_defs import ListUsersResponseTypeDef

def get_value() -> ListUsersResponseTypeDef:
    return {
        "Users": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListUsersResponseTypeDef definition

class ListUsersResponseTypeDef(TypedDict):
    Users: List[UserTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. See ResponseMetadataTypeDef