Skip to content

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

Usage example
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.

Usage example
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)
Type checking example
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

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

close

Closes underlying endpoint connections.

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

Method definition
await def close(
    self,
) -> None:
    ...

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

Method definition
await def describe_group(
    self,
    *,
    IdentityStoreId: str,
    GroupId: str,
) -> DescribeGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeGroupResponseTypeDef
Usage example with kwargs
kwargs: DescribeGroupRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
    "GroupId": ...,
}

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

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

Method definition
await def describe_user(
    self,
    *,
    IdentityStoreId: str,
    UserId: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...
  1. See DescribeUserResponseTypeDef
Usage example with kwargs
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 session.client("identitystore").generate_presigned_url method. boto3 documentation

Method definition
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

Method definition
await def list_groups(
    self,
    *,
    IdentityStoreId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListGroupsResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListGroupsResponseTypeDef
Usage example with kwargs
kwargs: ListGroupsRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
}

parent.list_groups(**kwargs)
  1. See ListGroupsRequestRequestTypeDef

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

Method definition
await def list_users(
    self,
    *,
    IdentityStoreId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListUsersResponseTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See ListUsersResponseTypeDef
Usage example with kwargs
kwargs: ListUsersRequestRequestTypeDef = {  # (1)
    "IdentityStoreId": ...,
}

parent.list_users(**kwargs)
  1. See ListUsersRequestRequestTypeDef

__aenter__

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

Method definition
await def __aenter__(
    self,
) -> IdentityStoreClient:
    ...

__aexit__

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

Method definition
await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...