Skip to content

Type definitions#

Index > CognitoIdentity > Type definitions

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

CognitoIdentityProviderTypeDef#

# CognitoIdentityProviderTypeDef definition

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

CredentialsTypeDef#

# CredentialsTypeDef definition

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

DeleteIdentitiesInputRequestTypeDef#

# DeleteIdentitiesInputRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

UnprocessedIdentityIdTypeDef#

# UnprocessedIdentityIdTypeDef definition

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

DeleteIdentityPoolInputRequestTypeDef#

# DeleteIdentityPoolInputRequestTypeDef definition

class DeleteIdentityPoolInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

DescribeIdentityInputRequestTypeDef#

# DescribeIdentityInputRequestTypeDef definition

class DescribeIdentityInputRequestTypeDef(TypedDict):
    IdentityId: str,

DescribeIdentityPoolInputRequestTypeDef#

# DescribeIdentityPoolInputRequestTypeDef definition

class DescribeIdentityPoolInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetCredentialsForIdentityInputRequestTypeDef#

# GetCredentialsForIdentityInputRequestTypeDef definition

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

GetIdInputRequestTypeDef#

# GetIdInputRequestTypeDef definition

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

GetIdentityPoolRolesInputRequestTypeDef#

# GetIdentityPoolRolesInputRequestTypeDef definition

class GetIdentityPoolRolesInputRequestTypeDef(TypedDict):
    IdentityPoolId: str,

GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef#

# GetOpenIdTokenForDeveloperIdentityInputRequestTypeDef definition

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

GetOpenIdTokenInputRequestTypeDef#

# GetOpenIdTokenInputRequestTypeDef definition

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

GetPrincipalTagAttributeMapInputRequestTypeDef#

# GetPrincipalTagAttributeMapInputRequestTypeDef definition

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

IdentityDescriptionTypeDef#

# IdentityDescriptionTypeDef definition

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

IdentityPoolShortDescriptionTypeDef#

# IdentityPoolShortDescriptionTypeDef definition

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

ListIdentitiesInputRequestTypeDef#

# ListIdentitiesInputRequestTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListIdentityPoolsInputRequestTypeDef#

# ListIdentityPoolsInputRequestTypeDef definition

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

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

LookupDeveloperIdentityInputRequestTypeDef#

# LookupDeveloperIdentityInputRequestTypeDef definition

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

MappingRuleTypeDef#

# MappingRuleTypeDef definition

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

MergeDeveloperIdentitiesInputRequestTypeDef#

# MergeDeveloperIdentitiesInputRequestTypeDef definition

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

SetPrincipalTagAttributeMapInputRequestTypeDef#

# SetPrincipalTagAttributeMapInputRequestTypeDef definition

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

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

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

UnlinkDeveloperIdentityInputRequestTypeDef#

# UnlinkDeveloperIdentityInputRequestTypeDef definition

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

UnlinkIdentityInputRequestTypeDef#

# UnlinkIdentityInputRequestTypeDef definition

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

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

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

CreateIdentityPoolInputRequestTypeDef#

# 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 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#

# EmptyResponseMetadataTypeDef definition

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

GetCredentialsForIdentityResponseTypeDef#

# GetCredentialsForIdentityResponseTypeDef definition

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

GetIdResponseTypeDef#

# GetIdResponseTypeDef definition

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

GetOpenIdTokenForDeveloperIdentityResponseTypeDef#

# GetOpenIdTokenForDeveloperIdentityResponseTypeDef definition

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

GetOpenIdTokenResponseTypeDef#

# GetOpenIdTokenResponseTypeDef definition

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

GetPrincipalTagAttributeMapResponseTypeDef#

# GetPrincipalTagAttributeMapResponseTypeDef definition

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

IdentityDescriptionResponseTypeDef#

# IdentityDescriptionResponseTypeDef definition

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

IdentityPoolTypeDef#

# 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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

LookupDeveloperIdentityResponseTypeDef#

# LookupDeveloperIdentityResponseTypeDef definition

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

MergeDeveloperIdentitiesResponseTypeDef#

# MergeDeveloperIdentitiesResponseTypeDef definition

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

SetPrincipalTagAttributeMapResponseTypeDef#

# SetPrincipalTagAttributeMapResponseTypeDef definition

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

DeleteIdentitiesResponseTypeDef#

# DeleteIdentitiesResponseTypeDef definition

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

ListIdentitiesResponseTypeDef#

# ListIdentitiesResponseTypeDef definition

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

ListIdentityPoolsResponseTypeDef#

# ListIdentityPoolsResponseTypeDef definition

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

ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef#

# ListIdentityPoolsInputListIdentityPoolsPaginateTypeDef definition

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

RulesConfigurationTypeTypeDef#

# RulesConfigurationTypeTypeDef definition

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

RoleMappingTypeDef#

# 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 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 definition

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