rboto-cognito-identity

rboto is an independent project maintained by Ferrumio. It is not affiliated with, sponsored by, or endorsed by Amazon Web Services (AWS).

Preview (Alpha). rboto is under active development. APIs may change between releases.

rboto provides an async-only, typed Python client for Amazon Cognito Identity, powered by Rust. This package contains CognitoIdentityClient and 23 operations.

Installation

Requires Python 3.12 or newer and a native wheel for your Python version and platform.

python -m pip install "rboto[cognito-identity]"

You can also install rboto-cognito-identity directly; it installs the matching rboto package. Only the selected service is installed.

These are the package names to use when a release is available on your package index. If your index has no release yet, follow the source installation instructions.

Usage

Configure credentials through your environment, shared profile, or workload role. The example uses us-east-1; select a region where your service and resources are available. Resource names, identifiers, input files, and model IDs in the example are placeholders to replace with your own.

import asyncio

from rboto import CognitoIdentityClient


async def main() -> None:
    client = CognitoIdentityClient(region="us-east-1")
    # The identity pool must allow unauthenticated identities for this request.
    response = await client.get_id(
        identity_pool_id="us-east-1:00000000-0000-0000-0000-000000000000",
    )
    print(response.identity_id)


if __name__ == "__main__":
    asyncio.run(main())

In an application with an event loop, call await main() instead of asyncio.run(main()). Reuse the client across calls. Constructing a client does not send a request.

API conventions

• Import the client with from rboto import CognitoIdentityClient.

• Every operation is asynchronous: use await client.method(...).

• Operation arguments are keyword-only and use the Python names listed below.

• Structured inputs use typed dictionaries and tagged unions from rboto_cognito_identity.types.

• Regular responses expose typed attributes; response.to_dict() converts them to a dictionary.

• Event-stream responses may be typed dictionaries containing async iterators. Follow the declared return type; consume event streams with async for.

• Byte streams are consumed asynchronously. await stream.read() buffers the complete body; iterate the stream when processing a large response.

• Direct operation calls return one page.

• Use async for page in client.paginators.method(...) for supported paginated operations. Paginators accept the same typed arguments as the corresponding client method.

• Catch modeled exceptions from rboto_cognito_identity.exceptions. Their error_code, message, and operation_name identify service failures.

Clients also accept profile, endpoint_url, or shared Session settings. See configuration, errors, and streaming.

Operations

This is the complete operation catalog for this generated package. “Required arguments” lists arguments without defaults in the Python signature. Service-side conditions may require additional arguments. Each method links to its complete signature, including optional arguments. Nested input definitions are in rboto_cognito_identity.types; native response definitions are in the package's _native.pyi.

Method	Required arguments	Return type
create_identity_pool	identity_pool_name: str, allow_unauthenticated_identities: bool	CreateIdentityPoolOutput
delete_identities	identity_ids_to_delete: Sequence[str]	DeleteIdentitiesOutput
delete_identity_pool	identity_pool_id: str	None
describe_identity	identity_id: str	DescribeIdentityOutput
describe_identity_pool	identity_pool_id: str	DescribeIdentityPoolOutput
get_credentials_for_identity	identity_id: str	GetCredentialsForIdentityOutput
get_id	identity_pool_id: str	GetIdOutput
get_identity_pool_roles	identity_pool_id: str	GetIdentityPoolRolesOutput
get_open_id_token	identity_id: str	GetOpenIdTokenOutput
get_open_id_token_for_developer_identity	identity_pool_id: str, logins: dict[str, str]	GetOpenIdTokenForDeveloperIdentityOutput
get_principal_tag_attribute_map	identity_pool_id: str, identity_provider_name: str	GetPrincipalTagAttributeMapOutput
list_identities	identity_pool_id: str, max_results: int	ListIdentitiesOutput
list_identity_pools	max_results: int	ListIdentityPoolsOutput
list_tags_for_resource	resource_arn: str	ListTagsForResourceOutput
lookup_developer_identity	identity_pool_id: str	LookupDeveloperIdentityOutput
merge_developer_identities	source_user_identifier: str, destination_user_identifier: str, developer_provider_name: str, identity_pool_id: str	MergeDeveloperIdentitiesOutput
set_identity_pool_roles	identity_pool_id: str, roles: dict[str, str]	None
set_principal_tag_attribute_map	identity_pool_id: str, identity_provider_name: str	SetPrincipalTagAttributeMapOutput
tag_resource	resource_arn: str, tags: dict[str, str]	TagResourceOutput
unlink_developer_identity	identity_id: str, identity_pool_id: str, developer_provider_name: str, developer_user_identifier: str	None
unlink_identity	identity_id: str, logins: dict[str, str], logins_to_remove: Sequence[str]	None
untag_resource	resource_arn: str, tag_keys: Sequence[str]	UntagResourceOutput
update_identity_pool	identity_pool_id: str, identity_pool_name: str, allow_unauthenticated_identities: bool	UpdateIdentityPoolOutput

Complete signatures

create_identity_pool

async def create_identity_pool(
    *,
    identity_pool_name: str,
    allow_unauthenticated_identities: bool,
    allow_classic_flow: bool | None = None,
    supported_login_providers: dict[str, str] | None = None,
    developer_provider_name: str | None = None,
    open_id_connect_provider_arns: Sequence[str] | None = None,
    cognito_identity_providers: Sequence[CognitoIdentityProvider] | None = None,
    saml_provider_arns: Sequence[str] | None = None,
    identity_pool_tags: dict[str, str] | None = None,
) -> CreateIdentityPoolOutput: ...

delete_identities

async def delete_identities(
    *,
    identity_ids_to_delete: Sequence[str],
) -> DeleteIdentitiesOutput: ...

delete_identity_pool

async def delete_identity_pool(
    *,
    identity_pool_id: str,
) -> None: ...

describe_identity

async def describe_identity(
    *,
    identity_id: str,
) -> DescribeIdentityOutput: ...

describe_identity_pool

async def describe_identity_pool(
    *,
    identity_pool_id: str,
) -> DescribeIdentityPoolOutput: ...

get_credentials_for_identity

async def get_credentials_for_identity(
    *,
    identity_id: str,
    logins: dict[str, str] | None = None,
    custom_role_arn: str | None = None,
) -> GetCredentialsForIdentityOutput: ...

get_id

async def get_id(
    *,
    identity_pool_id: str,
    account_id: str | None = None,
    logins: dict[str, str] | None = None,
) -> GetIdOutput: ...

get_identity_pool_roles

async def get_identity_pool_roles(
    *,
    identity_pool_id: str,
) -> GetIdentityPoolRolesOutput: ...

get_open_id_token

async def get_open_id_token(
    *,
    identity_id: str,
    logins: dict[str, str] | None = None,
) -> GetOpenIdTokenOutput: ...

get_open_id_token_for_developer_identity

async def get_open_id_token_for_developer_identity(
    *,
    identity_pool_id: str,
    logins: dict[str, str],
    identity_id: str | None = None,
    principal_tags: dict[str, str] | None = None,
    token_duration: int | None = None,
) -> GetOpenIdTokenForDeveloperIdentityOutput: ...

get_principal_tag_attribute_map

async def get_principal_tag_attribute_map(
    *,
    identity_pool_id: str,
    identity_provider_name: str,
) -> GetPrincipalTagAttributeMapOutput: ...

list_identities

async def list_identities(
    *,
    identity_pool_id: str,
    max_results: int,
    next_token: str | None = None,
    hide_disabled: bool | None = None,
) -> ListIdentitiesOutput: ...

list_identity_pools

async def list_identity_pools(
    *,
    max_results: int,
    next_token: str | None = None,
) -> ListIdentityPoolsOutput: ...

Also available as client.paginators.list_identity_pools(...), returning an async iterator of the response type above.

list_tags_for_resource

async def list_tags_for_resource(
    *,
    resource_arn: str,
) -> ListTagsForResourceOutput: ...

lookup_developer_identity

async def lookup_developer_identity(
    *,
    identity_pool_id: str,
    identity_id: str | None = None,
    developer_user_identifier: str | None = None,
    max_results: int | None = None,
    next_token: str | None = None,
) -> LookupDeveloperIdentityOutput: ...

merge_developer_identities

async def merge_developer_identities(
    *,
    source_user_identifier: str,
    destination_user_identifier: str,
    developer_provider_name: str,
    identity_pool_id: str,
) -> MergeDeveloperIdentitiesOutput: ...

set_identity_pool_roles

async def set_identity_pool_roles(
    *,
    identity_pool_id: str,
    roles: dict[str, str],
    role_mappings: dict[str, RoleMapping] | None = None,
) -> None: ...

set_principal_tag_attribute_map

async def set_principal_tag_attribute_map(
    *,
    identity_pool_id: str,
    identity_provider_name: str,
    use_defaults: bool | None = None,
    principal_tags: dict[str, str] | None = None,
) -> SetPrincipalTagAttributeMapOutput: ...

tag_resource

async def tag_resource(
    *,
    resource_arn: str,
    tags: dict[str, str],
) -> TagResourceOutput: ...

unlink_developer_identity

async def unlink_developer_identity(
    *,
    identity_id: str,
    identity_pool_id: str,
    developer_provider_name: str,
    developer_user_identifier: str,
) -> None: ...

unlink_identity

async def unlink_identity(
    *,
    identity_id: str,
    logins: dict[str, str],
    logins_to_remove: Sequence[str],
) -> None: ...

untag_resource

async def untag_resource(
    *,
    resource_arn: str,
    tag_keys: Sequence[str],
) -> UntagResourceOutput: ...

update_identity_pool

async def update_identity_pool(
    *,
    identity_pool_id: str,
    identity_pool_name: str,
    allow_unauthenticated_identities: bool,
    allow_classic_flow: bool | None = None,
    supported_login_providers: dict[str, str] | None = None,
    developer_provider_name: str | None = None,
    open_id_connect_provider_arns: Sequence[str] | None = None,
    cognito_identity_providers: Sequence[CognitoIdentityProvider] | None = None,
    saml_provider_arns: Sequence[str] | None = None,
    identity_pool_tags: dict[str, str] | None = None,
) -> UpdateIdentityPoolOutput: ...

Links

• Service guide
• Repository
• Issues
• Releases

Licensed under Apache-2.0.