ICognitoIdentityProviderClient

Interface in AWS.CognitoIdentityProvider

Interface for Amazon Cognito User Pools service client.

Methods

AddCustomAttributes

function AddCustomAttributes( const ARequest: ICognitoIdentityProviderAddCustomAttributesRequest): ICognitoIdentityProviderAddCustomAttributesResponse;

ICognitoIdentityProviderAddCustomAttributesRequest → ICognitoIdentityProviderAddCustomAttributesResponse

Add additional user attributes to a user pool schema.

Parameters

Name	Description
ARequest	A AddCustomAttributes request object.

Returns

Response containing AddCustomAttributes results.

AdminAddUserToGroup

function AdminAddUserToGroup( const ARequest: ICognitoIdentityProviderAdminAddUserToGroupRequest): ICognitoIdentityProviderAdminAddUserToGroupResponse; overload;

ICognitoIdentityProviderAdminAddUserToGroupRequest → ICognitoIdentityProviderAdminAddUserToGroupResponse

Add the specified user to the specified group.

Parameters

Name	Description
ARequest	A AdminAddUserToGroup request object.

Returns

Response containing AdminAddUserToGroup results.

---

function AdminAddUserToGroup( const AUserPoolId, AUsername, AGroupName: string): ICognitoIdentityProviderAdminAddUserToGroupResponse; overload;

ICognitoIdentityProviderAdminAddUserToGroupResponse

Add the specified user to the specified group.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
AGroupName	Specify the group name.

Returns

Response containing AdminAddUserToGroup results.

AdminConfirmSignUp

function AdminConfirmSignUp( const ARequest: ICognitoIdentityProviderAdminConfirmSignUpRequest): ICognitoIdentityProviderAdminConfirmSignUpResponse; overload;

ICognitoIdentityProviderAdminConfirmSignUpRequest → ICognitoIdentityProviderAdminConfirmSignUpResponse

Confirm user registration as an admin without using a confirmation code.

Parameters

Name	Description
ARequest	A AdminConfirmSignUp request object.

Returns

Response containing AdminConfirmSignUp results.

---

function AdminConfirmSignUp( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminConfirmSignUpResponse; overload;

ICognitoIdentityProviderAdminConfirmSignUpResponse

Confirm user registration as an admin without using a confirmation code.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminConfirmSignUp results.

AdminCreateUser

function AdminCreateUser( const ARequest: ICognitoIdentityProviderAdminCreateUserRequest): ICognitoIdentityProviderAdminCreateUserResponse;

ICognitoIdentityProviderAdminCreateUserRequest → ICognitoIdentityProviderAdminCreateUserResponse

Create a new user in the specified user pool.

Parameters

Name	Description
ARequest	An AdminCreateUser request object.

Returns

Response containing AdminCreateUser results.

AdminDeleteUser

function AdminDeleteUser( const ARequest: ICognitoIdentityProviderAdminDeleteUserRequest): ICognitoIdentityProviderAdminDeleteUserResponse; overload;

ICognitoIdentityProviderAdminDeleteUserRequest → ICognitoIdentityProviderAdminDeleteUserResponse

Delete user as an administrator.

Parameters

Name	Description
ARequest	An AdminDeleteUser request object.

Returns

Response containing AdminDeleteUser results.

---

function AdminDeleteUser( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminDeleteUserResponse; overload;

ICognitoIdentityProviderAdminDeleteUserResponse

Delete user as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminDeleteUser results.

AdminDeleteUserAttributes

function AdminDeleteUserAttributes( const ARequest: ICognitoIdentityProviderAdminDeleteUserAttributesRequest): ICognitoIdentityProviderAdminDeleteUserAttributesResponse; overload;

ICognitoIdentityProviderAdminDeleteUserAttributesRequest → ICognitoIdentityProviderAdminDeleteUserAttributesResponse

Delete user attributes as an administrator.

Parameters

Name	Description
ARequest	An AdminDeleteUser request object.

Returns

Response containing AdminDeleteUserAttributes results.

---

function AdminDeleteUserAttributes( const AUserPoolId, AUsername: string; const AUserAttributeNames: array of string): ICognitoIdentityProviderAdminDeleteUserAttributesResponse; overload;

ICognitoIdentityProviderAdminDeleteUserAttributesResponse

Delete user attributes as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
AUserAttributeNames	Specify a list of attribute names you want to delete from the user.

Returns

Response containing AdminDeleteUserAttributes results.

AdminDisableProviderForUser

function AdminDisableProviderForUser( const ARequest: ICognitoIdentityProviderAdminDisableProviderForUserRequest): ICognitoIdentityProviderAdminDisableProviderForUserResponse;

ICognitoIdentityProviderAdminDisableProviderForUserRequest → ICognitoIdentityProviderAdminDisableProviderForUserResponse

Prevent a user from signing in with a specified external (SAML or social) identity provider (IdP).

Parameters

Name	Description
ARequest	An AdminDisableProviderForUser request object.

Returns

Response containing AdminDisableProviderForUser results.

AdminDisableUser

function AdminDisableUser( const ARequest: ICognitoIdentityProviderAdminDisableUserRequest): ICognitoIdentityProviderAdminDisableUserResponse; overload;

ICognitoIdentityProviderAdminDisableUserRequest → ICognitoIdentityProviderAdminDisableUserResponse

Deactive a user and revoke all access tokens for the user.

Parameters

Name	Description
ARequest	An AdminDisableUser request object.

Returns

Response containing AdminDisableUser results.

---

function AdminDisableUser( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminDisableUserResponse; overload;

ICognitoIdentityProviderAdminDisableUserResponse

Deactive a user and revoke all access tokens for the user.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminDisableUser results.

AdminEnableUser

function AdminEnableUser( const ARequest: ICognitoIdentityProviderAdminEnableUserRequest): ICognitoIdentityProviderAdminEnableUserResponse; overload;

ICognitoIdentityProviderAdminEnableUserRequest → ICognitoIdentityProviderAdminEnableUserResponse

Enable the specified user as an administrator.

Parameters

Name	Description
ARequest	An AdminEnableUser request object.

Returns

Response containing AdminEnableUser results.

---

function AdminEnableUser( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminEnableUserResponse; overload;

ICognitoIdentityProviderAdminEnableUserResponse

Enable the specified user as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminEnableUser results.

AdminForgetDevice

function AdminForgetDevice( const ARequest: ICognitoIdentityProviderAdminForgetDeviceRequest): ICognitoIdentityProviderAdminForgetDeviceResponse; overload;

ICognitoIdentityProviderAdminForgetDeviceRequest → ICognitoIdentityProviderAdminForgetDeviceResponse

Forget a device, as an administrator.

Parameters

Name	Description
ARequest	A AdminForgetDevice request object.

Returns

Response containing AdminForgetDevice results.

---

function AdminForgetDevice( const AUserPoolId, AUsername, ADeviceKey: string): ICognitoIdentityProviderAdminForgetDeviceResponse; overload;

ICognitoIdentityProviderAdminForgetDeviceResponse

Forget a device, as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
ADeviceKey	Specify the device key.

Returns

Response containing AdminForgetDevice results.

AdminGetDevice

function AdminGetDevice( const ARequest: ICognitoIdentityProviderAdminGetDeviceRequest): ICognitoIdentityProviderAdminGetDeviceResponse; overload;

ICognitoIdentityProviderAdminGetDeviceRequest → ICognitoIdentityProviderAdminGetDeviceResponse

Get a device, as an administrator.

Parameters

Name	Description
ARequest	A AdminGetDevice request object.

Returns

Response containing AdminGetDevice results.

---

function AdminGetDevice( const AUserPoolId, AUsername, ADeviceKey: string): ICognitoIdentityProviderAdminGetDeviceResponse; overload;

ICognitoIdentityProviderAdminGetDeviceResponse

Get a device, as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
ADeviceKey	Specify the device key.

Returns

Response containing AdminGetDevice results.

AdminGetUser

function AdminGetUser( const ARequest: ICognitoIdentityProviderAdminGetUserRequest): ICognitoIdentityProviderAdminGetUserResponse; overload;

ICognitoIdentityProviderAdminGetUserRequest → ICognitoIdentityProviderAdminGetUserResponse

Get the specified user by username in a user pool as an administrator.

Parameters

Name	Description
ARequest	An AdminGetUser request object.

Returns

Response containing AdminGetUser results.

---

function AdminGetUser( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminGetUserResponse; overload;

ICognitoIdentityProviderAdminGetUserResponse

Get the specified user by username in a user pool as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminGetUser results.

AdminInitiateAuth

function AdminInitiateAuth( const ARequest: ICognitoIdentityProviderAdminInitiateAuthRequest): ICognitoIdentityProviderAdminInitiateAuthResponse;

ICognitoIdentityProviderAdminInitiateAuthRequest → ICognitoIdentityProviderAdminInitiateAuthResponse

Initiate an authentication flow as an administrator.

Parameters

Name	Description
ARequest	An AdminInitiateAuth request object.

Returns

Response containing AdminInitiateAuth results.

AdminLinkProviderForUser

function AdminLinkProviderForUser( const ARequest: ICognitoIdentityProviderAdminLinkProviderForUserRequest): ICognitoIdentityProviderAdminLinkProviderForUserResponse;

ICognitoIdentityProviderAdminLinkProviderForUserRequest → ICognitoIdentityProviderAdminLinkProviderForUserResponse

Link an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP.

Parameters

Name	Description
ARequest	An AdminLinkProviderForUser object.

Returns

Response containing AdminLinkProviderForUser results.

AdminListDevices

function AdminListDevices( const ARequest: ICognitoIdentityProviderAdminListDevicesRequest): ICognitoIdentityProviderAdminListDevicesResponse; overload;

ICognitoIdentityProviderAdminListDevicesRequest → ICognitoIdentityProviderAdminListDevicesResponse

List devices as an administrator.

Parameters

Name	Description
ARequest	An AdminListDevices request object.

Returns

Response containing AdminListDevices results.

---

function AdminListDevices( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminListDevicesResponse; overload;

ICognitoIdentityProviderAdminListDevicesResponse

List devices as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminListDevices results.

---

function AdminListDevices( const AUserPoolId, AUsername: string; const ALimit: Integer; const APaginationToken: string): ICognitoIdentityProviderAdminListDevicesResponse; overload;

ICognitoIdentityProviderAdminListDevicesResponse

List devices as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
ALimit	Specify the limit of devices to be returned. Valid range: 0 - 60.
APaginationToken	Specify a pagination token from a previous request.

Returns

Response containing AdminListDevices results.

AdminListGroupsForUser

function AdminListGroupsForUser( const ARequest: ICognitoIdentityProviderAdminListGroupsForUserRequest): ICognitoIdentityProviderAdminListGroupsForUserResponse; overload;

ICognitoIdentityProviderAdminListGroupsForUserRequest → ICognitoIdentityProviderAdminListGroupsForUserResponse

List the groups that a user belongs to as an administrator.

Parameters

Name	Description
ARequest	An AdminListGroupsForUser request object.

Returns

Response containing AdminListGroupsForUser results.

---

function AdminListGroupsForUser( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminListGroupsForUserResponse; overload;

ICognitoIdentityProviderAdminListGroupsForUserResponse

List the groups that a user belongs to as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminListGroupsForUser results.

---

function AdminListGroupsForUser( const AUserPoolId, AUsername: string; const ALimit: Integer; const APaginationToken: string): ICognitoIdentityProviderAdminListGroupsForUserResponse; overload;

ICognitoIdentityProviderAdminListGroupsForUserResponse

List the groups that a user belongs to as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
ALimit	Specify the limit of groups to be returned. Valid range: 0 - 60.
APaginationToken	Specify a pagination token from a previous request.

Returns

Response containing AdminListGroupsForUser results.

AdminListUserAuthEvents

function AdminListUserAuthEvents( const ARequest: ICognitoIdentityProviderAdminListUserAuthEventsRequest): ICognitoIdentityProviderAdminListUserAuthEventsResponse; overload;

ICognitoIdentityProviderAdminListUserAuthEventsRequest → ICognitoIdentityProviderAdminListUserAuthEventsResponse

List the history of user activity and any risks detected as a part of Amazon Cognito advanced security.

Parameters

Name	Description
ARequest	An AdminListUserAuthEvents request object.

Returns

Response containing AdminListUserAuthEvents results.

---

function AdminListUserAuthEvents( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminListUserAuthEventsResponse; overload;

ICognitoIdentityProviderAdminListUserAuthEventsResponse

List the history of user activity and any risks detected as a part of Amazon Cognito advanced security.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminListUserAuthEvents results.

---

function AdminListUserAuthEvents( const AUserPoolId, AUsername: string; const AMaxResults: Integer; const ANextToken: string): ICognitoIdentityProviderAdminListUserAuthEventsResponse; overload;

ICognitoIdentityProviderAdminListUserAuthEventsResponse

List the history of user activity and any risks detected as a part of Amazon Cognito advanced security.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
AMaxResults	Specify the limit of authentication events to be returned. Valid range: 0 - 60.
ANextToken	Specify a pagination token from a previous request.

Returns

Response containing AdminListUserAuthEvents results.

AdminRemoveUserFromGroup

function AdminRemoveUserFromGroup( const ARequest: ICognitoIdentityProviderAdminRemoveUserFromGroupRequest): ICognitoIdentityProviderAdminRemoveUserFromGroupResponse; overload;

ICognitoIdentityProviderAdminRemoveUserFromGroupRequest → ICognitoIdentityProviderAdminRemoveUserFromGroupResponse

Remove a user from a group.

Parameters

Name	Description
ARequest	An AdminRemoveUserFromGroup request object.

Returns

Response containing AdminRemoveUserFromGroup results.

---

function AdminRemoveUserFromGroup( const AUserPoolId, AUsername, AGroupName: string): ICognitoIdentityProviderAdminRemoveUserFromGroupResponse; overload;

ICognitoIdentityProviderAdminRemoveUserFromGroupResponse

Remove a user from a group.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
AGroupName	Specify the name of the group.

Returns

Response containing AdminRemoveUserFromGroup results.

AdminResetUserPassword

function AdminResetUserPassword( const ARequest: ICognitoIdentityProviderAdminResetUserPasswordRequest): ICognitoIdentityProviderAdminResetUserPasswordResponse; overload;

ICognitoIdentityProviderAdminResetUserPasswordRequest → ICognitoIdentityProviderAdminResetUserPasswordResponse

Reset a user's password as an administrator.

Parameters

Name	Description
ARequest	An AdminResetUserPassword request object.

Returns

Response containing AdminResetUserPassword results.

---

function AdminResetUserPassword( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminResetUserPasswordResponse; overload;

ICognitoIdentityProviderAdminResetUserPasswordResponse

Reset a user's password as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminResetUserPassword results.

AdminRespondToAuthChallenge

function AdminRespondToAuthChallenge( const ARequest: ICognitoIdentityProviderAdminRespondToAuthChallengeRequest): ICognitoIdentityProviderAdminRespondToAuthChallengeResponse;

ICognitoIdentityProviderAdminRespondToAuthChallengeRequest → ICognitoIdentityProviderAdminRespondToAuthChallengeResponse

Respond to an authentication challenge as an administrator.

Parameters

Name	Description
ARequest	An AdminRespondToAuthChallenge request object.

Returns

Response containing AdminRespondToAuthChallenge results.

AdminSetUserMFAPreference

function AdminSetUserMFAPreference( const ARequest: ICognitoIdentityProviderAdminSetUserMFAPreferenceRequest): ICognitoIdentityProviderAdminSetUserMFAPreferenceResponse;

ICognitoIdentityProviderAdminSetUserMFAPreferenceRequest → ICognitoIdentityProviderAdminSetUserMFAPreferenceResponse

Set a user's multi-factor authentication (MFA) preferences.

Parameters

Name	Description
ARequest	An AdminSetUserMFAPreference request object.

Returns

Response containing AdminSetUserMFAPreference results.

AdminSetUserPassword

function AdminSetUserPassword( const ARequest: ICognitoIdentityProviderAdminSetUserPasswordRequest): ICognitoIdentityProviderAdminSetUserPasswordResponse; overload;

ICognitoIdentityProviderAdminSetUserPasswordRequest → ICognitoIdentityProviderAdminSetUserPasswordResponse

Set a user's password as an administrator.

Parameters

Name	Description
ARequest	An AdminSetUserPassword request object.

Returns

Response containing AdminSetUserPassword results.

---

function AdminSetUserPassword( const AUserPoolId, AUsername, APassword: string; const APermanent: Boolean = False): ICognitoIdentityProviderAdminSetUserPasswordResponse; overload;

ICognitoIdentityProviderAdminSetUserPasswordResponse

Set a user's password as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
APassword	Specify the password for the user.
APermanent	Specify whether the password for the user is permanent () or temporary ().

Returns

Response containing AdminSetUserPassword results.

AdminSetUserSettings

function AdminSetUserSettings( const ARequest: ICognitoIdentityProviderAdminSetUserSettingsRequest): ICognitoIdentityProviderAdminSetUserSettingsResponse;

ICognitoIdentityProviderAdminSetUserSettingsRequest → ICognitoIdentityProviderAdminSetUserSettingsResponse

Configure a user's SMS MFA settings.

This action is no longer supported. To configure either type of MFA, use AdminSetUserMFAPreference instead.

Parameters

Name	Description
ARequest	An AdminSetUserSettings request object.

Returns

Response containing AdminSetUserSettings results.

AdminUpdateAuthEventFeedback

function AdminUpdateAuthEventFeedback( const ARequest: ICognitoIdentityProviderAdminUpdateAuthEventFeedbackRequest): ICognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse; overload;

ICognitoIdentityProviderAdminUpdateAuthEventFeedbackRequest → ICognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse

Provide feedback for an authentication event indicating whether it was from a valid user. The feedback is used for improving the risk evaluation decision for the user pool as a part of Amazon Cognito's advanced security.

Parameters

Name	Description
ARequest	An AdminUpdateAuthEventFeedback request object.

Returns

Response containing AdminUpdateAuthEventFeedback results.

---

function AdminUpdateAuthEventFeedback( const AUserPoolId, AUsername, AEventId, AFeedbackValue: string): ICognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse; overload;

ICognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse

Provide feedback for an authentication event indicating whether it was from a valid user. The feedback is used for improving the risk evaluation decision for the user pool as a part of Amazon Cognito's advanced security.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
AEventId	Specify the ID of the authentication event.
AFeedbackValue	Specify the feedback value for the authentication event. Valid values:|.

Returns

Response containing AdminUpdateAuthEventFeedback results.

AdminUpdateDeviceStatus

function AdminUpdateDeviceStatus( const ARequest: ICognitoIdentityProviderAdminUpdateDeviceStatusRequest): ICognitoIdentityProviderAdminUpdateDeviceStatusResponse; overload;

ICognitoIdentityProviderAdminUpdateDeviceStatusRequest → ICognitoIdentityProviderAdminUpdateDeviceStatusResponse

Update the device status as an administrator.

Parameters

Name	Description
ARequest	An AdminUpdateDeviceStatus request object.

Returns

Response containing AdminUpdateDeviceStatus results.

---

function AdminUpdateDeviceStatus( const AUserPoolId, AUsername, ADeviceKey: string): ICognitoIdentityProviderAdminUpdateDeviceStatusResponse; overload;

ICognitoIdentityProviderAdminUpdateDeviceStatusResponse

Update the device status as an administrator.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.
ADeviceKey	Specify the device key.

Returns

Response containing AdminUpdateDeviceStatus results.

AdminUpdateUserAttributes

function AdminUpdateUserAttributes( const ARequest: ICognitoIdentityProviderAdminUpdateUserAttributesRequest): ICognitoIdentityProviderAdminUpdateUserAttributesResponse;

ICognitoIdentityProviderAdminUpdateUserAttributesRequest → ICognitoIdentityProviderAdminUpdateUserAttributesResponse

Update a user's attributes as an administrator.

Parameters

Name	Description
ARequest	An AdminUpdateUserAttributes request object.

Returns

Response containing AdminUpdateUserAttributes results.

AdminUserGlobalSignOut

function AdminUserGlobalSignOut( const ARequest: ICognitoIdentityProviderAdminUserGlobalSignOutRequest): ICognitoIdentityProviderAdminUserGlobalSignOutResponse; overload;

ICognitoIdentityProviderAdminUserGlobalSignOutRequest → ICognitoIdentityProviderAdminUserGlobalSignOutResponse

Sign out a user from all devices.

All refresh tokens issued by Amazon Cognito for the user will be invalidated. The user's current access and ID tokens will remain valid until they expire. By default access and ID tokens expire one hour after issue.

Parameters

Name	Description
ARequest	An AdminUserGlobalSignOut request object.

Returns

Response containing AdminUserGlobalSignOut results.

---

function AdminUserGlobalSignOut( const AUserPoolId, AUsername: string): ICognitoIdentityProviderAdminUserGlobalSignOutResponse; overload;

ICognitoIdentityProviderAdminUserGlobalSignOutResponse

Sign out a user from all devices.

All refresh tokens issued by Amazon Cognito for the user will be invalidated. The user's current access and ID tokens will remain valid until they expire. By default access and ID tokens expire one hour after issue.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AUsername	Specify the Username of the user.

Returns

Response containing AdminUserGlobalSignOut results.

AssociateSoftwareToken

function AssociateSoftwareToken( const ARequest: ICognitoIdentityProviderAssociateSoftwareTokenRequest): ICognitoIdentityProviderAssociateSoftwareTokenResponse; overload;

ICognitoIdentityProviderAssociateSoftwareTokenRequest → ICognitoIdentityProviderAssociateSoftwareTokenResponse

Begin setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user.

You can start the setup using a unique private key generated by Amazon Cognito and returned in an API response. The AssociateSoftwareToken request can be authorized by either the users access token or a session string from a challenge response received from Amazon Cognito.

Parameters

Name	Description
ARequest	An AssociateSoftwareToken request object.

Returns

Response containing AssociateSoftwareToken results.

---

function AssociateSoftwareToken( const AAccessToken, ASession: string): ICognitoIdentityProviderAssociateSoftwareTokenResponse; overload;

ICognitoIdentityProviderAssociateSoftwareTokenResponse

Begin setup of time-based one-time password (TOTP) multi-factor authentication (MFA) for a user.

You can start the setup using a unique private key generated by Amazon Cognito and returned in an API response. The AssociateSoftwareToken request can be authorized by either the users access token or a session string from a challenge response received from Amazon Cognito.

Parameters

Name	Description
AAccessToken	Specify a valid access token issued by Amazon Cognito to the user whose software token you want to generate.
ASession	Specify the session that should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

Returns

Response containing AssociateSoftwareToken results.

ChangePassword

function ChangePassword( const ARequest: ICognitoIdentityProviderChangePasswordRequest): ICognitoIdentityProviderChangePasswordResponse; overload;

ICognitoIdentityProviderChangePasswordRequest → ICognitoIdentityProviderChangePasswordResponse

Change the password for a given user in a user pool.

Parameters

Name	Description
ARequest	A ChangePassword request object.

Returns

Response containing ChangePassword results.

---

function ChangePassword( const AAccessToken, APreviousPassword, AProposedPassword: string): ICognitoIdentityProviderChangePasswordResponse; overload;

ICognitoIdentityProviderChangePasswordResponse

Change the password for a given user in a user pool.

Parameters

Name	Description
AAccessToken	Specify a valid access token issued to the user by Amazon Cognito.
APreviousPassword	Specify the old password.
AProposedPassword	Specify a new password.

Returns

Response containing ChangePassword results.

ConfirmDevice

function ConfirmDevice( const ARequest: ICognitoIdentityProviderConfirmDeviceRequest): ICognitoIdentityProviderConfirmDeviceResponse;

ICognitoIdentityProviderConfirmDeviceRequest → ICognitoIdentityProviderConfirmDeviceResponse

Confirm tracking of a device.

Calling ConfirmDevice begins device tracking.

Parameters

Name	Description
ARequest	A ConfirmDevice request object.

Returns

Response containing ConfirmDevice results.

ConfirmForgotPassword

function ConfirmForgotPassword( const ARequest: ICognitoIdentityProviderConfirmForgotPasswordRequest): ICognitoIdentityProviderConfirmForgotPasswordResponse;

ICognitoIdentityProviderConfirmForgotPasswordRequest → ICognitoIdentityProviderConfirmForgotPasswordResponse

Allow a user to enter a confirmation code to reset a forgotten password.

Parameters

Name	Description
ARequest	A ConfirmForgotPassword request object.

Returns

Response containing ConfirmForgotPassword results.

ConfirmSignUp

function ConfirmSignUp( const ARequest: ICognitoIdentityProviderConfirmSignUpRequest): ICognitoIdentityProviderConfirmSignUpResponse;

ICognitoIdentityProviderConfirmSignUpRequest → ICognitoIdentityProviderConfirmSignUpResponse

Confirm the registration of a new user.

Parameters

Name	Description
ARequest	A ConfirmSignUp request object.

Returns

Response containing ConfirmSignUp results.

CreateGroup

function CreateGroup( const ARequest: ICognitoIdentityProviderCreateGroupRequest): ICognitoIdentityProviderCreateGroupResponse; overload;

ICognitoIdentityProviderCreateGroupRequest → ICognitoIdentityProviderCreateGroupResponse

Create a group in a user pool.

Parameters

Name	Description
ARequest	A CreateGroup request object.

Returns

Response containing CreateGroup results.

---

function CreateGroup( const AUserPoolId, AGroupName: string): ICognitoIdentityProviderCreateGroupResponse; overload;

ICognitoIdentityProviderCreateGroupResponse

Create a group in a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AGroupName	Specify a name for the group. Must be unique.

Returns

Response containing CreateGroup results.

CreateIdentityProvider

function CreateIdentityProvider( const ARequest: ICognitoIdentityProviderCreateIdentityProviderRequest): ICognitoIdentityProviderCreateIdentityProviderResponse;

ICognitoIdentityProviderCreateIdentityProviderRequest → ICognitoIdentityProviderCreateIdentityProviderResponse

Create an Identity Provider (IdP) for a user pool.

Parameters

Name	Description
ARequest	A CreateIdentityProvider request object.

Returns

Response containing CreateIdentityProvider results.

CreateResourceServer

function CreateResourceServer( const ARequest: ICognitoIdentityProviderCreateResourceServerRequest): ICognitoIdentityProviderCreateResourceServerResponse;

ICognitoIdentityProviderCreateResourceServerRequest → ICognitoIdentityProviderCreateResourceServerResponse

Create a new OAuth2.0 resource server and define custom scopes within it.

Parameters

Name	Description
ARequest	A CreateResourceServer request object.

Returns

Response containing CreateResourceServer results.

CreateUserImportJob

function CreateUserImportJob( const ARequest: ICognitoIdentityProviderCreateUserImportJobRequest): ICognitoIdentityProviderCreateUserImportJobResponse; overload;

ICognitoIdentityProviderCreateUserImportJobRequest → ICognitoIdentityProviderCreateUserImportJobResponse

Create a user import job.

Parameters

Name	Description
ARequest	A CreateUserImportJob request object.

Returns

Response containing CreateUserImportJob results.

---

function CreateUserImportJob( const AUserPoolId, AJobName: string; const ACloudWatchLogsRoleArn: TARN): ICognitoIdentityProviderCreateUserImportJobResponse; overload;

ICognitoIdentityProviderCreateUserImportJobResponse

Create a user import job.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AJobName	Specify a name for the user import job.
ACloudWatchLogsRoleArn	Specify an Amazon Resource Name (ARN) of an Amazon CloudWatch Logs Logging role for the user import job.

Returns

Response containing CreateUserImportJob results.

CreateUserPool

function CreateUserPool( const ARequest: ICognitoIdentityProviderCreateUserPoolRequest): ICognitoIdentityProviderCreateUserPoolResponse;

ICognitoIdentityProviderCreateUserPoolRequest → ICognitoIdentityProviderCreateUserPoolResponse

Create a new Amazon Cognito user pool and set its password policy.

Parameters

Name	Description
ARequest	A CreateUserPool request object.

Returns

Response containing CreateUserPool results.

CreateUserPoolClient

function CreateUserPoolClient( const ARequest: ICognitoIdentityProviderCreateUserPoolClientRequest): ICognitoIdentityProviderCreateUserPoolClientResponse;

ICognitoIdentityProviderCreateUserPoolClientRequest → ICognitoIdentityProviderCreateUserPoolClientResponse

Create a user pool client.

Parameters

Name	Description
ARequest	A CreateUserPoolClient request object.

Returns

Response containing CreateUserPoolClient results.

CreateUserPoolDomain

function CreateUserPoolDomain( const ARequest: ICognitoIdentityProviderCreateUserPoolDomainRequest): ICognitoIdentityProviderCreateUserPoolDomainResponse;

ICognitoIdentityProviderCreateUserPoolDomainRequest → ICognitoIdentityProviderCreateUserPoolDomainResponse

Create a new domain for a user pool.

DeleteGroup

function DeleteGroup( const ARequest: ICognitoIdentityProviderDeleteGroupRequest): ICognitoIdentityProviderDeleteGroupResponse; overload;

ICognitoIdentityProviderDeleteGroupRequest → ICognitoIdentityProviderDeleteGroupResponse

Delete a group.

Parameters

Name	Description
ARequest	A DeleteGroup request object.

Returns

Response containing DeleteGroup results.

---

function DeleteGroup( const AUserPoolId, AGroupName: string): ICognitoIdentityProviderDeleteGroupResponse; overload;

ICognitoIdentityProviderDeleteGroupResponse

Delete a group.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AGroupName	Specify the name of the group.

Returns

Response containing DeleteGroup results.

DeleteIdentityProvider

function DeleteIdentityProvider( const ARequest: ICognitoIdentityProviderDeleteIdentityProviderRequest): ICognitoIdentityProviderDeleteIdentityProviderResponse; overload;

ICognitoIdentityProviderDeleteIdentityProviderRequest → ICognitoIdentityProviderDeleteIdentityProviderResponse

Delete an Identity Provider (IdP) for a user pool.

Parameters

Name	Description
ARequest	A DeleteIdentityProvider request object.

Returns

Response containing DeleteIdentityProvider results.

---

function DeleteIdentityProvider( const AUserPoolId, AProviderName: string): ICognitoIdentityProviderDeleteIdentityProviderResponse; overload;

ICognitoIdentityProviderDeleteIdentityProviderResponse

Delete an Identity Provider (IdP) for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AProviderName	Specify the name of the Identity Provider (IdP).

Returns

Response containing DeleteIdentityProvider results.

DeleteResourceServer

function DeleteResourceServer( const ARequest: ICognitoIdentityProviderDeleteResourceServerRequest): ICognitoIdentityProviderDeleteResourceServerResponse; overload;

ICognitoIdentityProviderDeleteResourceServerRequest → ICognitoIdentityProviderDeleteResourceServerResponse

Delete a resource server.

Parameters

Name	Description
AReqest	A DeleteResourceServer request object.

Returns

Response containing DeleteResourceServer results.

---

function DeleteResourceServer( const AUserPoolId, AIdentifier: string): ICognitoIdentityProviderDeleteResourceServerResponse; overload;

ICognitoIdentityProviderDeleteResourceServerResponse

Delete a resource server.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AIdentifier	Specify the identifier for the resource server.

Returns

Response containing DeleteResourceServer results.

DeleteUser

function DeleteUser( const ARequest: ICognitoIdentityProviderDeleteUserRequest): ICognitoIdentityProviderDeleteUserResponse; overload;

ICognitoIdentityProviderDeleteUserRequest → ICognitoIdentityProviderDeleteUserResponse

Delete a user.

This method allows a user to delete their own profile.

Parameters

Name	Description
ARequset	A DeleteUser request object.

Returns

Response containing DeleteUser results.

---

function DeleteUser(const AAccessToken: string): ICognitoIdentityProviderDeleteUserResponse; overload;

ICognitoIdentityProviderDeleteUserResponse

Delete a user.

This method allows a user to delete their own profile.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user whose profile you want to delete.

Returns

Response containing DeleteUser results.

DeleteUserAttributes

function DeleteUserAttributes( const ARequest: ICognitoIdentityProviderDeleteUserAttributesRequest): ICognitoIdentityProviderDeleteUserAttributesResponse; overload;

ICognitoIdentityProviderDeleteUserAttributesRequest → ICognitoIdentityProviderDeleteUserAttributesResponse

Delete the attributes of a user.

Parameters

Name	Description
ARequest	A DeleteUserAttributes request object.

Returns

Response containing DeleteUserAttributes results.

---

function DeleteUserAttributes( const AAccessToken: string; const AUserAttributeNames: array of string): ICognitoIdentityProviderDeleteUserAttributesResponse; overload;

ICognitoIdentityProviderDeleteUserAttributesResponse

Delete the attributes of a user.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user whose attributes you want to delete.
AUserAttributeNames	Specify a list of attribute names you want to delete.

Returns

Response containing DeleteUserAttributes results.

DeleteUserPool

function DeleteUserPool( const ARequest: ICognitoIdentityProviderDeleteUserPoolRequest): ICognitoIdentityProviderDeleteUserPoolResponse; overload;

ICognitoIdentityProviderDeleteUserPoolRequest → ICognitoIdentityProviderDeleteUserPoolResponse

Delete an Amazon Cognito user pool.

Parameters

Name	Description
ARequest	A DeleteUserPool request object.

Returns

Response containing DeleteUserPool results.

---

function DeleteUserPool( const AUserPoolId: string): ICognitoIdentityProviderDeleteUserPoolResponse; overload;

ICognitoIdentityProviderDeleteUserPoolResponse

Delete an Amazon Cognito user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing DeleteUserPool results.

DeleteUserPoolClient

function DeleteUserPoolClient( const ARequest: ICognitoIdentityProviderDeleteUserPoolClientRequest): ICognitoIdentityProviderDeleteUserPoolClientResponse; overload;

ICognitoIdentityProviderDeleteUserPoolClientRequest → ICognitoIdentityProviderDeleteUserPoolClientResponse

Delete a user pool client.

Parameters

Name	Description
ARequest	A DeleteUserPoolClient request object.

Returns

Response containing DeleteUserPoolClient results.

---

function DeleteUserPoolClient( const AUserPoolId, AClientId: string): ICognitoIdentityProviderDeleteUserPoolClientResponse; overload;

ICognitoIdentityProviderDeleteUserPoolClientResponse

Delete a user pool client.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AClientId	Specify the ID of the app client associated with the user pool.

Returns

Response containing DeleteUserPoolClient results.

DeleteUserPoolDomain

function DeleteUserPoolDomain( const ARequest: ICognitoIdentityProviderDeleteUserPoolDomainRequest): ICognitoIdentityProviderDeleteUserPoolDomainResponse; overload;

ICognitoIdentityProviderDeleteUserPoolDomainRequest → ICognitoIdentityProviderDeleteUserPoolDomainResponse

Delete a domain for a user pool.

Parameters

Name	Description
ARequest	A DeleteUserPoolDomain request object.

Returns

Response containing DeleteUserPoolDomain results.

---

function DeleteUserPoolDomain( const AUserPoolId, ADomain: string): ICognitoIdentityProviderDeleteUserPoolDomainResponse; overload;

ICognitoIdentityProviderDeleteUserPoolDomainResponse

Delete a domain for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
ADomain	The domain string. For custom domains, specify the fully-qualified domain name. For Amazon Cognito prefix domains, use the prefix on its own.

Returns

Response containing DeleteUserPoolDomain results.

DescribeIdentityProvider

function DescribeIdentityProvider( const ARequest: ICognitoIdentityProviderDescribeIdentityProviderRequest): ICognitoIdentityProviderDescribeIdentityProviderResponse; overload;

ICognitoIdentityProviderDescribeIdentityProviderRequest → ICognitoIdentityProviderDescribeIdentityProviderResponse

Fetch information about an Identity Provider (IdP).

Parameters

Name	Description
ARequest	A DescribeIdentityProvider request object.

Returns

Response containing DescribeIdentityProvider results.

---

function DescribeIdentityProvider( const AUserPoolId, AProviderName: string): ICognitoIdentityProviderDescribeIdentityProviderResponse; overload;

ICognitoIdentityProviderDescribeIdentityProviderResponse

Fetch information about an Identity Provider (IdP).

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AProviderName	Specify the name of the Identity Provider (IdP).

Returns

Response containing DescribeIdentityProvider results.

DescribeResourceServer

function DescribeResourceServer( const ARequest: ICognitoIdentityProviderDescribeResourceServerRequest): ICognitoIdentityProviderDescribeResourceServerResponse; overload;

ICognitoIdentityProviderDescribeResourceServerRequest → ICognitoIdentityProviderDescribeResourceServerResponse

Fetch information about a resource server.

Parameters

Name	Description
ARequest	A DescribeResourceServer request object.

Returns

Response containing DescribeResourceServer results.

---

function DescribeResourceServer( const AUserPoolId, AIdentifier: string): ICognitoIdentityProviderDescribeResourceServerResponse; overload;

ICognitoIdentityProviderDescribeResourceServerResponse

Fetch information about a resource server.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AIdentifier	Specify the identifier for the resource server.

Returns

Response containing DescribeResourceServer results.

DescribeRiskConfiguration

function DescribeRiskConfiguration( const ARequest: ICognitoIdentityProviderDescribeRiskConfigurationRequest): ICognitoIdentityProviderDescribeRiskConfigurationResponse; overload;

ICognitoIdentityProviderDescribeRiskConfigurationRequest → ICognitoIdentityProviderDescribeRiskConfigurationResponse

Fetch information about the risk configuration.

Parameters

Name	Description
ARequest	A DescribeRiskConfiguration request object.

Returns

Response containing DescribeRiskConfiguration results.

---

function DescribeRiskConfiguration( const AUserPoolId, AClientId: string): ICognitoIdentityProviderDescribeRiskConfigurationResponse; overload;

ICognitoIdentityProviderDescribeRiskConfigurationResponse

Fetch information about the risk configuration.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AClientId	Specify the ID of the app client.

Returns

Response containing DescribeRiskConfiguration results.

DescribeUserImportJob

function DescribeUserImportJob( const ARequest: ICognitoIdentityProviderDescribeUserImportJobRequest): ICognitoIdentityProviderDescribeUserImportJobResponse; overload;

ICognitoIdentityProviderDescribeUserImportJobRequest → ICognitoIdentityProviderDescribeUserImportJobResponse

Fetch information about a user import job.

Parameters

Name	Description
ARequest	A DescribeUserImportJob request object.

Returns

Response containing DescribeUserImportJob results.

---

function DescribeUserImportJob( const AUserPoolId, AJobId: string): ICognitoIdentityProviderDescribeUserImportJobResponse; overload;

ICognitoIdentityProviderDescribeUserImportJobResponse

Fetch information about a user import job.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AJobId	Specify the ID of the user import job.

Returns

Response containing DescribeUserImportJob results.

DescribeUserPool

function DescribeUserPool( const ARequest: ICognitoIdentityProviderDescribeUserPoolRequest): ICognitoIdentityProviderDescribeUserPoolResponse; overload;

ICognitoIdentityProviderDescribeUserPoolRequest → ICognitoIdentityProviderDescribeUserPoolResponse

Fetch information about a user pool.

Parameters

Name	Description
ARequest	A DescribeUserPool request object.

Returns

Response containing DescribeUserPool results.

---

function DescribeUserPool( const AUserPoolId: string): ICognitoIdentityProviderDescribeUserPoolResponse; overload;

ICognitoIdentityProviderDescribeUserPoolResponse

Fetch information about a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing DescribeUserPool results.

DescribeUserPoolClient

function DescribeUserPoolClient( const ARequest: ICognitoIdentityProviderDescribeUserPoolClientRequest): ICognitoIdentityProviderDescribeUserPoolClientResponse; overload;

ICognitoIdentityProviderDescribeUserPoolClientRequest → ICognitoIdentityProviderDescribeUserPoolClientResponse

Fetch information about a user pool client app.

Parameters

Name	Description
ARequest	A DescribeUserPoolClient request object.

Returns

Response containing DescribeUserPoolClient results.

---

function DescribeUserPoolClient( const AUserPoolId, AClientId: string): ICognitoIdentityProviderDescribeUserPoolClientResponse; overload;

ICognitoIdentityProviderDescribeUserPoolClientResponse

Fetch information about a user pool client app.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AClientId	Specify the ID of the app client.

Returns

Response containing DescribeUserPoolClient results.

DescribeUserPoolDomain

function DescribeUserPoolDomain( const ARequest: ICognitoIdentityProviderDescribeUserPoolDomainRequest): ICognitoIdentityProviderDescribeUserPoolDomainResponse; overload;

ICognitoIdentityProviderDescribeUserPoolDomainRequest → ICognitoIdentityProviderDescribeUserPoolDomainResponse

Fetch information about a domain.

Parameters

Name	Description
ARequest	A DescribeUserPoolDomain request object.

Returns

Response containing DescribeUserPoolDomain results.

---

function DescribeUserPoolDomain( const ADomain: string): ICognitoIdentityProviderDescribeUserPoolDomainResponse; overload;

ICognitoIdentityProviderDescribeUserPoolDomainResponse

Fetch information about a domain.

Parameters

Name	Description
ADomain	The domain string. For custom domains, specify the fully-qualified domain name. For Amazon Cognito prefix domains, use the prefix on its own.

Returns

Response containing DescribeUserPoolDomain results.

ForgetDevice

function ForgetDevice( const ARequest: ICognitoIdentityProviderForgetDeviceRequest): ICognitoIdentityProviderForgetDeviceResponse; overload;

ICognitoIdentityProviderForgetDeviceRequest → ICognitoIdentityProviderForgetDeviceResponse

Forget a device.

Parameters

Name	Description
ARequest	A ForgetDevice request object.

Returns

Response containing ForgetDevice results.

---

function ForgetDevice( const ADeviceKey: string; const AAccessToken: string = ''): ICognitoIdentityProviderForgetDeviceResponse; overload;

ICognitoIdentityProviderForgetDeviceResponse

Forget a device.

Parameters

Name	Description
ADeviceKey	Specify the device key.
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

Returns

Response containing ForgetDevice results.

ForgotPassword

function ForgotPassword( const ARequest: ICognitoIdentityProviderForgotPasswordRequest): ICognitoIdentityProviderForgotPasswordResponse;

ICognitoIdentityProviderForgotPasswordRequest → ICognitoIdentityProviderForgotPasswordResponse

Invoke the forgotten password procedure.

Calling ForgotPassword will send a message to the end user with a confirmation code that is required to change the user's password.

Parameters

Name	Description
ARequest	A ForgotPassword request object.

Returns

Response containing ForgotPassword results.

GetCSVHeader

function GetCSVHeader( const ARequest: ICognitoIdentityProviderGetCSVHeaderRequest): ICognitoIdentityProviderGetCSVHeaderResponse; overload;

ICognitoIdentityProviderGetCSVHeaderRequest → ICognitoIdentityProviderGetCSVHeaderResponse

Fetch the header information for the comma-separated value (CSV) file to be used as input to the user import job.

Parameters

Name	Description
ARequest	A GetCSVHeader request object.

Returns

Response containing GetCSVHeader results.

---

function GetCSVHeader( const AUserPoolId: string): ICognitoIdentityProviderGetCSVHeaderResponse; overload;

ICognitoIdentityProviderGetCSVHeaderResponse

Fetch the header information for the comma-separated value (CSV) file to be used as input to the user import job.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing GetCSVHeader results.

GetDevice

function GetDevice( const ARequest: ICognitoIdentityProviderGetDeviceRequest): ICognitoIdentityProviderGetDeviceResponse; overload;

ICognitoIdentityProviderGetDeviceRequest → ICognitoIdentityProviderGetDeviceResponse

Fetch the device details.

Parameters

Name	Description
ARequest	A GetDevice request object.

Returns

Response containing GetDevice results.

---

function GetDevice( const ADeviceKey: string; const AAccessToken: string = ''): ICognitoIdentityProviderGetDeviceResponse; overload;

ICognitoIdentityProviderGetDeviceResponse

Fetch the device details.

Parameters

Name	Description
ADeviceKey	Specify the device key.
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user whose registered device you want to forget.

Returns

Response containing GetDevice results.

GetGroup

function GetGroup( const ARequest: ICognitoIdentityProviderGetGroupRequest): ICognitoIdentityProviderGetGroupResponse; overload;

ICognitoIdentityProviderGetGroupRequest → ICognitoIdentityProviderGetGroupResponse

Fetch a groups details.

Parameters

Name	Description
ARequest	A GetGroup request object.

Returns

Response containing GetGroup results.

---

function GetGroup( const AUserPoolId, AGroupName: string): ICognitoIdentityProviderGetGroupResponse; overload;

ICognitoIdentityProviderGetGroupResponse

Fetch a groups details.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AGroupName	Specify the name of the group.

Returns

Response containing GetGroup results.

GetIdentityProviderByIdentifier

function GetIdentityProviderByIdentifier( const ARequest: ICognitoIdentityProviderGetIdentityProviderByIdentifierRequest): ICognitoIdentityProviderGetIdentityProviderByIdentifierResponse; overload;

ICognitoIdentityProviderGetIdentityProviderByIdentifierRequest → ICognitoIdentityProviderGetIdentityProviderByIdentifierResponse

Fetch an Identity Providers (IdPs) details.

Parameters

Name	Description
ARequest	A GetIdentityProviderByIdentifier request object.

Returns

Response containing GetIdentityProviderByIdentifier results.

---

function GetIdentityProviderByIdentifier( const AUserPoolId, AIdpIdentifier: string): ICognitoIdentityProviderGetIdentityProviderByIdentifierResponse; overload;

ICognitoIdentityProviderGetIdentityProviderByIdentifierResponse

Fetch an Identity Providers (IdPs) details.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AIdpIdentifier	Specify the Identity Provider (IdP) identifier.

Returns

Response containing GetIdentityProviderByIdentifier results.

GetSigningCertificate

function GetSigningCertificate( const ARequest: ICognitoIdentityProviderGetSigningCertificateRequest): ICognitoIdentityProviderGetSigningCertificateResponse; overload;

ICognitoIdentityProviderGetSigningCertificateRequest → ICognitoIdentityProviderGetSigningCertificateResponse

Fetch the signing certificate for a user pool.

Parameters

Name	Description
ARequest	A GetSigningCertificate request object.

Returns

Response containing GetSigningCertificate results.

---

function GetSigningCertificate( const AUserPoolId: string): ICognitoIdentityProviderGetSigningCertificateResponse; overload;

ICognitoIdentityProviderGetSigningCertificateResponse

Fetch the signing certificate for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing GetSigningCertificate results.

GetUICustomization

function GetUICustomization( const ARequest: ICognitoIdentityProviderGetUICustomizationRequest): ICognitoIdentityProviderGetUICustomizationResponse; overload;

ICognitoIdentityProviderGetUICustomizationRequest → ICognitoIdentityProviderGetUICustomizationResponse

Fetch the user interface (UI) customization information for an app client.

Parameters

Name	Description
ARequest	A GetUICustomization request object.

Returns

Response containing GetUICustomization results.

---

function GetUICustomization( const AUserPoolId: string; const AClientId: string = ''): ICognitoIdentityProviderGetUICustomizationResponse; overload;

ICognitoIdentityProviderGetUICustomizationResponse

Fetch the user interface (UI) customization information for an app client.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AClientId	Specify the ID of a client app.

Returns

Response containing GetUICustomization results.

GetUser

function GetUser( const ARequest: ICognitoIdentityProviderGetUserRequest): ICognitoIdentityProviderGetUserResponse; overload;

ICognitoIdentityProviderGetUserRequest → ICognitoIdentityProviderGetUserResponse

Fetch a users details.

Parameters

Name	Description
ARequest	A GetUser request object.

Returns

Response containing GetUser results.

---

function GetUser( const AAccessToken: string): ICognitoIdentityProviderGetUserResponse; overload;

ICognitoIdentityProviderGetUserResponse

Fetch a users details.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user whose information you want to retrieve.

Returns

Response containing GetUser results.

GetUserAttributeVerificationCode

function GetUserAttributeVerificationCode( const ARequest: ICognitoIdentityProviderGetUserAttributeVerificationCodeRequest): ICognitoIdentityProviderGetUserAttributeVerificationCodeResponse; overload;

ICognitoIdentityProviderGetUserAttributeVerificationCodeRequest → ICognitoIdentityProviderGetUserAttributeVerificationCodeResponse

Generate a user attribute verification code for the specified attribute name.

This action will send a message to a user with a code that they must return in a VerifyUserAttribute request.

Parameters

Name	Description
ARequest	A GetUserAttributeVerificationCode request object.

Returns

Response containing GetUserAttributeVerificationCode results.

---

function GetUserAttributeVerificationCode( const AAccessToken, AAttributeName: string): ICognitoIdentityProviderGetUserAttributeVerificationCodeResponse; overload;

ICognitoIdentityProviderGetUserAttributeVerificationCodeResponse

Generate a user attribute verification code for the specified attribute name.

This action will send a message to a user with a code that they must return in a VerifyUserAttribute request.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user whose attribute verification code you want to generate.
AAttributeName	Specify the name of the attribute.

Returns

Response containing GetUserAttributeVerificationCode results.

GetUserPoolMfaConfig

function GetUserPoolMfaConfig( const ARequest: ICognitoIdentityProviderGetUserPoolMfaConfigRequest): ICognitoIdentityProviderGetUserPoolMfaConfigResponse; overload;

ICognitoIdentityProviderGetUserPoolMfaConfigRequest → ICognitoIdentityProviderGetUserPoolMfaConfigResponse

Fetch the user pool's multi-factor authentication (MFA) configuration.

Parameters

Name	Description
ARequest	A GetUserPoolMfaConfig request object.

Returns

Response containing GetUserPoolMfaConfig results.

---

function GetUserPoolMfaConfig( const AUserPoolId: string): ICognitoIdentityProviderGetUserPoolMfaConfigResponse; overload;

ICognitoIdentityProviderGetUserPoolMfaConfigResponse

Fetch the user pool's multi-factor authentication (MFA) configuration.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing GetUserPoolMfaConfig results.

GlobalSignOut

function GlobalSignOut( const ARequest: ICognitoIdentityProviderGlobalSignOutRequest): ICognitoIdentityProviderGlobalSignOutResponse; overload;

ICognitoIdentityProviderGlobalSignOutRequest → ICognitoIdentityProviderGlobalSignOutResponse

Sign out from all devices.

This action will invalidate all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.

Parameters

Name	Description
ARequest	A GlobalSignOut request object.

Returns

Response containing GlobalSignOut results.

---

function GlobalSignOut( const AAccessToken: string): ICognitoIdentityProviderGlobalSignOutResponse; overload;

ICognitoIdentityProviderGlobalSignOutResponse

Sign out from all devices.

This action will invalidate all refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user who you want to sign out.

Returns

Response containing GlobalSignOut results.

InitiateAuth

function InitiateAuth( const ARequest: ICognitoIdentityProviderInitiateAuthRequest): ICognitoIdentityProviderInitiateAuthResponse;

ICognitoIdentityProviderInitiateAuthRequest → ICognitoIdentityProviderInitiateAuthResponse

Initiate sign-in for a user in the Amazon Cognito user directory.

Parameters

Name	Description
ARequest	A InitiateAuth request object.

Returns

Response containing InitiateAuth results.

ListDevices

function ListDevices( const ARequest: ICognitoIdentityProviderListDevicesRequest): ICognitoIdentityProviderListDevicesResponse; overload;

ICognitoIdentityProviderListDevicesRequest → ICognitoIdentityProviderListDevicesResponse

List the sign-in devices that Amazon Cognito has registered for the current user.

Parameters

Name	Description
ARequest	A ListDevices request object.

Returns

Response containing ListDevices results.

---

function ListDevices( const AAccessToken: string): ICognitoIdentityProviderListDevicesResponse; overload;

ICognitoIdentityProviderListDevicesResponse

List the sign-in devices that Amazon Cognito has registered for the current user.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user who you want list devices for.

Returns

Response containing ListDevices results.

---

function ListDevices( const AAccessToken: string; const ALimit: Integer; const APaginationToken: string = ''): ICognitoIdentityProviderListDevicesResponse; overload;

ICognitoIdentityProviderListDevicesResponse

List the sign-in devices that Amazon Cognito has registered for the current user.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user who you want list devices for.
ALimit	Specify a limit for number of devices returned. Minimum value of 0. Maximum value of 60.
APaginationToken	Specify a PaginationToken returned from a previous request.

Returns

Response containing ListDevices results.

ListGroups

function ListGroups( const ARequest: ICognitoIdentityProviderListGroupsRequest): ICognitoIdentityProviderListGroupsResponse; overload;

ICognitoIdentityProviderListGroupsRequest → ICognitoIdentityProviderListGroupsResponse

List groups for a user pool.

Parameters

Name	Description
ARequest	A ListGroups request object.

Returns

Response containing ListGroups results.

---

function ListGroups( const AUserPoolId: string): ICognitoIdentityProviderListGroupsResponse; overload;

ICognitoIdentityProviderListGroupsResponse

List groups for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing ListGroups results.

---

function ListGroups( const AUserPoolId: string; const ALimit: Integer; const ANextToken: string = ''): ICognitoIdentityProviderListGroupsResponse; overload;

ICognitoIdentityProviderListGroupsResponse

List groups for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
ALimit	Specify a limit for number of devices returned. Minimum value of 0. Maximum value of 60.
ANextToken	Specify a NextToken returned from a previous request.

Returns

Response containing ListGroups results.

ListIdentityProviders

function ListIdentityProviders( const ARequest: ICognitoIdentityProviderListIdentityProvidersRequest): ICognitoIdentityProviderListIdentityProvidersResponse; overload;

ICognitoIdentityProviderListIdentityProvidersRequest → ICognitoIdentityProviderListIdentityProvidersResponse

List identity providers (IdPs) for a user pool.

Parameters

Name	Description
ARequest	A ListIdentityProviders request object.

Returns

Response containing ListIdentityProviders results.

---

function ListIdentityProviders( const AUserPoolId: string): ICognitoIdentityProviderListIdentityProvidersResponse; overload;

ICognitoIdentityProviderListIdentityProvidersResponse

List identity providers (IdPs) for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing ListIdentityProviders results.

---

function ListIdentityProviders( const AUserPoolId: string; const AMaxResults: Integer; const ANextToken: string = ''): ICognitoIdentityProviderListIdentityProvidersResponse; overload;

ICognitoIdentityProviderListIdentityProvidersResponse

List identity providers (IdPs) for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AMaxResults	Specify a limit for number of identity providers returned. Minimum value of 0. Maximum value of 60.
ANextToken	Specify a NextToken returned from a previous request.

Returns

Response containing ListIdentityProviders results.

ListResourceServers

function ListResourceServers( const ARequest: ICognitoIdentityProviderListResourceServersRequest): ICognitoIdentityProviderListResourceServersResponse; overload;

ICognitoIdentityProviderListResourceServersRequest → ICognitoIdentityProviderListResourceServersResponse

List the resource servers for a user pool.

Parameters

Name	Description
ARequest	A ListResourceServers request object.

Returns

Response containing ListResourceServers results.

---

function ListResourceServers( const AUserPoolId: string): ICognitoIdentityProviderListResourceServersResponse; overload;

ICognitoIdentityProviderListResourceServersResponse

List the resource servers for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing ListResourceServers results.

---

function ListResourceServers( const AUserPoolId: string; const AMaxResults: Integer; const ANextToken: string = ''): ICognitoIdentityProviderListResourceServersResponse; overload;

ICognitoIdentityProviderListResourceServersResponse

List the resource servers for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AMaxResults	Specify a limit for number of resource servers returned. Minimum value of 0. Maximum value of 50.
ANextToken	Specify a NextToken returned from a previous request.

Returns

Response containing ListResourceServers results.

ListTagsForResource

function ListTagsForResource( const ARequest: ICognitoIdentityProviderListTagsForResourceRequest): ICognitoIdentityProviderListTagsForResourceResponse; overload;

ICognitoIdentityProviderListTagsForResourceRequest → ICognitoIdentityProviderListTagsForResourceResponse

List the tags assigned to an Amazon Cognito user pool.

Parameters

Name	Description
ARequest	A ListTagsForResource request object.

Returns

Response containing ListTagsForResource results.

---

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

ICognitoIdentityProviderListTagsForResourceResponse

List the tags assigned to an Amazon Cognito user pool.

Parameters

Name	Description
AResourceArn	Specify the Amazon Resource Name (ARN) of a user pool.

Returns

Response containing ListTagsForResource results.

ListUserImportJobs

function ListUserImportJobs( const ARequest: ICognitoIdentityProviderListUserImportJobsRequest): ICognitoIdentityProviderListUserImportJobsResponse; overload;

ICognitoIdentityProviderListUserImportJobsRequest → ICognitoIdentityProviderListUserImportJobsResponse

List the user import jobs for a user pool.

Parameters

Name	Description
ARequest	A ListUserImportJobs request object.

Returns

Response containing ListUserImportJobs results.

---

function ListUserImportJobs( const AUserPoolId: string): ICognitoIdentityProviderListUserImportJobsResponse; overload;

ICognitoIdentityProviderListUserImportJobsResponse

List the user import jobs for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing ListUserImportJobs results.

---

function ListUserImportJobs( const AUserPoolId: string; const AMaxResults: Integer; const APaginationToken: string = ''): ICognitoIdentityProviderListUserImportJobsResponse; overload;

ICognitoIdentityProviderListUserImportJobsResponse

List the user import jobs for a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AMaxResults	Specify a limit for number of user import jobs returned. Minimum value of 0. Maximum value of 60.
APaginationToken	Specify a PaginationToken returned from a previous request.

Returns

Response containing ListUserImportJobs results.

ListUserPoolClients

function ListUserPoolClients( const ARequest: ICognitoIdentityProviderListUserPoolClientsRequest): ICognitoIdentityProviderListUserPoolClientsResponse; overload;

ICognitoIdentityProviderListUserPoolClientsRequest → ICognitoIdentityProviderListUserPoolClientsResponse

List the clients of a user pool.

Parameters

Name	Description
ARequest	A ListUserPoolClients request object.

Returns

Response containing ListUserPoolClients results.

---

function ListUserPoolClients( const AUserPoolId: string): ICognitoIdentityProviderListUserPoolClientsResponse; overload;

ICognitoIdentityProviderListUserPoolClientsResponse

List the clients of a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing ListUserPoolClients results.

---

function ListUserPoolClients( const AUserPoolId: string; const AMaxResults: Integer; const ANextToken: string = ''): ICognitoIdentityProviderListUserPoolClientsResponse; overload;

ICognitoIdentityProviderListUserPoolClientsResponse

List the clients of a user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AMaxResults	Specify a limit for number of user pool clients returned. Minimum value of 0. Maximum value of 60.
ANextToken	Specify a NextToken returned from a previous request.

Returns

Response containing ListUserPoolClients results.

ListUserPools

function ListUserPools( const ARequest: ICognitoIdentityProviderListUserPoolsRequest): ICognitoIdentityProviderListUserPoolsResponse; overload;

ICognitoIdentityProviderListUserPoolsRequest → ICognitoIdentityProviderListUserPoolsResponse

List the user pools associated with the AWS account.

Parameters

Name	Description
ARequest	A ListUserPools request object.

Returns

Response containing ListUserPools results.

---

function ListUserPools: ICognitoIdentityProviderListUserPoolsResponse; overload;

ICognitoIdentityProviderListUserPoolsResponse

List the user pools associated with the AWS account.

Returns

Response containing ListUserPools results.

---

function ListUserPools( const AMaxResults: Integer; const ANextToken: string): ICognitoIdentityProviderListUserPoolsResponse; overload;

ICognitoIdentityProviderListUserPoolsResponse

List the user pools associated with the AWS account.

Parameters

Name	Description
AMaxResults	Specify a limit for number of user pools returned. Minimum value of 0. Maximum value of 60.
ANextToken	Specify a NextToken returned from a previous request.

Returns

Response containing ListUserPools results.

ListUsers

function ListUsers( const ARequest: ICognitoIdentityProviderListUsersRequest): ICognitoIdentityProviderListUsersResponse; overload;

ICognitoIdentityProviderListUsersRequest → ICognitoIdentityProviderListUsersResponse

List the users in an Amazon Cognito user pool.

Parameters

Name	Description
ARequest	A ListUsers request object.

Returns

Response containing ListUsers results.

---

function ListUsers( const AUserPoolId: string): ICognitoIdentityProviderListUsersResponse; overload;

ICognitoIdentityProviderListUsersResponse

List the users in an Amazon Cognito user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.

Returns

Response containing ListUsers results.

---

function ListUsers( const AUserPoolId: string; const ALimit: Integer; const APaginationToken: string = ''): ICognitoIdentityProviderListUsersResponse; overload;

ICognitoIdentityProviderListUsersResponse

List the users in an Amazon Cognito user pool.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
ALimit	Specify a limit for number of users returned. Minimum value of 0. Maximum value of 60.
APaginationToken	Specify a PaginationToken returned from a previous request.

Returns

Response containing ListUsers results.

ListUsersInGroup

function ListUsersInGroup( const ARequest: ICognitoIdentityProviderListUsersInGroupRequest): ICognitoIdentityProviderListUsersInGroupResponse; overload;

ICognitoIdentityProviderListUsersInGroupRequest → ICognitoIdentityProviderListUsersInGroupResponse

List the users in a group.

Parameters

Name	Description
ARequest	A ListUsersInGroup request object.

Returns

Response containing ListUsersInGroup results.

---

function ListUsersInGroup( const AUserPoolId, AGroupName: string): ICognitoIdentityProviderListUsersInGroupResponse; overload;

ICognitoIdentityProviderListUsersInGroupResponse

List the users in a group.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AGroupName	Specify the name of the group.

Returns

Response containing ListUsersInGroup results.

---

function ListUsersInGroup( const AUserPoolId, AGroupName: string; const ALimit: Integer; const ANextToken: string = ''): ICognitoIdentityProviderListUsersInGroupResponse; overload;

ICognitoIdentityProviderListUsersInGroupResponse

List the users in a group.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AGroupName	Specify the name of the group.
ALimit	Specify a limit for number of users returned. Minimum value of 0. Maximum value of 60.
ANextToken	Specify a NextToken returned from a previous request.

Returns

Response containing ListUsersInGroup results.

ResendConfirmationCode

function ResendConfirmationCode( const ARequest: ICognitoIdentityProviderResendConfirmationCodeRequest): ICognitoIdentityProviderResendConfirmationCodeResponse;

ICognitoIdentityProviderResendConfirmationCodeRequest → ICognitoIdentityProviderResendConfirmationCodeResponse

Resend the confirmation (for confirmation of registration) to a user.

Parameters

Name	Description
ARequest	A ResendConfirmationCode request object.

Returns

Response containing ResendConfirmationCode results.

RespondToAuthChallenge

function RespondToAuthChallenge( const ARequest: ICognitoIdentityProviderRespondToAuthChallengeRequest): ICognitoIdentityProviderRespondToAuthChallengeResponse;

ICognitoIdentityProviderRespondToAuthChallengeRequest → ICognitoIdentityProviderRespondToAuthChallengeResponse

Respond to an authentication challenge.

Parameters

Name	Description
ARequest	A RespondToAuthChallenge request object.

Returns

Response containing RespondToAuthChallenge results.

RevokeToken

function RevokeToken( const ARequest: ICognitoIdentityProviderRevokeTokenRequest): ICognitoIdentityProviderRevokeTokenResponse; overload;

ICognitoIdentityProviderRevokeTokenRequest → ICognitoIdentityProviderRevokeTokenResponse

Revoke all access tokens generated by and at the same time as, the specified refresh token.

Parameters

Name	Description
ARequest	A RevokeToken request object.

Returns

Response containing RevokeToken results.

---

function RevokeToken( const AClientId, AToken: string; const AClientSecret: string = ''): ICognitoIdentityProviderRevokeTokenResponse; overload;

ICognitoIdentityProviderRevokeTokenResponse

Revoke all access tokens generated by and at the same time as, the specified refresh token.

Parameters

Name	Description
AClientId	Specify the ID of a client app.
AToken	Specify the refresh token that you want to revoke.
AClientSecret	Specify the secret for the client ID. Only required if the client ID has a secret.

Returns

Response containing RevokeToken results.

SetRiskConfiguration

function SetRiskConfiguration( const ARequest: ICognitoIdentityProviderSetRiskConfigurationRequest): ICognitoIdentityProviderSetRiskConfigurationResponse;

ICognitoIdentityProviderSetRiskConfigurationRequest → ICognitoIdentityProviderSetRiskConfigurationResponse

Configure actions to take on detected risks.

Parameters

Name	Description
ARequest	A SetRiskConfiguration request object.

Returns

Response containing SetRiskConfiguration results.

SetUICustomization

function SetUICustomization( const ARequest: ICognitoIdentityProviderSetUICustomizationRequest): ICognitoIdentityProviderSetUICustomizationResponse;

ICognitoIdentityProviderSetUICustomizationRequest → ICognitoIdentityProviderSetUICustomizationResponse

Set user interface (UI) customization information for a user pools built-in app UI.

Parameters

Name	Description
ARequest	A SetUICustomization request object.

Returns

Response containing SetUICustomization results.

SetUserMFAPreference

function SetUserMFAPreference( const ARequest: ICognitoIdentityProviderSetUserMFAPreferenceRequest): ICognitoIdentityProviderSetUserMFAPreferenceResponse;

ICognitoIdentityProviderSetUserMFAPreferenceRequest → ICognitoIdentityProviderSetUserMFAPreferenceResponse

Set the users's multi-factor authentication (MFA) preferences.

Parameters

Name	Description
ARequest	A SetUserMFAPreference request object.

Returns

Response containing SetUserMFAPreference results.

SetUserPoolMfaConfig

function SetUserPoolMfaConfig( const ARequest: ICognitoIdentityProviderSetUserPoolMfaConfigRequest): ICognitoIdentityProviderSetUserPoolMfaConfigResponse;

ICognitoIdentityProviderSetUserPoolMfaConfigRequest → ICognitoIdentityProviderSetUserPoolMfaConfigResponse

Set the user pool multi-factor authentication (MFA) configuration.

Parameters

Name	Description
ARequest	A SetUserPoolMfaConfig request object.

Returns

Response containing SetUserPoolMfaConfig results.

SetUserSettings

function SetUserSettings( const ARequest: ICognitoIdentityProviderSetUserSettingsRequest): ICognitoIdentityProviderSetUserSettingsResponse;

ICognitoIdentityProviderSetUserSettingsRequest → ICognitoIdentityProviderSetUserSettingsResponse

Set the user's SMS multi-factor authentication (MFA) options.

This action is no longer supported. Use SetUserMFAPreference instead.

Parameters

Name	Description
ARequest	A SetUserSettings request object.

Returns

Response containing SetUserSettings results.

SignUp

function SignUp( const ARequest: ICognitoIdentityProviderSignUpRequest): ICognitoIdentityProviderSignUpResponse;

ICognitoIdentityProviderSignUpRequest → ICognitoIdentityProviderSignUpResponse

Register a user.

Parameters

Name	Description
ARequest	A SignUp request object.

Returns

Response containing SignUp results.

StartUserImportJob

function StartUserImportJob( const ARequest: ICognitoIdentityProviderStartUserImportJobRequest): ICognitoIdentityProviderStartUserImportJobResponse; overload;

ICognitoIdentityProviderStartUserImportJobRequest → ICognitoIdentityProviderStartUserImportJobResponse

Start the user import job.

Parameters

Name	Description
ARequest	A StartUserImportJob request object.

Returns

Response containing StartUserImportJob results.

---

function StartUserImportJob( const AUserPoolId, AJobId: string): ICognitoIdentityProviderStartUserImportJobResponse; overload;

ICognitoIdentityProviderStartUserImportJobResponse

Start the user import job.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AJobId	Specify the ID of the user import job.

Returns

Response containing StartUserImportJob results.

StopUserImportJob

function StopUserImportJob( const ARequest: ICognitoIdentityProviderStopUserImportJobRequest): ICognitoIdentityProviderStopUserImportJobResponse; overload;

ICognitoIdentityProviderStopUserImportJobRequest → ICognitoIdentityProviderStopUserImportJobResponse

Stop the user import job.

Parameters

Name	Description
ARequest	A StopUserImportJob request object.

Returns

Response containing StopUserImportJob results.

---

function StopUserImportJob( const AUserPoolId, AJobId: string): ICognitoIdentityProviderStopUserImportJobResponse; overload;

ICognitoIdentityProviderStopUserImportJobResponse

Stop the user import job.

Parameters

Name	Description
AUserPoolId	Specify the ID of the user pool.
AJobId	Specify the ID of the user import job.

Returns

Response containing StopUserImportJob results.

TagResource

function TagResource( const ARequest: ICognitoIdentityProviderTagResourceRequest): ICognitoIdentityProviderTagResourceResponse;

ICognitoIdentityProviderTagResourceRequest → ICognitoIdentityProviderTagResourceResponse

Assign tags to an Amazon Cognito user pool.

Parameters

Name	Description
ARequest	A TagResource request object.

Returns

Response containing TagResource results.

UntagResource

function UntagResource( const ARequest: ICognitoIdentityProviderUntagResourceRequest): ICognitoIdentityProviderUntagResourceResponse;

ICognitoIdentityProviderUntagResourceRequest → ICognitoIdentityProviderUntagResourceResponse

Remove tags from an Amazon Cognito user pool.

Parameters

Name	Description
ARequest	A UntagResource request object.

Returns

Response containing UntagResource results.

UpdateAuthEventFeedback

function UpdateAuthEventFeedback( const ARequest: ICognitoIdentityProviderUpdateAuthEventFeedbackRequest): ICognitoIdentityProviderUpdateAuthEventFeedbackResponse;

ICognitoIdentityProviderUpdateAuthEventFeedbackRequest → ICognitoIdentityProviderUpdateAuthEventFeedbackResponse

Provide feedback for an authentication event.

Parameters

Name	Description
ARequest	A UpdateAuthEventFeedback request object.

Returns

Response containing UpdateAuthEventFeedback results.

UpdateDeviceStatus

function UpdateDeviceStatus( const ARequest: ICognitoIdentityProviderUpdateDeviceStatusRequest): ICognitoIdentityProviderUpdateDeviceStatusResponse; overload;

ICognitoIdentityProviderUpdateDeviceStatusRequest → ICognitoIdentityProviderUpdateDeviceStatusResponse

Update the device status.

Parameters

Name	Description
ARequest	A UpdateDeviceStatus request object.

Returns

Response containing UpdateDeviceStatus results.

---

function UpdateDeviceStatus( const AAccessToken, ADeviceKey: string; const ADeviceRememberedStatus: string = ''): ICognitoIdentityProviderUpdateDeviceStatusResponse; overload;

ICognitoIdentityProviderUpdateDeviceStatusResponse

Update the device status.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user whose device status you want to update.
ADeviceKey	Specify the device key.
ADeviceRememberedStatus	Specify the status of whether the device is remembered. Valid values:|.

Returns

Response containing UpdateDeviceStatus results.

UpdateGroup

function UpdateGroup( const ARequest: ICognitoIdentityProviderUpdateGroupRequest): ICognitoIdentityProviderUpdateGroupResponse;

ICognitoIdentityProviderUpdateGroupRequest → ICognitoIdentityProviderUpdateGroupResponse

Update a group.

Parameters

Name	Description
ARequest	A UpdateGroup request object.

Returns

Response containing UpdateGroup results.

UpdateIdentityProvider

function UpdateIdentityProvider( const ARequest: ICognitoIdentityProviderUpdateIdentityProviderRequest): ICognitoIdentityProviderUpdateIdentityProviderResponse;

ICognitoIdentityProviderUpdateIdentityProviderRequest → ICognitoIdentityProviderUpdateIdentityProviderResponse

Update an Identity Provider (IdP) for a user pool.

Parameters

Name	Description
ARequest	A UpdateIdentityProvider request object.

Returns

Response containing UpdateIdentityProvider results.

UpdateResourceServer

function UpdateResourceServer( const ARequest: ICognitoIdentityProviderUpdateResourceServerRequest): ICognitoIdentityProviderUpdateResourceServerResponse;

ICognitoIdentityProviderUpdateResourceServerRequest → ICognitoIdentityProviderUpdateResourceServerResponse

Update the name and scopes of a resource server.

Parameters

Name	Description
ARequest	A UpdateResourceServer request object.

Returns

Response containing UpdateResourceServer results.

UpdateUserAttributes

function UpdateUserAttributes( const ARequest: ICognitoIdentityProviderUpdateUserAttributesRequest): ICognitoIdentityProviderUpdateUserAttributesResponse;

ICognitoIdentityProviderUpdateUserAttributesRequest → ICognitoIdentityProviderUpdateUserAttributesResponse

Update a specific user attribute (one at a time).

Parameters

Name	Description
ARequest	A UpdateUserAttributes request object.

Returns

Response containing UpdateUserAttributes results.

UpdateUserPool

function UpdateUserPool( const ARequest: ICognitoIdentityProviderUpdateUserPoolRequest): ICognitoIdentityProviderUpdateUserPoolResponse;

ICognitoIdentityProviderUpdateUserPoolRequest → ICognitoIdentityProviderUpdateUserPoolResponse

Update the attributes of a user pool.

Parameters

Name	Description
ARequest	A UpdateUserPool request object.

Returns

Response containing UpdateUserPool results.

UpdateUserPoolClient

function UpdateUserPoolClient( const ARequest: ICognitoIdentityProviderUpdateUserPoolClientRequest): ICognitoIdentityProviderUpdateUserPoolClientResponse;

ICognitoIdentityProviderUpdateUserPoolClientRequest → ICognitoIdentityProviderUpdateUserPoolClientResponse

Update the attributes of a user pool client.

Parameters

Name	Description
ARequest	A UpdateUserPoolClient request object.

Returns

Response containing UpdateUserPoolClient results.

UpdateUserPoolDomain

function UpdateUserPoolDomain( const ARequest: ICognitoIdentityProviderUpdateUserPoolDomainRequest): ICognitoIdentityProviderUpdateUserPoolDomainResponse;

ICognitoIdentityProviderUpdateUserPoolDomainRequest → ICognitoIdentityProviderUpdateUserPoolDomainResponse

Update the Secure Socket Layer (SSL) certificate for the custom domain of the user pool.

Parameters

Name	Description
ARequest	A UpdateUserPoolDomain request object.

Returns

Response containing UpdateUserPoolDomain results.

VerifySoftwareToken

function VerifySoftwareToken( const ARequest: ICognitoIdentityProviderVerifySoftwareTokenRequest): ICognitoIdentityProviderVerifySoftwareTokenResponse;

ICognitoIdentityProviderVerifySoftwareTokenRequest → ICognitoIdentityProviderVerifySoftwareTokenResponse

Submit a user entered time-based one-time password (TOTP) code and mark the user's software token MFA status as "verified" if successful.

Parameters

Name	Description
ARequest	A VerifySoftwareToken request object.

Returns

Response containing VerifySoftwareToken results.

VerifyUserAttribute

function VerifyUserAttribute( const ARequest: ICognitoIdentityProviderVerifyUserAttributeRequest): ICognitoIdentityProviderVerifyUserAttributeResponse; overload;

ICognitoIdentityProviderVerifyUserAttributeRequest → ICognitoIdentityProviderVerifyUserAttributeResponse

Verify a user attribute.

Parameters

Name	Description
ARequest	A VerifyUserAttribute request object.

Returns

Response containing VerifyUserAttribute results.

---

function VerifyUserAttribute( const AAccessToken, AAttributeName, ACode: string): ICognitoIdentityProviderVerifyUserAttributeResponse; overload;

ICognitoIdentityProviderVerifyUserAttributeResponse

Verify a user attribute.

Parameters

Name	Description
AAccessToken	Specify a valid access token that Amazon Cognito issued to the user whose attribute you want to verify.
AAttributeName	Specify the name of the attribute.
ACode	Specify the verification code.

Returns

Response containing VerifyUserAttribute results.