Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.4/services/cognitoidentityserviceprovider.ts?docs=full";

§Classes

CognitoIdentityServiceProvider

§Interfaces

AccountRecoverySettingType

The data type for AccountRecoverySetting.

AccountTakeoverActionsType

Account takeover actions type.

AccountTakeoverActionType

Account takeover action type.

AccountTakeoverRiskConfigurationType

Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.

AddCustomAttributesRequest

Represents the request to add custom attributes.

AdminAddUserToGroupRequest
AdminConfirmSignUpRequest

Represents the request to confirm user registration.

AdminCreateUserConfigType

The configuration for creating a new user profile.

AdminCreateUserRequest

Represents the request to create a user in the specified user pool.

AdminCreateUserResponse

Represents the response from the server to the request to create the user.

AdminDeleteUserAttributesRequest

Represents the request to delete user attributes as an administrator.

AdminDeleteUserRequest

Represents the request to delete a user as an administrator.

AdminDisableProviderForUserRequest
AdminDisableUserRequest

Represents the request to disable the user as an administrator.

AdminEnableUserRequest

Represents the request that enables the user as an administrator.

AdminForgetDeviceRequest

Sends the forgot device request, as an administrator.

AdminGetDeviceRequest

Represents the request to get the device, as an administrator.

AdminGetDeviceResponse

Gets the device response, as an administrator.

AdminGetUserRequest

Represents the request to get the specified user as an administrator.

AdminGetUserResponse

Represents the response from the server from the request to get the specified user as an administrator.

AdminInitiateAuthRequest

Initiates the authorization request, as an administrator.

AdminInitiateAuthResponse

Initiates the authentication response, as an administrator.

AdminLinkProviderForUserRequest
AdminListDevicesRequest

Represents the request to list devices, as an administrator.

AdminListDevicesResponse

Lists the device's response, as an administrator.

AdminListGroupsForUserRequest
AdminListGroupsForUserResponse
AdminListUserAuthEventsRequest
AdminListUserAuthEventsResponse
AdminRemoveUserFromGroupRequest
AdminResetUserPasswordRequest

Represents the request to reset a user's password as an administrator.

AdminRespondToAuthChallengeRequest

The request to respond to the authentication challenge, as an administrator.

AdminRespondToAuthChallengeResponse

Responds to the authentication challenge, as an administrator.

AdminSetUserMFAPreferenceRequest
AdminSetUserPasswordRequest
AdminSetUserSettingsRequest

You can use this parameter to set an MFA configuration that uses the SMS delivery medium.

AdminUpdateAuthEventFeedbackRequest
AdminUpdateDeviceStatusRequest

The request to update the device status, as an administrator.

AdminUpdateUserAttributesRequest

Represents the request to update the user's attributes as an administrator.

AdminUserGlobalSignOutRequest

The request to sign out of all devices, as an administrator.

AnalyticsConfigurationType

The Amazon Pinpoint analytics configuration necessary to collect metrics for a user pool.

AnalyticsMetadataType

An Amazon Pinpoint analytics endpoint.

AssociateSoftwareTokenRequest
AssociateSoftwareTokenResponse
AttributeType

Specifies whether the attribute is standard or custom.

AuthenticationResultType

The authentication result.

AuthEventType

The authentication event type.

ChallengeResponseType

The challenge response type.

ChangePasswordRequest

Represents the request to change a user password.

CodeDeliveryDetailsType

The delivery details for an email or SMS message that Amazon Cognito sent for authentication or verification.

CompromisedCredentialsActionsType

The compromised credentials actions type.

CompromisedCredentialsRiskConfigurationType

The compromised credentials risk configuration type.

ConfirmDeviceRequest

Confirms the device request.

ConfirmDeviceResponse

Confirms the device response.

ConfirmForgotPasswordRequest

The request representing the confirmation for a password reset.

ConfirmSignUpRequest

Represents the request to confirm registration of a user.

ContextDataType

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

CreateGroupRequest
CreateGroupResponse
CreateIdentityProviderRequest
CreateIdentityProviderResponse
CreateResourceServerRequest
CreateResourceServerResponse
CreateUserImportJobRequest

Represents the request to create the user import job.

CreateUserImportJobResponse

Represents the response from the server to the request to create the user import job.

CreateUserPoolClientRequest

Represents the request to create a user pool client.

CreateUserPoolClientResponse

Represents the response from the server to create a user pool client.

CreateUserPoolDomainRequest
CreateUserPoolDomainResponse
CreateUserPoolRequest

Represents the request to create a user pool.

CreateUserPoolResponse

Represents the response from the server for the request to create a user pool.

CustomDomainConfigType

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

CustomEmailLambdaVersionConfigType

A custom email sender Lambda configuration type.

CustomSMSLambdaVersionConfigType

A custom SMS sender Lambda configuration type.

DeleteGroupRequest
DeleteIdentityProviderRequest
DeleteResourceServerRequest
DeleteUserAttributesRequest

Represents the request to delete user attributes.

DeleteUserPoolClientRequest

Represents the request to delete a user pool client.

DeleteUserPoolDomainRequest
DeleteUserPoolRequest

Represents the request to delete a user pool.

DeleteUserRequest

Represents the request to delete a user.

DescribeIdentityProviderRequest
DescribeIdentityProviderResponse
DescribeResourceServerRequest
DescribeResourceServerResponse
DescribeRiskConfigurationRequest
DescribeRiskConfigurationResponse
DescribeUserImportJobRequest

Represents the request to describe the user import job.

DescribeUserImportJobResponse

Represents the response from the server to the request to describe the user import job.

DescribeUserPoolClientRequest

Represents the request to describe a user pool client.

DescribeUserPoolClientResponse

Represents the response from the server from a request to describe the user pool client.

DescribeUserPoolDomainRequest
DescribeUserPoolDomainResponse
DescribeUserPoolRequest

Represents the request to describe the user pool.

DescribeUserPoolResponse

Represents the response to describe the user pool.

DeviceConfigurationType

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 DeviceOnlyRememberedOnUserPrompt is true, you must follow ConfirmDevice with an UpdateDeviceStatus API request that sets the user's device to remembered or not_remembered.

DeviceSecretVerifierConfigType

The device verifier against which it is authenticated.

DeviceType

The device type.

DomainDescriptionType

A container for information about a domain.

EmailConfigurationType

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.

EventContextDataType

Specifies the user context data captured at the time of an event request.

EventFeedbackType

Specifies the event feedback type.

EventRiskType

The event risk type.

ForgetDeviceRequest

Represents the request to forget the device.

ForgotPasswordRequest

Represents the request to reset a user's password.

ForgotPasswordResponse

The response from Amazon Cognito to a request to reset a password.

GetCSVHeaderRequest

Represents the request to get the header information of the CSV file for the user import job.

GetCSVHeaderResponse

Represents the response from the server to the request to get the header information of the CSV file for the user import job.

GetDeviceRequest

Represents the request to get the device.

GetDeviceResponse

Gets the device response.

GetGroupRequest
GetGroupResponse
GetIdentityProviderByIdentifierRequest
GetIdentityProviderByIdentifierResponse
GetSigningCertificateRequest

Request to get a signing certificate from Amazon Cognito.

GetSigningCertificateResponse

Response from Amazon Cognito for a signing certificate request.

GetUICustomizationRequest
GetUICustomizationResponse
GetUserAttributeVerificationCodeRequest

Represents the request to get user attribute verification.

GetUserAttributeVerificationCodeResponse

The verification code response returned by the server response to get the user attribute verification code.

GetUserPoolMfaConfigRequest
GetUserPoolMfaConfigResponse
GetUserRequest

Represents the request to get information about the user.

GetUserResponse

Represents the response from the server from the request to get information about the user.

GlobalSignOutRequest

Represents the request to sign out all devices.

GroupType

The group type.

HttpHeader

The HTTP header.

IdentityProviderType

A container for information about an IdP.

InitiateAuthRequest

Initiates the authentication request.

InitiateAuthResponse

Initiates the authentication response.

LambdaConfigType

Specifies the configuration for Lambda triggers.

ListDevicesRequest

Represents the request to list the devices.

ListDevicesResponse

Represents the response to list devices.

ListGroupsRequest
ListGroupsResponse
ListIdentityProvidersRequest
ListIdentityProvidersResponse
ListResourceServersRequest
ListResourceServersResponse
ListTagsForResourceRequest
ListTagsForResourceResponse
ListUserImportJobsRequest

Represents the request to list the user import jobs.

ListUserImportJobsResponse

Represents the response from the server to the request to list the user import jobs.

ListUserPoolClientsRequest

Represents the request to list the user pool clients.

ListUserPoolClientsResponse

Represents the response from the server that lists user pool clients.

ListUserPoolsRequest

Represents the request to list user pools.

ListUserPoolsResponse

Represents the response to list user pools.

ListUsersInGroupRequest
ListUsersInGroupResponse
ListUsersRequest

Represents the request to list users.

ListUsersResponse

The response from the request to list users.

MessageTemplateType

The message template structure.

MFAOptionType

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.

NewDeviceMetadataType

The new device metadata type.

NotifyConfigurationType

The notify configuration type.

NotifyEmailType

The notify email type.

NumberAttributeConstraintsType

The minimum and maximum values of an attribute that is of the number data type.

PasswordPolicyType

The password policy type.

ProviderDescription

A container for IdP details.

ProviderUserIdentifierType

A container for information about an IdP for a user pool.

RecoveryOptionType

A map containing a priority as a key, and recovery method name as a value.

ResendConfirmationCodeRequest

Represents the request to resend the confirmation code.

ResendConfirmationCodeResponse

The response from the server when Amazon Cognito makes the request to resend a confirmation code.

ResourceServerScopeType

A resource server scope.

ResourceServerType

A container for information about a resource server for a user pool.

RespondToAuthChallengeRequest

The request to respond to an authentication challenge.

RespondToAuthChallengeResponse

The response to respond to the authentication challenge.

RevokeTokenRequest
RiskConfigurationType

The risk configuration type.

RiskExceptionConfigurationType

The type of the configuration to override the risk decision.

SchemaAttributeType

Contains information about the schema attribute.

SetRiskConfigurationRequest
SetRiskConfigurationResponse
SetUICustomizationRequest
SetUICustomizationResponse
SetUserMFAPreferenceRequest
SetUserPoolMfaConfigRequest
SetUserPoolMfaConfigResponse
SetUserSettingsRequest

Represents the request to set user settings.

SignUpRequest

Represents the request to register a user.

SignUpResponse

The response from the server for a registration request.

SmsConfigurationType

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.

SmsMfaConfigType

The SMS text message multi-factor authentication (MFA) configuration type.

SMSMfaSettingsType

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.

SoftwareTokenMfaConfigType

The type used for enabling software token MFA at the user pool level.

SoftwareTokenMfaSettingsType

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.

StartUserImportJobRequest

Represents the request to start the user import job.

StartUserImportJobResponse

Represents the response from the server to the request to start the user import job.

StopUserImportJobRequest

Represents the request to stop the user import job.

StopUserImportJobResponse

Represents the response from the server to the request to stop the user import job.

StringAttributeConstraintsType

The constraints associated with a string attribute.

TagResourceRequest
TokenValidityUnitsType

The data type TokenValidityUnits specifies the time units you use when you set the duration of ID, access, and refresh tokens.

UICustomizationType

A container for the UI customization information for a user pool's built-in app UI.

UntagResourceRequest
UpdateAuthEventFeedbackRequest
UpdateDeviceStatusRequest

Represents the request to update the device status.

UpdateGroupRequest
UpdateGroupResponse
UpdateIdentityProviderRequest
UpdateIdentityProviderResponse
UpdateResourceServerRequest
UpdateResourceServerResponse
UpdateUserAttributesRequest

Represents the request to update user attributes.

UpdateUserAttributesResponse

Represents the response from the server for the request to update user attributes.

UpdateUserPoolClientRequest

Represents the request to update the user pool client.

UpdateUserPoolClientResponse

Represents the response from the server to the request to update the user pool client.

UpdateUserPoolDomainRequest

The UpdateUserPoolDomain request input.

UpdateUserPoolDomainResponse

The UpdateUserPoolDomain response output.

UpdateUserPoolRequest

Represents the request to update the user pool.

UserAttributeUpdateSettingsType

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, 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.

UserContextDataType

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.

UserImportJobType

The user import job type.

UsernameConfigurationType

The username configuration type.

UserPoolAddOnsType

The user pool add-ons type.

UserPoolClientDescription

The description of the user pool client.

UserPoolClientType

Contains information about a user pool client.

UserPoolDescriptionType

A user pool description.

UserPoolPolicyType

The policy associated with a user pool.

UserPoolType

A container for information about the user pool.

UserType

A user profile in a Amazon Cognito user pool.

VerificationMessageTemplateType

The template for verification messages.

VerifySoftwareTokenRequest
VerifySoftwareTokenResponse
VerifyUserAttributeRequest

Represents the request to verify user attributes.

§Type Aliases

AccountTakeoverEventActionType
AdvancedSecurityModeType
AliasAttributeType
AttributeDataType
AuthFlowType
ChallengeName
ChallengeNameType
ChallengeResponse
CompromisedCredentialsEventActionType
CustomEmailSenderLambdaVersionType
CustomSMSSenderLambdaVersionType
DefaultEmailOptionType
DeletionProtectionType
DeliveryMediumType
DeviceRememberedStatusType
DomainStatusType
EmailSendingAccountType
EventFilterType
EventResponseType
EventType
ExplicitAuthFlowsType
FeedbackValueType
IdentityProviderTypeType
MessageActionType
OAuthFlowType
PreventUserExistenceErrorTypes
RecoveryOptionNameType
RiskDecisionType
RiskLevelType
StatusType
TimeUnitsType
UserImportJobStatusType
UsernameAttributeType
UserPoolMfaType
UserStatusType
VerifiedAttributeType
VerifySoftwareTokenResponseType