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
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.
client = boto3.client("identitystore")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("identitystore").close
method.
boto3 documentation
create_group
Creates a group within the specified identity store.
Type annotations and code completion for boto3.client("identitystore").create_group
method.
boto3 documentation
def create_group(
self,
*,
IdentityStoreId: str,
DisplayName: str = ...,
Description: str = ...,
) -> CreateGroupResponseTypeDef: # (1)
...
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
}
parent.create_group(**kwargs)
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
def create_group_membership(
self,
*,
IdentityStoreId: str,
GroupId: str,
MemberId: MemberIdTypeDef, # (1)
) -> CreateGroupMembershipResponseTypeDef: # (2)
...
kwargs: CreateGroupMembershipRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"GroupId": ...,
"MemberId": ...,
}
parent.create_group_membership(**kwargs)
create_user
Creates a new user within the specified identity store.
Type annotations and code completion for boto3.client("identitystore").create_user
method.
boto3 documentation
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)
...
- See NameTypeDef
- See EmailTypeDef
- See AddressTypeDef
- See PhoneNumberTypeDef
- See CreateUserResponseTypeDef
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
}
parent.create_user(**kwargs)
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
def delete_group(
self,
*,
IdentityStoreId: str,
GroupId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteGroupRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"GroupId": ...,
}
parent.delete_group(**kwargs)
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
def delete_group_membership(
self,
*,
IdentityStoreId: str,
MembershipId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteGroupMembershipRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"MembershipId": ...,
}
parent.delete_group_membership(**kwargs)
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
def delete_user(
self,
*,
IdentityStoreId: str,
UserId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"UserId": ...,
}
parent.delete_user(**kwargs)
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
def describe_group(
self,
*,
IdentityStoreId: str,
GroupId: str,
) -> DescribeGroupResponseTypeDef: # (1)
...
kwargs: DescribeGroupRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"GroupId": ...,
}
parent.describe_group(**kwargs)
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
def describe_group_membership(
self,
*,
IdentityStoreId: str,
MembershipId: str,
) -> DescribeGroupMembershipResponseTypeDef: # (1)
...
kwargs: DescribeGroupMembershipRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"MembershipId": ...,
}
parent.describe_group_membership(**kwargs)
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
def describe_user(
self,
*,
IdentityStoreId: str,
UserId: str,
) -> DescribeUserResponseTypeDef: # (1)
...
kwargs: DescribeUserRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"UserId": ...,
}
parent.describe_user(**kwargs)
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
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
def get_group_id(
self,
*,
IdentityStoreId: str,
AlternateIdentifier: AlternateIdentifierTypeDef, # (1)
) -> GetGroupIdResponseTypeDef: # (2)
...
kwargs: GetGroupIdRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"AlternateIdentifier": ...,
}
parent.get_group_id(**kwargs)
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
def get_group_membership_id(
self,
*,
IdentityStoreId: str,
GroupId: str,
MemberId: MemberIdTypeDef, # (1)
) -> GetGroupMembershipIdResponseTypeDef: # (2)
...
kwargs: GetGroupMembershipIdRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"GroupId": ...,
"MemberId": ...,
}
parent.get_group_membership_id(**kwargs)
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
def get_user_id(
self,
*,
IdentityStoreId: str,
AlternateIdentifier: AlternateIdentifierTypeDef, # (1)
) -> GetUserIdResponseTypeDef: # (2)
...
kwargs: GetUserIdRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"AlternateIdentifier": ...,
}
parent.get_user_id(**kwargs)
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
def is_member_in_groups(
self,
*,
IdentityStoreId: str,
MemberId: MemberIdTypeDef, # (1)
GroupIds: Sequence[str],
) -> IsMemberInGroupsResponseTypeDef: # (2)
...
kwargs: IsMemberInGroupsRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"MemberId": ...,
"GroupIds": ...,
}
parent.is_member_in_groups(**kwargs)
list_group_memberships
For the specified group in the specified identity store, returns the list of all
GroupMembership
objects and returns results in paginated form.
Type annotations and code completion for boto3.client("identitystore").list_group_memberships
method.
boto3 documentation
def list_group_memberships(
self,
*,
IdentityStoreId: str,
GroupId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListGroupMembershipsResponseTypeDef: # (1)
...
kwargs: ListGroupMembershipsRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"GroupId": ...,
}
parent.list_group_memberships(**kwargs)
list_group_memberships_for_member
For the specified member in the specified identity store, returns the list of
all GroupMembership
objects and returns results in paginated form.
Type annotations and code completion for boto3.client("identitystore").list_group_memberships_for_member
method.
boto3 documentation
def list_group_memberships_for_member(
self,
*,
IdentityStoreId: str,
MemberId: MemberIdTypeDef, # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListGroupMembershipsForMemberResponseTypeDef: # (2)
...
kwargs: ListGroupMembershipsForMemberRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"MemberId": ...,
}
parent.list_group_memberships_for_member(**kwargs)
list_groups
Lists all groups in the identity store.
Type annotations and code completion for boto3.client("identitystore").list_groups
method.
boto3 documentation
def list_groups(
self,
*,
IdentityStoreId: str,
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListGroupsResponseTypeDef: # (2)
...
kwargs: ListGroupsRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
}
parent.list_groups(**kwargs)
list_users
Lists all users in the identity store.
Type annotations and code completion for boto3.client("identitystore").list_users
method.
boto3 documentation
def list_users(
self,
*,
IdentityStoreId: str,
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListUsersResponseTypeDef: # (2)
...
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
}
parent.list_users(**kwargs)
update_group
For the specified group in the specified identity store, updates the group metadata and attributes.
Type annotations and code completion for boto3.client("identitystore").update_group
method.
boto3 documentation
def update_group(
self,
*,
IdentityStoreId: str,
GroupId: str,
Operations: Sequence[AttributeOperationTypeDef], # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateGroupRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"GroupId": ...,
"Operations": ...,
}
parent.update_group(**kwargs)
update_user
For the specified user in the specified identity store, updates the user metadata and attributes.
Type annotations and code completion for boto3.client("identitystore").update_user
method.
boto3 documentation
def update_user(
self,
*,
IdentityStoreId: str,
UserId: str,
Operations: Sequence[AttributeOperationTypeDef], # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateUserRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"UserId": ...,
"Operations": ...,
}
parent.update_user(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("identitystore").get_paginator
method with overloads.
client.get_paginator("list_group_memberships")
-> ListGroupMembershipsPaginatorclient.get_paginator("list_group_memberships_for_member")
-> ListGroupMembershipsForMemberPaginatorclient.get_paginator("list_groups")
-> ListGroupsPaginatorclient.get_paginator("list_users")
-> ListUsersPaginator