Skip to content

get_identity_pool_roles

Operation

get_identity_pool_roles

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

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIdentityPoolRolesOutput

An instance of GetIdentityPoolRolesOutput.

get_identity_pool_roles async

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

The input fields as keyword arguments.

{}

Returns:

Type Description
GetIdentityPoolRolesOutput

An instance of GetIdentityPoolRolesOutput.

Input

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

GetIdentityPoolRolesInputDict

Bases: TypedDict

Dictionary form of GetIdentityPoolRolesInput.

Attributes

identity_pool_id instance-attribute
identity_pool_id: Required[str]

An identity pool ID in the format REGION:GUID.

GetIdentityPoolRolesInput dataclass

Bases: _SerdeShape

Input to the GetIdentityPoolRoles action.

Attributes

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

An identity pool ID in the format REGION:GUID.

Output

GetIdentityPoolRolesOutput dataclass

Bases: _SerdeShape

Returned in response to a successful GetIdentityPoolRoles operation.

Attributes

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

An identity pool ID in the format REGION:GUID.

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.

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.

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

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