ICognitoIdentityClient

Interface in AWS.CognitoIdentity

Interface for Amazon Cognito Federated Identities service client.

Methods

CreateIdentityPool

function CreateIdentityPool( const ARequest: ICognitoIdentityCreateIdentityPoolRequest): ICognitoIdentityCreateIdentityPoolResponse;

ICognitoIdentityCreateIdentityPoolRequest → ICognitoIdentityCreateIdentityPoolResponse

Create a new identity pool.

Parameters

Name	Description
ARequest	A CreateIdentityPool request object.

Returns

Response containing CreateIdentityPool results.

DeleteIdentities

function DeleteIdentities( const ARequest: ICognitoIdentityDeleteIdentitiesRequest): ICognitoIdentityDeleteIdentitiesResponse; overload;

ICognitoIdentityDeleteIdentitiesRequest → ICognitoIdentityDeleteIdentitiesResponse

Delete identities from an identity pool.

Parameters

Name	Description
ARequest	A DeleteIdentities request object.

Returns

Response containing DeleteIdentities results.

---

function DeleteIdentities( const AIdentityIdsToDelete: array of string): ICognitoIdentityDeleteIdentitiesResponse; overload;

ICognitoIdentityDeleteIdentitiesResponse

Delete identities from an identity pool.

Parameters

Name	Description
AIdentityIdsToDelete	Specify a list of identities (up to 60) to delete.

Returns

Response containing DeleteIdentities results.

DeleteIdentityPool

function DeleteIdentityPool( const ARequest: ICognitoIdentityDeleteIdentityPoolRequest): ICognitoIdentityDeleteIdentityPoolResponse; overload;

ICognitoIdentityDeleteIdentityPoolRequest → ICognitoIdentityDeleteIdentityPoolResponse

Delete an identity pool.

Parameters

Name	Description
ARequest	A DeleteIdentityPool request object.

Returns

Response containing DeleteIdentityPool results.

---

function DeleteIdentityPool( const AIdentityPoolId: string): ICognitoIdentityDeleteIdentityPoolResponse; overload;

ICognitoIdentityDeleteIdentityPoolResponse

Delete an identity pool.

Parameters

Name	Description
AIdentityPoolId	Specify the ID of the identity pool in the format.

Returns

Response containing DeleteIdentityPool results.

DescribeIdentity

function DescribeIdentity( const ARequest: ICognitoIdentityDescribeIdentityRequest): ICognitoIdentityDescribeIdentityResponse; overload;

ICognitoIdentityDescribeIdentityRequest → ICognitoIdentityDescribeIdentityResponse

Fetch the metadata associated with the specified identity.

Parameters

Name	Description
ARequest	A DescribeIdentity request object.

Returns

Response containing DescribeIdentity results.

---

function DescribeIdentity( const AIdentityId: string): ICognitoIdentityDescribeIdentityResponse; overload;

ICognitoIdentityDescribeIdentityResponse

Fetch the metadata associated with the specified identity.

Parameters

Name	Description
AIdentityId	Specify the identities unique identifier in the format.

Returns

Response containing DescribeIdentity results.

DescribeIdentityPool

function DescribeIdentityPool( const ARequest: ICognitoIdentityDescribeIdentityPoolRequest): ICognitoIdentityDescribeIdentityPoolResponse; overload;

ICognitoIdentityDescribeIdentityPoolRequest → ICognitoIdentityDescribeIdentityPoolResponse

Fetch the details of an identity pool.

Parameters

Name	Description
ARequest	A DescribeIdentityPool request object.

Returns

Response containing DescribeIdentityPool results.

---

function DescribeIdentityPool( const AIdentityPoolId: string): ICognitoIdentityDescribeIdentityPoolResponse; overload;

ICognitoIdentityDescribeIdentityPoolResponse

Fetch the details of an identity pool.

Parameters

Name	Description
AIdentityPoolId	Specify the ID of the identity pool in the format.

Returns

Response containing DescribeIdentityPool results.

GetCredentialsForIdentity

function GetCredentialsForIdentity( const ARequest: ICognitoIdentityGetCredentialsForIdentityRequest): ICognitoIdentityGetCredentialsForIdentityResponse;

ICognitoIdentityGetCredentialsForIdentityRequest → ICognitoIdentityGetCredentialsForIdentityResponse

Fetch credentials for the specified identity.

Parameters

Name	Description
ARequest	A GetCredentialsForIdentity request object.

Returns

Response containing GetCredentialsForIdentity results.

GetId

function GetId(const ARequest: ICognitoIdentityGetIdRequest): ICognitoIdentityGetIdResponse;

ICognitoIdentityGetIdRequest → ICognitoIdentityGetIdResponse

Generate or retrieve IdentityID.

Supplying mutliple logins will create an implicit linked account.

Parameters

Name	Description
ARequest	A GetId request object.

Returns

Response containing GetId results.

GetIdentityPoolRoles

function GetIdentityPoolRoles( const ARequest: ICognitoIdentityGetIdentityPoolRolesRequest): ICognitoIdentityGetIdentityPoolRolesResponse; overload;

ICognitoIdentityGetIdentityPoolRolesRequest → ICognitoIdentityGetIdentityPoolRolesResponse

Fetch the roles for an identity pool.

Parameters

Name	Description
ARequest	A GetIdentityPoolRoles request object.

Returns

Response containing GetIdentityPoolRoles results.

---

function GetIdentityPoolRoles( const AIdentityPoolId: string): ICognitoIdentityGetIdentityPoolRolesResponse; overload;

ICognitoIdentityGetIdentityPoolRolesResponse

Fetch the roles for an identity pool.

Parameters

Name	Description
AIdentityPoolId	Specify the ID of the identity pool.

Returns

Response containing GetIdentityPoolRoles results.

GetOpenIdToken

function GetOpenIdToken( const ARequest: ICognitoIdentityGetOpenIdTokenRequest): ICognitoIdentityGetOpenIdTokenResponse;

ICognitoIdentityGetOpenIdTokenRequest → ICognitoIdentityGetOpenIdTokenResponse

Get an OpenID token using a known Cognito ID.

This known Cognito ID is returned by GetId. Supplying mutliple logins will create an implicit linked account.

Parameters

Name	Description
ARequest	A GetOpenIdToken request object.

Returns

Response containing GetOpenIdToken results.

GetOpenIdTokenForDeveloperIdentity

function GetOpenIdTokenForDeveloperIdentity( const ARequest: ICognitoIdentityGetOpenIdTokenForDeveloperIdentityRequest): ICognitoIdentityGetOpenIdTokenForDeveloperIdentityResponse;

ICognitoIdentityGetOpenIdTokenForDeveloperIdentityRequest → ICognitoIdentityGetOpenIdTokenForDeveloperIdentityResponse

Register or retrieve a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process.

Supplying mutliple logins will create an implicit linked account. You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity.

Parameters

Name	Description
ARequest	A GetOpenIdTokenForDeveloperIdentity request object.

Returns

Response containing GetOpenIdTokenForDeveloperIdentity results.

GetPrincipalTagAttributeMap

function GetPrincipalTagAttributeMap( const ARequest: ICognitoIdentityGetPrincipalTagAttributeMapRequest): ICognitoIdentityGetPrincipalTagAttributeMapResponse; overload;

ICognitoIdentityGetPrincipalTagAttributeMapRequest → ICognitoIdentityGetPrincipalTagAttributeMapResponse

Fetch a list of mappings between PricipalTags and user attributes.

Parameters

Name	Description
ARequest	A GetPrincipalTagAttributeMap request object.

Returns

Response containing GetPrincipalTagAttributeMap results.

---

function GetPrincipalTagAttributeMap( const AIdentityPoolId, AIdentityProviderName: string): ICognitoIdentityGetPrincipalTagAttributeMapResponse; overload;

ICognitoIdentityGetPrincipalTagAttributeMapResponse

Fetch a list of mappings between PricipalTags and user attributes.

Parameters

Name	Description
AIdentityPoolId	Specify the ID of the identity pool in the format.
AIdentityProviderName	Specify the name of the Identity Provider (IdP).

Returns

Response containing GetPrincipalTagAttributeMap results.

ListIdentities

function ListIdentities( const ARequest: ICognitoIdentityListIdentitiesRequest): ICognitoIdentityListIdentitiesResponse; overload;

ICognitoIdentityListIdentitiesRequest → ICognitoIdentityListIdentitiesResponse

List the identities in an identity pool.

Parameters

Name	Description
ARequest	A ListIdentities request object.

Returns

Response containing ListIdentities results.

---

function ListIdentities( const AIdentityPoolId: string; const AMaxResults: Integer; const ANextToken: string = ''): ICognitoIdentityListIdentitiesResponse; overload;

ICognitoIdentityListIdentitiesResponse

List the identities in an identity pool.

Parameters

Name	Description
AIdentityPoolId	Specify the ID of the identity pool in the format.
AMaxResults	Specify the maximum number of identities to return.
ANextToken	Specify a NextToken from a previous response to fetch more results.

Returns

Response containing ListIdentities results.

ListIdentityPools

function ListIdentityPools( const ARequest: ICognitoIdentityListIdentityPoolsRequest): ICognitoIdentityListIdentityPoolsResponse; overload;

ICognitoIdentityListIdentityPoolsRequest → ICognitoIdentityListIdentityPoolsResponse

List the Cognito identity pools.

Parameters

Name	Description
ARequest	A ListIdentityPools request object.

Returns

Response containing ListIdentityPools results.

---

function ListIdentityPools( const AMaxResults: Integer; const ANextToken: string = ''): ICognitoIdentityListIdentityPoolsResponse; overload;

ICognitoIdentityListIdentityPoolsResponse

List the Cognito identity pools.

Parameters

Name	Description
AMaxResults	Specify the maximum number of identity pools to return.
ANextToken	Specify a NextToken from a previous response to fetch more results.

Returns

Response containing ListIdentityPools results.

ListTagsForResource

function ListTagsForResource( const ARequest: ICognitoIdentityListTagsForResourceRequest): ICognitoIdentityListTagsForResourceResponse; overload;

ICognitoIdentityListTagsForResourceRequest → ICognitoIdentityListTagsForResourceResponse

List the tags assigned to an Amazon Cognito identity pool.

Parameters

Name	Description
ARequest	A ListTagsForResource request object.

Returns

Response containing ListTagsForResource results.

---

function ListTagsForResource( const AResourceArn: TARN): ICognitoIdentityListTagsForResourceResponse; overload;

ICognitoIdentityListTagsForResourceResponse

List the tags assigned to an Amazon Cognito identity pool.

Parameters

Name	Description
AResourceArn	Specify the Amazon Resource Name (ARN) of an Amazon Cognito identity pool.

Returns

Response containing ListTagsForResource results.

LookupDeveloperIdentity

function LookupDeveloperIdentity( const ARequest: ICognitoIdentityLookupDeveloperIdentityRequest): ICognitoIdentityLookupDeveloperIdentityResponse;

ICognitoIdentityLookupDeveloperIdentityRequest → ICognitoIdentityLookupDeveloperIdentityResponse

Retrieve the IdentityID associated with a DeveloperUserIdentifier or a list of DeveloperUserIdentifier values associated with an IdentityId for an existing IdentityID.

Parameters

Name	Description
ARequest	A LookupDeveloperIdentity request object.

Returns

Response containing LookupDeveloperIdentity results.

MergeDeveloperIdentities

function MergeDeveloperIdentities( const ARequest: ICognitoIdentityMergeDeveloperIdentitiesRequest): ICognitoIdentityMergeDeveloperIdentitiesResponse; overload;

ICognitoIdentityMergeDeveloperIdentitiesRequest → ICognitoIdentityMergeDeveloperIdentitiesResponse

Merge two users with different IdentityIds in the same identity pool and identified by the same developer provider.

The number of linked logins is limited to 20. So, the number of linked logins for the source and destination users must not be greater than 20 when combined.

Parameters

Name	Description
ARequest	A MergeDeveloperIdentities request object.

Returns

Response containing MergeDeveloperIdentities results.

---

function MergeDeveloperIdentities(const AIdentityPoolId, ADeveloperProviderName, ASourceUserIdentifier, ADestinationUserIdentifier: string): ICognitoIdentityMergeDeveloperIdentitiesResponse; overload;

ICognitoIdentityMergeDeveloperIdentitiesResponse

Merge two users with different IdentityIds in the same identity pool and identified by the same developer provider.

The number of linked logins is limited to 20. So, the number of linked logins for the source and destination users must not be greater than 20 when combined.

Parameters

Name	Description
AIdentityPoolId	Specify the ID of the identity pool in the format.
ADeveloperProviderName	Specify the "domain" by which Cognito refers to your users.
ASourceUserIdentifier	Specify the identifier for the source user.
ADestinationUserIdentifier	Specify the identifier for the destination user.

Returns

Response containing MergeDeveloperIdentities results.

SetIdentityPoolRoles

function SetIdentityPoolRoles( const ARequest: ICognitoIdentitySetIdentityPoolRolesRequest): ICognitoIdentitySetIdentityPoolRolesResponse;

ICognitoIdentitySetIdentityPoolRolesRequest → ICognitoIdentitySetIdentityPoolRolesResponse

Set the roles for an identity pool.

Parameters

Name	Description
ARequest	A SetIdentityPoolRoles request object.

Returns

Response containing SetIdentityPoolRoles results.

SetPrincipalTagAttributeMap

function SetPrincipalTagAttributeMap( const ARequest: ICognitoIdentitySetPrincipalTagAttributeMapRequest): ICognitoIdentitySetPrincipalTagAttributeMapResponse;

ICognitoIdentitySetPrincipalTagAttributeMapRequest → ICognitoIdentitySetPrincipalTagAttributeMapResponse

Set the attribute mappings for an identity pool.

Parameters

Name	Description
ARequest	A SetPrincipalTagAttributeMap request object.

Returns

Response containing SetPrincipalTagAttributeMap results.

TagResource

function TagResource( const ARequest: ICognitoIdentityTagResourceRequest): ICognitoIdentityTagResourceResponse;

ICognitoIdentityTagResourceRequest → ICognitoIdentityTagResourceResponse

Assign tags to an Amazon Cognito identity pool.

Parameters

Name	Description
ARequest	A TagResource request object.

Returns

Response containing TagResource results.

UnlinkDeveloperIdentity

function UnlinkDeveloperIdentity( const ARequest: ICognitoIdentityUnlinkDeveloperIdentityRequest): ICognitoIdentityUnlinkDeveloperIdentityResponse; overload;

ICognitoIdentityUnlinkDeveloperIdentityRequest → ICognitoIdentityUnlinkDeveloperIdentityResponse

Unlink a DeveloperUserIdentifier from an existing identity.

Parameters

Name	Description
ARequest	A UnlinkDeveloperIdentity request object.

Returns

Response containing UnlinkDeveloperIdentity results.

---

function UnlinkDeveloperIdentity(const AIdentityPoolId, ADeveloperProviderName, ADeveloperUserIdentifier, AIdentityId: string): ICognitoIdentityUnlinkDeveloperIdentityResponse; overload;

ICognitoIdentityUnlinkDeveloperIdentityResponse

Unlink a DeveloperUserIdentifier from an existing identity.

Parameters

Name	Description
AIdentityPoolId	Specify the ID of the identity pool in the format.
ADeveloperProviderName	Specify the "domain" by which Cognito refers to your users.
ADeveloperUserIdentifier	Specify a unique ID used by your backend authentication process to identify a user.
AIdentityId	Specify the unique identifier of the identity in the format.

Returns

Response containing UnlinkDeveloperIdentity results.

UnlinkIdentity

function UnlinkIdentity( const ARequest: ICognitoIdentityUnlinkIdentityRequest): ICognitoIdentityUnlinkIdentityResponse;

ICognitoIdentityUnlinkIdentityRequest → ICognitoIdentityUnlinkIdentityResponse

Unlink a federated identity from an existing identity.

Removing the last linked login will render the identity inaccessible.

Parameters

Name	Description
ARequest	A UnlinkIdentity request object.

Returns

Response containing UnlinkIdentity results.

UntagResource

function UntagResource( const ARequest: ICognitoIdentityUntagResourceRequest): ICognitoIdentityUntagResourceResponse; overload;

ICognitoIdentityUntagResourceRequest → ICognitoIdentityUntagResourceResponse

Remove tags from an Amazon Cognito identity pool.

Parameters

Name	Description
ARequest	A UntagResource request object.

Returns

Response containing UntagResource results.

---

function UntagResource( const AResourceArn: TARN; const ATagKeys: array of string): ICognitoIdentityUntagResourceResponse; overload;

ICognitoIdentityUntagResourceResponse

Remove tags from an Amazon Cognito identity pool.

Parameters

Name	Description
AResourceArn	Specify the Amazon Resource Name (ARN) of an Amazon Cognito identity pool.
ATagKeys	Specify the keys of tags to remove from the identity pool.

Returns

Response containing UntagResource results.

UpdateIdentityPool

function UpdateIdentityPool( const ARequest: ICognitoIdentityUpdateIdentityPoolRequest): ICognitoIdentityUpdateIdentityPoolResponse;

ICognitoIdentityUpdateIdentityPoolRequest → ICognitoIdentityUpdateIdentityPoolResponse

Update an identity pool.

Parameters

Name	Description
ARequest	A UpdateIdentityPool request object.

Returns

Response containing UpdateIdentityPool results.