Skip to content

Cognito Identity  >  Operations  >  set_identity_pool_roles

set_identity_pool_roles

Operation

set_identity_pool_roles async 

set_identity_pool_roles(input: SetIdentityPoolRolesInput, plugins: list[Plugin] | None = None) -> SetIdentityPoolRolesOutput

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

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

Parameters:

Name Type Description Default
input SetIdentityPoolRolesInput

An instance of SetIdentityPoolRolesInput.

 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
SetIdentityPoolRolesOutput

An instance of SetIdentityPoolRolesOutput.

Input

SetIdentityPoolRolesInput dataclass

Input to the SetIdentityPoolRoles action.

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.

Up to 25 rules can be specified per identity provider.

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

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.

Output

SetIdentityPoolRolesOutput dataclass

Dataclass for SetIdentityPoolRolesOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.