Skip to content

Cognito Identity  >  Operations  >  get_identity_pool_roles

get_identity_pool_roles

Operation

get_identity_pool_roles async

get_identity_pool_roles(input: GetIdentityPoolRolesInput, plugins: list[Plugin] | None = None) -> GetIdentityPoolRolesOutput

Gets the roles for an identity pool.

You must use Amazon Web Services developer credentials to call this operation.

Parameters:

Name Type Description Default
input GetIdentityPoolRolesInput

An instance of GetIdentityPoolRolesInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetIdentityPoolRolesOutput

An instance of GetIdentityPoolRolesOutput.

Input

GetIdentityPoolRolesInput dataclass

Input to the GetIdentityPoolRoles action.

Attributes

identity_pool_id class-attribute instance-attribute
identity_pool_id: str | None = None

An identity pool ID in the format REGION:GUID.

Output

GetIdentityPoolRolesOutput dataclass

Returned in response to a successful GetIdentityPoolRoles operation.

Attributes

identity_pool_id class-attribute instance-attribute
identity_pool_id: str | None = None

An identity pool ID in the format REGION:GUID.

role_mappings class-attribute instance-attribute
role_mappings: dict[str, RoleMapping] | None = None

How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id.

roles class-attribute instance-attribute
roles: dict[str, str] | None = None

The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.