Skip to content

Typed dictionaries#

Index > CognitoIdentity > Typed dictionaries

Auto-generated documentation for CognitoIdentity type annotations stubs module mypy-boto3-cognito-identity.

CognitoIdentityProviderTypeDef#

# CognitoIdentityProviderTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import CognitoIdentityProviderTypeDef

def get_value() -> CognitoIdentityProviderTypeDef:
    return {
        "ProviderName": ...,
    }
# CognitoIdentityProviderTypeDef definition

class CognitoIdentityProviderTypeDef(TypedDict):
    ProviderName: NotRequired[str],
    ClientId: NotRequired[str],
    ServerSideTokenCheck: NotRequired[bool],

CredentialsTypeDef#

# CredentialsTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import CredentialsTypeDef

def get_value() -> CredentialsTypeDef:
    return {
        "AccessKeyId": ...,
    }
# CredentialsTypeDef definition

class CredentialsTypeDef(TypedDict):
    AccessKeyId: NotRequired[str],
    SecretKey: NotRequired[str],
    SessionToken: NotRequired[str],
    Expiration: NotRequired[datetime],

DeleteIdentitiesInputRequestTypeDef#

# DeleteIdentitiesInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import DeleteIdentitiesInputRequestTypeDef

def get_value() -> DeleteIdentitiesInputRequestTypeDef:
    return {
        "IdentityIdsToDelete": ...,
    }
# DeleteIdentitiesInputRequestTypeDef definition

class DeleteIdentitiesInputRequestTypeDef(TypedDict):
    IdentityIdsToDelete: Sequence[str],

UnprocessedIdentityIdTypeDef#

# UnprocessedIdentityIdTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import UnprocessedIdentityIdTypeDef

def get_value() -> UnprocessedIdentityIdTypeDef:
    return {
        "IdentityId": ...,
    }
# UnprocessedIdentityIdTypeDef definition

class UnprocessedIdentityIdTypeDef(TypedDict):
    IdentityId: NotRequired[str],
    ErrorCode: NotRequired[ErrorCodeType],  # (1)
  1. See ErrorCodeType

DeleteIdentityPoolInputRequestTypeDef#

# DeleteIdentityPoolInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import DeleteIdentityPoolInputRequestTypeDef

def get_value() -> DeleteIdentityPoolInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
# DeleteIdentityPoolInputRequestTypeDef definition

class DeleteIdentityPoolInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

DescribeIdentityInputRequestTypeDef#

# DescribeIdentityInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import DescribeIdentityInputRequestTypeDef

def get_value() -> DescribeIdentityInputRequestTypeDef:
    return {
        "IdentityId": ...,
    }
# DescribeIdentityInputRequestTypeDef definition

class DescribeIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,

DescribeIdentityPoolInputRequestTypeDef#

# DescribeIdentityPoolInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import DescribeIdentityPoolInputRequestTypeDef

def get_value() -> DescribeIdentityPoolInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
# DescribeIdentityPoolInputRequestTypeDef definition

class DescribeIdentityPoolInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCredentialsForIdentityInputRequestTypeDef#

# GetCredentialsForIdentityInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetCredentialsForIdentityInputRequestTypeDef

def get_value() -> GetCredentialsForIdentityInputRequestTypeDef:
    return {
        "IdentityId": ...,
    }
# GetCredentialsForIdentityInputRequestTypeDef definition

class GetCredentialsForIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,
    Logins: NotRequired[Mapping[str, str]],
    CustomRoleArn: NotRequired[str],

GetIdInputRequestTypeDef#

# GetIdInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetIdInputRequestTypeDef

def get_value() -> GetIdInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
# GetIdInputRequestTypeDef definition

class GetIdInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    AccountId: NotRequired[str],
    Logins: NotRequired[Mapping[str, str]],

GetIdResponseTypeDef#

# GetIdResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetIdResponseTypeDef

def get_value() -> GetIdResponseTypeDef:
    return {
        "IdentityId": ...,
        "ResponseMetadata": ...,
    }
# GetIdResponseTypeDef definition

class GetIdResponseTypeDef(TypedDict):
    IdentityId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetIdentityPoolRolesInputRequestTypeDef#

# GetIdentityPoolRolesInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetIdentityPoolRolesInputRequestTypeDef

def get_value() -> GetIdentityPoolRolesInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
# GetIdentityPoolRolesInputRequestTypeDef definition

class GetIdentityPoolRolesInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef#

# GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef

def get_value() -> GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "Logins": ...,
    }
# GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef definition

class GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    Logins: Mapping[str, str],
    IdentityId: NotRequired[str],
    PrincipalTags: NotRequired[Mapping[str, str]],
    TokenDuration: NotRequired[int],

GetOpenIdTokenForDeveloperIdentityResponseTypeDef#

# GetOpenIdTokenForDeveloperIdentityResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetOpenIdTokenForDeveloperIdentityResponseTypeDef

def get_value() -> GetOpenIdTokenForDeveloperIdentityResponseTypeDef:
    return {
        "IdentityId": ...,
        "Token": ...,
        "ResponseMetadata": ...,
    }
# GetOpenIdTokenForDeveloperIdentityResponseTypeDef definition

class GetOpenIdTokenForDeveloperIdentityResponseTypeDef(TypedDict):
    IdentityId: str,
    Token: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetOpenIdTokenInputRequestTypeDef#

# GetOpenIdTokenInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetOpenIdTokenInputRequestTypeDef

def get_value() -> GetOpenIdTokenInputRequestTypeDef:
    return {
        "IdentityId": ...,
    }
# GetOpenIdTokenInputRequestTypeDef definition

class GetOpenIdTokenInputRequestTypeDef(TypedDict):
    IdentityId: str,
    Logins: NotRequired[Mapping[str, str]],

GetOpenIdTokenResponseTypeDef#

# GetOpenIdTokenResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetOpenIdTokenResponseTypeDef

def get_value() -> GetOpenIdTokenResponseTypeDef:
    return {
        "IdentityId": ...,
        "Token": ...,
        "ResponseMetadata": ...,
    }
# GetOpenIdTokenResponseTypeDef definition

class GetOpenIdTokenResponseTypeDef(TypedDict):
    IdentityId: str,
    Token: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetPrincipalTagAttributeMapInputRequestTypeDef#

# GetPrincipalTagAttributeMapInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetPrincipalTagAttributeMapInputRequestTypeDef

def get_value() -> GetPrincipalTagAttributeMapInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityProviderName": ...,
    }
# GetPrincipalTagAttributeMapInputRequestTypeDef definition

class GetPrincipalTagAttributeMapInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityProviderName: str,

GetPrincipalTagAttributeMapResponseTypeDef#

# GetPrincipalTagAttributeMapResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetPrincipalTagAttributeMapResponseTypeDef

def get_value() -> GetPrincipalTagAttributeMapResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityProviderName": ...,
        "UseDefaults": ...,
        "PrincipalTags": ...,
        "ResponseMetadata": ...,
    }
# GetPrincipalTagAttributeMapResponseTypeDef definition

class GetPrincipalTagAttributeMapResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityProviderName: str,
    UseDefaults: bool,
    PrincipalTags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

IdentityDescriptionResponseMetadataTypeDef#

# IdentityDescriptionResponseMetadataTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import IdentityDescriptionResponseMetadataTypeDef

def get_value() -> IdentityDescriptionResponseMetadataTypeDef:
    return {
        "IdentityId": ...,
        "Logins": ...,
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "ResponseMetadata": ...,
    }
# IdentityDescriptionResponseMetadataTypeDef definition

class IdentityDescriptionResponseMetadataTypeDef(TypedDict):
    IdentityId: str,
    Logins: List[str],
    CreationDate: datetime,
    LastModifiedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

IdentityDescriptionTypeDef#

# IdentityDescriptionTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import IdentityDescriptionTypeDef

def get_value() -> IdentityDescriptionTypeDef:
    return {
        "IdentityId": ...,
    }
# IdentityDescriptionTypeDef definition

class IdentityDescriptionTypeDef(TypedDict):
    IdentityId: NotRequired[str],
    Logins: NotRequired[List[str]],
    CreationDate: NotRequired[datetime],
    LastModifiedDate: NotRequired[datetime],

IdentityPoolShortDescriptionTypeDef#

# IdentityPoolShortDescriptionTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import IdentityPoolShortDescriptionTypeDef

def get_value() -> IdentityPoolShortDescriptionTypeDef:
    return {
        "IdentityPoolId": ...,
    }
# IdentityPoolShortDescriptionTypeDef definition

class IdentityPoolShortDescriptionTypeDef(TypedDict):
    IdentityPoolId: NotRequired[str],
    IdentityPoolName: NotRequired[str],

ListIdentitiesInputRequestTypeDef#

# ListIdentitiesInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import ListIdentitiesInputRequestTypeDef

def get_value() -> ListIdentitiesInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "MaxResults": ...,
    }
# ListIdentitiesInputRequestTypeDef definition

class ListIdentitiesInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    MaxResults: int,
    NextToken: NotRequired[str],
    HideDisabled: NotRequired[bool],

ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef#

# ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef

def get_value() -> ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
# ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef definition

class ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListIdentityPoolsInputRequestTypeDef#

# ListIdentityPoolsInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import ListIdentityPoolsInputRequestTypeDef

def get_value() -> ListIdentityPoolsInputRequestTypeDef:
    return {
        "MaxResults": ...,
    }
# ListIdentityPoolsInputRequestTypeDef definition

class ListIdentityPoolsInputRequestTypeDef(TypedDict):
    MaxResults: int,
    NextToken: NotRequired[str],

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import ListTagsForResourceInputRequestTypeDef

def get_value() -> ListTagsForResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

LookupDeveloperIdentityInputRequestTypeDef#

# LookupDeveloperIdentityInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import LookupDeveloperIdentityInputRequestTypeDef

def get_value() -> LookupDeveloperIdentityInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
# LookupDeveloperIdentityInputRequestTypeDef definition

class LookupDeveloperIdentityInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: NotRequired[str],
    DeveloperUserIdentifier: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

LookupDeveloperIdentityResponseTypeDef#

# LookupDeveloperIdentityResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import LookupDeveloperIdentityResponseTypeDef

def get_value() -> LookupDeveloperIdentityResponseTypeDef:
    return {
        "IdentityId": ...,
        "DeveloperUserIdentifierList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# LookupDeveloperIdentityResponseTypeDef definition

class LookupDeveloperIdentityResponseTypeDef(TypedDict):
    IdentityId: str,
    DeveloperUserIdentifierList: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

MappingRuleTypeDef#

# MappingRuleTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import MappingRuleTypeDef

def get_value() -> MappingRuleTypeDef:
    return {
        "Claim": ...,
        "MatchType": ...,
        "Value": ...,
        "RoleARN": ...,
    }
# MappingRuleTypeDef definition

class MappingRuleTypeDef(TypedDict):
    Claim: str,
    MatchType: MappingRuleMatchTypeType,  # (1)
    Value: str,
    RoleARN: str,
  1. See MappingRuleMatchTypeType

MergeDeveloperIdentitiesInputRequestTypeDef#

# MergeDeveloperIdentitiesInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import MergeDeveloperIdentitiesInputRequestTypeDef

def get_value() -> MergeDeveloperIdentitiesInputRequestTypeDef:
    return {
        "SourceUserIdentifier": ...,
        "DestinationUserIdentifier": ...,
        "DeveloperProviderName": ...,
        "IdentityPoolId": ...,
    }
# MergeDeveloperIdentitiesInputRequestTypeDef definition

class MergeDeveloperIdentitiesInputRequestTypeDef(TypedDict):
    SourceUserIdentifier: str,
    DestinationUserIdentifier: str,
    DeveloperProviderName: str,
    IdentityPoolId: str,

MergeDeveloperIdentitiesResponseTypeDef#

# MergeDeveloperIdentitiesResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import MergeDeveloperIdentitiesResponseTypeDef

def get_value() -> MergeDeveloperIdentitiesResponseTypeDef:
    return {
        "IdentityId": ...,
        "ResponseMetadata": ...,
    }
# MergeDeveloperIdentitiesResponseTypeDef definition

class MergeDeveloperIdentitiesResponseTypeDef(TypedDict):
    IdentityId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SetPrincipalTagAttributeMapInputRequestTypeDef#

# SetPrincipalTagAttributeMapInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import SetPrincipalTagAttributeMapInputRequestTypeDef

def get_value() -> SetPrincipalTagAttributeMapInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityProviderName": ...,
    }
# SetPrincipalTagAttributeMapInputRequestTypeDef definition

class SetPrincipalTagAttributeMapInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityProviderName: str,
    UseDefaults: NotRequired[bool],
    PrincipalTags: NotRequired[Mapping[str, str]],

SetPrincipalTagAttributeMapResponseTypeDef#

# SetPrincipalTagAttributeMapResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import SetPrincipalTagAttributeMapResponseTypeDef

def get_value() -> SetPrincipalTagAttributeMapResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityProviderName": ...,
        "UseDefaults": ...,
        "PrincipalTags": ...,
        "ResponseMetadata": ...,
    }
# SetPrincipalTagAttributeMapResponseTypeDef definition

class SetPrincipalTagAttributeMapResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityProviderName: str,
    UseDefaults: bool,
    PrincipalTags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import TagResourceInputRequestTypeDef

def get_value() -> TagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UnlinkDeveloperIdentityInputRequestTypeDef#

# UnlinkDeveloperIdentityInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import UnlinkDeveloperIdentityInputRequestTypeDef

def get_value() -> UnlinkDeveloperIdentityInputRequestTypeDef:
    return {
        "IdentityId": ...,
        "IdentityPoolId": ...,
        "DeveloperProviderName": ...,
        "DeveloperUserIdentifier": ...,
    }
# UnlinkDeveloperIdentityInputRequestTypeDef definition

class UnlinkDeveloperIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,
    IdentityPoolId: str,
    DeveloperProviderName: str,
    DeveloperUserIdentifier: str,

UnlinkIdentityInputRequestTypeDef#

# UnlinkIdentityInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import UnlinkIdentityInputRequestTypeDef

def get_value() -> UnlinkIdentityInputRequestTypeDef:
    return {
        "IdentityId": ...,
        "Logins": ...,
        "LoginsToRemove": ...,
    }
# UnlinkIdentityInputRequestTypeDef definition

class UnlinkIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,
    Logins: Mapping[str, str],
    LoginsToRemove: Sequence[str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import UntagResourceInputRequestTypeDef

def get_value() -> UntagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

CreateIdentityPoolInputRequestTypeDef#

# CreateIdentityPoolInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import CreateIdentityPoolInputRequestTypeDef

def get_value() -> CreateIdentityPoolInputRequestTypeDef:
    return {
        "IdentityPoolName": ...,
        "AllowUnauthenticatedIdentities": ...,
    }
# CreateIdentityPoolInputRequestTypeDef definition

class CreateIdentityPoolInputRequestTypeDef(TypedDict):
    IdentityPoolName: str,
    AllowUnauthenticatedIdentities: bool,
    AllowClassicFlow: NotRequired[bool],
    SupportedLoginProviders: NotRequired[Mapping[str, str]],
    DeveloperProviderName: NotRequired[str],
    OpenIdConnectProviderARNs: NotRequired[Sequence[str]],
    CognitoIdentityProviders: NotRequired[Sequence[CognitoIdentityProviderTypeDef]],  # (1)
    SamlProviderARNs: NotRequired[Sequence[str]],
    IdentityPoolTags: NotRequired[Mapping[str, str]],
  1. See CognitoIdentityProviderTypeDef

IdentityPoolRequestTypeDef#

# IdentityPoolRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import IdentityPoolRequestTypeDef

def get_value() -> IdentityPoolRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityPoolName": ...,
        "AllowUnauthenticatedIdentities": ...,
    }
# IdentityPoolRequestTypeDef definition

class IdentityPoolRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityPoolName: str,
    AllowUnauthenticatedIdentities: bool,
    AllowClassicFlow: NotRequired[bool],
    SupportedLoginProviders: NotRequired[Mapping[str, str]],
    DeveloperProviderName: NotRequired[str],
    OpenIdConnectProviderARNs: NotRequired[Sequence[str]],
    CognitoIdentityProviders: NotRequired[Sequence[CognitoIdentityProviderTypeDef]],  # (1)
    SamlProviderARNs: NotRequired[Sequence[str]],
    IdentityPoolTags: NotRequired[Mapping[str, str]],
  1. See CognitoIdentityProviderTypeDef

IdentityPoolTypeDef#

# IdentityPoolTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import IdentityPoolTypeDef

def get_value() -> IdentityPoolTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityPoolName": ...,
        "AllowUnauthenticatedIdentities": ...,
        "AllowClassicFlow": ...,
        "SupportedLoginProviders": ...,
        "DeveloperProviderName": ...,
        "OpenIdConnectProviderARNs": ...,
        "CognitoIdentityProviders": ...,
        "SamlProviderARNs": ...,
        "IdentityPoolTags": ...,
        "ResponseMetadata": ...,
    }
# IdentityPoolTypeDef definition

class IdentityPoolTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityPoolName: str,
    AllowUnauthenticatedIdentities: bool,
    AllowClassicFlow: bool,
    SupportedLoginProviders: Dict[str, str],
    DeveloperProviderName: str,
    OpenIdConnectProviderARNs: List[str],
    CognitoIdentityProviders: List[CognitoIdentityProviderTypeDef],  # (1)
    SamlProviderARNs: List[str],
    IdentityPoolTags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CognitoIdentityProviderTypeDef
  2. See ResponseMetadataTypeDef

GetCredentialsForIdentityResponseTypeDef#

# GetCredentialsForIdentityResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetCredentialsForIdentityResponseTypeDef

def get_value() -> GetCredentialsForIdentityResponseTypeDef:
    return {
        "IdentityId": ...,
        "Credentials": ...,
        "ResponseMetadata": ...,
    }
# GetCredentialsForIdentityResponseTypeDef definition

class GetCredentialsForIdentityResponseTypeDef(TypedDict):
    IdentityId: str,
    Credentials: CredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CredentialsTypeDef
  2. See ResponseMetadataTypeDef

DeleteIdentitiesResponseTypeDef#

# DeleteIdentitiesResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import DeleteIdentitiesResponseTypeDef

def get_value() -> DeleteIdentitiesResponseTypeDef:
    return {
        "UnprocessedIdentityIds": ...,
        "ResponseMetadata": ...,
    }
# DeleteIdentitiesResponseTypeDef definition

class DeleteIdentitiesResponseTypeDef(TypedDict):
    UnprocessedIdentityIds: List[UnprocessedIdentityIdTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UnprocessedIdentityIdTypeDef
  2. See ResponseMetadataTypeDef

ListIdentitiesResponseTypeDef#

# ListIdentitiesResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import ListIdentitiesResponseTypeDef

def get_value() -> ListIdentitiesResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "Identities": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListIdentitiesResponseTypeDef definition

class ListIdentitiesResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    Identities: List[IdentityDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListIdentityPoolsResponseTypeDef#

# ListIdentityPoolsResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import ListIdentityPoolsResponseTypeDef

def get_value() -> ListIdentityPoolsResponseTypeDef:
    return {
        "IdentityPools": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListIdentityPoolsResponseTypeDef definition

class ListIdentityPoolsResponseTypeDef(TypedDict):
    IdentityPools: List[IdentityPoolShortDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityPoolShortDescriptionTypeDef
  2. See ResponseMetadataTypeDef

RulesConfigurationTypeTypeDef#

# RulesConfigurationTypeTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import RulesConfigurationTypeTypeDef

def get_value() -> RulesConfigurationTypeTypeDef:
    return {
        "Rules": ...,
    }
# RulesConfigurationTypeTypeDef definition

class RulesConfigurationTypeTypeDef(TypedDict):
    Rules: List[MappingRuleTypeDef],  # (1)
  1. See MappingRuleTypeDef

RoleMappingTypeDef#

# RoleMappingTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import RoleMappingTypeDef

def get_value() -> RoleMappingTypeDef:
    return {
        "Type": ...,
    }
# RoleMappingTypeDef definition

class RoleMappingTypeDef(TypedDict):
    Type: RoleMappingTypeType,  # (1)
    AmbiguousRoleResolution: NotRequired[AmbiguousRoleResolutionTypeType],  # (2)
    RulesConfiguration: NotRequired[RulesConfigurationTypeTypeDef],  # (3)
  1. See RoleMappingTypeType
  2. See AmbiguousRoleResolutionTypeType
  3. See RulesConfigurationTypeTypeDef

GetIdentityPoolRolesResponseTypeDef#

# GetIdentityPoolRolesResponseTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import GetIdentityPoolRolesResponseTypeDef

def get_value() -> GetIdentityPoolRolesResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "Roles": ...,
        "RoleMappings": ...,
        "ResponseMetadata": ...,
    }
# GetIdentityPoolRolesResponseTypeDef definition

class GetIdentityPoolRolesResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    Roles: Dict[str, str],
    RoleMappings: Dict[str, RoleMappingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RoleMappingTypeDef
  2. See ResponseMetadataTypeDef

SetIdentityPoolRolesInputRequestTypeDef#

# SetIdentityPoolRolesInputRequestTypeDef usage example

from mypy_boto3_cognito_identity.type_defs import SetIdentityPoolRolesInputRequestTypeDef

def get_value() -> SetIdentityPoolRolesInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "Roles": ...,
    }
# SetIdentityPoolRolesInputRequestTypeDef definition

class SetIdentityPoolRolesInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    Roles: Mapping[str, str],
    RoleMappings: NotRequired[Mapping[str, RoleMappingTypeDef]],  # (1)
  1. See RoleMappingTypeDef