Skip to content

Typed dictionaries

Index > CognitoIdentity > Typed dictionaries

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

CognitoIdentityProviderTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import CognitoIdentityProviderTypeDef

def get_value() -> CognitoIdentityProviderTypeDef:
    return {
        "ProviderName": ...,
    }
Definition
class CognitoIdentityProviderTypeDef(TypedDict):
    ProviderName: NotRequired[str],
    ClientId: NotRequired[str],
    ServerSideTokenCheck: NotRequired[bool],

CredentialsTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import CredentialsTypeDef

def get_value() -> CredentialsTypeDef:
    return {
        "AccessKeyId": ...,
    }
Definition
class CredentialsTypeDef(TypedDict):
    AccessKeyId: NotRequired[str],
    SecretKey: NotRequired[str],
    SessionToken: NotRequired[str],
    Expiration: NotRequired[datetime],

DeleteIdentitiesInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import DeleteIdentitiesInputRequestTypeDef

def get_value() -> DeleteIdentitiesInputRequestTypeDef:
    return {
        "IdentityIdsToDelete": ...,
    }
Definition
class DeleteIdentitiesInputRequestTypeDef(TypedDict):
    IdentityIdsToDelete: Sequence[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

UnprocessedIdentityIdTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import UnprocessedIdentityIdTypeDef

def get_value() -> UnprocessedIdentityIdTypeDef:
    return {
        "IdentityId": ...,
    }
Definition
class UnprocessedIdentityIdTypeDef(TypedDict):
    IdentityId: NotRequired[str],
    ErrorCode: NotRequired[ErrorCodeType],  # (1)
  1. See ErrorCodeType

DeleteIdentityPoolInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import DeleteIdentityPoolInputRequestTypeDef

def get_value() -> DeleteIdentityPoolInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
Definition
class DeleteIdentityPoolInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

DescribeIdentityInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import DescribeIdentityInputRequestTypeDef

def get_value() -> DescribeIdentityInputRequestTypeDef:
    return {
        "IdentityId": ...,
    }
Definition
class DescribeIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,

DescribeIdentityPoolInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import DescribeIdentityPoolInputRequestTypeDef

def get_value() -> DescribeIdentityPoolInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
Definition
class DescribeIdentityPoolInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetCredentialsForIdentityInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetCredentialsForIdentityInputRequestTypeDef

def get_value() -> GetCredentialsForIdentityInputRequestTypeDef:
    return {
        "IdentityId": ...,
    }
Definition
class GetCredentialsForIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,
    Logins: NotRequired[Mapping[str, str]],
    CustomRoleArn: NotRequired[str],

GetIdInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetIdInputRequestTypeDef

def get_value() -> GetIdInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
Definition
class GetIdInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    AccountId: NotRequired[str],
    Logins: NotRequired[Mapping[str, str]],

GetIdentityPoolRolesInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetIdentityPoolRolesInputRequestTypeDef

def get_value() -> GetIdentityPoolRolesInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
Definition
class GetIdentityPoolRolesInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef

def get_value() -> GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "Logins": ...,
    }
Definition
class GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    Logins: Mapping[str, str],
    IdentityId: NotRequired[str],
    PrincipalTags: NotRequired[Mapping[str, str]],
    TokenDuration: NotRequired[int],

GetOpenIdTokenInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetOpenIdTokenInputRequestTypeDef

def get_value() -> GetOpenIdTokenInputRequestTypeDef:
    return {
        "IdentityId": ...,
    }
Definition
class GetOpenIdTokenInputRequestTypeDef(TypedDict):
    IdentityId: str,
    Logins: NotRequired[Mapping[str, str]],

GetPrincipalTagAttributeMapInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetPrincipalTagAttributeMapInputRequestTypeDef

def get_value() -> GetPrincipalTagAttributeMapInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityProviderName": ...,
    }
Definition
class GetPrincipalTagAttributeMapInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityProviderName: str,

IdentityDescriptionTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import IdentityDescriptionTypeDef

def get_value() -> IdentityDescriptionTypeDef:
    return {
        "IdentityId": ...,
    }
Definition
class IdentityDescriptionTypeDef(TypedDict):
    IdentityId: NotRequired[str],
    Logins: NotRequired[List[str]],
    CreationDate: NotRequired[datetime],
    LastModifiedDate: NotRequired[datetime],

IdentityPoolShortDescriptionTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import IdentityPoolShortDescriptionTypeDef

def get_value() -> IdentityPoolShortDescriptionTypeDef:
    return {
        "IdentityPoolId": ...,
    }
Definition
class IdentityPoolShortDescriptionTypeDef(TypedDict):
    IdentityPoolId: NotRequired[str],
    IdentityPoolName: NotRequired[str],

ListIdentitiesInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import ListIdentitiesInputRequestTypeDef

def get_value() -> ListIdentitiesInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "MaxResults": ...,
    }
Definition
class ListIdentitiesInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    MaxResults: int,
    NextToken: NotRequired[str],
    HideDisabled: NotRequired[bool],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListIdentityPoolsInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import ListIdentityPoolsInputRequestTypeDef

def get_value() -> ListIdentityPoolsInputRequestTypeDef:
    return {
        "MaxResults": ...,
    }
Definition
class ListIdentityPoolsInputRequestTypeDef(TypedDict):
    MaxResults: int,
    NextToken: NotRequired[str],

ListTagsForResourceInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import ListTagsForResourceInputRequestTypeDef

def get_value() -> ListTagsForResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
Definition
class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

LookupDeveloperIdentityInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import LookupDeveloperIdentityInputRequestTypeDef

def get_value() -> LookupDeveloperIdentityInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
    }
Definition
class LookupDeveloperIdentityInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityId: NotRequired[str],
    DeveloperUserIdentifier: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

MappingRuleTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import MappingRuleTypeDef

def get_value() -> MappingRuleTypeDef:
    return {
        "Claim": ...,
        "MatchType": ...,
        "Value": ...,
        "RoleARN": ...,
    }
Definition
class MappingRuleTypeDef(TypedDict):
    Claim: str,
    MatchType: MappingRuleMatchTypeType,  # (1)
    Value: str,
    RoleARN: str,
  1. See MappingRuleMatchTypeType

MergeDeveloperIdentitiesInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import MergeDeveloperIdentitiesInputRequestTypeDef

def get_value() -> MergeDeveloperIdentitiesInputRequestTypeDef:
    return {
        "SourceUserIdentifier": ...,
        "DestinationUserIdentifier": ...,
        "DeveloperProviderName": ...,
        "IdentityPoolId": ...,
    }
Definition
class MergeDeveloperIdentitiesInputRequestTypeDef(TypedDict):
    SourceUserIdentifier: str,
    DestinationUserIdentifier: str,
    DeveloperProviderName: str,
    IdentityPoolId: str,

SetPrincipalTagAttributeMapInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import SetPrincipalTagAttributeMapInputRequestTypeDef

def get_value() -> SetPrincipalTagAttributeMapInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityProviderName": ...,
    }
Definition
class SetPrincipalTagAttributeMapInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityProviderName: str,
    UseDefaults: NotRequired[bool],
    PrincipalTags: NotRequired[Mapping[str, str]],

TagResourceInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import TagResourceInputRequestTypeDef

def get_value() -> TagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
Definition
class TagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UnlinkDeveloperIdentityInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import UnlinkDeveloperIdentityInputRequestTypeDef

def get_value() -> UnlinkDeveloperIdentityInputRequestTypeDef:
    return {
        "IdentityId": ...,
        "IdentityPoolId": ...,
        "DeveloperProviderName": ...,
        "DeveloperUserIdentifier": ...,
    }
Definition
class UnlinkDeveloperIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,
    IdentityPoolId: str,
    DeveloperProviderName: str,
    DeveloperUserIdentifier: str,

UnlinkIdentityInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import UnlinkIdentityInputRequestTypeDef

def get_value() -> UnlinkIdentityInputRequestTypeDef:
    return {
        "IdentityId": ...,
        "Logins": ...,
        "LoginsToRemove": ...,
    }
Definition
class UnlinkIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,
    Logins: Mapping[str, str],
    LoginsToRemove: Sequence[str],

UntagResourceInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import UntagResourceInputRequestTypeDef

def get_value() -> UntagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
Definition
class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

CreateIdentityPoolInputRequestTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import CreateIdentityPoolInputRequestTypeDef

def get_value() -> CreateIdentityPoolInputRequestTypeDef:
    return {
        "IdentityPoolName": ...,
        "AllowUnauthenticatedIdentities": ...,
    }
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

Usage Example
from mypy_boto3_cognito_identity.type_defs import IdentityPoolRequestTypeDef

def get_value() -> IdentityPoolRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityPoolName": ...,
        "AllowUnauthenticatedIdentities": ...,
    }
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

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetCredentialsForIdentityResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetCredentialsForIdentityResponseTypeDef

def get_value() -> GetCredentialsForIdentityResponseTypeDef:
    return {
        "IdentityId": ...,
        "Credentials": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetCredentialsForIdentityResponseTypeDef(TypedDict):
    IdentityId: str,
    Credentials: CredentialsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CredentialsTypeDef
  2. See ResponseMetadataTypeDef

GetIdResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetIdResponseTypeDef

def get_value() -> GetIdResponseTypeDef:
    return {
        "IdentityId": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetIdResponseTypeDef(TypedDict):
    IdentityId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetOpenIdTokenForDeveloperIdentityResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetOpenIdTokenForDeveloperIdentityResponseTypeDef

def get_value() -> GetOpenIdTokenForDeveloperIdentityResponseTypeDef:
    return {
        "IdentityId": ...,
        "Token": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetOpenIdTokenForDeveloperIdentityResponseTypeDef(TypedDict):
    IdentityId: str,
    Token: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetOpenIdTokenResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetOpenIdTokenResponseTypeDef

def get_value() -> GetOpenIdTokenResponseTypeDef:
    return {
        "IdentityId": ...,
        "Token": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetOpenIdTokenResponseTypeDef(TypedDict):
    IdentityId: str,
    Token: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetPrincipalTagAttributeMapResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetPrincipalTagAttributeMapResponseTypeDef

def get_value() -> GetPrincipalTagAttributeMapResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityProviderName": ...,
        "UseDefaults": ...,
        "PrincipalTags": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetPrincipalTagAttributeMapResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityProviderName: str,
    UseDefaults: bool,
    PrincipalTags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

IdentityDescriptionResponseMetadataTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import IdentityDescriptionResponseMetadataTypeDef

def get_value() -> IdentityDescriptionResponseMetadataTypeDef:
    return {
        "IdentityId": ...,
        "Logins": ...,
        "CreationDate": ...,
        "LastModifiedDate": ...,
        "ResponseMetadata": ...,
    }
Definition
class IdentityDescriptionResponseMetadataTypeDef(TypedDict):
    IdentityId: str,
    Logins: List[str],
    CreationDate: datetime,
    LastModifiedDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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": ...,
    }
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

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

LookupDeveloperIdentityResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import LookupDeveloperIdentityResponseTypeDef

def get_value() -> LookupDeveloperIdentityResponseTypeDef:
    return {
        "IdentityId": ...,
        "DeveloperUserIdentifierList": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class LookupDeveloperIdentityResponseTypeDef(TypedDict):
    IdentityId: str,
    DeveloperUserIdentifierList: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

MergeDeveloperIdentitiesResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import MergeDeveloperIdentitiesResponseTypeDef

def get_value() -> MergeDeveloperIdentitiesResponseTypeDef:
    return {
        "IdentityId": ...,
        "ResponseMetadata": ...,
    }
Definition
class MergeDeveloperIdentitiesResponseTypeDef(TypedDict):
    IdentityId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SetPrincipalTagAttributeMapResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import SetPrincipalTagAttributeMapResponseTypeDef

def get_value() -> SetPrincipalTagAttributeMapResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "IdentityProviderName": ...,
        "UseDefaults": ...,
        "PrincipalTags": ...,
        "ResponseMetadata": ...,
    }
Definition
class SetPrincipalTagAttributeMapResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    IdentityProviderName: str,
    UseDefaults: bool,
    PrincipalTags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteIdentitiesResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import DeleteIdentitiesResponseTypeDef

def get_value() -> DeleteIdentitiesResponseTypeDef:
    return {
        "UnprocessedIdentityIds": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteIdentitiesResponseTypeDef(TypedDict):
    UnprocessedIdentityIds: List[UnprocessedIdentityIdTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UnprocessedIdentityIdTypeDef
  2. See ResponseMetadataTypeDef

ListIdentitiesResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import ListIdentitiesResponseTypeDef

def get_value() -> ListIdentitiesResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "Identities": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListIdentitiesResponseTypeDef(TypedDict):
    IdentityPoolId: str,
    Identities: List[IdentityDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListIdentityPoolsResponseTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import ListIdentityPoolsResponseTypeDef

def get_value() -> ListIdentityPoolsResponseTypeDef:
    return {
        "IdentityPools": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListIdentityPoolsResponseTypeDef(TypedDict):
    IdentityPools: List[IdentityPoolShortDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See IdentityPoolShortDescriptionTypeDef
  2. See ResponseMetadataTypeDef

ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef

def get_value() -> ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

RulesConfigurationTypeTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import RulesConfigurationTypeTypeDef

def get_value() -> RulesConfigurationTypeTypeDef:
    return {
        "Rules": ...,
    }
Definition
class RulesConfigurationTypeTypeDef(TypedDict):
    Rules: List[MappingRuleTypeDef],  # (1)
  1. See MappingRuleTypeDef

RoleMappingTypeDef

Usage Example
from mypy_boto3_cognito_identity.type_defs import RoleMappingTypeDef

def get_value() -> RoleMappingTypeDef:
    return {
        "Type": ...,
    }
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

Usage Example
from mypy_boto3_cognito_identity.type_defs import GetIdentityPoolRolesResponseTypeDef

def get_value() -> GetIdentityPoolRolesResponseTypeDef:
    return {
        "IdentityPoolId": ...,
        "Roles": ...,
        "RoleMappings": ...,
        "ResponseMetadata": ...,
    }
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

Usage Example
from mypy_boto3_cognito_identity.type_defs import SetIdentityPoolRolesInputRequestTypeDef

def get_value() -> SetIdentityPoolRolesInputRequestTypeDef:
    return {
        "IdentityPoolId": ...,
        "Roles": ...,
    }
Definition
class SetIdentityPoolRolesInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,
    Roles: Mapping[str, str],
    RoleMappings: NotRequired[Mapping[str, RoleMappingTypeDef]],  # (1)
  1. See RoleMappingTypeDef