Skip to content

IdentityStoreClient#

Index > IdentityStore > IdentityStoreClient

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

IdentityStoreClient#

Type annotations and code completion for boto3.client("identitystore"). boto3 documentation

# IdentityStoreClient usage example

from boto3.session import Session
from mypy_boto3_identitystore.client import IdentityStoreClient

def get_identitystore_client() -> IdentityStoreClient:
    return Session().client("identitystore")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("identitystore").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("identitystore")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_identitystore.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("identitystore").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("identitystore").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_group#

Creates a group within the specified identity store.

Type annotations and code completion for boto3.client("identitystore").create_group method. boto3 documentation

# create_group method definition

def create_group(
    self,
    *,
    IdentityStoreId: str,
    DisplayName: str = ...,
    Description: str = ...,
) -> CreateGroupResponseTypeDef:  # (1)
    ...
  1. See CreateGroupResponseTypeDef
# create_group method usage example with argument unpacking

kwargs: CreateGroupRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
}

parent.create_group(**kwargs)
  1. See CreateGroupRequestRequestTypeDef

create_group_membership#

Creates a relationship between a member and a group.

Type annotations and code completion for boto3.client("identitystore").create_group_membership method. boto3 documentation

# create_group_membership method definition

def create_group_membership(
    self,
    *,
    IdentityStoreId: str,
    GroupId: str,
    MemberId: MemberIdTypeDef,  # (1)
) -> CreateGroupMembershipResponseTypeDef:  # (2)
    ...
  1. See MemberIdTypeDef
  2. See CreateGroupMembershipResponseTypeDef
# create_group_membership method usage example with argument unpacking

kwargs: CreateGroupMembershipRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "GroupId": ...,
    "MemberId": ...,
}

parent.create_group_membership(**kwargs)
  1. See CreateGroupMembershipRequestRequestTypeDef

create_user#

Creates a user within the specified identity store.

Type annotations and code completion for boto3.client("identitystore").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    IdentityStoreId: str,
    UserName: str = ...,
    Name: NameTypeDef = ...,  # (1)
    DisplayName: str = ...,
    NickName: str = ...,
    ProfileUrl: str = ...,
    Emails: Sequence[EmailTypeDef] = ...,  # (2)
    Addresses: Sequence[AddressTypeDef] = ...,  # (3)
    PhoneNumbers: Sequence[PhoneNumberTypeDef] = ...,  # (4)
    UserType: str = ...,
    Title: str = ...,
    PreferredLanguage: str = ...,
    Locale: str = ...,
    Timezone: str = ...,
) -> CreateUserResponseTypeDef:  # (5)
    ...
  1. See NameTypeDef
  2. See EmailTypeDef
  3. See AddressTypeDef
  4. See PhoneNumberTypeDef
  5. See CreateUserResponseTypeDef
# create_user method usage example with argument unpacking

kwargs: CreateUserRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestRequestTypeDef

delete_group#

Delete a group within an identity store given GroupId.

Type annotations and code completion for boto3.client("identitystore").delete_group method. boto3 documentation

# delete_group method definition

def delete_group(
    self,
    *,
    IdentityStoreId: str,
    GroupId: str,
) -> Dict[str, Any]:
    ...
# delete_group method usage example with argument unpacking

kwargs: DeleteGroupRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "GroupId": ...,
}

parent.delete_group(**kwargs)
  1. See DeleteGroupRequestRequestTypeDef

delete_group_membership#

Delete a membership within a group given MembershipId.

Type annotations and code completion for boto3.client("identitystore").delete_group_membership method. boto3 documentation

# delete_group_membership method definition

def delete_group_membership(
    self,
    *,
    IdentityStoreId: str,
    MembershipId: str,
) -> Dict[str, Any]:
    ...
# delete_group_membership method usage example with argument unpacking

kwargs: DeleteGroupMembershipRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "MembershipId": ...,
}

parent.delete_group_membership(**kwargs)
  1. See DeleteGroupMembershipRequestRequestTypeDef

delete_user#

Deletes a user within an identity store given UserId.

Type annotations and code completion for boto3.client("identitystore").delete_user method. boto3 documentation

# delete_user method definition

def delete_user(
    self,
    *,
    IdentityStoreId: str,
    UserId: str,
) -> Dict[str, Any]:
    ...
# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "UserId": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestRequestTypeDef

describe_group#

Retrieves the group metadata and attributes from GroupId in an identity store.

Type annotations and code completion for boto3.client("identitystore").describe_group method. boto3 documentation

# describe_group method definition

def describe_group(
    self,
    *,
    IdentityStoreId: str,
    GroupId: str,
) -> DescribeGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeGroupResponseTypeDef
# describe_group method usage example with argument unpacking

kwargs: DescribeGroupRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "GroupId": ...,
}

parent.describe_group(**kwargs)
  1. See DescribeGroupRequestRequestTypeDef

describe_group_membership#

Retrieves membership metadata and attributes from MembershipId in an identity store.

Type annotations and code completion for boto3.client("identitystore").describe_group_membership method. boto3 documentation

# describe_group_membership method definition

def describe_group_membership(
    self,
    *,
    IdentityStoreId: str,
    MembershipId: str,
) -> DescribeGroupMembershipResponseTypeDef:  # (1)
    ...
  1. See DescribeGroupMembershipResponseTypeDef
# describe_group_membership method usage example with argument unpacking

kwargs: DescribeGroupMembershipRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "MembershipId": ...,
}

parent.describe_group_membership(**kwargs)
  1. See DescribeGroupMembershipRequestRequestTypeDef

describe_user#

Retrieves the user metadata and attributes from the UserId in an identity store.

Type annotations and code completion for boto3.client("identitystore").describe_user method. boto3 documentation

# describe_user method definition

def describe_user(
    self,
    *,
    IdentityStoreId: str,
    UserId: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...
  1. See DescribeUserResponseTypeDef
# describe_user method usage example with argument unpacking

kwargs: DescribeUserRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "UserId": ...,
}

parent.describe_user(**kwargs)
  1. See DescribeUserRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("identitystore").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_group_id#

Retrieves GroupId in an identity store.

Type annotations and code completion for boto3.client("identitystore").get_group_id method. boto3 documentation

# get_group_id method definition

def get_group_id(
    self,
    *,
    IdentityStoreId: str,
    AlternateIdentifier: AlternateIdentifierTypeDef,  # (1)
) -> GetGroupIdResponseTypeDef:  # (2)
    ...
  1. See AlternateIdentifierTypeDef
  2. See GetGroupIdResponseTypeDef
# get_group_id method usage example with argument unpacking

kwargs: GetGroupIdRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "AlternateIdentifier": ...,
}

parent.get_group_id(**kwargs)
  1. See GetGroupIdRequestRequestTypeDef

get_group_membership_id#

Retrieves the MembershipId in an identity store.

Type annotations and code completion for boto3.client("identitystore").get_group_membership_id method. boto3 documentation

# get_group_membership_id method definition

def get_group_membership_id(
    self,
    *,
    IdentityStoreId: str,
    GroupId: str,
    MemberId: MemberIdTypeDef,  # (1)
) -> GetGroupMembershipIdResponseTypeDef:  # (2)
    ...
  1. See MemberIdTypeDef
  2. See GetGroupMembershipIdResponseTypeDef
# get_group_membership_id method usage example with argument unpacking

kwargs: GetGroupMembershipIdRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "GroupId": ...,
    "MemberId": ...,
}

parent.get_group_membership_id(**kwargs)
  1. See GetGroupMembershipIdRequestRequestTypeDef

get_user_id#

Retrieves the UserId in an identity store.

Type annotations and code completion for boto3.client("identitystore").get_user_id method. boto3 documentation

# get_user_id method definition

def get_user_id(
    self,
    *,
    IdentityStoreId: str,
    AlternateIdentifier: AlternateIdentifierTypeDef,  # (1)
) -> GetUserIdResponseTypeDef:  # (2)
    ...
  1. See AlternateIdentifierTypeDef
  2. See GetUserIdResponseTypeDef
# get_user_id method usage example with argument unpacking

kwargs: GetUserIdRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "AlternateIdentifier": ...,
}

parent.get_user_id(**kwargs)
  1. See GetUserIdRequestRequestTypeDef

is_member_in_groups#

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

Type annotations and code completion for boto3.client("identitystore").is_member_in_groups method. boto3 documentation

# is_member_in_groups method definition

def is_member_in_groups(
    self,
    *,
    IdentityStoreId: str,
    MemberId: MemberIdTypeDef,  # (1)
    GroupIds: Sequence[str],
) -> IsMemberInGroupsResponseTypeDef:  # (2)
    ...
  1. See MemberIdTypeDef
  2. See IsMemberInGroupsResponseTypeDef
# is_member_in_groups method usage example with argument unpacking

kwargs: IsMemberInGroupsRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "MemberId": ...,
    "GroupIds": ...,
}

parent.is_member_in_groups(**kwargs)
  1. See