Skip to content

SetIdentityPoolRolesInput

Source code in docs_src/capo_cognito_identity/types/set_identity_pool_roles_input.py
class SetIdentityPoolRolesInput(TypedDict, closed=True):
    identity_pool_id: "capo_cognito_identity.types.identity_pool_id.IdentityPoolId"
    """<p>An identity pool ID in the format REGION:GUID.</p>"""
    roles: "capo_cognito_identity.types.roles_map.RolesMap"
    """<p>The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.</p>"""
    role_mappings: NotRequired[
        "capo_cognito_identity.types.role_mapping_map.RoleMappingMap"
    ]
    """<p>How users for a specific identity provider are to mapped to roles. This is a string to <a>RoleMapping</a> object map. The string identifies the identity provider, for example, <code>graph.facebook.com</code> or <code>cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id</code>.</p> <p>Up to 25 rules can be specified per identity provider.</p>"""

identity_pool_id instance-attribute

identity_pool_id: IdentityPoolId

An identity pool ID in the format REGION:GUID.

role_mappings instance-attribute

role_mappings: NotRequired[RoleMappingMap]

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.

Up to 25 rules can be specified per identity provider.

roles instance-attribute

roles: RolesMap

The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.