Skip to content

set_identity_pool_roles

Operation

set_identity_pool_roles

set_identity_pool_roles(request: SetIdentityPoolRolesInput | SetIdentityPoolRolesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SetIdentityPoolRolesInputDict]) -> 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
request SetIdentityPoolRolesInput | SetIdentityPoolRolesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[SetIdentityPoolRolesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SetIdentityPoolRolesOutput

An instance of SetIdentityPoolRolesOutput.

set_identity_pool_roles async

set_identity_pool_roles(request: SetIdentityPoolRolesInput | SetIdentityPoolRolesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SetIdentityPoolRolesInputDict]) -> 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
request SetIdentityPoolRolesInput | SetIdentityPoolRolesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[SetIdentityPoolRolesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SetIdentityPoolRolesOutput

An instance of SetIdentityPoolRolesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

SetIdentityPoolRolesInputDict

Bases: TypedDict

Dictionary form of SetIdentityPoolRolesInput.

Attributes

identity_pool_id instance-attribute
identity_pool_id: Required[str]

An identity pool ID in the format REGION:GUID.

role_mappings instance-attribute
role_mappings: Mapping[str, RoleMapping | RoleMappingDict] | 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 instance-attribute
roles: Required[Mapping[str, str]]

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.

SetIdentityPoolRolesInput dataclass

Bases: _SerdeShape

Input to the SetIdentityPoolRoles action.

Attributes

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

An identity pool ID in the format REGION:GUID.

role_mappings class-attribute instance-attribute
role_mappings: dict[str, RoleMapping] | 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 = ...

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

Bases: _SerdeShape

Dataclass for SetIdentityPoolRolesOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.