IdentityStoreClient
Index > IdentityStore > IdentityStoreClient
Auto-generated documentation for IdentityStore type annotations stubs module types-aiobotocore-identitystore.
IdentityStoreClient
Type annotations and code completion for session.client("identitystore")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_identitystore.client import IdentityStoreClient
session = Session()
async with session.client("identitystore") as client:
client: IdentityStoreClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("identitystore").exceptions
structure.
async with session.client("identitystore") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.InternalServerException,
client.ResourceNotFoundException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_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 session.client("identitystore").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("identitystore").close
method.
boto3 documentation
describe_group
Retrieves the group metadata and attributes from GroupId
in an identity store.
Type annotations and code completion for session.client("identitystore").describe_group
method.
boto3 documentation
await def describe_group(
self,
*,
IdentityStoreId: str,
GroupId: str,
) -> DescribeGroupResponseTypeDef: # (1)
...
kwargs: DescribeGroupRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
"GroupId": ...,
}
parent.describe_group(**kwargs)
describe_user
Retrieves the user metadata and attributes from UserId
in an identity store.
Type annotations and code completion for session.client("identitystore").describe_user
method.
boto3 documentation
await 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 session.client("identitystore").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_groups
Lists the attribute name and value of the group that you specified in the search.
Type annotations and code completion for session.client("identitystore").list_groups
method.
boto3 documentation
await 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 the attribute name and value of the user that you specified in the search.
Type annotations and code completion for session.client("identitystore").list_users
method.
boto3 documentation
await def list_users(
self,
*,
IdentityStoreId: str,
MaxResults: int = ...,
NextToken: str = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListUsersResponseTypeDef: # (2)
...
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"IdentityStoreId": ...,
}
parent.list_users(**kwargs)
__aenter__
Type annotations and code completion for session.client("identitystore").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("identitystore").__aexit__
method.
boto3 documentation