list_identities¶
Operation¶
list_identities
¶
list_identities(request: ListIdentitiesInput | ListIdentitiesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListIdentitiesInputDict]) -> ListIdentitiesOutput
Lists the identities in an identity pool.
You must use Amazon Web Services developer credentials to call this operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListIdentitiesInput | ListIdentitiesInputDict | 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[ListIdentitiesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListIdentitiesOutput
|
An instance of |
list_identities
async
¶
list_identities(request: ListIdentitiesInput | ListIdentitiesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListIdentitiesInputDict]) -> ListIdentitiesOutput
Lists the identities in an identity pool.
You must use Amazon Web Services developer credentials to call this operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListIdentitiesInput | ListIdentitiesInputDict | 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[ListIdentitiesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListIdentitiesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListIdentitiesInputDict
¶
Bases: TypedDict
Dictionary form of ListIdentitiesInput.
Attributes¶
hide_disabled
instance-attribute
¶
hide_disabled: bool | None
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
identity_pool_id
instance-attribute
¶
An identity pool ID in the format REGION:GUID.
max_results
instance-attribute
¶
The maximum number of identities to return.
ListIdentitiesInput
dataclass
¶
Bases: _SerdeShape
Input to the ListIdentities action.
Attributes¶
hide_disabled
class-attribute
instance-attribute
¶
hide_disabled: bool = ...
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
identity_pool_id
class-attribute
instance-attribute
¶
identity_pool_id: str | None = ...
An identity pool ID in the format REGION:GUID.
Output¶
ListIdentitiesOutput
dataclass
¶
Bases: _SerdeShape
The response to a ListIdentities request.
Attributes¶
identities
class-attribute
instance-attribute
¶
identities: list[IdentityDescription] | None = ...
An object containing a set of identities and associated mappings.
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
¶
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.