View on GitHub
Install in Dash
Classes Reference
Classes
The following classes are available globally.
-
The data type for
See moreAccountRecoverySetting.Declaration
Objective-C
@interface AWSCognitoIdentityProviderAccountRecoverySettingTypeSwift
class AWSCognitoIdentityProviderAccountRecoverySettingType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAccountTakeoverActionTypeSwift
class AWSCognitoIdentityProviderAccountTakeoverActionType -
Account takeover actions type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAccountTakeoverActionsTypeSwift
class AWSCognitoIdentityProviderAccountTakeoverActionsType -
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
Required parameters: [Actions]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationTypeSwift
class AWSCognitoIdentityProviderAccountTakeoverRiskConfigurationType -
Represents the request to add custom attributes.
Required parameters: [UserPoolId, CustomAttributes]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAddCustomAttributesRequestSwift
class AWSCognitoIdentityProviderAddCustomAttributesRequest -
Represents the response from the server for the request to add custom attributes.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAddCustomAttributesResponseSwift
class AWSCognitoIdentityProviderAddCustomAttributesResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminAddUserToGroupRequestSwift
class AWSCognitoIdentityProviderAdminAddUserToGroupRequest -
Confirm a user’s registration as a user pool administrator.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminConfirmSignUpRequestSwift
class AWSCognitoIdentityProviderAdminConfirmSignUpRequest -
Represents the response from the server for the request to confirm registration.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminConfirmSignUpResponseSwift
class AWSCognitoIdentityProviderAdminConfirmSignUpResponse -
The configuration for creating a new user profile.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminCreateUserConfigTypeSwift
class AWSCognitoIdentityProviderAdminCreateUserConfigType -
Represents the request to create a user in the specified user pool.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminCreateUserRequestSwift
class AWSCognitoIdentityProviderAdminCreateUserRequest -
Represents the response from the server to the request to create the user.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminCreateUserResponseSwift
class AWSCognitoIdentityProviderAdminCreateUserResponse -
Represents the request to delete user attributes as an administrator.
Required parameters: [UserPoolId, Username, UserAttributeNames]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminDeleteUserAttributesRequestSwift
class AWSCognitoIdentityProviderAdminDeleteUserAttributesRequest -
Represents the response received from the server for a request to delete user attributes.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminDeleteUserAttributesResponseSwift
class AWSCognitoIdentityProviderAdminDeleteUserAttributesResponse -
Represents the request to delete a user as an administrator.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminDeleteUserRequestSwift
class AWSCognitoIdentityProviderAdminDeleteUserRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminDisableProviderForUserRequestSwift
class AWSCognitoIdentityProviderAdminDisableProviderForUserRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminDisableProviderForUserResponseSwift
class AWSCognitoIdentityProviderAdminDisableProviderForUserResponse -
Represents the request to disable the user as an administrator.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminDisableUserRequestSwift
class AWSCognitoIdentityProviderAdminDisableUserRequest -
Represents the response received from the server to disable the user as an administrator.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminDisableUserResponseSwift
class AWSCognitoIdentityProviderAdminDisableUserResponse -
Represents the request that enables the user as an administrator.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminEnableUserRequestSwift
class AWSCognitoIdentityProviderAdminEnableUserRequest -
Represents the response from the server for the request to enable a user as an administrator.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminEnableUserResponseSwift
class AWSCognitoIdentityProviderAdminEnableUserResponse -
Sends the forgot device request, as an administrator.
Required parameters: [UserPoolId, Username, DeviceKey]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminForgetDeviceRequestSwift
class AWSCognitoIdentityProviderAdminForgetDeviceRequest -
Represents the request to get the device, as an administrator.
Required parameters: [DeviceKey, UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminGetDeviceRequestSwift
class AWSCognitoIdentityProviderAdminGetDeviceRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminGetDeviceResponseSwift
class AWSCognitoIdentityProviderAdminGetDeviceResponse -
Represents the request to get the specified user as an administrator.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminGetUserRequestSwift
class AWSCognitoIdentityProviderAdminGetUserRequest -
Represents the response from the server from the request to get the specified user as an administrator.
Required parameters: [Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminGetUserResponseSwift
class AWSCognitoIdentityProviderAdminGetUserResponse -
Initiates the authorization request, as an administrator.
Required parameters: [UserPoolId, ClientId, AuthFlow]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminInitiateAuthRequestSwift
class AWSCognitoIdentityProviderAdminInitiateAuthRequest -
Initiates the authentication response, as an administrator.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminInitiateAuthResponseSwift
class AWSCognitoIdentityProviderAdminInitiateAuthResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminLinkProviderForUserRequestSwift
class AWSCognitoIdentityProviderAdminLinkProviderForUserRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminLinkProviderForUserResponseSwift
class AWSCognitoIdentityProviderAdminLinkProviderForUserResponse -
Represents the request to list devices, as an administrator.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminListDevicesRequestSwift
class AWSCognitoIdentityProviderAdminListDevicesRequest -
Lists the device’s response, as an administrator.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminListDevicesResponseSwift
class AWSCognitoIdentityProviderAdminListDevicesResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminListGroupsForUserRequestSwift
class AWSCognitoIdentityProviderAdminListGroupsForUserRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminListGroupsForUserResponseSwift
class AWSCognitoIdentityProviderAdminListGroupsForUserResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminListUserAuthEventsRequestSwift
class AWSCognitoIdentityProviderAdminListUserAuthEventsRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminListUserAuthEventsResponseSwift
class AWSCognitoIdentityProviderAdminListUserAuthEventsResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminRemoveUserFromGroupRequestSwift
class AWSCognitoIdentityProviderAdminRemoveUserFromGroupRequest -
Represents the request to reset a user’s password as an administrator.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminResetUserPasswordRequestSwift
class AWSCognitoIdentityProviderAdminResetUserPasswordRequest -
Represents the response from the server to reset a user password as an administrator.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminResetUserPasswordResponseSwift
class AWSCognitoIdentityProviderAdminResetUserPasswordResponse -
The request to respond to the authentication challenge, as an administrator.
Required parameters: [UserPoolId, ClientId, ChallengeName]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequestSwift
class AWSCognitoIdentityProviderAdminRespondToAuthChallengeRequest -
Responds to the authentication challenge, as an administrator.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminRespondToAuthChallengeResponseSwift
class AWSCognitoIdentityProviderAdminRespondToAuthChallengeResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminSetUserMFAPreferenceRequestSwift
class AWSCognitoIdentityProviderAdminSetUserMFAPreferenceRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminSetUserMFAPreferenceResponseSwift
class AWSCognitoIdentityProviderAdminSetUserMFAPreferenceResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminSetUserPasswordRequestSwift
class AWSCognitoIdentityProviderAdminSetUserPasswordRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminSetUserPasswordResponseSwift
class AWSCognitoIdentityProviderAdminSetUserPasswordResponse -
You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
Required parameters: [UserPoolId, Username, MFAOptions]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminSetUserSettingsRequestSwift
class AWSCognitoIdentityProviderAdminSetUserSettingsRequest -
Represents the response from the server to set user settings as an administrator.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminSetUserSettingsResponseSwift
class AWSCognitoIdentityProviderAdminSetUserSettingsResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackRequestSwift
class AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackResponseSwift
class AWSCognitoIdentityProviderAdminUpdateAuthEventFeedbackResponse -
The request to update the device status, as an administrator.
Required parameters: [UserPoolId, Username, DeviceKey]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminUpdateDeviceStatusRequestSwift
class AWSCognitoIdentityProviderAdminUpdateDeviceStatusRequest -
The status response to the request to update the device, as an administrator.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminUpdateDeviceStatusResponseSwift
class AWSCognitoIdentityProviderAdminUpdateDeviceStatusResponse -
Represents the request to update the user’s attributes as an administrator.
Required parameters: [UserPoolId, Username, UserAttributes]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminUpdateUserAttributesRequestSwift
class AWSCognitoIdentityProviderAdminUpdateUserAttributesRequest -
Represents the response from the server for the request to update user attributes as an administrator.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminUpdateUserAttributesResponseSwift
class AWSCognitoIdentityProviderAdminUpdateUserAttributesResponse -
The request to sign out of all devices, as an administrator.
Required parameters: [UserPoolId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAdminUserGlobalSignOutRequestSwift
class AWSCognitoIdentityProviderAdminUserGlobalSignOutRequest -
The global sign-out response, as an administrator.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAdminUserGlobalSignOutResponseSwift
class AWSCognitoIdentityProviderAdminUserGlobalSignOutResponse -
The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.
In Regions where Amazon Pinpoint isn’t available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAnalyticsConfigurationTypeSwift
class AWSCognitoIdentityProviderAnalyticsConfigurationType -
An Amazon Pinpoint analytics endpoint.
An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. For more information about Amazon Web Services Regions that can contain Amazon Pinpoint resources for use with Amazon Cognito user pools, see Using Amazon Pinpoint analytics with Amazon Cognito user pools.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAnalyticsMetadataTypeSwift
class AWSCognitoIdentityProviderAnalyticsMetadataType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAssociateSoftwareTokenRequestSwift
class AWSCognitoIdentityProviderAssociateSoftwareTokenRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAssociateSoftwareTokenResponseSwift
class AWSCognitoIdentityProviderAssociateSoftwareTokenResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderAttributeTypeSwift
class AWSCognitoIdentityProviderAttributeType -
The authentication event type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAuthEventTypeSwift
class AWSCognitoIdentityProviderAuthEventType -
The authentication result.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderAuthenticationResultTypeSwift
class AWSCognitoIdentityProviderAuthenticationResultType -
The challenge response type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderChallengeResponseTypeSwift
class AWSCognitoIdentityProviderChallengeResponseType -
Represents the request to change a user password.
Required parameters: [PreviousPassword, ProposedPassword, AccessToken]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderChangePasswordRequestSwift
class AWSCognitoIdentityProviderChangePasswordRequest -
The response from the server to the change password request.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderChangePasswordResponseSwift
class AWSCognitoIdentityProviderChangePasswordResponse -
The CloudWatch logging destination of a user pool detailed activity logging configuration.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCloudWatchLogsConfigurationTypeSwift
class AWSCognitoIdentityProviderCloudWatchLogsConfigurationType -
The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCodeDeliveryDetailsTypeSwift
class AWSCognitoIdentityProviderCodeDeliveryDetailsType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCompromisedCredentialsActionsTypeSwift
class AWSCognitoIdentityProviderCompromisedCredentialsActionsType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationTypeSwift
class AWSCognitoIdentityProviderCompromisedCredentialsRiskConfigurationType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderConfirmDeviceRequestSwift
class AWSCognitoIdentityProviderConfirmDeviceRequest -
Confirms the device response.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderConfirmDeviceResponseSwift
class AWSCognitoIdentityProviderConfirmDeviceResponse -
The request representing the confirmation for a password reset.
Required parameters: [ClientId, Username, ConfirmationCode, Password]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderConfirmForgotPasswordRequestSwift
class AWSCognitoIdentityProviderConfirmForgotPasswordRequest -
The response from the server that results from a user’s request to retrieve a forgotten password.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderConfirmForgotPasswordResponseSwift
class AWSCognitoIdentityProviderConfirmForgotPasswordResponse -
Represents the request to confirm registration of a user.
Required parameters: [ClientId, Username, ConfirmationCode]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderConfirmSignUpRequestSwift
class AWSCognitoIdentityProviderConfirmSignUpRequest -
Represents the response from the server for the registration confirmation.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderConfirmSignUpResponseSwift
class AWSCognitoIdentityProviderConfirmSignUpResponse -
Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Required parameters: [IpAddress, ServerName, ServerPath, HttpHeaders]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderContextDataTypeSwift
class AWSCognitoIdentityProviderContextDataType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateGroupRequestSwift
class AWSCognitoIdentityProviderCreateGroupRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateGroupResponseSwift
class AWSCognitoIdentityProviderCreateGroupResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateIdentityProviderRequestSwift
class AWSCognitoIdentityProviderCreateIdentityProviderRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateIdentityProviderResponseSwift
class AWSCognitoIdentityProviderCreateIdentityProviderResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateResourceServerRequestSwift
class AWSCognitoIdentityProviderCreateResourceServerRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateResourceServerResponseSwift
class AWSCognitoIdentityProviderCreateResourceServerResponse -
Represents the request to create the user import job.
Required parameters: [JobName, UserPoolId, CloudWatchLogsRoleArn]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCreateUserImportJobRequestSwift
class AWSCognitoIdentityProviderCreateUserImportJobRequest -
Represents the response from the server to the request to create the user import job.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCreateUserImportJobResponseSwift
class AWSCognitoIdentityProviderCreateUserImportJobResponse -
Represents the request to create a user pool client.
Required parameters: [UserPoolId, ClientName]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCreateUserPoolClientRequestSwift
class AWSCognitoIdentityProviderCreateUserPoolClientRequest -
Represents the response from the server to create a user pool client.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCreateUserPoolClientResponseSwift
class AWSCognitoIdentityProviderCreateUserPoolClientResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateUserPoolDomainRequestSwift
class AWSCognitoIdentityProviderCreateUserPoolDomainRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateUserPoolDomainResponseSwift
class AWSCognitoIdentityProviderCreateUserPoolDomainResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderCreateUserPoolRequestSwift
class AWSCognitoIdentityProviderCreateUserPoolRequest -
Represents the response from the server for the request to create a user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCreateUserPoolResponseSwift
class AWSCognitoIdentityProviderCreateUserPoolResponse -
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
Required parameters: [CertificateArn]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCustomDomainConfigTypeSwift
class AWSCognitoIdentityProviderCustomDomainConfigType -
The properties of a custom email sender Lambda trigger.
Required parameters: [LambdaVersion, LambdaArn]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCustomEmailLambdaVersionConfigTypeSwift
class AWSCognitoIdentityProviderCustomEmailLambdaVersionConfigType -
The properties of a custom SMS sender Lambda trigger.
Required parameters: [LambdaVersion, LambdaArn]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderCustomSMSLambdaVersionConfigTypeSwift
class AWSCognitoIdentityProviderCustomSMSLambdaVersionConfigType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteGroupRequestSwift
class AWSCognitoIdentityProviderDeleteGroupRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteIdentityProviderRequestSwift
class AWSCognitoIdentityProviderDeleteIdentityProviderRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteResourceServerRequestSwift
class AWSCognitoIdentityProviderDeleteResourceServerRequest -
Represents the request to delete user attributes.
Required parameters: [UserAttributeNames, AccessToken]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteUserAttributesRequestSwift
class AWSCognitoIdentityProviderDeleteUserAttributesRequest -
Represents the response from the server to delete user attributes.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteUserAttributesResponseSwift
class AWSCognitoIdentityProviderDeleteUserAttributesResponse -
Represents the request to delete a user pool client.
Required parameters: [UserPoolId, ClientId]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteUserPoolClientRequestSwift
class AWSCognitoIdentityProviderDeleteUserPoolClientRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteUserPoolDomainRequestSwift
class AWSCognitoIdentityProviderDeleteUserPoolDomainRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteUserPoolDomainResponseSwift
class AWSCognitoIdentityProviderDeleteUserPoolDomainResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteUserPoolRequestSwift
class AWSCognitoIdentityProviderDeleteUserPoolRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeleteUserRequestSwift
class AWSCognitoIdentityProviderDeleteUserRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeIdentityProviderRequestSwift
class AWSCognitoIdentityProviderDescribeIdentityProviderRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeIdentityProviderResponseSwift
class AWSCognitoIdentityProviderDescribeIdentityProviderResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeResourceServerRequestSwift
class AWSCognitoIdentityProviderDescribeResourceServerRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeResourceServerResponseSwift
class AWSCognitoIdentityProviderDescribeResourceServerResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeRiskConfigurationRequestSwift
class AWSCognitoIdentityProviderDescribeRiskConfigurationRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeRiskConfigurationResponseSwift
class AWSCognitoIdentityProviderDescribeRiskConfigurationResponse -
Represents the request to describe the user import job.
Required parameters: [UserPoolId, JobId]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeUserImportJobRequestSwift
class AWSCognitoIdentityProviderDescribeUserImportJobRequest -
Represents the response from the server to the request to describe the user import job.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeUserImportJobResponseSwift
class AWSCognitoIdentityProviderDescribeUserImportJobResponse -
Represents the request to describe a user pool client.
Required parameters: [UserPoolId, ClientId]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeUserPoolClientRequestSwift
class AWSCognitoIdentityProviderDescribeUserPoolClientRequest -
Represents the response from the server from a request to describe the user pool client.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeUserPoolClientResponseSwift
class AWSCognitoIdentityProviderDescribeUserPoolClientResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeUserPoolDomainRequestSwift
class AWSCognitoIdentityProviderDescribeUserPoolDomainRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeUserPoolDomainResponseSwift
class AWSCognitoIdentityProviderDescribeUserPoolDomainResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeUserPoolRequestSwift
class AWSCognitoIdentityProviderDescribeUserPoolRequest -
Represents the response to describe the user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDescribeUserPoolResponseSwift
class AWSCognitoIdentityProviderDescribeUserPoolResponse -
The device-remembering configuration for a user pool. A DescribeUserPool request returns a null value for this object when the user pool isn’t configured to remember devices. When device remembering is active, you can remember a user’s device with a ConfirmDevice API request. Additionally. when the property
DeviceOnlyRememberedOnUserPromptistrue, you must followConfirmDevicewith an UpdateDeviceStatus API request that sets the user’s device torememberedornot_remembered.To sign in with a remembered device, include
DEVICE_KEYin the authentication parameters in your user’s InitiateAuth request. If your app doesn’t include aDEVICE_KEYparameter, the response from Amazon Cognito includes newly-generatedDEVICE_KEYandDEVICE_GROUP_KEYvalues underNewDeviceMetadata. Store these values to use in future device-authentication requests.When you provide a value for any property of
DeviceConfiguration, you activate the device remembering for the user pool.Declaration
Objective-C
@interface AWSCognitoIdentityProviderDeviceConfigurationTypeSwift
class AWSCognitoIdentityProviderDeviceConfigurationType -
The device verifier against which it is authenticated.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDeviceSecretVerifierConfigTypeSwift
class AWSCognitoIdentityProviderDeviceSecretVerifierConfigType -
The device type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDeviceTypeSwift
class AWSCognitoIdentityProviderDeviceType -
A container for information about a domain.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderDomainDescriptionTypeSwift
class AWSCognitoIdentityProviderDomainDescriptionType -
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
Amazon Cognito can send email messages with Amazon Simple Email Service resources in the Amazon Web Services Region where you created your user pool, and in alternate Regions in some cases. For more information on the supported Regions, see Email settings for Amazon Cognito user pools.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderEmailConfigurationTypeSwift
class AWSCognitoIdentityProviderEmailConfigurationType -
Specifies the user context data captured at the time of an event request.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderEventContextDataTypeSwift
class AWSCognitoIdentityProviderEventContextDataType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderEventFeedbackTypeSwift
class AWSCognitoIdentityProviderEventFeedbackType -
The event risk type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderEventRiskTypeSwift
class AWSCognitoIdentityProviderEventRiskType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderForgetDeviceRequestSwift
class AWSCognitoIdentityProviderForgetDeviceRequest -
Represents the request to reset a user’s password.
Required parameters: [ClientId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderForgotPasswordRequestSwift
class AWSCognitoIdentityProviderForgotPasswordRequest -
The response from Amazon Cognito to a request to reset a password.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderForgotPasswordResponseSwift
class AWSCognitoIdentityProviderForgotPasswordResponse -
Represents the request to get the header information of the CSV file for the user import job.
Required parameters: [UserPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGetCSVHeaderRequestSwift
class AWSCognitoIdentityProviderGetCSVHeaderRequest -
Represents the response from the server to the request to get the header information of the CSV file for the user import job.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGetCSVHeaderResponseSwift
class AWSCognitoIdentityProviderGetCSVHeaderResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetDeviceRequestSwift
class AWSCognitoIdentityProviderGetDeviceRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetDeviceResponseSwift
class AWSCognitoIdentityProviderGetDeviceResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetGroupRequestSwift
class AWSCognitoIdentityProviderGetGroupRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetGroupResponseSwift
class AWSCognitoIdentityProviderGetGroupResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetIdentityProviderByIdentifierRequestSwift
class AWSCognitoIdentityProviderGetIdentityProviderByIdentifierRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetIdentityProviderByIdentifierResponseSwift
class AWSCognitoIdentityProviderGetIdentityProviderByIdentifierResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetLogDeliveryConfigurationRequestSwift
class AWSCognitoIdentityProviderGetLogDeliveryConfigurationRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetLogDeliveryConfigurationResponseSwift
class AWSCognitoIdentityProviderGetLogDeliveryConfigurationResponse -
Request to get a signing certificate from Amazon Cognito.
Required parameters: [UserPoolId]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGetSigningCertificateRequestSwift
class AWSCognitoIdentityProviderGetSigningCertificateRequest -
Response from Amazon Cognito for a signing certificate request.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGetSigningCertificateResponseSwift
class AWSCognitoIdentityProviderGetSigningCertificateResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetUICustomizationRequestSwift
class AWSCognitoIdentityProviderGetUICustomizationRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetUICustomizationResponseSwift
class AWSCognitoIdentityProviderGetUICustomizationResponse -
Represents the request to get user attribute verification.
Required parameters: [AccessToken, AttributeName]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGetUserAttributeVerificationCodeRequestSwift
class AWSCognitoIdentityProviderGetUserAttributeVerificationCodeRequest -
The verification code response returned by the server response to get the user attribute verification code.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGetUserAttributeVerificationCodeResponseSwift
class AWSCognitoIdentityProviderGetUserAttributeVerificationCodeResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetUserPoolMfaConfigRequestSwift
class AWSCognitoIdentityProviderGetUserPoolMfaConfigRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGetUserPoolMfaConfigResponseSwift
class AWSCognitoIdentityProviderGetUserPoolMfaConfigResponse -
Represents the request to get information about the user.
Required parameters: [AccessToken]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGetUserRequestSwift
class AWSCognitoIdentityProviderGetUserRequest -
Represents the response from the server from the request to get information about the user.
Required parameters: [Username, UserAttributes]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGetUserResponseSwift
class AWSCognitoIdentityProviderGetUserResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGlobalSignOutRequestSwift
class AWSCognitoIdentityProviderGlobalSignOutRequest -
The response to the request to sign out all devices.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderGlobalSignOutResponseSwift
class AWSCognitoIdentityProviderGlobalSignOutResponse -
The group type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderGroupTypeSwift
class AWSCognitoIdentityProviderGroupType -
The HTTP header.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderHttpHeaderSwift
class AWSCognitoIdentityProviderHttpHeader -
A container for information about an IdP.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderIdentityProviderTypeSwift
class AWSCognitoIdentityProviderIdentityProviderType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderInitiateAuthRequestSwift
class AWSCognitoIdentityProviderInitiateAuthRequest -
Initiates the authentication response.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderInitiateAuthResponseSwift
class AWSCognitoIdentityProviderInitiateAuthResponse -
Specifies the configuration for Lambda triggers.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderLambdaConfigTypeSwift
class AWSCognitoIdentityProviderLambdaConfigType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListDevicesRequestSwift
class AWSCognitoIdentityProviderListDevicesRequest -
Represents the response to list devices.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderListDevicesResponseSwift
class AWSCognitoIdentityProviderListDevicesResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListGroupsRequestSwift
class AWSCognitoIdentityProviderListGroupsRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListGroupsResponseSwift
class AWSCognitoIdentityProviderListGroupsResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListIdentityProvidersRequestSwift
class AWSCognitoIdentityProviderListIdentityProvidersRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListIdentityProvidersResponseSwift
class AWSCognitoIdentityProviderListIdentityProvidersResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListResourceServersRequestSwift
class AWSCognitoIdentityProviderListResourceServersRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListResourceServersResponseSwift
class AWSCognitoIdentityProviderListResourceServersResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListTagsForResourceRequestSwift
class AWSCognitoIdentityProviderListTagsForResourceRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListTagsForResourceResponseSwift
class AWSCognitoIdentityProviderListTagsForResourceResponse -
Represents the request to list the user import jobs.
Required parameters: [UserPoolId, MaxResults]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderListUserImportJobsRequestSwift
class AWSCognitoIdentityProviderListUserImportJobsRequest -
Represents the response from the server to the request to list the user import jobs.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderListUserImportJobsResponseSwift
class AWSCognitoIdentityProviderListUserImportJobsResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListUserPoolClientsRequestSwift
class AWSCognitoIdentityProviderListUserPoolClientsRequest -
Represents the response from the server that lists user pool clients.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderListUserPoolClientsResponseSwift
class AWSCognitoIdentityProviderListUserPoolClientsResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListUserPoolsRequestSwift
class AWSCognitoIdentityProviderListUserPoolsRequest -
Represents the response to list user pools.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderListUserPoolsResponseSwift
class AWSCognitoIdentityProviderListUserPoolsResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListUsersInGroupRequestSwift
class AWSCognitoIdentityProviderListUsersInGroupRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListUsersInGroupResponseSwift
class AWSCognitoIdentityProviderListUsersInGroupResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderListUsersRequestSwift
class AWSCognitoIdentityProviderListUsersRequest -
The response from the request to list users.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderListUsersResponseSwift
class AWSCognitoIdentityProviderListUsersResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderLogConfigurationTypeSwift
class AWSCognitoIdentityProviderLogConfigurationType -
The logging parameters of a user pool.
Required parameters: [UserPoolId, LogConfigurations]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderLogDeliveryConfigurationTypeSwift
class AWSCognitoIdentityProviderLogDeliveryConfigurationType -
This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderMFAOptionTypeSwift
class AWSCognitoIdentityProviderMFAOptionType -
The message template structure.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderMessageTemplateTypeSwift
class AWSCognitoIdentityProviderMessageTemplateType -
The new device metadata type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderLatestDeviceMetadataTypeSwift
class AWSCognitoIdentityProviderLatestDeviceMetadataType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderNotifyConfigurationTypeSwift
class AWSCognitoIdentityProviderNotifyConfigurationType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderNotifyEmailTypeSwift
class AWSCognitoIdentityProviderNotifyEmailType -
The minimum and maximum values of an attribute that is of the number data type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderNumberAttributeConstraintsTypeSwift
class AWSCognitoIdentityProviderNumberAttributeConstraintsType -
The password policy type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderPasswordPolicyTypeSwift
class AWSCognitoIdentityProviderPasswordPolicyType -
The properties of a pre token generation Lambda trigger.
Required parameters: [LambdaVersion, LambdaArn]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderPreTokenGenerationVersionConfigTypeSwift
class AWSCognitoIdentityProviderPreTokenGenerationVersionConfigType -
A container for IdP details.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderProviderDescriptionSwift
class AWSCognitoIdentityProviderProviderDescription -
A container for information about an IdP for a user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderProviderUserIdentifierTypeSwift
class AWSCognitoIdentityProviderProviderUserIdentifierType -
A map containing a priority as a key, and recovery method name as a value.
Required parameters: [Priority, Name]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderRecoveryOptionTypeSwift
class AWSCognitoIdentityProviderRecoveryOptionType -
Represents the request to resend the confirmation code.
Required parameters: [ClientId, Username]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderResendConfirmationCodeRequestSwift
class AWSCognitoIdentityProviderResendConfirmationCodeRequest -
The response from the server when Amazon Cognito makes the request to resend a confirmation code.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderResendConfirmationCodeResponseSwift
class AWSCognitoIdentityProviderResendConfirmationCodeResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderResourceServerScopeTypeSwift
class AWSCognitoIdentityProviderResourceServerScopeType -
A container for information about a resource server for a user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderResourceServerTypeSwift
class AWSCognitoIdentityProviderResourceServerType -
The request to respond to an authentication challenge.
Required parameters: [ClientId, ChallengeName]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderRespondToAuthChallengeRequestSwift
class AWSCognitoIdentityProviderRespondToAuthChallengeRequest -
The response to respond to the authentication challenge.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderRespondToAuthChallengeResponseSwift
class AWSCognitoIdentityProviderRespondToAuthChallengeResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderRevokeTokenRequestSwift
class AWSCognitoIdentityProviderRevokeTokenRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderRevokeTokenResponseSwift
class AWSCognitoIdentityProviderRevokeTokenResponse -
The risk configuration type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderRiskConfigurationTypeSwift
class AWSCognitoIdentityProviderRiskConfigurationType -
The type of the configuration to override the risk decision.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderRiskExceptionConfigurationTypeSwift
class AWSCognitoIdentityProviderRiskExceptionConfigurationType -
The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don’t need to be verified to be used for SMS MFA. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you would like MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSMSMfaSettingsTypeSwift
class AWSCognitoIdentityProviderSMSMfaSettingsType -
A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a
custom:prefix, and developer attributes with adev:prefix. For more information, see User pool attributes.Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSchemaAttributeTypeSwift
class AWSCognitoIdentityProviderSchemaAttributeType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetLogDeliveryConfigurationRequestSwift
class AWSCognitoIdentityProviderSetLogDeliveryConfigurationRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetLogDeliveryConfigurationResponseSwift
class AWSCognitoIdentityProviderSetLogDeliveryConfigurationResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetRiskConfigurationRequestSwift
class AWSCognitoIdentityProviderSetRiskConfigurationRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetRiskConfigurationResponseSwift
class AWSCognitoIdentityProviderSetRiskConfigurationResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetUICustomizationRequestSwift
class AWSCognitoIdentityProviderSetUICustomizationRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetUICustomizationResponseSwift
class AWSCognitoIdentityProviderSetUICustomizationResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetUserMFAPreferenceRequestSwift
class AWSCognitoIdentityProviderSetUserMFAPreferenceRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetUserMFAPreferenceResponseSwift
class AWSCognitoIdentityProviderSetUserMFAPreferenceResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetUserPoolMfaConfigRequestSwift
class AWSCognitoIdentityProviderSetUserPoolMfaConfigRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetUserPoolMfaConfigResponseSwift
class AWSCognitoIdentityProviderSetUserPoolMfaConfigResponse -
Represents the request to set user settings.
Required parameters: [AccessToken, MFAOptions]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSetUserSettingsRequestSwift
class AWSCognitoIdentityProviderSetUserSettingsRequest -
The response from the server for a set user settings request.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderSetUserSettingsResponseSwift
class AWSCognitoIdentityProviderSetUserSettingsResponse -
Represents the request to register a user.
Required parameters: [ClientId, Username, Password]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSignUpRequestSwift
class AWSCognitoIdentityProviderSignUpRequest -
The response from the server for a registration request.
Required parameters: [UserConfirmed, UserSub]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSignUpResponseSwift
class AWSCognitoIdentityProviderSignUpResponse -
The SMS configuration type is the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
Required parameters: [SnsCallerArn]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSmsConfigurationTypeSwift
class AWSCognitoIdentityProviderSmsConfigurationType -
The SMS text message multi-factor authentication (MFA) configuration type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSmsMfaConfigTypeSwift
class AWSCognitoIdentityProviderSmsMfaConfigType -
The type used for enabling software token MFA at the user pool level.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSoftwareTokenMfaConfigTypeSwift
class AWSCognitoIdentityProviderSoftwareTokenMfaConfigType -
The type used for enabling software token MFA at the user level. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSoftwareTokenMfaSettingsTypeSwift
class AWSCognitoIdentityProviderSoftwareTokenMfaSettingsType -
Represents the request to start the user import job.
Required parameters: [UserPoolId, JobId]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderStartUserImportJobRequestSwift
class AWSCognitoIdentityProviderStartUserImportJobRequest -
Represents the response from the server to the request to start the user import job.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderStartUserImportJobResponseSwift
class AWSCognitoIdentityProviderStartUserImportJobResponse -
Represents the request to stop the user import job.
Required parameters: [UserPoolId, JobId]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderStopUserImportJobRequestSwift
class AWSCognitoIdentityProviderStopUserImportJobRequest -
Represents the response from the server to the request to stop the user import job.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderStopUserImportJobResponseSwift
class AWSCognitoIdentityProviderStopUserImportJobResponse -
The constraints associated with a string attribute.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderStringAttributeConstraintsTypeSwift
class AWSCognitoIdentityProviderStringAttributeConstraintsType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderTagResourceRequestSwift
class AWSCognitoIdentityProviderTagResourceRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderTagResourceResponseSwift
class AWSCognitoIdentityProviderTagResourceResponse -
The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderTokenValidityUnitsTypeSwift
class AWSCognitoIdentityProviderTokenValidityUnitsType -
A container for the UI customization information for a user pool’s built-in app UI.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUICustomizationTypeSwift
class AWSCognitoIdentityProviderUICustomizationType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUntagResourceRequestSwift
class AWSCognitoIdentityProviderUntagResourceRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUntagResourceResponseSwift
class AWSCognitoIdentityProviderUntagResourceResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateAuthEventFeedbackRequestSwift
class AWSCognitoIdentityProviderUpdateAuthEventFeedbackRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateAuthEventFeedbackResponseSwift
class AWSCognitoIdentityProviderUpdateAuthEventFeedbackResponse -
Represents the request to update the device status.
Required parameters: [AccessToken, DeviceKey]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateDeviceStatusRequestSwift
class AWSCognitoIdentityProviderUpdateDeviceStatusRequest -
The response to the request to update the device status.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateDeviceStatusResponseSwift
class AWSCognitoIdentityProviderUpdateDeviceStatusResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateGroupRequestSwift
class AWSCognitoIdentityProviderUpdateGroupRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateGroupResponseSwift
class AWSCognitoIdentityProviderUpdateGroupResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateIdentityProviderRequestSwift
class AWSCognitoIdentityProviderUpdateIdentityProviderRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateIdentityProviderResponseSwift
class AWSCognitoIdentityProviderUpdateIdentityProviderResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateResourceServerRequestSwift
class AWSCognitoIdentityProviderUpdateResourceServerRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateResourceServerResponseSwift
class AWSCognitoIdentityProviderUpdateResourceServerResponse -
Represents the request to update user attributes.
Required parameters: [UserAttributes, AccessToken]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserAttributesRequestSwift
class AWSCognitoIdentityProviderUpdateUserAttributesRequest -
Represents the response from the server for the request to update user attributes.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserAttributesResponseSwift
class AWSCognitoIdentityProviderUpdateUserAttributesResponse -
Represents the request to update the user pool client.
Required parameters: [UserPoolId, ClientId]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserPoolClientRequestSwift
class AWSCognitoIdentityProviderUpdateUserPoolClientRequest -
Represents the response from the server to the request to update the user pool client.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserPoolClientResponseSwift
class AWSCognitoIdentityProviderUpdateUserPoolClientResponse -
The UpdateUserPoolDomain request input.
Required parameters: [Domain, UserPoolId, CustomDomainConfig]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserPoolDomainRequestSwift
class AWSCognitoIdentityProviderUpdateUserPoolDomainRequest -
The UpdateUserPoolDomain response output.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserPoolDomainResponseSwift
class AWSCognitoIdentityProviderUpdateUserPoolDomainResponse -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserPoolRequestSwift
class AWSCognitoIdentityProviderUpdateUserPoolRequest -
Represents the response from the server when you make a request to update the user pool.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUpdateUserPoolResponseSwift
class AWSCognitoIdentityProviderUpdateUserPoolResponse -
The settings for updates to user attributes. These settings include the property
See moreAttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users’ email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.Declaration
Objective-C
@interface AWSCognitoIdentityProviderUserAttributeUpdateSettingsTypeSwift
class AWSCognitoIdentityProviderUserAttributeUpdateSettingsType -
Contextual data, such as the user’s device fingerprint, IP address, or location, used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserContextDataTypeSwift
class AWSCognitoIdentityProviderUserContextDataType -
The user import job type.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserImportJobTypeSwift
class AWSCognitoIdentityProviderUserImportJobType -
User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to
AUDIT. To configure automatic security responses to risky traffic to your user pool, set toENFORCED.For more information, see Adding advanced security to a user pool.
Required parameters: [AdvancedSecurityMode]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserPoolAddOnsTypeSwift
class AWSCognitoIdentityProviderUserPoolAddOnsType -
The description of the user pool client.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserPoolClientDescriptionSwift
class AWSCognitoIdentityProviderUserPoolClientDescription -
Contains information about a user pool client.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserPoolClientTypeSwift
class AWSCognitoIdentityProviderUserPoolClientType -
A user pool description.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserPoolDescriptionTypeSwift
class AWSCognitoIdentityProviderUserPoolDescriptionType -
The policy associated with a user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserPoolPolicyTypeSwift
class AWSCognitoIdentityProviderUserPoolPolicyType -
A container for information about the user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserPoolTypeSwift
class AWSCognitoIdentityProviderUserPoolType -
A user profile in a Amazon Cognito user pool.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderUserTypeSwift
class AWSCognitoIdentityProviderUserType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderUsernameConfigurationTypeSwift
class AWSCognitoIdentityProviderUsernameConfigurationType -
The template for verification messages.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderVerificationMessageTemplateTypeSwift
class AWSCognitoIdentityProviderVerificationMessageTemplateType -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderVerifySoftwareTokenRequestSwift
class AWSCognitoIdentityProviderVerifySoftwareTokenRequest -
Declaration
Objective-C
@interface AWSCognitoIdentityProviderVerifySoftwareTokenResponseSwift
class AWSCognitoIdentityProviderVerifySoftwareTokenResponse -
Represents the request to verify user attributes.
Required parameters: [AccessToken, AttributeName, Code]
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderVerifyUserAttributeRequestSwift
class AWSCognitoIdentityProviderVerifyUserAttributeRequest -
A container representing the response from the server from the request to verify user attributes.
Declaration
Objective-C
@interface AWSCognitoIdentityProviderVerifyUserAttributeResponseSwift
class AWSCognitoIdentityProviderVerifyUserAttributeResponse -
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderResources : NSObject + (instancetype)sharedInstance; - (NSDictionary *)JSONObject; @endSwift
class AWSCognitoIdentityProviderResources : NSObject -
With the Amazon Cognito user pools API, you can configure user pools and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can link IdP users to native user profiles. Learn more about the authentication and authorization of federated users at Adding user pool sign-in through a third party and in the User pool federation endpoints and hosted UI reference.
This API reference provides detailed information about API operations and object types in Amazon Cognito.
Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side authentication of users. You can interact with operations in the Amazon Cognito user pools API as any of the following subjects.
An administrator who wants to configure user pools, app clients, users, groups, or other user pool functions.
A server-side app, like a web application, that wants to use its Amazon Web Services privileges to manage, authenticate, or authorize a user.
A client-side app, like a mobile app, that wants to make unauthenticated requests to manage, authenticate, or authorize a user.
For more information, see Using the Amazon Cognito user pools API and user pool endpoints in the Amazon Cognito Developer Guide.
With your Amazon Web Services SDK, you can build the logic to support operational flows in every use case for this API. You can also make direct REST API requests to Amazon Cognito user pools service endpoints. The following links can get you started with the
CognitoIdentityProviderclient in other supported Amazon Web Services SDKs.To get started with an Amazon Web Services SDK, see Tools to Build on Amazon Web Services. For example actions and scenarios, see Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityProviderSwift
class AWSCognitoIdentityProvider -
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUser : NSObject /** The username of this user */ @property (nonatomic, readonly, nullable) NSString *username; /** If this user is a result of a signup, this has the confirmation status */ @property (nonatomic, readonly) AWSCognitoIdentityUserStatus confirmedStatus; /** Determines whether this user has an active session or not. If the refresh token is expired the user will be prompted to authenticate when you call getSession. */ @property (nonatomic, readonly, getter=isSignedIn) BOOL signedIn; /** Determines whether this user's session is revocable. If the access token has "origin_jti" claim, then the revocation feature is enabled. */ @property (nonatomic, readonly, getter=isSessionRevocable) BOOL sessionRevocable; /** Get the device id @warning This function is deprecated and will be removed in an upcoming minor version of the SDK. You should use deviceIdentifier instead. @deprecated Use deviceIdentifier instead. */ @property (nonatomic, readonly) NSString * deviceId DEPRECATED_MSG_ATTRIBUTE("Use deviceIdentifier instead."); /** Get the device id */ @property (nonatomic, readonly, nullable) NSString * deviceIdentifier; /** Confirm a users' sign up with the confirmation code */ - (AWSTask<AWSCognitoIdentityUserConfirmSignUpResponse *> *)confirmSignUp:(NSString *)confirmationCode; /** Confirm a users' sign up with the confirmation code. If forceAliasCreation is set, if another user is aliased to the same email/phone this code was sent to, reassign alias to this user. */ -(AWSTask<AWSCognitoIdentityUserConfirmSignUpResponse *> *) confirmSignUp:(NSString *) confirmationCode forceAliasCreation:(BOOL)forceAliasCreation; -(AWSTask<AWSCognitoIdentityUserConfirmSignUpResponse *> *) confirmSignUp:(NSString *) confirmationCode clientMetaData:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData; -(AWSTask<AWSCognitoIdentityUserConfirmSignUpResponse *> *) confirmSignUp:(NSString *) confirmationCode forceAliasCreation:(BOOL)forceAliasCreation clientMetaData:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData; /** Resend the confirmation code sent during sign up */ - (AWSTask<AWSCognitoIdentityUserResendConfirmationCodeResponse *> *)resendConfirmationCode: (nullable NSDictionary<NSString *, NSString*> *) clientMetaData; - (AWSTask<AWSCognitoIdentityUserResendConfirmationCodeResponse *> *)resendConfirmationCode; /** Get a session with id, access and refresh tokens. */ - (AWSTask<AWSCognitoIdentityUserSession *> *)getSession; /** Get a session with the following username and password */ - (AWSTask<AWSCognitoIdentityUserSession *> *)getSession:(NSString *)username password:(NSString *)password validationData:(nullable NSArray<AWSCognitoIdentityUserAttributeType *> *)validationData; - (AWSTask<AWSCognitoIdentityUserSession *> *)getSession:(NSString *)username password:(NSString *)password validationData:(nullable NSArray<AWSCognitoIdentityUserAttributeType *> *)validationData clientMetaData:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData; - (AWSTask<AWSCognitoIdentityUserSession *> *)getSession:(NSString *)username password:(NSString *)password validationData:(nullable NSArray<AWSCognitoIdentityUserAttributeType *> *)validationData isInitialCustomChallenge:(BOOL)isInitialCustomChallenge; - (AWSTask<AWSCognitoIdentityUserSession *> *)getSession:(NSString *)username password:(NSString *)password validationData:(nullable NSArray<AWSCognitoIdentityUserAttributeType *> *)validationData clientMetaData:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData isInitialCustomChallenge:(BOOL)isInitialCustomChallenge; /** Get details about this user, including user attributes */ - (AWSTask<AWSCognitoIdentityUserGetDetailsResponse *> *)getDetails; /** Send a code to this user to initiate the forgot password flow */ - (AWSTask<AWSCognitoIdentityUserForgotPasswordResponse *> *)forgotPassword:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData; - (AWSTask<AWSCognitoIdentityUserForgotPasswordResponse *> *)forgotPassword; /** Conclude the forgot password flow by providing the forgot password code and new password. */ - (AWSTask<AWSCognitoIdentityUserConfirmForgotPasswordResponse *> *)confirmForgotPassword:(NSString *)confirmationCode password:(NSString *)password clientMetaData:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData; - (AWSTask<AWSCognitoIdentityUserConfirmForgotPasswordResponse *> *)confirmForgotPassword:(NSString *)confirmationCode password:(NSString *)password; /** Change this user's password */ - (AWSTask<AWSCognitoIdentityUserChangePasswordResponse *> *)changePassword:(NSString *)currentPassword proposedPassword:(NSString *)proposedPassword; /** Update this user's attributes */ - (AWSTask<AWSCognitoIdentityUserUpdateAttributesResponse *> *)updateAttributes:(NSArray<AWSCognitoIdentityUserAttributeType *> *)attributes clientMetaData:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData; - (AWSTask<AWSCognitoIdentityUserUpdateAttributesResponse *> *)updateAttributes:(NSArray<AWSCognitoIdentityUserAttributeType *> *)attributes; /** Delete the attributes specified by attributeNames */ - (AWSTask<AWSCognitoIdentityUserDeleteAttributesResponse *> *)deleteAttributes:(NSArray<NSString *> *)attributeNames; /** Verify a user attribute upon receiving the verification code. */ - (AWSTask<AWSCognitoIdentityUserVerifyAttributeResponse *> *)verifyAttribute:(NSString *)attributeName code:(NSString *)code; /** Request a verification code to verify an attribute. */ - (AWSTask<AWSCognitoIdentityUserGetAttributeVerificationCodeResponse *> *)getAttributeVerificationCode:(NSString *)attributeName clientMetaData:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData; - (AWSTask<AWSCognitoIdentityUserGetAttributeVerificationCodeResponse *> *)getAttributeVerificationCode:(NSString *)attributeName; /** Set the user settings for this user such as MFA */ - (AWSTask<AWSCognitoIdentityUserSetUserSettingsResponse *> *)setUserSettings:(AWSCognitoIdentityUserSettings *)settings; /** Set the user mfa preference supercedes SetUserSettings */ - (AWSTask<AWSCognitoIdentityUserSetUserMfaPreferenceResponse *> *)setUserMfaPreference:(AWSCognitoIdentityUserMfaPreferences *) preferences; /** Start the process of associating a software token */ - (AWSTask<AWSCognitoIdentityUserAssociateSoftwareTokenResponse *> *) associateSoftwareToken; /** Complete the process of associating a software token by verifying the code and setting device friendly name */ -(AWSTask<AWSCognitoIdentityUserVerifySoftwareTokenResponse *>*) verifySoftwareToken: (NSString*) userCode friendlyDeviceName: (NSString* _Nullable) friendlyDeviceName; /** Delete this user */ - (AWSTask *)deleteUser; /** Remove all sessions from the keychain for this user. Last known user remains. */ - (void)signOut; /** Revoke all tokens for this user. Check Access Token for claims for validity to revoke tokens. */ - (AWSTask<AWSCognitoIdentityProviderRevokeTokenResponse *> *) revokeToken; /** Invalidate any active sessions with the service. Last known user remains. */ - (AWSTask<AWSCognitoIdentityUserGlobalSignOutResponse *> *) globalSignOut; /** Remove all sessions from the keychain for this user and clear last known user. */ - (void) signOutAndClearLastKnownUser; /** Remove the id and access token from the keychain, but keep the refresh token. Use this when you have updated user attributes and want to refresh the id and access tokens. */ - (void) clearSession; /** List devices for this user */ - (AWSTask<AWSCognitoIdentityUserListDevicesResponse *> *) listDevices: (int) limit paginationToken:(NSString * _Nullable) paginationToken; /** Update device remembered status for a specific device id. */ - (AWSTask<AWSCognitoIdentityUserUpdateDeviceStatusResponse *> *) updateDeviceStatus: (NSString *) deviceId remembered:(BOOL) remembered; /** Convenience method to update device remembered status for this device. */ - (AWSTask<AWSCognitoIdentityUserUpdateDeviceStatusResponse *> *) updateDeviceStatus: (BOOL) remembered; /** Get device details for a specific deviceId. */ - (AWSTask<AWSCognitoIdentityUserGetDeviceResponse *> *) getDevice: (NSString *) deviceId; /** Convenience method to get device details for this device. */ - (AWSTask<AWSCognitoIdentityUserGetDeviceResponse *> *) getDevice; /** Forget (stop tracking) a specific deviceId. */ - (AWSTask *) forgetDevice: (NSString *) deviceId; /** Forget (stop tracking) this device. */ - (AWSTask *) forgetDevice; @endSwift
class AWSCognitoIdentityUser : NSObject -
A User session. Encapsulates all tokens (id, access and refresh tokens) for a user.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserSession : NSObjectSwift
class AWSCognitoIdentityUserSession : NSObject -
A JWT session token.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserSessionToken : NSObjectSwift
class AWSCognitoIdentityUserSessionToken : NSObject -
User settings. Currently only mfa options.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserSettings : NSObjectSwift
class AWSCognitoIdentityUserSettings : NSObject -
User MFA preferences. Replaces user settings for mfa
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserMfaPreferences : NSObjectSwift
class AWSCognitoIdentityUserMfaPreferences : NSObject -
User settings. Currently only mfa options.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserMfaType : NSObjectSwift
class AWSCognitoIdentityUserMfaType : NSObject -
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserMFAOption : NSObject @property (nonatomic, strong) NSString * attributeName; @property (nonatomic, assign) AWSCognitoIdentityProviderDeliveryMediumType deliveryMedium; @endSwift
class AWSCognitoIdentityUserMFAOption : NSObject -
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserAttributeType : AWSCognitoIdentityProviderAttributeTypeSwift
class AWSCognitoIdentityUserAttributeType : AWSCognitoIdentityProviderAttributeType -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserConfirmSignUpResponse : AWSCognitoIdentityProviderConfirmSignUpResponseSwift
class AWSCognitoIdentityUserConfirmSignUpResponse : AWSCognitoIdentityProviderConfirmSignUpResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserResendConfirmationCodeResponse : AWSCognitoIdentityProviderResendConfirmationCodeResponseSwift
class AWSCognitoIdentityUserResendConfirmationCodeResponse : AWSCognitoIdentityProviderResendConfirmationCodeResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserGetDetailsResponse : AWSCognitoIdentityProviderGetUserResponseSwift
class AWSCognitoIdentityUserGetDetailsResponse : AWSCognitoIdentityProviderGetUserResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserForgotPasswordResponse : AWSCognitoIdentityProviderForgotPasswordResponseSwift
class AWSCognitoIdentityUserForgotPasswordResponse : AWSCognitoIdentityProviderForgotPasswordResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserConfirmForgotPasswordResponse : AWSCognitoIdentityProviderConfirmForgotPasswordResponseSwift
class AWSCognitoIdentityUserConfirmForgotPasswordResponse : AWSCognitoIdentityProviderConfirmForgotPasswordResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserChangePasswordResponse : AWSCognitoIdentityProviderChangePasswordResponseSwift
class AWSCognitoIdentityUserChangePasswordResponse : AWSCognitoIdentityProviderChangePasswordResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserUpdateAttributesResponse : AWSCognitoIdentityProviderUpdateUserAttributesResponseSwift
class AWSCognitoIdentityUserUpdateAttributesResponse : AWSCognitoIdentityProviderUpdateUserAttributesResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserDeleteAttributesResponse : AWSCognitoIdentityProviderDeleteUserAttributesResponseSwift
class AWSCognitoIdentityUserDeleteAttributesResponse : AWSCognitoIdentityProviderDeleteUserAttributesResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserVerifyAttributeResponse : AWSCognitoIdentityProviderVerifyUserAttributeResponseSwift
class AWSCognitoIdentityUserVerifyAttributeResponse : AWSCognitoIdentityProviderVerifyUserAttributeResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserGetAttributeVerificationCodeResponse : AWSCognitoIdentityProviderGetUserAttributeVerificationCodeResponseSwift
class AWSCognitoIdentityUserGetAttributeVerificationCodeResponse : AWSCognitoIdentityProviderGetUserAttributeVerificationCodeResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserSetUserSettingsResponse : AWSCognitoIdentityProviderSetUserSettingsResponseSwift
class AWSCognitoIdentityUserSetUserSettingsResponse : AWSCognitoIdentityProviderSetUserSettingsResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserGlobalSignOutResponse : AWSCognitoIdentityProviderGlobalSignOutResponseSwift
class AWSCognitoIdentityUserGlobalSignOutResponse : AWSCognitoIdentityProviderGlobalSignOutResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserListDevicesResponse : AWSCognitoIdentityProviderListDevicesResponseSwift
class AWSCognitoIdentityUserListDevicesResponse : AWSCognitoIdentityProviderListDevicesResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserUpdateDeviceStatusResponse : AWSCognitoIdentityProviderUpdateDeviceStatusResponseSwift
class AWSCognitoIdentityUserUpdateDeviceStatusResponse : AWSCognitoIdentityProviderUpdateDeviceStatusResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserGetDeviceResponse : AWSCognitoIdentityProviderGetDeviceResponseSwift
class AWSCognitoIdentityUserGetDeviceResponse : AWSCognitoIdentityProviderGetDeviceResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserVerifySoftwareTokenResponse : AWSCognitoIdentityProviderVerifySoftwareTokenResponseSwift
class AWSCognitoIdentityUserVerifySoftwareTokenResponse : AWSCognitoIdentityProviderVerifySoftwareTokenResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserAssociateSoftwareTokenResponse : AWSCognitoIdentityProviderAssociateSoftwareTokenResponseSwift
class AWSCognitoIdentityUserAssociateSoftwareTokenResponse : AWSCognitoIdentityProviderAssociateSoftwareTokenResponse -
Undocumented
Declaration
Objective-C
@interface AWSCognitoIdentityUserSetUserMfaPreferenceResponse : AWSCognitoIdentityProviderSetUserMFAPreferenceResponseSwift
class AWSCognitoIdentityUserSetUserMfaPreferenceResponse : AWSCognitoIdentityProviderSetUserMFAPreferenceResponse -
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserPool : NSObject <AWSIdentityProvider, AWSIdentityProviderManager> @property (nonatomic, readonly) AWSServiceConfiguration *configuration; @property (nonatomic, readonly) AWSCognitoIdentityUserPoolConfiguration *userPoolConfiguration; @property (nonatomic, readonly) NSString *identityProviderName; /** Set this delegate to interactively prompt users for authentication challenges when necessary */ @property (nonatomic, strong) id <AWSCognitoIdentityInteractiveAuthenticationDelegate> delegate; /** * Fetches the Cognito User Pool instance configured in the `info.plist` under `CognitoUserPool` * * @return the default instance for Cognito User Pool */ + (instancetype)defaultCognitoIdentityUserPool; + (void)registerCognitoIdentityUserPoolWithUserPoolConfiguration:(AWSCognitoIdentityUserPoolConfiguration *)userPoolConfiguration forKey:(NSString *)key; + (void)registerCognitoIdentityUserPoolWithConfiguration:(nullable AWSServiceConfiguration *)configuration userPoolConfiguration:(AWSCognitoIdentityUserPoolConfiguration *)userPoolConfiguration forKey:(NSString *)key; + (nullable instancetype)CognitoIdentityUserPoolForKey:(NSString *)key; + (void)removeCognitoIdentityUserPoolForKey:(NSString *)key; + (AWSCognitoIdentityUserPoolConfiguration *)buildUserPoolConfiguration:(nullable AWSServiceInfo *) serviceInfo; /** Sign up a new user */ - (AWSTask<AWSCognitoIdentityUserPoolSignUpResponse *> *)signUp:(NSString *)username password:(NSString *)password userAttributes:(nullable NSArray<AWSCognitoIdentityUserAttributeType *> *)userAttributes validationData:(nullable NSArray<AWSCognitoIdentityUserAttributeType *> *)validationData clientMetaData:(nullable NSDictionary<NSString *, NSString*> *) clientMetaData; - (AWSTask<AWSCognitoIdentityUserPoolSignUpResponse *> *)signUp:(NSString *)username password:(NSString *)password userAttributes:(nullable NSArray<AWSCognitoIdentityUserAttributeType *> *)userAttributes validationData:(nullable NSArray<AWSCognitoIdentityUserAttributeType *> *)validationData; /** Return the user who last authenticated. Username may be nil if current user is unknown. @return The last authenticated user */ - (nullable AWSCognitoIdentityUser *)currentUser; /** Return the user without a username, when username is unknown. */ - (AWSCognitoIdentityUser *)getUser; /** Return the user with a specific username */ - (AWSCognitoIdentityUser *)getUser:(NSString *)username; /** Clear the last known user only without signing out of their user session */ - (void) clearLastKnownUser; /** Clear everything from keychain, including last known user and user sessions for all users. */ - (void) clearAll; @endSwift
class AWSCognitoIdentityUserPool : NSObject -
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserPoolConfiguration : NSObject @property (nonatomic, readonly) NSString *clientId; @property (nonatomic, readonly, nullable) NSString *clientSecret; @property (nonatomic, readonly) NSString *poolId; @property (nonatomic, readonly) NSString *pinpointAppId; @property (nonatomic, readonly) BOOL shouldProvideCognitoValidationData; @property (nonatomic, readonly) BOOL migrationEnabled; - (instancetype)initWithClientId:(NSString *)clientId clientSecret:(nullable NSString *)clientSecret poolId:(NSString *)poolId; - (instancetype)initWithClientId:(NSString *)clientId clientSecret:(nullable NSString *)clientSecret poolId:(NSString *)poolId shouldProvideCognitoValidationData:(BOOL)shouldProvideCognitoValidationData; - (instancetype)initWithClientId:(NSString *)clientId clientSecret:(nullable NSString *)clientSecret poolId:(NSString *)poolId shouldProvideCognitoValidationData:(BOOL)shouldProvideCognitoValidationData pinpointAppId:(nullable NSString *)pinpointAppId; - (instancetype)initWithClientId:(NSString *)clientId clientSecret:(nullable NSString *)clientSecret poolId:(NSString *)poolId shouldProvideCognitoValidationData:(BOOL)shouldProvideCognitoValidationData pinpointAppId:(nullable NSString *)pinpointAppId migrationEnabled:(BOOL) migrationEnabled; @endSwift
class AWSCognitoIdentityUserPoolConfiguration : NSObject -
When interactive sign in is initiated, this encapsulates the last known username
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityPasswordAuthenticationInput : NSObjectSwift
class AWSCognitoIdentityPasswordAuthenticationInput : NSObject -
When interactive auth requires a multifactor authentication code, this encapsulates the destination and delivery medium
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityMultifactorAuthenticationInput : NSObjectSwift
class AWSCognitoIdentityMultifactorAuthenticationInput : NSObject -
When responding to an interactive sign in, this encapsulates the end users’ username and password
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityPasswordAuthenticationDetails : NSObjectSwift
class AWSCognitoIdentityPasswordAuthenticationDetails : NSObject -
When responding to a custom sign in, this encapsulates the end users challenge responses
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityCustomChallengeDetails : NSObjectSwift
class AWSCognitoIdentityCustomChallengeDetails : NSObject -
When responding to a new password required challenge this encapsulates the end users’ new password and required attributes
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityNewPasswordRequiredDetails : NSObjectSwift
class AWSCognitoIdentityNewPasswordRequiredDetails : NSObject -
When responding to a mfa code challenge this encapsulates the end users’ mfa code and client metadata
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityMfaCodeDetails : NSObjectSwift
class AWSCognitoIdentityMfaCodeDetails : NSObject -
When responding to a custom sign in, this encapsulates the challenge parameters that define the challenge
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityCustomAuthenticationInput : NSObjectSwift
class AWSCognitoIdentityCustomAuthenticationInput : NSObject -
When responding to new password required, this encapsulates the existing user attributes and the required user attributes.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityNewPasswordRequiredInput : NSObjectSwift
class AWSCognitoIdentityNewPasswordRequiredInput : NSObject -
When responding to software mfa setup required, this encapsulates the secret code the end user must provide to their software mfa.
See moreDeclaration
Objective-C
@interface AWSCognitoIdentitySoftwareMfaSetupRequiredInput : NSObjectSwift
class AWSCognitoIdentitySoftwareMfaSetupRequiredInput : NSObject -
When responding to a software mfa setup required challenge this encapsulates the end user’s user code and friendly name for their TOTP
See moreDeclaration
Objective-C
@interface AWSCognitoIdentitySoftwareMfaSetupRequiredDetails : NSObjectSwift
class AWSCognitoIdentitySoftwareMfaSetupRequiredDetails : NSObject -
When responding to a select mfa challenge, this encapsulates the available mfas the end user can choose from
See moreDeclaration
Objective-C
@interface AWSCognitoIdentitySelectMfaInput : NSObjectSwift
class AWSCognitoIdentitySelectMfaInput : NSObject -
When responding to a select mfa challenge this encapsulates the end users mfa choice
See moreDeclaration
Objective-C
@interface AWSCognitoIdentitySelectMfaDetails : NSObjectSwift
class AWSCognitoIdentitySelectMfaDetails : NSObject -
Undocumented
See moreDeclaration
Objective-C
@interface AWSCognitoIdentityUserPoolSignUpResponse : AWSCognitoIdentityProviderSignUpResponseSwift
class AWSCognitoIdentityUserPoolSignUpResponse : AWSCognitoIdentityProviderSignUpResponse