View on GitHub
CognitoIdentityProvider Structure Reference
CognitoIdentityProvider
public struct CognitoIdentityProviderClient object for interacting with AWS CognitoIdentityProvider service.
Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies. This API reference provides information about user pools in Amazon Cognito User Pools. For more information, see the Amazon Cognito Documentation.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the CognitoIdentityProvider client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Adds additional user attributes to the user pool schema.
Declaration
Swift
public func addCustomAttributes(_ input: AddCustomAttributesRequest) -> EventLoopFuture<AddCustomAttributesResponse> -
Adds the specified user to the specified group. Calling this action requires developer credentials.
Declaration
Swift
@discardableResult public func adminAddUserToGroup(_ input: AdminAddUserToGroupRequest) -> EventLoopFuture<Void> -
Confirms user registration as an admin without using a confirmation code. Works on any user. Calling this action requires developer credentials.
Declaration
Swift
public func adminConfirmSignUp(_ input: AdminConfirmSignUpRequest) -> EventLoopFuture<AdminConfirmSignUpResponse> -
Creates a new user in the specified user pool. If MessageAction is not set, the default is to send a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to create or update a user pool. This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password. AdminCreateUser requires developer credentials.
Declaration
Swift
public func adminCreateUser(_ input: AdminCreateUserRequest) -> EventLoopFuture<AdminCreateUserResponse> -
Deletes a user as an administrator. Works on any user. Calling this action requires developer credentials.
Declaration
Swift
@discardableResult public func adminDeleteUser(_ input: AdminDeleteUserRequest) -> EventLoopFuture<Void> -
Deletes the user attributes in a user pool as an administrator. Works on any user. Calling this action requires developer credentials.
Declaration
Swift
public func adminDeleteUserAttributes(_ input: AdminDeleteUserAttributesRequest) -> EventLoopFuture<AdminDeleteUserAttributesResponse> -
Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See AdminLinkProviderForUser. This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked using AdminLinkProviderForUser call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
Declaration
Swift
public func adminDisableProviderForUser(_ input: AdminDisableProviderForUserRequest) -> EventLoopFuture<AdminDisableProviderForUserResponse> -
Disables the specified user. Calling this action requires developer credentials.
Declaration
Swift
public func adminDisableUser(_ input: AdminDisableUserRequest) -> EventLoopFuture<AdminDisableUserResponse> -
Enables the specified user as an administrator. Works on any user. Calling this action requires developer credentials.
Declaration
Swift
public func adminEnableUser(_ input: AdminEnableUserRequest) -> EventLoopFuture<AdminEnableUserResponse> -
Forgets the device, as an administrator. Calling this action requires developer credentials.
Declaration
Swift
@discardableResult public func adminForgetDevice(_ input: AdminForgetDeviceRequest) -> EventLoopFuture<Void> -
Gets the device, as an administrator. Calling this action requires developer credentials.
Declaration
Swift
public func adminGetDevice(_ input: AdminGetDeviceRequest) -> EventLoopFuture<AdminGetDeviceResponse> -
Gets the specified user by user name in a user pool as an administrator. Works on any user. Calling this action requires developer credentials.
Declaration
Swift
public func adminGetUser(_ input: AdminGetUserRequest) -> EventLoopFuture<AdminGetUserResponse> -
Initiates the authentication flow, as an administrator. Calling this action requires developer credentials.
Declaration
Swift
public func adminInitiateAuth(_ input: AdminInitiateAuthRequest) -> EventLoopFuture<AdminInitiateAuthResponse> -
Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account. The maximum number of federated identities linked to a user is 5. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner. This action is enabled only for admin access and requires developer credentials.
Declaration
Swift
public func adminLinkProviderForUser(_ input: AdminLinkProviderForUserRequest) -> EventLoopFuture<AdminLinkProviderForUserResponse> -
Lists devices, as an administrator. Calling this action requires developer credentials.
Declaration
Swift
public func adminListDevices(_ input: AdminListDevicesRequest) -> EventLoopFuture<AdminListDevicesResponse> -
Lists the groups that the user belongs to. Calling this action requires developer credentials.
Declaration
Swift
public func adminListGroupsForUser(_ input: AdminListGroupsForUserRequest) -> EventLoopFuture<AdminListGroupsForUserResponse> -
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
Declaration
Swift
public func adminListUserAuthEvents(_ input: AdminListUserAuthEventsRequest) -> EventLoopFuture<AdminListUserAuthEventsResponse> -
Removes the specified user from the specified group. Calling this action requires developer credentials.
Declaration
Swift
@discardableResult public func adminRemoveUserFromGroup(_ input: AdminRemoveUserFromGroupRequest) -> EventLoopFuture<Void> -
Resets the specified user’s password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. Calling this action requires developer credentials.
Declaration
Swift
public func adminResetUserPassword(_ input: AdminResetUserPasswordRequest) -> EventLoopFuture<AdminResetUserPasswordResponse> -
Responds to an authentication challenge, as an administrator. Calling this action requires developer credentials.
Declaration
Swift
public func adminRespondToAuthChallenge(_ input: AdminRespondToAuthChallengeRequest) -> EventLoopFuture<AdminRespondToAuthChallengeResponse> -
Sets the user’s multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
Declaration
Swift
public func adminSetUserMFAPreference(_ input: AdminSetUserMFAPreferenceRequest) -> EventLoopFuture<AdminSetUserMFAPreferenceResponse> -
Sets the specified user’s password in a user pool as an administrator. Works on any user. The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator. Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed.
Declaration
Swift
public func adminSetUserPassword(_ input: AdminSetUserPasswordRequest) -> EventLoopFuture<AdminSetUserPasswordResponse> -
This action is no longer supported. You can use it to configure only SMS MFA. You can’t use it to configure TOTP software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.
Declaration
Swift
public func adminSetUserSettings(_ input: AdminSetUserSettingsRequest) -> EventLoopFuture<AdminSetUserSettingsResponse> -
Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
Declaration
Swift
public func adminUpdateAuthEventFeedback(_ input: AdminUpdateAuthEventFeedbackRequest) -> EventLoopFuture<AdminUpdateAuthEventFeedbackResponse> -
Updates the device status as an administrator. Calling this action requires developer credentials.
Declaration
Swift
public func adminUpdateDeviceStatus(_ input: AdminUpdateDeviceStatusRequest) -> EventLoopFuture<AdminUpdateDeviceStatusResponse> -
Updates the specified user’s attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. Calling this action requires developer credentials.
Declaration
Swift
public func adminUpdateUserAttributes(_ input: AdminUpdateUserAttributesRequest) -> EventLoopFuture<AdminUpdateUserAttributesResponse> -
Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user’s current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued. Calling this action requires developer credentials.
Declaration
Swift
public func adminUserGlobalSignOut(_ input: AdminUserGlobalSignOutRequest) -> EventLoopFuture<AdminUserGlobalSignOutResponse> -
Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
Declaration
Swift
public func associateSoftwareToken(_ input: AssociateSoftwareTokenRequest) -> EventLoopFuture<AssociateSoftwareTokenResponse> -
Changes the password for a specified user in a user pool.
Declaration
Swift
public func changePassword(_ input: ChangePasswordRequest) -> EventLoopFuture<ChangePasswordResponse> -
Confirms tracking of the device. This API call is the call that begins device tracking.
Declaration
Swift
public func confirmDevice(_ input: ConfirmDeviceRequest) -> EventLoopFuture<ConfirmDeviceResponse> -
Allows a user to enter a confirmation code to reset a forgotten password.
Declaration
Swift
public func confirmForgotPassword(_ input: ConfirmForgotPasswordRequest) -> EventLoopFuture<ConfirmForgotPasswordResponse> -
Confirms registration of a user and handles the existing alias from a previous user.
Declaration
Swift
public func confirmSignUp(_ input: ConfirmSignUpRequest) -> EventLoopFuture<ConfirmSignUpResponse> -
Creates a new group in the specified user pool. Calling this action requires developer credentials.
Declaration
Swift
public func createGroup(_ input: CreateGroupRequest) -> EventLoopFuture<CreateGroupResponse> -
Creates an identity provider for a user pool.
Declaration
Swift
public func createIdentityProvider(_ input: CreateIdentityProviderRequest) -> EventLoopFuture<CreateIdentityProviderResponse> -
Creates a new OAuth2.0 resource server and defines custom scopes in it.
Declaration
Swift
public func createResourceServer(_ input: CreateResourceServerRequest) -> EventLoopFuture<CreateResourceServerResponse> -
Creates the user import job.
Declaration
Swift
public func createUserImportJob(_ input: CreateUserImportJobRequest) -> EventLoopFuture<CreateUserImportJobResponse> -
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
Declaration
Swift
public func createUserPool(_ input: CreateUserPoolRequest) -> EventLoopFuture<CreateUserPoolResponse> -
Creates the user pool client.
Declaration
Swift
public func createUserPoolClient(_ input: CreateUserPoolClientRequest) -> EventLoopFuture<CreateUserPoolClientResponse> -
Creates a new domain for a user pool.
Declaration
Swift
public func createUserPoolDomain(_ input: CreateUserPoolDomainRequest) -> EventLoopFuture<CreateUserPoolDomainResponse> -
Deletes a group. Currently only groups with no members can be deleted. Calling this action requires developer credentials.
Declaration
Swift
@discardableResult public func deleteGroup(_ input: DeleteGroupRequest) -> EventLoopFuture<Void> -
Deletes an identity provider for a user pool.
Declaration
Swift
@discardableResult public func deleteIdentityProvider(_ input: DeleteIdentityProviderRequest) -> EventLoopFuture<Void> -
Deletes a resource server.
Declaration
Swift
@discardableResult public func deleteResourceServer(_ input: DeleteResourceServerRequest) -> EventLoopFuture<Void> -
Allows a user to delete himself or herself.
Declaration
Swift
@discardableResult public func deleteUser(_ input: DeleteUserRequest) -> EventLoopFuture<Void> -
Deletes the attributes for a user.
Declaration
Swift
public func deleteUserAttributes(_ input: DeleteUserAttributesRequest) -> EventLoopFuture<DeleteUserAttributesResponse> -
Deletes the specified Amazon Cognito user pool.
Declaration
Swift
@discardableResult public func deleteUserPool(_ input: DeleteUserPoolRequest) -> EventLoopFuture<Void> -
Allows the developer to delete the user pool client.
Declaration
Swift
@discardableResult public func deleteUserPoolClient(_ input: DeleteUserPoolClientRequest) -> EventLoopFuture<Void> -
Deletes a domain for a user pool.
Declaration
Swift
public func deleteUserPoolDomain(_ input: DeleteUserPoolDomainRequest) -> EventLoopFuture<DeleteUserPoolDomainResponse> -
Gets information about a specific identity provider.
Declaration
Swift
public func describeIdentityProvider(_ input: DescribeIdentityProviderRequest) -> EventLoopFuture<DescribeIdentityProviderResponse> -
Describes a resource server.
Declaration
Swift
public func describeResourceServer(_ input: DescribeResourceServerRequest) -> EventLoopFuture<DescribeResourceServerResponse> -
Describes the risk configuration.
Declaration
Swift
public func describeRiskConfiguration(_ input: DescribeRiskConfigurationRequest) -> EventLoopFuture<DescribeRiskConfigurationResponse> -
Describes the user import job.
Declaration
Swift
public func describeUserImportJob(_ input: DescribeUserImportJobRequest) -> EventLoopFuture<DescribeUserImportJobResponse> -
Returns the configuration information and metadata of the specified user pool.
Declaration
Swift
public func describeUserPool(_ input: DescribeUserPoolRequest) -> EventLoopFuture<DescribeUserPoolResponse> -
Client method for returning the configuration information and metadata of the specified user pool app client.
Declaration
Swift
public func describeUserPoolClient(_ input: DescribeUserPoolClientRequest) -> EventLoopFuture<DescribeUserPoolClientResponse> -
Gets information about a domain.
Declaration
Swift
public func describeUserPoolDomain(_ input: DescribeUserPoolDomainRequest) -> EventLoopFuture<DescribeUserPoolDomainResponse> -
Forgets the specified device.
Declaration
Swift
@discardableResult public func forgetDevice(_ input: ForgetDeviceRequest) -> EventLoopFuture<Void> -
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user’s password. For the Username parameter, you can use the username or user alias. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call ConfirmForgotPassword.
Declaration
Swift
public func forgotPassword(_ input: ForgotPasswordRequest) -> EventLoopFuture<ForgotPasswordResponse> -
Gets the header information for the .csv file to be used as input for the user import job.
Declaration
Swift
public func getCSVHeader(_ input: GetCSVHeaderRequest) -> EventLoopFuture<GetCSVHeaderResponse> -
Gets the device.
Declaration
Swift
public func getDevice(_ input: GetDeviceRequest) -> EventLoopFuture<GetDeviceResponse> -
Gets a group. Calling this action requires developer credentials.
Declaration
Swift
public func getGroup(_ input: GetGroupRequest) -> EventLoopFuture<GetGroupResponse> -
Gets the specified identity provider.
Declaration
Swift
public func getIdentityProviderByIdentifier(_ input: GetIdentityProviderByIdentifierRequest) -> EventLoopFuture<GetIdentityProviderByIdentifierResponse> -
This method takes a user pool ID, and returns the signing certificate.
Declaration
Swift
public func getSigningCertificate(_ input: GetSigningCertificateRequest) -> EventLoopFuture<GetSigningCertificateResponse> -
Gets the UI Customization information for a particular app client’s app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.
Declaration
Swift
public func getUICustomization(_ input: GetUICustomizationRequest) -> EventLoopFuture<GetUICustomizationResponse> -
Gets the user attributes and metadata for a user.
Declaration
Swift
public func getUser(_ input: GetUserRequest) -> EventLoopFuture<GetUserResponse> -
Gets the user attribute verification code for the specified attribute name.
Declaration
Swift
public func getUserAttributeVerificationCode(_ input: GetUserAttributeVerificationCodeRequest) -> EventLoopFuture<GetUserAttributeVerificationCodeResponse> -
Gets the user pool multi-factor authentication (MFA) configuration.
Declaration
Swift
public func getUserPoolMfaConfig(_ input: GetUserPoolMfaConfigRequest) -> EventLoopFuture<GetUserPoolMfaConfigResponse> -
Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user’s current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Declaration
Swift
public func globalSignOut(_ input: GlobalSignOutRequest) -> EventLoopFuture<GlobalSignOutResponse> -
Initiates the authentication flow.
Declaration
Swift
public func initiateAuth(_ input: InitiateAuthRequest) -> EventLoopFuture<InitiateAuthResponse> -
Lists the devices.
Declaration
Swift
public func listDevices(_ input: ListDevicesRequest) -> EventLoopFuture<ListDevicesResponse> -
Lists the groups associated with a user pool. Calling this action requires developer credentials.
Declaration
Swift
public func listGroups(_ input: ListGroupsRequest) -> EventLoopFuture<ListGroupsResponse> -
Lists information about all identity providers for a user pool.
Declaration
Swift
public func listIdentityProviders(_ input: ListIdentityProvidersRequest) -> EventLoopFuture<ListIdentityProvidersResponse> -
Lists the resource servers for a user pool.
Declaration
Swift
public func listResourceServers(_ input: ListResourceServersRequest) -> EventLoopFuture<ListResourceServersResponse> -
Lists the tags that are assigned to an Amazon Cognito user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Lists the user import jobs.
Declaration
Swift
public func listUserImportJobs(_ input: ListUserImportJobsRequest) -> EventLoopFuture<ListUserImportJobsResponse> -
Lists the clients that have been created for the specified user pool.
Declaration
Swift
public func listUserPoolClients(_ input: ListUserPoolClientsRequest) -> EventLoopFuture<ListUserPoolClientsResponse> -
Lists the user pools associated with an AWS account.
Declaration
Swift
public func listUserPools(_ input: ListUserPoolsRequest) -> EventLoopFuture<ListUserPoolsResponse> -
Lists the users in the Amazon Cognito user pool.
Declaration
Swift
public func listUsers(_ input: ListUsersRequest) -> EventLoopFuture<ListUsersResponse> -
Lists the users in the specified group. Calling this action requires developer credentials.
Declaration
Swift
public func listUsersInGroup(_ input: ListUsersInGroupRequest) -> EventLoopFuture<ListUsersInGroupResponse> -
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
Declaration
Swift
public func resendConfirmationCode(_ input: ResendConfirmationCodeRequest) -> EventLoopFuture<ResendConfirmationCodeResponse> -
Responds to the authentication challenge.
Declaration
Swift
public func respondToAuthChallenge(_ input: RespondToAuthChallengeRequest) -> EventLoopFuture<RespondToAuthChallengeResponse> -
Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
Declaration
Swift
public func setRiskConfiguration(_ input: SetRiskConfigurationRequest) -> EventLoopFuture<SetRiskConfigurationResponse> -
Sets the UI customization information for a user pool’s built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration. To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app’s pages, and the service will throw an error.
Declaration
Swift
public func setUICustomization(_ input: SetUICustomizationRequest) -> EventLoopFuture<SetUICustomizationResponse> -
Set the user’s multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
Declaration
Swift
public func setUserMFAPreference(_ input: SetUserMFAPreferenceRequest) -> EventLoopFuture<SetUserMFAPreferenceResponse> -
Set the user pool multi-factor authentication (MFA) configuration.
Declaration
Swift
public func setUserPoolMfaConfig(_ input: SetUserPoolMfaConfigRequest) -> EventLoopFuture<SetUserPoolMfaConfigResponse> -
This action is no longer supported. You can use it to configure only SMS MFA. You can’t use it to configure TOTP software token MFA. To configure either type of MFA, use SetUserMFAPreference instead.
Declaration
Swift
public func setUserSettings(_ input: SetUserSettingsRequest) -> EventLoopFuture<SetUserSettingsResponse> -
Registers the user in the specified user pool and creates a user name, password, and user attributes.
Declaration
Swift
public func signUp(_ input: SignUpRequest) -> EventLoopFuture<SignUpResponse> -
Starts the user import.
Declaration
Swift
public func startUserImportJob(_ input: StartUserImportJobRequest) -> EventLoopFuture<StartUserImportJobResponse> -
Stops the user import job.
Declaration
Swift
public func stopUserImportJob(_ input: StopUserImportJobRequest) -> EventLoopFuture<StopUserImportJobResponse> -
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse> -
Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
Declaration
Swift
public func updateAuthEventFeedback(_ input: UpdateAuthEventFeedbackRequest) -> EventLoopFuture<UpdateAuthEventFeedbackResponse> -
Updates the device status.
Declaration
Swift
public func updateDeviceStatus(_ input: UpdateDeviceStatusRequest) -> EventLoopFuture<UpdateDeviceStatusResponse> -
Updates the specified group with the specified attributes. Calling this action requires developer credentials. If you don’t provide a value for an attribute, it will be set to the default value.
Declaration
Swift
public func updateGroup(_ input: UpdateGroupRequest) -> EventLoopFuture<UpdateGroupResponse> -
Updates identity provider information for a user pool.
Declaration
Swift
public func updateIdentityProvider(_ input: UpdateIdentityProviderRequest) -> EventLoopFuture<UpdateIdentityProviderResponse> -
Updates the name and scopes of resource server. All other fields are read-only. If you don’t provide a value for an attribute, it will be set to the default value.
Declaration
Swift
public func updateResourceServer(_ input: UpdateResourceServerRequest) -> EventLoopFuture<UpdateResourceServerResponse> -
Allows a user to update a specific attribute (one at a time).
Declaration
Swift
public func updateUserAttributes(_ input: UpdateUserAttributesRequest) -> EventLoopFuture<UpdateUserAttributesResponse> -
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don’t provide a value for an attribute, it will be set to the default value.
Declaration
Swift
public func updateUserPool(_ input: UpdateUserPoolRequest) -> EventLoopFuture<UpdateUserPoolResponse> -
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient. If you don’t provide a value for an attribute, it will be set to the default value.
Declaration
Swift
public func updateUserPoolClient(_ input: UpdateUserPoolClientRequest) -> EventLoopFuture<UpdateUserPoolClientResponse> -
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
Declaration
Swift
public func updateUserPoolDomain(_ input: UpdateUserPoolDomainRequest) -> EventLoopFuture<UpdateUserPoolDomainResponse> -
Use this API to register a user’s entered TOTP code and mark the user’s software token MFA status as “verified” if successful. The request takes an access token or a session string, but not both.
Declaration
Swift
public func verifySoftwareToken(_ input: VerifySoftwareTokenRequest) -> EventLoopFuture<VerifySoftwareTokenResponse> -
Verifies the specified user attributes in the user pool.
Declaration
Swift
public func verifyUserAttribute(_ input: VerifyUserAttributeRequest) -> EventLoopFuture<VerifyUserAttributeResponse>
-
Lists the groups that the user belongs to. Calling this action requires developer credentials.
Declaration
Swift
public func adminListGroupsForUserPaginator(_ input: AdminListGroupsForUserRequest, onPage: @escaping (AdminListGroupsForUserResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
Declaration
Swift
public func adminListUserAuthEventsPaginator(_ input: AdminListUserAuthEventsRequest, onPage: @escaping (AdminListUserAuthEventsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the groups associated with a user pool. Calling this action requires developer credentials.
Declaration
Swift
public func listGroupsPaginator(_ input: ListGroupsRequest, onPage: @escaping (ListGroupsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists information about all identity providers for a user pool.
Declaration
Swift
public func listIdentityProvidersPaginator(_ input: ListIdentityProvidersRequest, onPage: @escaping (ListIdentityProvidersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the resource servers for a user pool.
Declaration
Swift
public func listResourceServersPaginator(_ input: ListResourceServersRequest, onPage: @escaping (ListResourceServersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the clients that have been created for the specified user pool.
Declaration
Swift
public func listUserPoolClientsPaginator(_ input: ListUserPoolClientsRequest, onPage: @escaping (ListUserPoolClientsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the user pools associated with an AWS account.
Declaration
Swift
public func listUserPoolsPaginator(_ input: ListUserPoolsRequest, onPage: @escaping (ListUserPoolsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the users in the Amazon Cognito user pool.
Declaration
Swift
public func listUsersPaginator(_ input: ListUsersRequest, onPage: @escaping (ListUsersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the users in the specified group. Calling this action requires developer credentials.
Declaration
Swift
public func listUsersInGroupPaginator(_ input: ListUsersInGroupRequest, onPage: @escaping (ListUsersInGroupResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct AdminListGroupsForUserRequest : AWSShapeextension CognitoIdentityProvider.AdminListGroupsForUserRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct AdminListUserAuthEventsRequest : AWSShapeextension CognitoIdentityProvider.AdminListUserAuthEventsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListGroupsRequest : AWSShapeextension CognitoIdentityProvider.ListGroupsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListIdentityProvidersRequest : AWSShapeextension CognitoIdentityProvider.ListIdentityProvidersRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListResourceServersRequest : AWSShapeextension CognitoIdentityProvider.ListResourceServersRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListUserPoolClientsRequest : AWSShapeextension CognitoIdentityProvider.ListUserPoolClientsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListUserPoolsRequest : AWSShapeextension CognitoIdentityProvider.ListUserPoolsRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListUsersRequest : AWSShapeextension CognitoIdentityProvider.ListUsersRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListUsersInGroupRequest : AWSShapeextension CognitoIdentityProvider.ListUsersInGroupRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum AccountTakeoverEventActionType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AdvancedSecurityModeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AliasAttributeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AttributeDataType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum AuthFlowType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ChallengeName : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ChallengeNameType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ChallengeResponse : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum CompromisedCredentialsEventActionType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DefaultEmailOptionType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DeliveryMediumType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DeviceRememberedStatusType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum DomainStatusType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum EmailSendingAccountType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum EventFilterType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum EventResponseType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum EventType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ExplicitAuthFlowsType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum FeedbackValueType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum IdentityProviderTypeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum MessageActionType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum OAuthFlowType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PreventUserExistenceErrorTypes : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RecoveryOptionNameType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RiskDecisionType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RiskLevelType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum StatusType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum TimeUnitsType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum UserImportJobStatusType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum UserPoolMfaType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum UserStatusType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum UsernameAttributeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum VerifiedAttributeType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum VerifySoftwareTokenResponseType : String, CustomStringConvertible, Codable