Crate rusoto_cognito_idp
source · [−]Expand description
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.
If you’re using the service, you’re probably looking for CognitoIdentityProviderClient and CognitoIdentityProvider.
Structs
The data type for AccountRecoverySetting.
Account takeover action type.
Account takeover actions type.
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.
Represents the request to add custom attributes.
Represents the response from the server for the request to add custom attributes.
Represents the request to confirm user registration.
Represents the response from the server for the request to confirm registration.
The configuration for creating a new user profile.
Represents the request to create a user in the specified user pool.
Represents the response from the server to the request to create the user.
Represents the request to delete user attributes as an administrator.
Represents the response received from the server for a request to delete user attributes.
Represents the request to delete a user as an administrator.
Represents the request to disable the user as an administrator.
Represents the response received from the server to disable the user as an administrator.
Represents the request that enables the user as an administrator.
Represents the response from the server for the request to enable a user as an administrator.
Sends the forgot device request, as an administrator.
Represents the request to get the device, as an administrator.
Gets the device response, as an administrator.
Represents the request to get the specified user as an administrator.
Represents the response from the server from the request to get the specified user as an administrator.
Initiates the authorization request, as an administrator.
Initiates the authentication response, as an administrator.
Represents the request to list devices, as an administrator.
Lists the device's response, as an administrator.
Represents the request to reset a user's password as an administrator.
Represents the response from the server to reset a user password as an administrator.
The request to respond to the authentication challenge, as an administrator.
Responds to the authentication challenge, as an administrator.
You can use this parameter to set an MFA configuration that uses the SMS delivery medium.
Represents the response from the server to set user settings as an administrator.
The request to update the device status, as an administrator.
The status response from the request to update the device, as an administrator.
Represents the request to update the user's attributes as an administrator.
Represents the response from the server for the request to update user attributes as an administrator.
The request to sign out of all devices, as an administrator.
The global sign-out response, as an administrator.
The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
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.
Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
Specifies whether the attribute is standard or custom.
The authentication event type.
The authentication result.
The challenge response type.
Represents the request to change a user password.
The response from the server to the change password request.
The code delivery details being returned from the server.
A client for the Amazon Cognito Identity Provider API.
The compromised credentials actions type
The compromised credentials risk configuration type.
Confirms the device request.
Confirms the device response.
The request representing the confirmation for a password reset.
The response from the server that results from a user's request to retrieve a forgotten password.
Represents the request to confirm registration of a user.
Represents the response from the server for the registration confirmation.
Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
Represents the request to create the user import job.
Represents the response from the server to the request to create the user import job.
Represents the request to create a user pool client.
Represents the response from the server to create a user pool client.
Represents the request to create a user pool.
Represents the response from the server for the request to create a user pool.
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
A custom email sender Lambda configuration type.
A custom SMS sender Lambda configuration type.
Represents the request to delete user attributes.
Represents the response from the server to delete user attributes.
Represents the request to delete a user pool client.
Represents the request to delete a user pool.
Represents the request to delete a user.
Represents the request to describe the user import job.
Represents the response from the server to the request to describe the user import job.
Represents the request to describe a user pool client.
Represents the response from the server from a request to describe the user pool client.
Represents the request to describe the user pool.
Represents the response to describe the user pool.
The configuration for the user pool's device tracking.
The device verifier against which it will be authenticated.
The device type.
A container for information about a domain.
The email configuration type.
Amazon Cognito has specific regions for use with Amazon SES. For more information on the supported regions, see Email Settings for Amazon Cognito User Pools.
Specifies the user context data captured at the time of an event request.
Specifies the event feedback type.
The event risk type.
Represents the request to forget the device.
Represents the request to reset a user's password.
Respresents the response from the server regarding the request to reset a password.
Represents the request to get the header information for the .csv file for the user import job.
Represents the response from the server to the request to get the header information for the .csv file for the user import job.
Represents the request to get the device.
Gets the device response.
Request to get a signing certificate from Cognito.
Response from Cognito for a signing certificate request.
Represents the request to get user attribute verification.
The verification code response returned by the server response to get the user attribute verification code.
Represents the request to get information about the user.
Represents the response from the server from the request to get information about the user.
Represents the request to sign out all devices.
The response to the request to sign out all devices.
The group type.
The HTTP header.
A container for information about an identity provider.
Initiates the authentication request.
Initiates the authentication response.
Specifies the configuration for AWS Lambda triggers.
Represents the request to list the devices.
Represents the response to list devices.
Represents the request to list the user import jobs.
Represents the response from the server to the request to list the user import jobs.
Represents the request to list the user pool clients.
Represents the response from the server that lists user pool clients.
Represents the request to list user pools.
Represents the response to list user pools.
Represents the request to list users.
The response from the request to list users.
This data type is no longer supported. You can use it only for SMS MFA configurations. You can't use it for TOTP software token MFA configurations.
The message template structure.
The new device metadata type.
The notify configuration type.
The notify email type.
The minimum and maximum value of an attribute that is of the number data type.
The password policy type.
A container for identity provider details.
A container for information about an identity provider for a user pool.
A map containing a priority as a key, and recovery method name as a value.
Represents the request to resend the confirmation code.
The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code.
A resource server scope.
A container for information about a resource server for a user pool.
The request to respond to an authentication challenge.
The response to respond to the authentication challenge.
The risk configuration type.
The type of the configuration to override the risk decision.
The type used for enabling SMS MFA at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is enabled 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, disable MFA for users and turn on Adaptive Authentication for the user pool.
Contains information about the schema attribute.
Represents the request to set user settings.
The response from the server for a set user settings request.
Represents the request to register a user.
The response from the server for a registration request.
The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account. The Cognito User Pool makes the request to the Amazon SNS Service by using an AWS IAM role that you provide for your AWS account.
The SMS text message multi-factor authentication (MFA) configuration type.
The type used for enabling software token MFA at the user pool level.
The type used for enabling software token MFA at the user level. If an MFA type is enabled 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, disable MFA for users and turn on Adaptive Authentication for the user pool.
Represents the request to start the user import job.
Represents the response from the server to the request to start the user import job.
Represents the request to stop the user import job.
Represents the response from the server to the request to stop the user import job.
The constraints associated with a string attribute.
The data type for TokenValidityUnits that specifics the time measurements for token validity.
A container for the UI customization information for a user pool's built-in app UI.
Represents the request to update the device status.
The response to the request to update the device status.
Represents the request to update user attributes.
Represents the response from the server for the request to update user attributes.
Represents the request to update the user pool client.
Represents the response from the server to the request to update the user pool client.
The UpdateUserPoolDomain request input.
The UpdateUserPoolDomain response output.
Represents the request to update the user pool.
Represents the response from the server when you make a request to update the user pool.
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.
The user import job type.
The user pool add-ons type.
The description of the user pool client.
Contains information about a user pool client.
A user pool description.
The policy associated with a user pool.
A container for information about the user pool.
The user type.
The username configuration type.
The template for verification messages.
Represents the request to verify user attributes.
A container representing the response from the server from the request to verify user attributes.
Enums
Errors returned by AddCustomAttributes
Errors returned by AdminAddUserToGroup
Errors returned by AdminConfirmSignUp
Errors returned by AdminCreateUser
Errors returned by AdminDeleteUserAttributes
Errors returned by AdminDeleteUser
Errors returned by AdminDisableProviderForUser
Errors returned by AdminDisableUser
Errors returned by AdminEnableUser
Errors returned by AdminForgetDevice
Errors returned by AdminGetDevice
Errors returned by AdminGetUser
Errors returned by AdminInitiateAuth
Errors returned by AdminLinkProviderForUser
Errors returned by AdminListDevices
Errors returned by AdminListGroupsForUser
Errors returned by AdminListUserAuthEvents
Errors returned by AdminRemoveUserFromGroup
Errors returned by AdminResetUserPassword
Errors returned by AdminRespondToAuthChallenge
Errors returned by AdminSetUserMFAPreference
Errors returned by AdminSetUserPassword
Errors returned by AdminSetUserSettings
Errors returned by AdminUpdateAuthEventFeedback
Errors returned by AdminUpdateDeviceStatus
Errors returned by AdminUpdateUserAttributes
Errors returned by AdminUserGlobalSignOut
Errors returned by AssociateSoftwareToken
Errors returned by ChangePassword
Errors returned by ConfirmDevice
Errors returned by ConfirmForgotPassword
Errors returned by ConfirmSignUp
Errors returned by CreateGroup
Errors returned by CreateIdentityProvider
Errors returned by CreateResourceServer
Errors returned by CreateUserImportJob
Errors returned by CreateUserPoolClient
Errors returned by CreateUserPoolDomain
Errors returned by CreateUserPool
Errors returned by DeleteGroup
Errors returned by DeleteIdentityProvider
Errors returned by DeleteResourceServer
Errors returned by DeleteUserAttributes
Errors returned by DeleteUser
Errors returned by DeleteUserPoolClient
Errors returned by DeleteUserPoolDomain
Errors returned by DeleteUserPool
Errors returned by DescribeIdentityProvider
Errors returned by DescribeResourceServer
Errors returned by DescribeRiskConfiguration
Errors returned by DescribeUserImportJob
Errors returned by DescribeUserPoolClient
Errors returned by DescribeUserPoolDomain
Errors returned by DescribeUserPool
Errors returned by ForgetDevice
Errors returned by ForgotPassword
Errors returned by GetCSVHeader
Errors returned by GetDevice
Errors returned by GetGroup
Errors returned by GetIdentityProviderByIdentifier
Errors returned by GetSigningCertificate
Errors returned by GetUICustomization
Errors returned by GetUserAttributeVerificationCode
Errors returned by GetUser
Errors returned by GetUserPoolMfaConfig
Errors returned by GlobalSignOut
Errors returned by InitiateAuth
Errors returned by ListDevices
Errors returned by ListGroups
Errors returned by ListIdentityProviders
Errors returned by ListResourceServers
Errors returned by ListTagsForResource
Errors returned by ListUserImportJobs
Errors returned by ListUserPoolClients
Errors returned by ListUserPools
Errors returned by ListUsers
Errors returned by ListUsersInGroup
Errors returned by ResendConfirmationCode
Errors returned by RespondToAuthChallenge
Errors returned by RevokeToken
Errors returned by SetRiskConfiguration
Errors returned by SetUICustomization
Errors returned by SetUserMFAPreference
Errors returned by SetUserPoolMfaConfig
Errors returned by SetUserSettings
Errors returned by SignUp
Errors returned by StartUserImportJob
Errors returned by StopUserImportJob
Errors returned by TagResource
Errors returned by UntagResource
Errors returned by UpdateAuthEventFeedback
Errors returned by UpdateDeviceStatus
Errors returned by UpdateGroup
Errors returned by UpdateIdentityProvider
Errors returned by UpdateResourceServer
Errors returned by UpdateUserAttributes
Errors returned by UpdateUserPoolClient
Errors returned by UpdateUserPoolDomain
Errors returned by UpdateUserPool
Errors returned by VerifySoftwareToken
Errors returned by VerifyUserAttribute
Traits
Trait representing the capabilities of the Amazon Cognito Identity Provider API. Amazon Cognito Identity Provider clients implement this trait.