const (
    // AccountTakeoverEventActionTypeBlock is a AccountTakeoverEventActionType enum value
    AccountTakeoverEventActionTypeBlock = "BLOCK"

    // AccountTakeoverEventActionTypeMfaIfConfigured is a AccountTakeoverEventActionType enum value
    AccountTakeoverEventActionTypeMfaIfConfigured = "MFA_IF_CONFIGURED"

    // AccountTakeoverEventActionTypeMfaRequired is a AccountTakeoverEventActionType enum value
    AccountTakeoverEventActionTypeMfaRequired = "MFA_REQUIRED"

    // AccountTakeoverEventActionTypeNoAction is a AccountTakeoverEventActionType enum value
    AccountTakeoverEventActionTypeNoAction = "NO_ACTION"
)

const (
    // AdvancedSecurityModeTypeOff is a AdvancedSecurityModeType enum value
    AdvancedSecurityModeTypeOff = "OFF"

    // AdvancedSecurityModeTypeAudit is a AdvancedSecurityModeType enum value
    AdvancedSecurityModeTypeAudit = "AUDIT"

    // AdvancedSecurityModeTypeEnforced is a AdvancedSecurityModeType enum value
    AdvancedSecurityModeTypeEnforced = "ENFORCED"
)

const (
    // AliasAttributeTypePhoneNumber is a AliasAttributeType enum value
    AliasAttributeTypePhoneNumber = "phone_number"

    // AliasAttributeTypeEmail is a AliasAttributeType enum value
    AliasAttributeTypeEmail = "email"

    // AliasAttributeTypePreferredUsername is a AliasAttributeType enum value
    AliasAttributeTypePreferredUsername = "preferred_username"
)

const (
    // AttributeDataTypeString is a AttributeDataType enum value
    AttributeDataTypeString = "String"

    // AttributeDataTypeNumber is a AttributeDataType enum value
    AttributeDataTypeNumber = "Number"

    // AttributeDataTypeDateTime is a AttributeDataType enum value
    AttributeDataTypeDateTime = "DateTime"

    // AttributeDataTypeBoolean is a AttributeDataType enum value
    AttributeDataTypeBoolean = "Boolean"
)

const (
    // AuthFlowTypeUserSrpAuth is a AuthFlowType enum value
    AuthFlowTypeUserSrpAuth = "USER_SRP_AUTH"

    // AuthFlowTypeRefreshTokenAuth is a AuthFlowType enum value
    AuthFlowTypeRefreshTokenAuth = "REFRESH_TOKEN_AUTH"

    // AuthFlowTypeRefreshToken is a AuthFlowType enum value
    AuthFlowTypeRefreshToken = "REFRESH_TOKEN"

    // AuthFlowTypeCustomAuth is a AuthFlowType enum value
    AuthFlowTypeCustomAuth = "CUSTOM_AUTH"

    // AuthFlowTypeAdminNoSrpAuth is a AuthFlowType enum value
    AuthFlowTypeAdminNoSrpAuth = "ADMIN_NO_SRP_AUTH"

    // AuthFlowTypeUserPasswordAuth is a AuthFlowType enum value
    AuthFlowTypeUserPasswordAuth = "USER_PASSWORD_AUTH"

    // AuthFlowTypeAdminUserPasswordAuth is a AuthFlowType enum value
    AuthFlowTypeAdminUserPasswordAuth = "ADMIN_USER_PASSWORD_AUTH"
)

const (
    // ChallengeNamePassword is a ChallengeName enum value
    ChallengeNamePassword = "Password"

    // ChallengeNameMfa is a ChallengeName enum value
    ChallengeNameMfa = "Mfa"
)

const (
    // ChallengeNameTypeSmsMfa is a ChallengeNameType enum value
    ChallengeNameTypeSmsMfa = "SMS_MFA"

    // ChallengeNameTypeSoftwareTokenMfa is a ChallengeNameType enum value
    ChallengeNameTypeSoftwareTokenMfa = "SOFTWARE_TOKEN_MFA"

    // ChallengeNameTypeSelectMfaType is a ChallengeNameType enum value
    ChallengeNameTypeSelectMfaType = "SELECT_MFA_TYPE"

    // ChallengeNameTypeMfaSetup is a ChallengeNameType enum value
    ChallengeNameTypeMfaSetup = "MFA_SETUP"

    // ChallengeNameTypePasswordVerifier is a ChallengeNameType enum value
    ChallengeNameTypePasswordVerifier = "PASSWORD_VERIFIER"

    // ChallengeNameTypeCustomChallenge is a ChallengeNameType enum value
    ChallengeNameTypeCustomChallenge = "CUSTOM_CHALLENGE"

    // ChallengeNameTypeDeviceSrpAuth is a ChallengeNameType enum value
    ChallengeNameTypeDeviceSrpAuth = "DEVICE_SRP_AUTH"

    // ChallengeNameTypeDevicePasswordVerifier is a ChallengeNameType enum value
    ChallengeNameTypeDevicePasswordVerifier = "DEVICE_PASSWORD_VERIFIER"

    // ChallengeNameTypeAdminNoSrpAuth is a ChallengeNameType enum value
    ChallengeNameTypeAdminNoSrpAuth = "ADMIN_NO_SRP_AUTH"

    // ChallengeNameTypeNewPasswordRequired is a ChallengeNameType enum value
    ChallengeNameTypeNewPasswordRequired = "NEW_PASSWORD_REQUIRED"
)

const (
    // ChallengeResponseSuccess is a ChallengeResponse enum value
    ChallengeResponseSuccess = "Success"

    // ChallengeResponseFailure is a ChallengeResponse enum value
    ChallengeResponseFailure = "Failure"
)

const (
    // CompromisedCredentialsEventActionTypeBlock is a CompromisedCredentialsEventActionType enum value
    CompromisedCredentialsEventActionTypeBlock = "BLOCK"

    // CompromisedCredentialsEventActionTypeNoAction is a CompromisedCredentialsEventActionType enum value
    CompromisedCredentialsEventActionTypeNoAction = "NO_ACTION"
)

const (
    // DefaultEmailOptionTypeConfirmWithLink is a DefaultEmailOptionType enum value
    DefaultEmailOptionTypeConfirmWithLink = "CONFIRM_WITH_LINK"

    // DefaultEmailOptionTypeConfirmWithCode is a DefaultEmailOptionType enum value
    DefaultEmailOptionTypeConfirmWithCode = "CONFIRM_WITH_CODE"
)

const (
    // DeletionProtectionTypeActive is a DeletionProtectionType enum value
    DeletionProtectionTypeActive = "ACTIVE"

    // DeletionProtectionTypeInactive is a DeletionProtectionType enum value
    DeletionProtectionTypeInactive = "INACTIVE"
)

const (
    // DeliveryMediumTypeSms is a DeliveryMediumType enum value
    DeliveryMediumTypeSms = "SMS"

    // DeliveryMediumTypeEmail is a DeliveryMediumType enum value
    DeliveryMediumTypeEmail = "EMAIL"
)

const (
    // DeviceRememberedStatusTypeRemembered is a DeviceRememberedStatusType enum value
    DeviceRememberedStatusTypeRemembered = "remembered"

    // DeviceRememberedStatusTypeNotRemembered is a DeviceRememberedStatusType enum value
    DeviceRememberedStatusTypeNotRemembered = "not_remembered"
)

const (
    // DomainStatusTypeCreating is a DomainStatusType enum value
    DomainStatusTypeCreating = "CREATING"

    // DomainStatusTypeDeleting is a DomainStatusType enum value
    DomainStatusTypeDeleting = "DELETING"

    // DomainStatusTypeUpdating is a DomainStatusType enum value
    DomainStatusTypeUpdating = "UPDATING"

    // DomainStatusTypeActive is a DomainStatusType enum value
    DomainStatusTypeActive = "ACTIVE"

    // DomainStatusTypeFailed is a DomainStatusType enum value
    DomainStatusTypeFailed = "FAILED"
)

const (
    // EmailSendingAccountTypeCognitoDefault is a EmailSendingAccountType enum value
    EmailSendingAccountTypeCognitoDefault = "COGNITO_DEFAULT"

    // EmailSendingAccountTypeDeveloper is a EmailSendingAccountType enum value
    EmailSendingAccountTypeDeveloper = "DEVELOPER"
)

const (
    // EventFilterTypeSignIn is a EventFilterType enum value
    EventFilterTypeSignIn = "SIGN_IN"

    // EventFilterTypePasswordChange is a EventFilterType enum value
    EventFilterTypePasswordChange = "PASSWORD_CHANGE"

    // EventFilterTypeSignUp is a EventFilterType enum value
    EventFilterTypeSignUp = "SIGN_UP"
)

const (
    // EventResponseTypePass is a EventResponseType enum value
    EventResponseTypePass = "Pass"

    // EventResponseTypeFail is a EventResponseType enum value
    EventResponseTypeFail = "Fail"

    // EventResponseTypeInProgress is a EventResponseType enum value
    EventResponseTypeInProgress = "InProgress"
)

const (
    // EventTypeSignIn is a EventType enum value
    EventTypeSignIn = "SignIn"

    // EventTypeSignUp is a EventType enum value
    EventTypeSignUp = "SignUp"

    // EventTypeForgotPassword is a EventType enum value
    EventTypeForgotPassword = "ForgotPassword"

    // EventTypePasswordChange is a EventType enum value
    EventTypePasswordChange = "PasswordChange"

    // EventTypeResendCode is a EventType enum value
    EventTypeResendCode = "ResendCode"
)

const (
    // ExplicitAuthFlowsTypeAdminNoSrpAuth is a ExplicitAuthFlowsType enum value
    ExplicitAuthFlowsTypeAdminNoSrpAuth = "ADMIN_NO_SRP_AUTH"

    // ExplicitAuthFlowsTypeCustomAuthFlowOnly is a ExplicitAuthFlowsType enum value
    ExplicitAuthFlowsTypeCustomAuthFlowOnly = "CUSTOM_AUTH_FLOW_ONLY"

    // ExplicitAuthFlowsTypeUserPasswordAuth is a ExplicitAuthFlowsType enum value
    ExplicitAuthFlowsTypeUserPasswordAuth = "USER_PASSWORD_AUTH"

    // ExplicitAuthFlowsTypeAllowAdminUserPasswordAuth is a ExplicitAuthFlowsType enum value
    ExplicitAuthFlowsTypeAllowAdminUserPasswordAuth = "ALLOW_ADMIN_USER_PASSWORD_AUTH"

    // ExplicitAuthFlowsTypeAllowCustomAuth is a ExplicitAuthFlowsType enum value
    ExplicitAuthFlowsTypeAllowCustomAuth = "ALLOW_CUSTOM_AUTH"

    // ExplicitAuthFlowsTypeAllowUserPasswordAuth is a ExplicitAuthFlowsType enum value
    ExplicitAuthFlowsTypeAllowUserPasswordAuth = "ALLOW_USER_PASSWORD_AUTH"

    // ExplicitAuthFlowsTypeAllowUserSrpAuth is a ExplicitAuthFlowsType enum value
    ExplicitAuthFlowsTypeAllowUserSrpAuth = "ALLOW_USER_SRP_AUTH"

    // ExplicitAuthFlowsTypeAllowRefreshTokenAuth is a ExplicitAuthFlowsType enum value
    ExplicitAuthFlowsTypeAllowRefreshTokenAuth = "ALLOW_REFRESH_TOKEN_AUTH"
)

const (
    // FeedbackValueTypeValid is a FeedbackValueType enum value
    FeedbackValueTypeValid = "Valid"

    // FeedbackValueTypeInvalid is a FeedbackValueType enum value
    FeedbackValueTypeInvalid = "Invalid"
)

const (
    // IdentityProviderTypeTypeSaml is a IdentityProviderTypeType enum value
    IdentityProviderTypeTypeSaml = "SAML"

    // IdentityProviderTypeTypeFacebook is a IdentityProviderTypeType enum value
    IdentityProviderTypeTypeFacebook = "Facebook"

    // IdentityProviderTypeTypeGoogle is a IdentityProviderTypeType enum value
    IdentityProviderTypeTypeGoogle = "Google"

    // IdentityProviderTypeTypeLoginWithAmazon is a IdentityProviderTypeType enum value
    IdentityProviderTypeTypeLoginWithAmazon = "LoginWithAmazon"

    // IdentityProviderTypeTypeSignInWithApple is a IdentityProviderTypeType enum value
    IdentityProviderTypeTypeSignInWithApple = "SignInWithApple"

    // IdentityProviderTypeTypeOidc is a IdentityProviderTypeType enum value
    IdentityProviderTypeTypeOidc = "OIDC"
)

const (
    // MessageActionTypeResend is a MessageActionType enum value
    MessageActionTypeResend = "RESEND"

    // MessageActionTypeSuppress is a MessageActionType enum value
    MessageActionTypeSuppress = "SUPPRESS"
)

const (
    // OAuthFlowTypeCode is a OAuthFlowType enum value
    OAuthFlowTypeCode = "code"

    // OAuthFlowTypeImplicit is a OAuthFlowType enum value
    OAuthFlowTypeImplicit = "implicit"

    // OAuthFlowTypeClientCredentials is a OAuthFlowType enum value
    OAuthFlowTypeClientCredentials = "client_credentials"
)

const (
    // PreventUserExistenceErrorTypesLegacy is a PreventUserExistenceErrorTypes enum value
    PreventUserExistenceErrorTypesLegacy = "LEGACY"

    // PreventUserExistenceErrorTypesEnabled is a PreventUserExistenceErrorTypes enum value
    PreventUserExistenceErrorTypesEnabled = "ENABLED"
)

const (
    // RecoveryOptionNameTypeVerifiedEmail is a RecoveryOptionNameType enum value
    RecoveryOptionNameTypeVerifiedEmail = "verified_email"

    // RecoveryOptionNameTypeVerifiedPhoneNumber is a RecoveryOptionNameType enum value
    RecoveryOptionNameTypeVerifiedPhoneNumber = "verified_phone_number"

    // RecoveryOptionNameTypeAdminOnly is a RecoveryOptionNameType enum value
    RecoveryOptionNameTypeAdminOnly = "admin_only"
)

const (
    // RiskDecisionTypeNoRisk is a RiskDecisionType enum value
    RiskDecisionTypeNoRisk = "NoRisk"

    // RiskDecisionTypeAccountTakeover is a RiskDecisionType enum value
    RiskDecisionTypeAccountTakeover = "AccountTakeover"

    // RiskDecisionTypeBlock is a RiskDecisionType enum value
    RiskDecisionTypeBlock = "Block"
)

const (
    // RiskLevelTypeLow is a RiskLevelType enum value
    RiskLevelTypeLow = "Low"

    // RiskLevelTypeMedium is a RiskLevelType enum value
    RiskLevelTypeMedium = "Medium"

    // RiskLevelTypeHigh is a RiskLevelType enum value
    RiskLevelTypeHigh = "High"
)

const (
    // StatusTypeEnabled is a StatusType enum value
    StatusTypeEnabled = "Enabled"

    // StatusTypeDisabled is a StatusType enum value
    StatusTypeDisabled = "Disabled"
)

const (
    // TimeUnitsTypeSeconds is a TimeUnitsType enum value
    TimeUnitsTypeSeconds = "seconds"

    // TimeUnitsTypeMinutes is a TimeUnitsType enum value
    TimeUnitsTypeMinutes = "minutes"

    // TimeUnitsTypeHours is a TimeUnitsType enum value
    TimeUnitsTypeHours = "hours"

    // TimeUnitsTypeDays is a TimeUnitsType enum value
    TimeUnitsTypeDays = "days"
)

const (
    // UserImportJobStatusTypeCreated is a UserImportJobStatusType enum value
    UserImportJobStatusTypeCreated = "Created"

    // UserImportJobStatusTypePending is a UserImportJobStatusType enum value
    UserImportJobStatusTypePending = "Pending"

    // UserImportJobStatusTypeInProgress is a UserImportJobStatusType enum value
    UserImportJobStatusTypeInProgress = "InProgress"

    // UserImportJobStatusTypeStopping is a UserImportJobStatusType enum value
    UserImportJobStatusTypeStopping = "Stopping"

    // UserImportJobStatusTypeExpired is a UserImportJobStatusType enum value
    UserImportJobStatusTypeExpired = "Expired"

    // UserImportJobStatusTypeStopped is a UserImportJobStatusType enum value
    UserImportJobStatusTypeStopped = "Stopped"

    // UserImportJobStatusTypeFailed is a UserImportJobStatusType enum value
    UserImportJobStatusTypeFailed = "Failed"

    // UserImportJobStatusTypeSucceeded is a UserImportJobStatusType enum value
    UserImportJobStatusTypeSucceeded = "Succeeded"
)

const (
    // UserPoolMfaTypeOff is a UserPoolMfaType enum value
    UserPoolMfaTypeOff = "OFF"

    // UserPoolMfaTypeOn is a UserPoolMfaType enum value
    UserPoolMfaTypeOn = "ON"

    // UserPoolMfaTypeOptional is a UserPoolMfaType enum value
    UserPoolMfaTypeOptional = "OPTIONAL"
)

const (
    // UserStatusTypeUnconfirmed is a UserStatusType enum value
    UserStatusTypeUnconfirmed = "UNCONFIRMED"

    // UserStatusTypeConfirmed is a UserStatusType enum value
    UserStatusTypeConfirmed = "CONFIRMED"

    // UserStatusTypeArchived is a UserStatusType enum value
    UserStatusTypeArchived = "ARCHIVED"

    // UserStatusTypeCompromised is a UserStatusType enum value
    UserStatusTypeCompromised = "COMPROMISED"

    // UserStatusTypeUnknown is a UserStatusType enum value
    UserStatusTypeUnknown = "UNKNOWN"

    // UserStatusTypeResetRequired is a UserStatusType enum value
    UserStatusTypeResetRequired = "RESET_REQUIRED"

    // UserStatusTypeForceChangePassword is a UserStatusType enum value
    UserStatusTypeForceChangePassword = "FORCE_CHANGE_PASSWORD"
)

const (
    // UsernameAttributeTypePhoneNumber is a UsernameAttributeType enum value
    UsernameAttributeTypePhoneNumber = "phone_number"

    // UsernameAttributeTypeEmail is a UsernameAttributeType enum value
    UsernameAttributeTypeEmail = "email"
)

const (
    // VerifiedAttributeTypePhoneNumber is a VerifiedAttributeType enum value
    VerifiedAttributeTypePhoneNumber = "phone_number"

    // VerifiedAttributeTypeEmail is a VerifiedAttributeType enum value
    VerifiedAttributeTypeEmail = "email"
)

const (
    // VerifySoftwareTokenResponseTypeSuccess is a VerifySoftwareTokenResponseType enum value
    VerifySoftwareTokenResponseTypeSuccess = "SUCCESS"

    // VerifySoftwareTokenResponseTypeError is a VerifySoftwareTokenResponseType enum value
    VerifySoftwareTokenResponseTypeError = "ERROR"
)

const (

    // ErrCodeAliasExistsException for service response error code
    // "AliasExistsException".
    //
    // This exception is thrown when a user tries to confirm the account with an
    // email address or phone number that has already been supplied as an alias
    // for a different user profile. This exception indicates that an account with
    // this email address or phone already exists in a user pool that you've configured
    // to use email address or phone number as a sign-in alias.
    ErrCodeAliasExistsException = "AliasExistsException"

    // ErrCodeCodeDeliveryFailureException for service response error code
    // "CodeDeliveryFailureException".
    //
    // This exception is thrown when a verification code fails to deliver successfully.
    ErrCodeCodeDeliveryFailureException = "CodeDeliveryFailureException"

    // ErrCodeCodeMismatchException for service response error code
    // "CodeMismatchException".
    //
    // This exception is thrown if the provided code doesn't match what the server
    // was expecting.
    ErrCodeCodeMismatchException = "CodeMismatchException"

    // ErrCodeConcurrentModificationException for service response error code
    // "ConcurrentModificationException".
    //
    // This exception is thrown if two or more modifications are happening concurrently.
    ErrCodeConcurrentModificationException = "ConcurrentModificationException"

    // ErrCodeDuplicateProviderException for service response error code
    // "DuplicateProviderException".
    //
    // This exception is thrown when the provider is already supported by the user
    // pool.
    ErrCodeDuplicateProviderException = "DuplicateProviderException"

    // ErrCodeEnableSoftwareTokenMFAException for service response error code
    // "EnableSoftwareTokenMFAException".
    //
    // This exception is thrown when there is a code mismatch and the service fails
    // to configure the software token TOTP multi-factor authentication (MFA).
    ErrCodeEnableSoftwareTokenMFAException = "EnableSoftwareTokenMFAException"

    // ErrCodeExpiredCodeException for service response error code
    // "ExpiredCodeException".
    //
    // This exception is thrown if a code has expired.
    ErrCodeExpiredCodeException = "ExpiredCodeException"

    // ErrCodeForbiddenException for service response error code
    // "ForbiddenException".
    //
    // This exception is thrown when WAF doesn't allow your request based on a web
    // ACL that's associated with your user pool.
    ErrCodeForbiddenException = "ForbiddenException"

    // ErrCodeGroupExistsException for service response error code
    // "GroupExistsException".
    //
    // This exception is thrown when Amazon Cognito encounters a group that already
    // exists in the user pool.
    ErrCodeGroupExistsException = "GroupExistsException"

    // ErrCodeInternalErrorException for service response error code
    // "InternalErrorException".
    //
    // This exception is thrown when Amazon Cognito encounters an internal error.
    ErrCodeInternalErrorException = "InternalErrorException"

    // ErrCodeInvalidEmailRoleAccessPolicyException for service response error code
    // "InvalidEmailRoleAccessPolicyException".
    //
    // This exception is thrown when Amazon Cognito isn't allowed to use your email
    // identity. HTTP status code: 400.
    ErrCodeInvalidEmailRoleAccessPolicyException = "InvalidEmailRoleAccessPolicyException"

    // ErrCodeInvalidLambdaResponseException for service response error code
    // "InvalidLambdaResponseException".
    //
    // This exception is thrown when Amazon Cognito encounters an invalid Lambda
    // response.
    ErrCodeInvalidLambdaResponseException = "InvalidLambdaResponseException"

    // ErrCodeInvalidOAuthFlowException for service response error code
    // "InvalidOAuthFlowException".
    //
    // This exception is thrown when the specified OAuth flow is not valid.
    ErrCodeInvalidOAuthFlowException = "InvalidOAuthFlowException"

    // ErrCodeInvalidParameterException for service response error code
    // "InvalidParameterException".
    //
    // This exception is thrown when the Amazon Cognito service encounters an invalid
    // parameter.
    ErrCodeInvalidParameterException = "InvalidParameterException"

    // ErrCodeInvalidPasswordException for service response error code
    // "InvalidPasswordException".
    //
    // This exception is thrown when Amazon Cognito encounters an invalid password.
    ErrCodeInvalidPasswordException = "InvalidPasswordException"

    // ErrCodeInvalidSmsRoleAccessPolicyException for service response error code
    // "InvalidSmsRoleAccessPolicyException".
    //
    // This exception is returned when the role provided for SMS configuration doesn't
    // have permission to publish using Amazon SNS.
    ErrCodeInvalidSmsRoleAccessPolicyException = "InvalidSmsRoleAccessPolicyException"

    // ErrCodeInvalidSmsRoleTrustRelationshipException for service response error code
    // "InvalidSmsRoleTrustRelationshipException".
    //
    // This exception is thrown when the trust relationship is not valid for the
    // role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com
    // or the external ID provided in the role does not match what is provided in
    // the SMS configuration for the user pool.
    ErrCodeInvalidSmsRoleTrustRelationshipException = "InvalidSmsRoleTrustRelationshipException"

    // ErrCodeInvalidUserPoolConfigurationException for service response error code
    // "InvalidUserPoolConfigurationException".
    //
    // This exception is thrown when the user pool configuration is not valid.
    ErrCodeInvalidUserPoolConfigurationException = "InvalidUserPoolConfigurationException"

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // This exception is thrown when a user exceeds the limit for a requested Amazon
    // Web Services resource.
    ErrCodeLimitExceededException = "LimitExceededException"

    // ErrCodeMFAMethodNotFoundException for service response error code
    // "MFAMethodNotFoundException".
    //
    // This exception is thrown when Amazon Cognito can't find a multi-factor authentication
    // (MFA) method.
    ErrCodeMFAMethodNotFoundException = "MFAMethodNotFoundException"

    // ErrCodeNotAuthorizedException for service response error code
    // "NotAuthorizedException".
    //
    // This exception is thrown when a user isn't authorized.
    ErrCodeNotAuthorizedException = "NotAuthorizedException"

    // ErrCodePasswordResetRequiredException for service response error code
    // "PasswordResetRequiredException".
    //
    // This exception is thrown when a password reset is required.
    ErrCodePasswordResetRequiredException = "PasswordResetRequiredException"

    // ErrCodePreconditionNotMetException for service response error code
    // "PreconditionNotMetException".
    //
    // This exception is thrown when a precondition is not met.
    ErrCodePreconditionNotMetException = "PreconditionNotMetException"

    // ErrCodeResourceNotFoundException for service response error code
    // "ResourceNotFoundException".
    //
    // This exception is thrown when the Amazon Cognito service can't find the requested
    // resource.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

    // ErrCodeScopeDoesNotExistException for service response error code
    // "ScopeDoesNotExistException".
    //
    // This exception is thrown when the specified scope doesn't exist.
    ErrCodeScopeDoesNotExistException = "ScopeDoesNotExistException"

    // ErrCodeSoftwareTokenMFANotFoundException for service response error code
    // "SoftwareTokenMFANotFoundException".
    //
    // This exception is thrown when the software token time-based one-time password
    // (TOTP) multi-factor authentication (MFA) isn't activated for the user pool.
    ErrCodeSoftwareTokenMFANotFoundException = "SoftwareTokenMFANotFoundException"

    // ErrCodeTooManyFailedAttemptsException for service response error code
    // "TooManyFailedAttemptsException".
    //
    // This exception is thrown when the user has made too many failed attempts
    // for a given action, such as sign-in.
    ErrCodeTooManyFailedAttemptsException = "TooManyFailedAttemptsException"

    // ErrCodeTooManyRequestsException for service response error code
    // "TooManyRequestsException".
    //
    // This exception is thrown when the user has made too many requests for a given
    // operation.
    ErrCodeTooManyRequestsException = "TooManyRequestsException"

    // ErrCodeUnauthorizedException for service response error code
    // "UnauthorizedException".
    //
    // Exception that is thrown when the request isn't authorized. This can happen
    // due to an invalid access token in the request.
    ErrCodeUnauthorizedException = "UnauthorizedException"

    // ErrCodeUnexpectedLambdaException for service response error code
    // "UnexpectedLambdaException".
    //
    // This exception is thrown when Amazon Cognito encounters an unexpected exception
    // with Lambda.
    ErrCodeUnexpectedLambdaException = "UnexpectedLambdaException"

    // ErrCodeUnsupportedIdentityProviderException for service response error code
    // "UnsupportedIdentityProviderException".
    //
    // This exception is thrown when the specified identifier isn't supported.
    ErrCodeUnsupportedIdentityProviderException = "UnsupportedIdentityProviderException"

    // ErrCodeUnsupportedOperationException for service response error code
    // "UnsupportedOperationException".
    //
    // Exception that is thrown when you attempt to perform an operation that isn't
    // enabled for the user pool client.
    ErrCodeUnsupportedOperationException = "UnsupportedOperationException"

    // ErrCodeUnsupportedTokenTypeException for service response error code
    // "UnsupportedTokenTypeException".
    //
    // Exception that is thrown when an unsupported token is passed to an operation.
    ErrCodeUnsupportedTokenTypeException = "UnsupportedTokenTypeException"

    // ErrCodeUnsupportedUserStateException for service response error code
    // "UnsupportedUserStateException".
    //
    // The request failed because the user is in an unsupported state.
    ErrCodeUnsupportedUserStateException = "UnsupportedUserStateException"

    // ErrCodeUserImportInProgressException for service response error code
    // "UserImportInProgressException".
    //
    // This exception is thrown when you're trying to modify a user pool while a
    // user import job is in progress for that pool.
    ErrCodeUserImportInProgressException = "UserImportInProgressException"

    // ErrCodeUserLambdaValidationException for service response error code
    // "UserLambdaValidationException".
    //
    // This exception is thrown when the Amazon Cognito service encounters a user
    // validation exception with the Lambda service.
    ErrCodeUserLambdaValidationException = "UserLambdaValidationException"

    // ErrCodeUserNotConfirmedException for service response error code
    // "UserNotConfirmedException".
    //
    // This exception is thrown when a user isn't confirmed successfully.
    ErrCodeUserNotConfirmedException = "UserNotConfirmedException"

    // ErrCodeUserNotFoundException for service response error code
    // "UserNotFoundException".
    //
    // This exception is thrown when a user isn't found.
    ErrCodeUserNotFoundException = "UserNotFoundException"

    // ErrCodeUserPoolAddOnNotEnabledException for service response error code
    // "UserPoolAddOnNotEnabledException".
    //
    // This exception is thrown when user pool add-ons aren't enabled.
    ErrCodeUserPoolAddOnNotEnabledException = "UserPoolAddOnNotEnabledException"

    // ErrCodeUserPoolTaggingException for service response error code
    // "UserPoolTaggingException".
    //
    // This exception is thrown when a user pool tag can't be set or updated.
    ErrCodeUserPoolTaggingException = "UserPoolTaggingException"

    // ErrCodeUsernameExistsException for service response error code
    // "UsernameExistsException".
    //
    // This exception is thrown when Amazon Cognito encounters a user name that
    // already exists in the user pool.
    ErrCodeUsernameExistsException = "UsernameExistsException"
)

const (
    ServiceName = "cognito-idp"               // Name of service.
    EndpointsID = ServiceName                 // ID to lookup a service endpoint with.
    ServiceID   = "Cognito Identity Provider" // ServiceID is a unique identifier of a specific service.
)

const (
    // CustomEmailSenderLambdaVersionTypeV10 is a CustomEmailSenderLambdaVersionType enum value
    CustomEmailSenderLambdaVersionTypeV10 = "V1_0"
)

const (
    // CustomSMSSenderLambdaVersionTypeV10 is a CustomSMSSenderLambdaVersionType enum value
    CustomSMSSenderLambdaVersionTypeV10 = "V1_0"
)

const (
    // EventSourceNameUserNotification is a EventSourceName enum value
    EventSourceNameUserNotification = "userNotification"
)

const (
    // LogLevelError is a LogLevel enum value
    LogLevelError = "ERROR"
)

func AccountTakeoverEventActionType_Values ¶

func AccountTakeoverEventActionType_Values() []string

AccountTakeoverEventActionType_Values returns all elements of the AccountTakeoverEventActionType enum

func AdvancedSecurityModeType_Values ¶

func AdvancedSecurityModeType_Values() []string

AdvancedSecurityModeType_Values returns all elements of the AdvancedSecurityModeType enum

func AliasAttributeType_Values ¶

func AliasAttributeType_Values() []string

AliasAttributeType_Values returns all elements of the AliasAttributeType enum

func AttributeDataType_Values ¶

func AttributeDataType_Values() []string

AttributeDataType_Values returns all elements of the AttributeDataType enum

func AuthFlowType_Values ¶

func AuthFlowType_Values() []string

AuthFlowType_Values returns all elements of the AuthFlowType enum

func ChallengeNameType_Values ¶

func ChallengeNameType_Values() []string

ChallengeNameType_Values returns all elements of the ChallengeNameType enum

func ChallengeName_Values ¶

func ChallengeName_Values() []string

ChallengeName_Values returns all elements of the ChallengeName enum

func ChallengeResponse_Values ¶

func ChallengeResponse_Values() []string

ChallengeResponse_Values returns all elements of the ChallengeResponse enum

func CompromisedCredentialsEventActionType_Values ¶

func CompromisedCredentialsEventActionType_Values() []string

CompromisedCredentialsEventActionType_Values returns all elements of the CompromisedCredentialsEventActionType enum

func CustomEmailSenderLambdaVersionType_Values ¶

func CustomEmailSenderLambdaVersionType_Values() []string

CustomEmailSenderLambdaVersionType_Values returns all elements of the CustomEmailSenderLambdaVersionType enum

func CustomSMSSenderLambdaVersionType_Values ¶

func CustomSMSSenderLambdaVersionType_Values() []string

CustomSMSSenderLambdaVersionType_Values returns all elements of the CustomSMSSenderLambdaVersionType enum

func DefaultEmailOptionType_Values ¶

func DefaultEmailOptionType_Values() []string

DefaultEmailOptionType_Values returns all elements of the DefaultEmailOptionType enum

func DeletionProtectionType_Values ¶

func DeletionProtectionType_Values() []string

DeletionProtectionType_Values returns all elements of the DeletionProtectionType enum

func DeliveryMediumType_Values ¶

func DeliveryMediumType_Values() []string

DeliveryMediumType_Values returns all elements of the DeliveryMediumType enum

func DeviceRememberedStatusType_Values ¶

func DeviceRememberedStatusType_Values() []string

DeviceRememberedStatusType_Values returns all elements of the DeviceRememberedStatusType enum

func DomainStatusType_Values ¶

func DomainStatusType_Values() []string

DomainStatusType_Values returns all elements of the DomainStatusType enum

func EmailSendingAccountType_Values ¶

func EmailSendingAccountType_Values() []string

EmailSendingAccountType_Values returns all elements of the EmailSendingAccountType enum

func EventFilterType_Values ¶

func EventFilterType_Values() []string

EventFilterType_Values returns all elements of the EventFilterType enum

func EventResponseType_Values ¶

func EventResponseType_Values() []string

EventResponseType_Values returns all elements of the EventResponseType enum

func EventSourceName_Values ¶

func EventSourceName_Values() []string

EventSourceName_Values returns all elements of the EventSourceName enum

func EventType_Values ¶

func EventType_Values() []string

EventType_Values returns all elements of the EventType enum

func ExplicitAuthFlowsType_Values ¶

func ExplicitAuthFlowsType_Values() []string

ExplicitAuthFlowsType_Values returns all elements of the ExplicitAuthFlowsType enum

func FeedbackValueType_Values ¶

func FeedbackValueType_Values() []string

FeedbackValueType_Values returns all elements of the FeedbackValueType enum

func IdentityProviderTypeType_Values ¶

func IdentityProviderTypeType_Values() []string

IdentityProviderTypeType_Values returns all elements of the IdentityProviderTypeType enum

func LogLevel_Values ¶

func LogLevel_Values() []string

LogLevel_Values returns all elements of the LogLevel enum

func MessageActionType_Values ¶

func MessageActionType_Values() []string

MessageActionType_Values returns all elements of the MessageActionType enum

func OAuthFlowType_Values ¶

func OAuthFlowType_Values() []string

OAuthFlowType_Values returns all elements of the OAuthFlowType enum

func PreventUserExistenceErrorTypes_Values ¶

func PreventUserExistenceErrorTypes_Values() []string

PreventUserExistenceErrorTypes_Values returns all elements of the PreventUserExistenceErrorTypes enum

func RecoveryOptionNameType_Values ¶

func RecoveryOptionNameType_Values() []string

RecoveryOptionNameType_Values returns all elements of the RecoveryOptionNameType enum

func RiskDecisionType_Values ¶

func RiskDecisionType_Values() []string

RiskDecisionType_Values returns all elements of the RiskDecisionType enum

func RiskLevelType_Values ¶

func RiskLevelType_Values() []string

RiskLevelType_Values returns all elements of the RiskLevelType enum

func StatusType_Values ¶

func StatusType_Values() []string

StatusType_Values returns all elements of the StatusType enum

func TimeUnitsType_Values ¶

func TimeUnitsType_Values() []string

TimeUnitsType_Values returns all elements of the TimeUnitsType enum

func UserImportJobStatusType_Values ¶

func UserImportJobStatusType_Values() []string

UserImportJobStatusType_Values returns all elements of the UserImportJobStatusType enum

func UserPoolMfaType_Values ¶

func UserPoolMfaType_Values() []string

UserPoolMfaType_Values returns all elements of the UserPoolMfaType enum

func UserStatusType_Values ¶

func UserStatusType_Values() []string

UserStatusType_Values returns all elements of the UserStatusType enum

func UsernameAttributeType_Values ¶

func UsernameAttributeType_Values() []string

UsernameAttributeType_Values returns all elements of the UsernameAttributeType enum

func VerifiedAttributeType_Values ¶

func VerifiedAttributeType_Values() []string

VerifiedAttributeType_Values returns all elements of the VerifiedAttributeType enum

func VerifySoftwareTokenResponseType_Values ¶

func VerifySoftwareTokenResponseType_Values() []string

VerifySoftwareTokenResponseType_Values returns all elements of the VerifySoftwareTokenResponseType enum

type AccountRecoverySettingType ¶

type AccountRecoverySettingType struct {

    // The list of RecoveryOptionTypes.
    RecoveryMechanisms []*RecoveryOptionType `min:"1" type:"list"`
    // contains filtered or unexported fields
}

The data type for AccountRecoverySetting.

func (AccountRecoverySettingType) GoString ¶

func (s AccountRecoverySettingType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountRecoverySettingType) SetRecoveryMechanisms ¶

func (s *AccountRecoverySettingType) SetRecoveryMechanisms(v []*RecoveryOptionType) *AccountRecoverySettingType

SetRecoveryMechanisms sets the RecoveryMechanisms field's value.

func (AccountRecoverySettingType) String ¶

func (s AccountRecoverySettingType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountRecoverySettingType) Validate ¶

func (s *AccountRecoverySettingType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AccountTakeoverActionType ¶

type AccountTakeoverActionType struct {

    // The action to take in response to the account takeover action. Valid values
    // are as follows:
    //
    //    * BLOCK Choosing this action will block the request.
    //
    //    * MFA_IF_CONFIGURED Present an MFA challenge if user has configured it,
    //    else allow the request.
    //
    //    * MFA_REQUIRED Present an MFA challenge if user has configured it, else
    //    block the request.
    //
    //    * NO_ACTION Allow the user to sign in.
    //
    // EventAction is a required field
    EventAction *string `type:"string" required:"true" enum:"AccountTakeoverEventActionType"`

    // Flag specifying whether to send a notification.
    //
    // Notify is a required field
    Notify *bool `type:"boolean" required:"true"`
    // contains filtered or unexported fields
}

Account takeover action type.

func (AccountTakeoverActionType) GoString ¶

func (s AccountTakeoverActionType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountTakeoverActionType) SetEventAction ¶

func (s *AccountTakeoverActionType) SetEventAction(v string) *AccountTakeoverActionType

SetEventAction sets the EventAction field's value.

func (*AccountTakeoverActionType) SetNotify ¶

func (s *AccountTakeoverActionType) SetNotify(v bool) *AccountTakeoverActionType

SetNotify sets the Notify field's value.

func (AccountTakeoverActionType) String ¶

func (s AccountTakeoverActionType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountTakeoverActionType) Validate ¶

func (s *AccountTakeoverActionType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AccountTakeoverActionsType ¶

type AccountTakeoverActionsType struct {

    // Action to take for a high risk.
    HighAction *AccountTakeoverActionType `type:"structure"`

    // Action to take for a low risk.
    LowAction *AccountTakeoverActionType `type:"structure"`

    // Action to take for a medium risk.
    MediumAction *AccountTakeoverActionType `type:"structure"`
    // contains filtered or unexported fields
}

Account takeover actions type.

func (AccountTakeoverActionsType) GoString ¶

func (s AccountTakeoverActionsType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountTakeoverActionsType) SetHighAction ¶

func (s *AccountTakeoverActionsType) SetHighAction(v *AccountTakeoverActionType) *AccountTakeoverActionsType

SetHighAction sets the HighAction field's value.

func (*AccountTakeoverActionsType) SetLowAction ¶

func (s *AccountTakeoverActionsType) SetLowAction(v *AccountTakeoverActionType) *AccountTakeoverActionsType

SetLowAction sets the LowAction field's value.

func (*AccountTakeoverActionsType) SetMediumAction ¶

func (s *AccountTakeoverActionsType) SetMediumAction(v *AccountTakeoverActionType) *AccountTakeoverActionsType

SetMediumAction sets the MediumAction field's value.

func (AccountTakeoverActionsType) String ¶

func (s AccountTakeoverActionsType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountTakeoverActionsType) Validate ¶

func (s *AccountTakeoverActionsType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AccountTakeoverRiskConfigurationType ¶

type AccountTakeoverRiskConfigurationType struct {

    // Account takeover risk configuration actions.
    //
    // Actions is a required field
    Actions *AccountTakeoverActionsType `type:"structure" required:"true"`

    // The notify configuration used to construct email notifications.
    NotifyConfiguration *NotifyConfigurationType `type:"structure"`
    // contains filtered or unexported fields
}

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

func (AccountTakeoverRiskConfigurationType) GoString ¶

func (s AccountTakeoverRiskConfigurationType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountTakeoverRiskConfigurationType) SetActions ¶

func (s *AccountTakeoverRiskConfigurationType) SetActions(v *AccountTakeoverActionsType) *AccountTakeoverRiskConfigurationType

SetActions sets the Actions field's value.

func (*AccountTakeoverRiskConfigurationType) SetNotifyConfiguration ¶

func (s *AccountTakeoverRiskConfigurationType) SetNotifyConfiguration(v *NotifyConfigurationType) *AccountTakeoverRiskConfigurationType

SetNotifyConfiguration sets the NotifyConfiguration field's value.

func (AccountTakeoverRiskConfigurationType) String ¶

func (s AccountTakeoverRiskConfigurationType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccountTakeoverRiskConfigurationType) Validate ¶

func (s *AccountTakeoverRiskConfigurationType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddCustomAttributesInput ¶

type AddCustomAttributesInput struct {

    // An array of custom attributes, such as Mutable and Name.
    //
    // CustomAttributes is a required field
    CustomAttributes []*SchemaAttributeType `min:"1" type:"list" required:"true"`

    // The user pool ID for the user pool where you want to add custom attributes.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Represents the request to add custom attributes.

func (AddCustomAttributesInput) GoString ¶

func (s AddCustomAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddCustomAttributesInput) SetCustomAttributes ¶

func (s *AddCustomAttributesInput) SetCustomAttributes(v []*SchemaAttributeType) *AddCustomAttributesInput

SetCustomAttributes sets the CustomAttributes field's value.

func (*AddCustomAttributesInput) SetUserPoolId ¶

func (s *AddCustomAttributesInput) SetUserPoolId(v string) *AddCustomAttributesInput

SetUserPoolId sets the UserPoolId field's value.

func (AddCustomAttributesInput) String ¶

func (s AddCustomAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AddCustomAttributesInput) Validate ¶

func (s *AddCustomAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddCustomAttributesOutput ¶

type AddCustomAttributesOutput struct {
    // contains filtered or unexported fields
}

Represents the response from the server for the request to add custom attributes.

func (AddCustomAttributesOutput) GoString ¶

func (s AddCustomAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AddCustomAttributesOutput) String ¶

func (s AddCustomAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminAddUserToGroupInput ¶

type AdminAddUserToGroupInput struct {

    // The group name.
    //
    // GroupName is a required field
    GroupName *string `min:"1" type:"string" required:"true"`

    // The user pool ID for the user pool.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The username for the user.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminAddUserToGroupInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AdminAddUserToGroupInput) GoString ¶

func (s AdminAddUserToGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminAddUserToGroupInput) SetGroupName ¶

func (s *AdminAddUserToGroupInput) SetGroupName(v string) *AdminAddUserToGroupInput

SetGroupName sets the GroupName field's value.

func (*AdminAddUserToGroupInput) SetUserPoolId ¶

func (s *AdminAddUserToGroupInput) SetUserPoolId(v string) *AdminAddUserToGroupInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminAddUserToGroupInput) SetUsername ¶

func (s *AdminAddUserToGroupInput) SetUsername(v string) *AdminAddUserToGroupInput

SetUsername sets the Username field's value.

func (AdminAddUserToGroupInput) String ¶

func (s AdminAddUserToGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminAddUserToGroupInput) Validate ¶

func (s *AdminAddUserToGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminAddUserToGroupOutput ¶

type AdminAddUserToGroupOutput struct {
    // contains filtered or unexported fields
}

func (AdminAddUserToGroupOutput) GoString ¶

func (s AdminAddUserToGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminAddUserToGroupOutput) String ¶

func (s AdminAddUserToGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminConfirmSignUpInput ¶

type AdminConfirmSignUpInput struct {

    // A map of custom key-value pairs that you can provide as input for any custom
    // workflows that this action triggers.
    //
    // If your user pool configuration includes triggers, the AdminConfirmSignUp
    // API action invokes the Lambda function that is specified for the post confirmation
    // trigger. When Amazon Cognito invokes this function, it passes a JSON payload,
    // which the function receives as input. In this payload, the clientMetadata
    // attribute provides the data that you assigned to the ClientMetadata parameter
    // in your AdminConfirmSignUp request. In your function code in Lambda, you
    // can process the ClientMetadata value to enhance your workflow for your specific
    // needs.
    //
    // For more information, see Customizing user pool Workflows with Lambda Triggers
    // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
    // in the Amazon Cognito Developer Guide.
    //
    // When you use the ClientMetadata parameter, remember that Amazon Cognito won't
    // do the following:
    //
    //    * Store the ClientMetadata value. This data is available only to Lambda
    //    triggers that are assigned to a user pool to support custom workflows.
    //    If your user pool configuration doesn't include triggers, the ClientMetadata
    //    parameter serves no purpose.
    //
    //    * Validate the ClientMetadata value.
    //
    //    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide
    //    sensitive information.
    ClientMetadata map[string]*string `type:"map"`

    // The user pool ID for which you want to confirm user registration.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name for which you want to confirm user registration.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminConfirmSignUpInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Confirm a user's registration as a user pool administrator.

func (AdminConfirmSignUpInput) GoString ¶

func (s AdminConfirmSignUpInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminConfirmSignUpInput) SetClientMetadata ¶

func (s *AdminConfirmSignUpInput) SetClientMetadata(v map[string]*string) *AdminConfirmSignUpInput

SetClientMetadata sets the ClientMetadata field's value.

func (*AdminConfirmSignUpInput) SetUserPoolId ¶

func (s *AdminConfirmSignUpInput) SetUserPoolId(v string) *AdminConfirmSignUpInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminConfirmSignUpInput) SetUsername ¶

func (s *AdminConfirmSignUpInput) SetUsername(v string) *AdminConfirmSignUpInput

SetUsername sets the Username field's value.

func (AdminConfirmSignUpInput) String ¶

func (s AdminConfirmSignUpInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminConfirmSignUpInput) Validate ¶

func (s *AdminConfirmSignUpInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminConfirmSignUpOutput ¶

type AdminConfirmSignUpOutput struct {
    // contains filtered or unexported fields
}

Represents the response from the server for the request to confirm registration.

func (AdminConfirmSignUpOutput) GoString ¶

func (s AdminConfirmSignUpOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminConfirmSignUpOutput) String ¶

func (s AdminConfirmSignUpOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminCreateUserConfigType ¶

type AdminCreateUserConfigType struct {

    // Set to True if only the administrator is allowed to create user profiles.
    // Set to False if users can sign themselves up via an app.
    AllowAdminCreateUserOnly *bool `type:"boolean"`

    // The message template to be used for the welcome message to new users.
    //
    // See also Customizing User Invitation Messages (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization).
    InviteMessageTemplate *MessageTemplateType `type:"structure"`

    // The user account expiration limit, in days, after which a new account that
    // hasn't signed in is no longer usable. To reset the account after that time
    // limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction
    // parameter. The default value for this parameter is 7.
    //
    // If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that
    // value will be used, and UnusedAccountValidityDays will be no longer be an
    // available parameter for that user pool.
    UnusedAccountValidityDays *int64 `type:"integer"`
    // contains filtered or unexported fields
}

The configuration for creating a new user profile.

func (AdminCreateUserConfigType) GoString ¶

func (s AdminCreateUserConfigType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminCreateUserConfigType) SetAllowAdminCreateUserOnly ¶

func (s *AdminCreateUserConfigType) SetAllowAdminCreateUserOnly(v bool) *AdminCreateUserConfigType

SetAllowAdminCreateUserOnly sets the AllowAdminCreateUserOnly field's value.

func (*AdminCreateUserConfigType) SetInviteMessageTemplate ¶

func (s *AdminCreateUserConfigType) SetInviteMessageTemplate(v *MessageTemplateType) *AdminCreateUserConfigType

SetInviteMessageTemplate sets the InviteMessageTemplate field's value.

func (*AdminCreateUserConfigType) SetUnusedAccountValidityDays ¶

func (s *AdminCreateUserConfigType) SetUnusedAccountValidityDays(v int64) *AdminCreateUserConfigType

SetUnusedAccountValidityDays sets the UnusedAccountValidityDays field's value.

func (AdminCreateUserConfigType) String ¶

func (s AdminCreateUserConfigType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminCreateUserConfigType) Validate ¶

func (s *AdminCreateUserConfigType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminCreateUserInput ¶

type AdminCreateUserInput struct {

    // A map of custom key-value pairs that you can provide as input for any custom
    // workflows that this action triggers.
    //
    // You create custom workflows by assigning Lambda functions to user pool triggers.
    // When you use the AdminCreateUser API action, Amazon Cognito invokes the function
    // that is assigned to the pre sign-up trigger. When Amazon Cognito invokes
    // this function, it passes a JSON payload, which the function receives as input.
    // This payload contains a clientMetadata attribute, which provides the data
    // that you assigned to the ClientMetadata parameter in your AdminCreateUser
    // request. In your function code in Lambda, you can process the clientMetadata
    // value to enhance your workflow for your specific needs.
    //
    // For more information, see Customizing user pool Workflows with Lambda Triggers
    // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
    // in the Amazon Cognito Developer Guide.
    //
    // When you use the ClientMetadata parameter, remember that Amazon Cognito won't
    // do the following:
    //
    //    * Store the ClientMetadata value. This data is available only to Lambda
    //    triggers that are assigned to a user pool to support custom workflows.
    //    If your user pool configuration doesn't include triggers, the ClientMetadata
    //    parameter serves no purpose.
    //
    //    * Validate the ClientMetadata value.
    //
    //    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide
    //    sensitive information.
    ClientMetadata map[string]*string `type:"map"`

    // Specify "EMAIL" if email will be used to send the welcome message. Specify
    // "SMS" if the phone number will be used. The default value is "SMS". You can
    // specify more than one value.
    DesiredDeliveryMediums []*string `type:"list" enum:"DeliveryMediumType"`

    // This parameter is used only if the phone_number_verified or email_verified
    // attribute is set to True. Otherwise, it is ignored.
    //
    // If this parameter is set to True and the phone number or email address specified
    // in the UserAttributes parameter already exists as an alias with a different
    // user, the API call will migrate the alias from the previous user to the newly
    // created user. The previous user will no longer be able to log in using that
    // alias.
    //
    // If this parameter is set to False, the API throws an AliasExistsException
    // error if the alias already exists. The default value is False.
    ForceAliasCreation *bool `type:"boolean"`

    // Set to RESEND to resend the invitation message to a user that already exists
    // and reset the expiration limit on the user's account. Set to SUPPRESS to
    // suppress sending the message. You can specify only one value.
    MessageAction *string `type:"string" enum:"MessageActionType"`

    // The user's temporary password. This password must conform to the password
    // policy that you specified when you created the user pool.
    //
    // The temporary password is valid only once. To complete the Admin Create User
    // flow, the user must enter the temporary password in the sign-in page, along
    // with a new password to be used in all future sign-ins.
    //
    // This parameter isn't required. If you don't specify a value, Amazon Cognito
    // generates one for you.
    //
    // The temporary password can only be used until the user account expiration
    // limit that you set for your user pool. To reset the account after that time
    // limit, you must call AdminCreateUser again and specify RESEND for the MessageAction
    // parameter.
    //
    // TemporaryPassword is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminCreateUserInput's
    // String and GoString methods.
    TemporaryPassword *string `type:"string" sensitive:"true"`

    // An array of name-value pairs that contain user attributes and attribute values
    // to be set for the user to be created. You can create a user without specifying
    // any attributes other than Username. However, any attributes that you specify
    // as required (when creating a user pool or in the Attributes tab of the console)
    // either you should supply (in your call to AdminCreateUser) or the user should
    // supply (when they sign up in response to your welcome message).
    //
    // For custom attributes, you must prepend the custom: prefix to the attribute
    // name.
    //
    // To send a message inviting the user to sign up, you must specify the user's
    // email address or phone number. You can do this in your call to AdminCreateUser
    // or in the Users tab of the Amazon Cognito console for managing your user
    // pools.
    //
    // In your call to AdminCreateUser, you can set the email_verified attribute
    // to True, and you can set the phone_number_verified attribute to True. You
    // can also do this by calling AdminUpdateUserAttributes (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html).
    //
    //    * email: The email address of the user to whom the message that contains
    //    the code and username will be sent. Required if the email_verified attribute
    //    is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums
    //    parameter.
    //
    //    * phone_number: The phone number of the user to whom the message that
    //    contains the code and username will be sent. Required if the phone_number_verified
    //    attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums
    //    parameter.
    UserAttributes []*AttributeType `type:"list"`

    // The user pool ID for the user pool where the user will be created.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The value that you want to set as the username sign-in attribute. The following
    // conditions apply to the username parameter.
    //
    //    * The username can't be a duplicate of another username in the same user
    //    pool.
    //
    //    * You can't change the value of a username after you create it.
    //
    //    * You can only provide a value if usernames are a valid sign-in attribute
    //    for your user pool. If your user pool only supports phone numbers or email
    //    addresses as sign-in attributes, Amazon Cognito automatically generates
    //    a username value. For more information, see Customizing sign-in attributes
    //    (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-aliases).
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminCreateUserInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`

    // The user's validation data. This is an array of name-value pairs that contain
    // user attributes and attribute values that you can use for custom validation,
    // such as restricting the types of user accounts that can be registered. For
    // example, you might choose to allow or disallow user sign-up based on the
    // user's domain.
    //
    // To configure custom validation, you must create a Pre Sign-up Lambda trigger
    // for the user pool as described in the Amazon Cognito Developer Guide. The
    // Lambda trigger receives the validation data and uses it in the validation
    // process.
    //
    // The user's validation data isn't persisted.
    ValidationData []*AttributeType `type:"list"`
    // contains filtered or unexported fields
}

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

func (AdminCreateUserInput) GoString ¶

func (s AdminCreateUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminCreateUserInput) SetClientMetadata ¶

func (s *AdminCreateUserInput) SetClientMetadata(v map[string]*string) *AdminCreateUserInput

SetClientMetadata sets the ClientMetadata field's value.

func (*AdminCreateUserInput) SetDesiredDeliveryMediums ¶

func (s *AdminCreateUserInput) SetDesiredDeliveryMediums(v []*string) *AdminCreateUserInput

SetDesiredDeliveryMediums sets the DesiredDeliveryMediums field's value.

func (*AdminCreateUserInput) SetForceAliasCreation ¶

func (s *AdminCreateUserInput) SetForceAliasCreation(v bool) *AdminCreateUserInput

SetForceAliasCreation sets the ForceAliasCreation field's value.

func (*AdminCreateUserInput) SetMessageAction ¶

func (s *AdminCreateUserInput) SetMessageAction(v string) *AdminCreateUserInput

SetMessageAction sets the MessageAction field's value.

func (*AdminCreateUserInput) SetTemporaryPassword ¶

func (s *AdminCreateUserInput) SetTemporaryPassword(v string) *AdminCreateUserInput

SetTemporaryPassword sets the TemporaryPassword field's value.

func (*AdminCreateUserInput) SetUserAttributes ¶

func (s *AdminCreateUserInput) SetUserAttributes(v []*AttributeType) *AdminCreateUserInput

SetUserAttributes sets the UserAttributes field's value.

func (*AdminCreateUserInput) SetUserPoolId ¶

func (s *AdminCreateUserInput) SetUserPoolId(v string) *AdminCreateUserInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminCreateUserInput) SetUsername ¶

func (s *AdminCreateUserInput) SetUsername(v string) *AdminCreateUserInput

SetUsername sets the Username field's value.

func (*AdminCreateUserInput) SetValidationData ¶

func (s *AdminCreateUserInput) SetValidationData(v []*AttributeType) *AdminCreateUserInput

SetValidationData sets the ValidationData field's value.

func (AdminCreateUserInput) String ¶

func (s AdminCreateUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminCreateUserInput) Validate ¶

func (s *AdminCreateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminCreateUserOutput ¶

type AdminCreateUserOutput struct {

    // The newly created user.
    User *UserType `type:"structure"`
    // contains filtered or unexported fields
}

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

func (AdminCreateUserOutput) GoString ¶

func (s AdminCreateUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminCreateUserOutput) SetUser ¶

func (s *AdminCreateUserOutput) SetUser(v *UserType) *AdminCreateUserOutput

SetUser sets the User field's value.

func (AdminCreateUserOutput) String ¶

func (s AdminCreateUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminDeleteUserAttributesInput ¶

type AdminDeleteUserAttributesInput struct {

    // An array of strings representing the user attribute names you want to delete.
    //
    // For custom attributes, you must prepend the custom: prefix to the attribute
    // name.
    //
    // UserAttributeNames is a required field
    UserAttributeNames []*string `type:"list" required:"true"`

    // The user pool ID for the user pool where you want to delete user attributes.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user from which you would like to delete attributes.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminDeleteUserAttributesInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Represents the request to delete user attributes as an administrator.

func (AdminDeleteUserAttributesInput) GoString ¶

func (s AdminDeleteUserAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminDeleteUserAttributesInput) SetUserAttributeNames ¶

func (s *AdminDeleteUserAttributesInput) SetUserAttributeNames(v []*string) *AdminDeleteUserAttributesInput

SetUserAttributeNames sets the UserAttributeNames field's value.

func (*AdminDeleteUserAttributesInput) SetUserPoolId ¶

func (s *AdminDeleteUserAttributesInput) SetUserPoolId(v string) *AdminDeleteUserAttributesInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminDeleteUserAttributesInput) SetUsername ¶

func (s *AdminDeleteUserAttributesInput) SetUsername(v string) *AdminDeleteUserAttributesInput

SetUsername sets the Username field's value.

func (AdminDeleteUserAttributesInput) String ¶

func (s AdminDeleteUserAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminDeleteUserAttributesInput) Validate ¶

func (s *AdminDeleteUserAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminDeleteUserAttributesOutput ¶

type AdminDeleteUserAttributesOutput struct {
    // contains filtered or unexported fields
}

Represents the response received from the server for a request to delete user attributes.

func (AdminDeleteUserAttributesOutput) GoString ¶

func (s AdminDeleteUserAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminDeleteUserAttributesOutput) String ¶

func (s AdminDeleteUserAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminDeleteUserInput ¶

type AdminDeleteUserInput struct {

    // The user pool ID for the user pool where you want to delete the user.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user you want to delete.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminDeleteUserInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Represents the request to delete a user as an administrator.

func (AdminDeleteUserInput) GoString ¶

func (s AdminDeleteUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminDeleteUserInput) SetUserPoolId ¶

func (s *AdminDeleteUserInput) SetUserPoolId(v string) *AdminDeleteUserInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminDeleteUserInput) SetUsername ¶

func (s *AdminDeleteUserInput) SetUsername(v string) *AdminDeleteUserInput

SetUsername sets the Username field's value.

func (AdminDeleteUserInput) String ¶

func (s AdminDeleteUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminDeleteUserInput) Validate ¶

func (s *AdminDeleteUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminDeleteUserOutput ¶

type AdminDeleteUserOutput struct {
    // contains filtered or unexported fields
}

func (AdminDeleteUserOutput) GoString ¶

func (s AdminDeleteUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminDeleteUserOutput) String ¶

func (s AdminDeleteUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminDisableProviderForUserInput ¶

type AdminDisableProviderForUserInput struct {

    // The user to be disabled.
    //
    // User is a required field
    User *ProviderUserIdentifierType `type:"structure" required:"true"`

    // The user pool ID for the user pool.
    //
    // UserPoolId is a required field
    UserPoolId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (AdminDisableProviderForUserInput) GoString ¶

func (s AdminDisableProviderForUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminDisableProviderForUserInput) SetUser ¶

func (s *AdminDisableProviderForUserInput) SetUser(v *ProviderUserIdentifierType) *AdminDisableProviderForUserInput

SetUser sets the User field's value.

func (*AdminDisableProviderForUserInput) SetUserPoolId ¶

func (s *AdminDisableProviderForUserInput) SetUserPoolId(v string) *AdminDisableProviderForUserInput

SetUserPoolId sets the UserPoolId field's value.

func (AdminDisableProviderForUserInput) String ¶

func (s AdminDisableProviderForUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminDisableProviderForUserInput) Validate ¶

func (s *AdminDisableProviderForUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminDisableProviderForUserOutput ¶

type AdminDisableProviderForUserOutput struct {
    // contains filtered or unexported fields
}

func (AdminDisableProviderForUserOutput) GoString ¶

func (s AdminDisableProviderForUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminDisableProviderForUserOutput) String ¶

func (s AdminDisableProviderForUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminDisableUserInput ¶

type AdminDisableUserInput struct {

    // The user pool ID for the user pool where you want to disable the user.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user you want to disable.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminDisableUserInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Represents the request to disable the user as an administrator.

func (AdminDisableUserInput) GoString ¶

func (s AdminDisableUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminDisableUserInput) SetUserPoolId ¶

func (s *AdminDisableUserInput) SetUserPoolId(v string) *AdminDisableUserInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminDisableUserInput) SetUsername ¶

func (s *AdminDisableUserInput) SetUsername(v string) *AdminDisableUserInput

SetUsername sets the Username field's value.

func (AdminDisableUserInput) String ¶

func (s AdminDisableUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminDisableUserInput) Validate ¶

func (s *AdminDisableUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminDisableUserOutput ¶

type AdminDisableUserOutput struct {
    // contains filtered or unexported fields
}

Represents the response received from the server to disable the user as an administrator.

func (AdminDisableUserOutput) GoString ¶

func (s AdminDisableUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminDisableUserOutput) String ¶

func (s AdminDisableUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminEnableUserInput ¶

type AdminEnableUserInput struct {

    // The user pool ID for the user pool where you want to enable the user.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user you want to enable.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminEnableUserInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Represents the request that enables the user as an administrator.

func (AdminEnableUserInput) GoString ¶

func (s AdminEnableUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminEnableUserInput) SetUserPoolId ¶

func (s *AdminEnableUserInput) SetUserPoolId(v string) *AdminEnableUserInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminEnableUserInput) SetUsername ¶

func (s *AdminEnableUserInput) SetUsername(v string) *AdminEnableUserInput

SetUsername sets the Username field's value.

func (AdminEnableUserInput) String ¶

func (s AdminEnableUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminEnableUserInput) Validate ¶

func (s *AdminEnableUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminEnableUserOutput ¶

type AdminEnableUserOutput struct {
    // contains filtered or unexported fields
}

Represents the response from the server for the request to enable a user as an administrator.

func (AdminEnableUserOutput) GoString ¶

func (s AdminEnableUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminEnableUserOutput) String ¶

func (s AdminEnableUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminForgetDeviceInput ¶

type AdminForgetDeviceInput struct {

    // The device key.
    //
    // DeviceKey is a required field
    DeviceKey *string `min:"1" type:"string" required:"true"`

    // The user pool ID.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminForgetDeviceInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Sends the forgot device request, as an administrator.

func (AdminForgetDeviceInput) GoString ¶

func (s AdminForgetDeviceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminForgetDeviceInput) SetDeviceKey ¶

func (s *AdminForgetDeviceInput) SetDeviceKey(v string) *AdminForgetDeviceInput

SetDeviceKey sets the DeviceKey field's value.

func (*AdminForgetDeviceInput) SetUserPoolId ¶

func (s *AdminForgetDeviceInput) SetUserPoolId(v string) *AdminForgetDeviceInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminForgetDeviceInput) SetUsername ¶

func (s *AdminForgetDeviceInput) SetUsername(v string) *AdminForgetDeviceInput

SetUsername sets the Username field's value.

func (AdminForgetDeviceInput) String ¶

func (s AdminForgetDeviceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminForgetDeviceInput) Validate ¶

func (s *AdminForgetDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminForgetDeviceOutput ¶

type AdminForgetDeviceOutput struct {
    // contains filtered or unexported fields
}

func (AdminForgetDeviceOutput) GoString ¶

func (s AdminForgetDeviceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminForgetDeviceOutput) String ¶

func (s AdminForgetDeviceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminGetDeviceInput ¶

type AdminGetDeviceInput struct {

    // The device key.
    //
    // DeviceKey is a required field
    DeviceKey *string `min:"1" type:"string" required:"true"`

    // The user pool ID.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminGetDeviceInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

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

func (AdminGetDeviceInput) GoString ¶

func (s AdminGetDeviceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminGetDeviceInput) SetDeviceKey ¶

func (s *AdminGetDeviceInput) SetDeviceKey(v string) *AdminGetDeviceInput

SetDeviceKey sets the DeviceKey field's value.

func (*AdminGetDeviceInput) SetUserPoolId ¶

func (s *AdminGetDeviceInput) SetUserPoolId(v string) *AdminGetDeviceInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminGetDeviceInput) SetUsername ¶

func (s *AdminGetDeviceInput) SetUsername(v string) *AdminGetDeviceInput

SetUsername sets the Username field's value.

func (AdminGetDeviceInput) String ¶

func (s AdminGetDeviceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminGetDeviceInput) Validate ¶

func (s *AdminGetDeviceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminGetDeviceOutput ¶

type AdminGetDeviceOutput struct {

    // The device.
    //
    // Device is a required field
    Device *DeviceType `type:"structure" required:"true"`
    // contains filtered or unexported fields
}

Gets the device response, as an administrator.

func (AdminGetDeviceOutput) GoString ¶

func (s AdminGetDeviceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminGetDeviceOutput) SetDevice ¶

func (s *AdminGetDeviceOutput) SetDevice(v *DeviceType) *AdminGetDeviceOutput

SetDevice sets the Device field's value.

func (AdminGetDeviceOutput) String ¶

func (s AdminGetDeviceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminGetUserInput ¶

type AdminGetUserInput struct {

    // The user pool ID for the user pool where you want to get information about
    // the user.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user you want to retrieve.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminGetUserInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

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

func (AdminGetUserInput) GoString ¶

func (s AdminGetUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminGetUserInput) SetUserPoolId ¶

func (s *AdminGetUserInput) SetUserPoolId(v string) *AdminGetUserInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminGetUserInput) SetUsername ¶

func (s *AdminGetUserInput) SetUsername(v string) *AdminGetUserInput

SetUsername sets the Username field's value.

func (AdminGetUserInput) String ¶

func (s AdminGetUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminGetUserInput) Validate ¶

func (s *AdminGetUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminGetUserOutput ¶

type AdminGetUserOutput struct {

    // Indicates that the status is enabled.
    Enabled *bool `type:"boolean"`

    // This response parameter is no longer supported. It provides information only
    // about SMS MFA configurations. It doesn't provide information about time-based
    // one-time password (TOTP) software token MFA configurations. To look up information
    // about either type of MFA configuration, use UserMFASettingList instead.
    MFAOptions []*MFAOptionType `type:"list"`

    // The user's preferred MFA setting.
    PreferredMfaSetting *string `type:"string"`

    // An array of name-value pairs representing user attributes.
    UserAttributes []*AttributeType `type:"list"`

    // The date the user was created.
    UserCreateDate *time.Time `type:"timestamp"`

    // The date and time, in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
    // format, when the item was modified.
    UserLastModifiedDate *time.Time `type:"timestamp"`

    // The MFA options that are activated for the user. The possible values in this
    // list are SMS_MFA and SOFTWARE_TOKEN_MFA.
    UserMFASettingList []*string `type:"list"`

    // The user status. Can be one of the following:
    //
    //    * UNCONFIRMED - User has been created but not confirmed.
    //
    //    * CONFIRMED - User has been confirmed.
    //
    //    * UNKNOWN - User status isn't known.
    //
    //    * RESET_REQUIRED - User is confirmed, but the user must request a code
    //    and reset their password before they can sign in.
    //
    //    * FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign
    //    in using a temporary password, but on first sign-in, the user must change
    //    their password to a new value before doing anything else.
    UserStatus *string `type:"string" enum:"UserStatusType"`

    // The username of the user that you requested.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminGetUserOutput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

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

func (AdminGetUserOutput) GoString ¶

func (s AdminGetUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminGetUserOutput) SetEnabled ¶

func (s *AdminGetUserOutput) SetEnabled(v bool) *AdminGetUserOutput

SetEnabled sets the Enabled field's value.

func (*AdminGetUserOutput) SetMFAOptions ¶

func (s *AdminGetUserOutput) SetMFAOptions(v []*MFAOptionType) *AdminGetUserOutput

SetMFAOptions sets the MFAOptions field's value.

func (*AdminGetUserOutput) SetPreferredMfaSetting ¶

func (s *AdminGetUserOutput) SetPreferredMfaSetting(v string) *AdminGetUserOutput

SetPreferredMfaSetting sets the PreferredMfaSetting field's value.

func (*AdminGetUserOutput) SetUserAttributes ¶

func (s *AdminGetUserOutput) SetUserAttributes(v []*AttributeType) *AdminGetUserOutput

SetUserAttributes sets the UserAttributes field's value.

func (*AdminGetUserOutput) SetUserCreateDate ¶

func (s *AdminGetUserOutput) SetUserCreateDate(v time.Time) *AdminGetUserOutput

SetUserCreateDate sets the UserCreateDate field's value.

func (*AdminGetUserOutput) SetUserLastModifiedDate ¶

func (s *AdminGetUserOutput) SetUserLastModifiedDate(v time.Time) *AdminGetUserOutput

SetUserLastModifiedDate sets the UserLastModifiedDate field's value.

func (*AdminGetUserOutput) SetUserMFASettingList ¶

func (s *AdminGetUserOutput) SetUserMFASettingList(v []*string) *AdminGetUserOutput

SetUserMFASettingList sets the UserMFASettingList field's value.

func (*AdminGetUserOutput) SetUserStatus ¶

func (s *AdminGetUserOutput) SetUserStatus(v string) *AdminGetUserOutput

SetUserStatus sets the UserStatus field's value.

func (*AdminGetUserOutput) SetUsername ¶

func (s *AdminGetUserOutput) SetUsername(v string) *AdminGetUserOutput

SetUsername sets the Username field's value.

func (AdminGetUserOutput) String ¶

func (s AdminGetUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminInitiateAuthInput ¶

type AdminInitiateAuthInput struct {

    // The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth
    // calls.
    AnalyticsMetadata *AnalyticsMetadataType `type:"structure"`

    // The authentication flow for this call to run. The API action will depend
    // on this value. For example:
    //
    //    * REFRESH_TOKEN_AUTH will take in a valid refresh token and return new
    //    tokens.
    //
    //    * USER_SRP_AUTH will take in USERNAME and SRP_A and return the Secure
    //    Remote Password (SRP) protocol variables to be used for next challenge
    //    execution.
    //
    //    * ADMIN_USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return
    //    the next challenge or tokens.
    //
    // Valid values include:
    //
    //    * USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP)
    //    protocol.
    //
    //    * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing
    //    the access token and ID token by supplying a valid refresh token.
    //
    //    * CUSTOM_AUTH: Custom authentication flow.
    //
    //    * ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the
    //    USERNAME and PASSWORD directly if the flow is enabled for calling the
    //    app client.
    //
    //    * ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication.
    //    This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow,
    //    Amazon Cognito receives the password in the request instead of using the
    //    SRP process to verify passwords.
    //
    // AuthFlow is a required field
    AuthFlow *string `type:"string" required:"true" enum:"AuthFlowType"`

    // The authentication parameters. These are inputs corresponding to the AuthFlow
    // that you're invoking. The required values depend on the value of AuthFlow:
    //
    //    * For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH
    //    (required if the app client is configured with a client secret), DEVICE_KEY.
    //
    //    * For ADMIN_USER_PASSWORD_AUTH: USERNAME (required), PASSWORD (required),
    //    SECRET_HASH (required if the app client is configured with a client secret),
    //    DEVICE_KEY.
    //
    //    * For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH
    //    (required if the app client is configured with a client secret), DEVICE_KEY.
    //
    //    * For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
    //    configured with client secret), DEVICE_KEY. To start the authentication
    //    flow with password verification, include ChallengeName: SRP_A and SRP_A:
    //    (The SRP_A Value).
    //
    // For more information about SECRET_HASH, see Computing secret hash values
    // (https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash).
    // For information about DEVICE_KEY, see Working with user devices in your user
    // pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html).
    //
    // AuthParameters is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminInitiateAuthInput's
    // String and GoString methods.
    AuthParameters map[string]*string `type:"map" sensitive:"true"`

    // The app client ID.
    //
    // ClientId is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminInitiateAuthInput's
    // String and GoString methods.
    //
    // ClientId is a required field
    ClientId *string `min:"1" type:"string" required:"true" sensitive:"true"`

    // A map of custom key-value pairs that you can provide as input for certain
    // custom workflows that this action triggers.
    //
    // You create custom workflows by assigning Lambda functions to user pool triggers.
    // When you use the AdminInitiateAuth API action, Amazon Cognito invokes the
    // Lambda functions that are specified for various triggers. The ClientMetadata
    // value is passed as input to the functions for only the following triggers:
    //
    //    * Pre signup
    //
    //    * Pre authentication
    //
    //    * User migration
    //
    // When Amazon Cognito invokes the functions for these triggers, it passes a
    // JSON payload, which the function receives as input. This payload contains
    // a validationData attribute, which provides the data that you assigned to
    // the ClientMetadata parameter in your AdminInitiateAuth request. In your function
    // code in Lambda, you can process the validationData value to enhance your
    // workflow for your specific needs.
    //
    // When you use the AdminInitiateAuth API action, Amazon Cognito also invokes
    // the functions for the following triggers, but it doesn't provide the ClientMetadata
    // value as input:
    //
    //    * Post authentication
    //
    //    * Custom message
    //
    //    * Pre token generation
    //
    //    * Create auth challenge
    //
    //    * Define auth challenge
    //
    //    * Verify auth challenge
    //
    // For more information, see Customizing user pool Workflows with Lambda Triggers
    // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
    // in the Amazon Cognito Developer Guide.
    //
    // When you use the ClientMetadata parameter, remember that Amazon Cognito won't
    // do the following:
    //
    //    * Store the ClientMetadata value. This data is available only to Lambda
    //    triggers that are assigned to a user pool to support custom workflows.
    //    If your user pool configuration doesn't include triggers, the ClientMetadata
    //    parameter serves no purpose.
    //
    //    * Validate the ClientMetadata value.
    //
    //    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide
    //    sensitive information.
    ClientMetadata map[string]*string `type:"map"`

    // Contextual data about your user session, such as the device fingerprint,
    // IP address, or location. Amazon Cognito advanced security evaluates the risk
    // of an authentication event based on the context that your app generates and
    // passes to Amazon Cognito when it makes API requests.
    ContextData *ContextDataType `type:"structure"`

    // The ID of the Amazon Cognito user pool.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

Initiates the authorization request, as an administrator.

func (AdminInitiateAuthInput) GoString ¶

func (s AdminInitiateAuthInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminInitiateAuthInput) SetAnalyticsMetadata ¶

func (s *AdminInitiateAuthInput) SetAnalyticsMetadata(v *AnalyticsMetadataType) *AdminInitiateAuthInput

SetAnalyticsMetadata sets the AnalyticsMetadata field's value.

func (*AdminInitiateAuthInput) SetAuthFlow ¶

func (s *AdminInitiateAuthInput) SetAuthFlow(v string) *AdminInitiateAuthInput

SetAuthFlow sets the AuthFlow field's value.

func (*AdminInitiateAuthInput) SetAuthParameters ¶

func (s *AdminInitiateAuthInput) SetAuthParameters(v map[string]*string) *AdminInitiateAuthInput

SetAuthParameters sets the AuthParameters field's value.

func (*AdminInitiateAuthInput) SetClientId ¶

func (s *AdminInitiateAuthInput) SetClientId(v string) *AdminInitiateAuthInput

SetClientId sets the ClientId field's value.

func (*AdminInitiateAuthInput) SetClientMetadata ¶

func (s *AdminInitiateAuthInput) SetClientMetadata(v map[string]*string) *AdminInitiateAuthInput

SetClientMetadata sets the ClientMetadata field's value.

func (*AdminInitiateAuthInput) SetContextData ¶

func (s *AdminInitiateAuthInput) SetContextData(v *ContextDataType) *AdminInitiateAuthInput

SetContextData sets the ContextData field's value.

func (*AdminInitiateAuthInput) SetUserPoolId ¶

func (s *AdminInitiateAuthInput) SetUserPoolId(v string) *AdminInitiateAuthInput

SetUserPoolId sets the UserPoolId field's value.

func (AdminInitiateAuthInput) String ¶

func (s AdminInitiateAuthInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminInitiateAuthInput) Validate ¶

func (s *AdminInitiateAuthInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminInitiateAuthOutput ¶

type AdminInitiateAuthOutput struct {

    // The result of the authentication response. This is only returned if the caller
    // doesn't need to pass another challenge. If the caller does need to pass another
    // challenge before it gets tokens, ChallengeName, ChallengeParameters, and
    // Session are returned.
    AuthenticationResult *AuthenticationResultType `type:"structure"`

    // The name of the challenge that you're responding to with this call. This
    // is returned in the AdminInitiateAuth response if you must pass another challenge.
    //
    //    * MFA_SETUP: If MFA is required, users who don't have at least one of
    //    the MFA methods set up are presented with an MFA_SETUP challenge. The
    //    user must set up at least one MFA type to continue to authenticate.
    //
    //    * SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA
    //    for text SMS MFA, and SOFTWARE_TOKEN_MFA for time-based one-time password
    //    (TOTP) software token MFA.
    //
    //    * SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via
    //    SMS.
    //
    //    * PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE,
    //    PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
    //
    //    * CUSTOM_CHALLENGE: This is returned if your custom authentication flow
    //    determines that the user should pass another challenge before tokens are
    //    issued.
    //
    //    * DEVICE_SRP_AUTH: If device tracking was activated in your user pool
    //    and the previous challenges were passed, this challenge is returned so
    //    that Amazon Cognito can start tracking this device.
    //
    //    * DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices
    //    only.
    //
    //    * ADMIN_NO_SRP_AUTH: This is returned if you must authenticate with USERNAME
    //    and PASSWORD directly. An app client must be enabled to use this flow.
    //
    //    * NEW_PASSWORD_REQUIRED: For users who are required to change their passwords
    //    after successful first login. Respond to this challenge with NEW_PASSWORD
    //    and any required attributes that Amazon Cognito returned in the requiredAttributes
    //    parameter. You can also set values for attributes that aren't required
    //    by your user pool and that your app client can write. For more information,
    //    see AdminRespondToAuthChallenge (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html).
    //    In a NEW_PASSWORD_REQUIRED challenge response, you can't modify a required
    //    attribute that already has a value. In AdminRespondToAuthChallenge, set
    //    a value for any keys that Amazon Cognito returned in the requiredAttributes
    //    parameter, then use the AdminUpdateUserAttributes API operation to modify
    //    the value of any additional attributes.
    //
    //    * MFA_SETUP: For users who are required to set up an MFA factor before
    //    they can sign in. The MFA types activated for the user pool will be listed
    //    in the challenge parameters MFA_CAN_SETUP value. To set up software token
    //    MFA, use the session returned here from InitiateAuth as an input to AssociateSoftwareToken,
    //    and use the session returned by VerifySoftwareToken as an input to RespondToAuthChallenge
    //    with challenge name MFA_SETUP to complete sign-in. To set up SMS MFA,
    //    users will need help from an administrator to add a phone number to their
    //    account and then call InitiateAuth again to restart sign-in.
    ChallengeName *string `type:"string" enum:"ChallengeNameType"`

    // The challenge parameters. These are returned to you in the AdminInitiateAuth
    // response if you must pass another challenge. The responses in this parameter
    // should be used to compute inputs to the next call (AdminRespondToAuthChallenge).
    //
    // All challenges require USERNAME and SECRET_HASH (if applicable).
    //
    // The value of the USER_ID_FOR_SRP attribute is the user's actual username,
    // not an alias (such as email address or phone number), even if you specified
    // an alias in your call to AdminInitiateAuth. This happens because, in the
    // AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute
    // can't be an alias.
    ChallengeParameters map[string]*string `type:"map"`

    // The session that should be passed both ways in challenge-response calls to
    // the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call
    // determines that the caller must pass another challenge, they return a session
    // with other challenge parameters. This session should be passed as it is to
    // the next AdminRespondToAuthChallenge API call.
    //
    // Session is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminInitiateAuthOutput's
    // String and GoString methods.
    Session *string `min:"20" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

Initiates the authentication response, as an administrator.

func (AdminInitiateAuthOutput) GoString ¶

func (s AdminInitiateAuthOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminInitiateAuthOutput) SetAuthenticationResult ¶

func (s *AdminInitiateAuthOutput) SetAuthenticationResult(v *AuthenticationResultType) *AdminInitiateAuthOutput

SetAuthenticationResult sets the AuthenticationResult field's value.

func (*AdminInitiateAuthOutput) SetChallengeName ¶

func (s *AdminInitiateAuthOutput) SetChallengeName(v string) *AdminInitiateAuthOutput

SetChallengeName sets the ChallengeName field's value.

func (*AdminInitiateAuthOutput) SetChallengeParameters ¶

func (s *AdminInitiateAuthOutput) SetChallengeParameters(v map[string]*string) *AdminInitiateAuthOutput

SetChallengeParameters sets the ChallengeParameters field's value.

func (*AdminInitiateAuthOutput) SetSession ¶

func (s *AdminInitiateAuthOutput) SetSession(v string) *AdminInitiateAuthOutput

SetSession sets the Session field's value.

func (AdminInitiateAuthOutput) String ¶

func (s AdminInitiateAuthOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminLinkProviderForUserInput ¶

type AdminLinkProviderForUserInput struct {

    // The existing user in the user pool that you want to assign to the external
    // IdP user account. This user can be a local (Username + Password) Amazon Cognito
    // user pools user or a federated user (for example, a SAML or Facebook user).
    // If the user doesn't exist, Amazon Cognito generates an exception. Amazon
    // Cognito returns this user when the new user (with the linked IdP attribute)
    // signs in.
    //
    // For a native username + password user, the ProviderAttributeValue for the
    // DestinationUser should be the username in the user pool. For a federated
    // user, it should be the provider-specific user_id.
    //
    // The ProviderAttributeName of the DestinationUser is ignored.
    //
    // The ProviderName should be set to Cognito for users in Cognito user pools.
    //
    // All attributes in the DestinationUser profile must be mutable. If you have
    // assigned the user any immutable custom attributes, the operation won't succeed.
    //
    // DestinationUser is a required field
    DestinationUser *ProviderUserIdentifierType `type:"structure" required:"true"`

    // An external IdP account for a user who doesn't exist yet in the user pool.
    // This user must be a federated user (for example, a SAML or Facebook user),
    // not another native user.
    //
    // If the SourceUser is using a federated social IdP, such as Facebook, Google,
    // or Login with Amazon, you must set the ProviderAttributeName to Cognito_Subject.
    // For social IdPs, the ProviderName will be Facebook, Google, or LoginWithAmazon,
    // and Amazon Cognito will automatically parse the Facebook, Google, and Login
    // with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue
    // for the user must be the same value as the id, sub, or user_id value found
    // in the social IdP token.
    //
    // For OIDC, the ProviderAttributeName can be any value that matches a claim
    // in the ID token, or that your app retrieves from the userInfo endpoint. You
    // must map the claim to a user pool attribute in your IdP configuration, and
    // set the user pool attribute name as the value of ProviderAttributeName in
    // your AdminLinkProviderForUser request.
    //
    // For SAML, the ProviderAttributeName can be any value that matches a claim
    // in the SAML assertion. To link SAML users based on the subject of the SAML
    // assertion, map the subject to a claim through the SAML IdP and set that claim
    // name as the value of ProviderAttributeName in your AdminLinkProviderForUser
    // request.
    //
    // For both OIDC and SAML users, when you set ProviderAttributeName to Cognito_Subject,
    // Amazon Cognito will automatically parse the default unique identifier found
    // in the subject from the IdP token.
    //
    // SourceUser is a required field
    SourceUser *ProviderUserIdentifierType `type:"structure" required:"true"`

    // The user pool ID for the user pool.
    //
    // UserPoolId is a required field
    UserPoolId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (AdminLinkProviderForUserInput) GoString ¶

func (s AdminLinkProviderForUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminLinkProviderForUserInput) SetDestinationUser ¶

func (s *AdminLinkProviderForUserInput) SetDestinationUser(v *ProviderUserIdentifierType) *AdminLinkProviderForUserInput

SetDestinationUser sets the DestinationUser field's value.

func (*AdminLinkProviderForUserInput) SetSourceUser ¶

func (s *AdminLinkProviderForUserInput) SetSourceUser(v *ProviderUserIdentifierType) *AdminLinkProviderForUserInput

SetSourceUser sets the SourceUser field's value.

func (*AdminLinkProviderForUserInput) SetUserPoolId ¶

func (s *AdminLinkProviderForUserInput) SetUserPoolId(v string) *AdminLinkProviderForUserInput

SetUserPoolId sets the UserPoolId field's value.

func (AdminLinkProviderForUserInput) String ¶

func (s AdminLinkProviderForUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminLinkProviderForUserInput) Validate ¶

func (s *AdminLinkProviderForUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminLinkProviderForUserOutput ¶

type AdminLinkProviderForUserOutput struct {
    // contains filtered or unexported fields
}

func (AdminLinkProviderForUserOutput) GoString ¶

func (s AdminLinkProviderForUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminLinkProviderForUserOutput) String ¶

func (s AdminLinkProviderForUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminListDevicesInput ¶

type AdminListDevicesInput struct {

    // The limit of the devices request.
    Limit *int64 `type:"integer"`

    // The pagination token.
    PaginationToken *string `min:"1" type:"string"`

    // The user pool ID.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminListDevicesInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Represents the request to list devices, as an administrator.

func (AdminListDevicesInput) GoString ¶

func (s AdminListDevicesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListDevicesInput) SetLimit ¶

func (s *AdminListDevicesInput) SetLimit(v int64) *AdminListDevicesInput

SetLimit sets the Limit field's value.

func (*AdminListDevicesInput) SetPaginationToken ¶

func (s *AdminListDevicesInput) SetPaginationToken(v string) *AdminListDevicesInput

SetPaginationToken sets the PaginationToken field's value.

func (*AdminListDevicesInput) SetUserPoolId ¶

func (s *AdminListDevicesInput) SetUserPoolId(v string) *AdminListDevicesInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminListDevicesInput) SetUsername ¶

func (s *AdminListDevicesInput) SetUsername(v string) *AdminListDevicesInput

SetUsername sets the Username field's value.

func (AdminListDevicesInput) String ¶

func (s AdminListDevicesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListDevicesInput) Validate ¶

func (s *AdminListDevicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminListDevicesOutput ¶

type AdminListDevicesOutput struct {

    // The devices in the list of devices response.
    Devices []*DeviceType `type:"list"`

    // The pagination token.
    PaginationToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Lists the device's response, as an administrator.

func (AdminListDevicesOutput) GoString ¶

func (s AdminListDevicesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListDevicesOutput) SetDevices ¶

func (s *AdminListDevicesOutput) SetDevices(v []*DeviceType) *AdminListDevicesOutput

SetDevices sets the Devices field's value.

func (*AdminListDevicesOutput) SetPaginationToken ¶

func (s *AdminListDevicesOutput) SetPaginationToken(v string) *AdminListDevicesOutput

SetPaginationToken sets the PaginationToken field's value.

func (AdminListDevicesOutput) String ¶

func (s AdminListDevicesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminListGroupsForUserInput ¶

type AdminListGroupsForUserInput struct {

    // The limit of the request to list groups.
    Limit *int64 `type:"integer"`

    // An identifier that was returned from the previous call to this operation,
    // which can be used to return the next set of items in the list.
    NextToken *string `min:"1" type:"string"`

    // The user pool ID for the user pool.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The username for the user.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminListGroupsForUserInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AdminListGroupsForUserInput) GoString ¶

func (s AdminListGroupsForUserInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListGroupsForUserInput) SetLimit ¶

func (s *AdminListGroupsForUserInput) SetLimit(v int64) *AdminListGroupsForUserInput

SetLimit sets the Limit field's value.

func (*AdminListGroupsForUserInput) SetNextToken ¶

func (s *AdminListGroupsForUserInput) SetNextToken(v string) *AdminListGroupsForUserInput

SetNextToken sets the NextToken field's value.

func (*AdminListGroupsForUserInput) SetUserPoolId ¶

func (s *AdminListGroupsForUserInput) SetUserPoolId(v string) *AdminListGroupsForUserInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminListGroupsForUserInput) SetUsername ¶

func (s *AdminListGroupsForUserInput) SetUsername(v string) *AdminListGroupsForUserInput

SetUsername sets the Username field's value.

func (AdminListGroupsForUserInput) String ¶

func (s AdminListGroupsForUserInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListGroupsForUserInput) Validate ¶

func (s *AdminListGroupsForUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminListGroupsForUserOutput ¶

type AdminListGroupsForUserOutput struct {

    // The groups that the user belongs to.
    Groups []*GroupType `type:"list"`

    // An identifier that was returned from the previous call to this operation,
    // which can be used to return the next set of items in the list.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (AdminListGroupsForUserOutput) GoString ¶

func (s AdminListGroupsForUserOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListGroupsForUserOutput) SetGroups ¶

func (s *AdminListGroupsForUserOutput) SetGroups(v []*GroupType) *AdminListGroupsForUserOutput

SetGroups sets the Groups field's value.

func (*AdminListGroupsForUserOutput) SetNextToken ¶

func (s *AdminListGroupsForUserOutput) SetNextToken(v string) *AdminListGroupsForUserOutput

SetNextToken sets the NextToken field's value.

func (AdminListGroupsForUserOutput) String ¶

func (s AdminListGroupsForUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminListUserAuthEventsInput ¶

type AdminListUserAuthEventsInput struct {

    // The maximum number of authentication events to return. Returns 60 events
    // if you set MaxResults to 0, or if you don't include a MaxResults parameter.
    MaxResults *int64 `type:"integer"`

    // A pagination token.
    NextToken *string `min:"1" type:"string"`

    // The user pool ID.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user pool username or an alias.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminListUserAuthEventsInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AdminListUserAuthEventsInput) GoString ¶

func (s AdminListUserAuthEventsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListUserAuthEventsInput) SetMaxResults ¶

func (s *AdminListUserAuthEventsInput) SetMaxResults(v int64) *AdminListUserAuthEventsInput

SetMaxResults sets the MaxResults field's value.

func (*AdminListUserAuthEventsInput) SetNextToken ¶

func (s *AdminListUserAuthEventsInput) SetNextToken(v string) *AdminListUserAuthEventsInput

SetNextToken sets the NextToken field's value.

func (*AdminListUserAuthEventsInput) SetUserPoolId ¶

func (s *AdminListUserAuthEventsInput) SetUserPoolId(v string) *AdminListUserAuthEventsInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminListUserAuthEventsInput) SetUsername ¶

func (s *AdminListUserAuthEventsInput) SetUsername(v string) *AdminListUserAuthEventsInput

SetUsername sets the Username field's value.

func (AdminListUserAuthEventsInput) String ¶

func (s AdminListUserAuthEventsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListUserAuthEventsInput) Validate ¶

func (s *AdminListUserAuthEventsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminListUserAuthEventsOutput ¶

type AdminListUserAuthEventsOutput struct {

    // The response object. It includes the EventID, EventType, CreationDate, EventRisk,
    // and EventResponse.
    AuthEvents []*AuthEventType `type:"list"`

    // A pagination token.
    NextToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (AdminListUserAuthEventsOutput) GoString ¶

func (s AdminListUserAuthEventsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminListUserAuthEventsOutput) SetAuthEvents ¶

func (s *AdminListUserAuthEventsOutput) SetAuthEvents(v []*AuthEventType) *AdminListUserAuthEventsOutput

SetAuthEvents sets the AuthEvents field's value.

func (*AdminListUserAuthEventsOutput) SetNextToken ¶

func (s *AdminListUserAuthEventsOutput) SetNextToken(v string) *AdminListUserAuthEventsOutput

SetNextToken sets the NextToken field's value.

func (AdminListUserAuthEventsOutput) String ¶

func (s AdminListUserAuthEventsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminRemoveUserFromGroupInput ¶

type AdminRemoveUserFromGroupInput struct {

    // The group name.
    //
    // GroupName is a required field
    GroupName *string `min:"1" type:"string" required:"true"`

    // The user pool ID for the user pool.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The username for the user.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminRemoveUserFromGroupInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AdminRemoveUserFromGroupInput) GoString ¶

func (s AdminRemoveUserFromGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminRemoveUserFromGroupInput) SetGroupName ¶

func (s *AdminRemoveUserFromGroupInput) SetGroupName(v string) *AdminRemoveUserFromGroupInput

SetGroupName sets the GroupName field's value.

func (*AdminRemoveUserFromGroupInput) SetUserPoolId ¶

func (s *AdminRemoveUserFromGroupInput) SetUserPoolId(v string) *AdminRemoveUserFromGroupInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminRemoveUserFromGroupInput) SetUsername ¶

func (s *AdminRemoveUserFromGroupInput) SetUsername(v string) *AdminRemoveUserFromGroupInput

SetUsername sets the Username field's value.

func (AdminRemoveUserFromGroupInput) String ¶

func (s AdminRemoveUserFromGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminRemoveUserFromGroupInput) Validate ¶

func (s *AdminRemoveUserFromGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminRemoveUserFromGroupOutput ¶

type AdminRemoveUserFromGroupOutput struct {
    // contains filtered or unexported fields
}

func (AdminRemoveUserFromGroupOutput) GoString ¶

func (s AdminRemoveUserFromGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminRemoveUserFromGroupOutput) String ¶

func (s AdminRemoveUserFromGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminResetUserPasswordInput ¶

type AdminResetUserPasswordInput struct {

    // A map of custom key-value pairs that you can provide as input for any custom
    // workflows that this action triggers.
    //
    // You create custom workflows by assigning Lambda functions to user pool triggers.
    // When you use the AdminResetUserPassword API action, Amazon Cognito invokes
    // the function that is assigned to the custom message trigger. When Amazon
    // Cognito invokes this function, it passes a JSON payload, which the function
    // receives as input. This payload contains a clientMetadata attribute, which
    // provides the data that you assigned to the ClientMetadata parameter in your
    // AdminResetUserPassword request. In your function code in Lambda, you can
    // process the clientMetadata value to enhance your workflow for your specific
    // needs.
    //
    // For more information, see Customizing user pool Workflows with Lambda Triggers
    // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
    // in the Amazon Cognito Developer Guide.
    //
    // When you use the ClientMetadata parameter, remember that Amazon Cognito won't
    // do the following:
    //
    //    * Store the ClientMetadata value. This data is available only to Lambda
    //    triggers that are assigned to a user pool to support custom workflows.
    //    If your user pool configuration doesn't include triggers, the ClientMetadata
    //    parameter serves no purpose.
    //
    //    * Validate the ClientMetadata value.
    //
    //    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide
    //    sensitive information.
    ClientMetadata map[string]*string `type:"map"`

    // The user pool ID for the user pool where you want to reset the user's password.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user whose password you want to reset.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminResetUserPasswordInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

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

func (AdminResetUserPasswordInput) GoString ¶

func (s AdminResetUserPasswordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminResetUserPasswordInput) SetClientMetadata ¶

func (s *AdminResetUserPasswordInput) SetClientMetadata(v map[string]*string) *AdminResetUserPasswordInput

SetClientMetadata sets the ClientMetadata field's value.

func (*AdminResetUserPasswordInput) SetUserPoolId ¶

func (s *AdminResetUserPasswordInput) SetUserPoolId(v string) *AdminResetUserPasswordInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminResetUserPasswordInput) SetUsername ¶

func (s *AdminResetUserPasswordInput) SetUsername(v string) *AdminResetUserPasswordInput

SetUsername sets the Username field's value.

func (AdminResetUserPasswordInput) String ¶

func (s AdminResetUserPasswordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminResetUserPasswordInput) Validate ¶

func (s *AdminResetUserPasswordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminResetUserPasswordOutput ¶

type AdminResetUserPasswordOutput struct {
    // contains filtered or unexported fields
}

Represents the response from the server to reset a user password as an administrator.

func (AdminResetUserPasswordOutput) GoString ¶

func (s AdminResetUserPasswordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminResetUserPasswordOutput) String ¶

func (s AdminResetUserPasswordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminRespondToAuthChallengeInput ¶

type AdminRespondToAuthChallengeInput struct {

    // The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge
    // calls.
    AnalyticsMetadata *AnalyticsMetadataType `type:"structure"`

    // The challenge name. For more information, see AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html).
    //
    // ChallengeName is a required field
    ChallengeName *string `type:"string" required:"true" enum:"ChallengeNameType"`

    // The challenge responses. These are inputs corresponding to the value of ChallengeName,
    // for example:
    //
    //    * SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured
    //    with client secret).
    //
    //    * PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK,
    //    TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client
    //    secret). PASSWORD_VERIFIER requires DEVICE_KEY when signing in with a
    //    remembered device.
    //
    //    * ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is
    //    configured with client secret).
    //
    //    * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, USERNAME, SECRET_HASH (if app client
    //    is configured with client secret). To set any required attributes that
    //    Amazon Cognito returned as requiredAttributes in the AdminInitiateAuth
    //    response, add a userAttributes.attributename parameter. This parameter
    //    can also set values for writable attributes that aren't required by your
    //    user pool. In a NEW_PASSWORD_REQUIRED challenge response, you can't modify
    //    a required attribute that already has a value. In AdminRespondToAuthChallenge,
    //    set a value for any keys that Amazon Cognito returned in the requiredAttributes
    //    parameter, then use the AdminUpdateUserAttributes API operation to modify
    //    the value of any additional attributes.
    //
    //    * MFA_SETUP requires USERNAME, plus you must use the session value returned
    //    by VerifySoftwareToken in the Session parameter.
    //
    // The value of the USERNAME attribute must be the user's actual username, not
    // an alias (such as an email address or phone number). To make this simpler,
    // the AdminInitiateAuth response includes the actual username value in the
    // USERNAMEUSER_ID_FOR_SRP attribute. This happens even if you specified an
    // alias in your call to AdminInitiateAuth.
    //
    // For more information about SECRET_HASH, see Computing secret hash values
    // (https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html#cognito-user-pools-computing-secret-hash).
    // For information about DEVICE_KEY, see Working with user devices in your user
    // pool (https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html).
    //
    // ChallengeResponses is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminRespondToAuthChallengeInput's
    // String and GoString methods.
    ChallengeResponses map[string]*string `type:"map" sensitive:"true"`

    // The app client ID.
    //
    // ClientId is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminRespondToAuthChallengeInput's
    // String and GoString methods.
    //
    // ClientId is a required field
    ClientId *string `min:"1" type:"string" required:"true" sensitive:"true"`

    // A map of custom key-value pairs that you can provide as input for any custom
    // workflows that this action triggers.
    //
    // You create custom workflows by assigning Lambda functions to user pool triggers.
    // When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes
    // any functions that you have assigned to the following triggers:
    //
    //    * pre sign-up
    //
    //    * custom message
    //
    //    * post authentication
    //
    //    * user migration
    //
    //    * pre token generation
    //
    //    * define auth challenge
    //
    //    * create auth challenge
    //
    //    * verify auth challenge response
    //
    // When Amazon Cognito invokes any of these functions, it passes a JSON payload,
    // which the function receives as input. This payload contains a clientMetadata
    // attribute that provides the data that you assigned to the ClientMetadata
    // parameter in your AdminRespondToAuthChallenge request. In your function code
    // in Lambda, you can process the clientMetadata value to enhance your workflow
    // for your specific needs.
    //
    // For more information, see Customizing user pool Workflows with Lambda Triggers
    // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
    // in the Amazon Cognito Developer Guide.
    //
    // When you use the ClientMetadata parameter, remember that Amazon Cognito won't
    // do the following:
    //
    //    * Store the ClientMetadata value. This data is available only to Lambda
    //    triggers that are assigned to a user pool to support custom workflows.
    //    If your user pool configuration doesn't include triggers, the ClientMetadata
    //    parameter serves no purpose.
    //
    //    * Validate the ClientMetadata value.
    //
    //    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide
    //    sensitive information.
    ClientMetadata map[string]*string `type:"map"`

    // Contextual data about your user session, such as the device fingerprint,
    // IP address, or location. Amazon Cognito advanced security evaluates the risk
    // of an authentication event based on the context that your app generates and
    // passes to Amazon Cognito when it makes API requests.
    ContextData *ContextDataType `type:"structure"`

    // The session that should be passed both ways in challenge-response calls to
    // the service. If an InitiateAuth or RespondToAuthChallenge API call determines
    // that the caller must pass another challenge, it returns a session with other
    // challenge parameters. This session should be passed as it is to the next
    // RespondToAuthChallenge API call.
    //
    // Session is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminRespondToAuthChallengeInput's
    // String and GoString methods.
    Session *string `min:"20" type:"string" sensitive:"true"`

    // The ID of the Amazon Cognito user pool.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

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

func (AdminRespondToAuthChallengeInput) GoString ¶

func (s AdminRespondToAuthChallengeInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminRespondToAuthChallengeInput) SetAnalyticsMetadata ¶

func (s *AdminRespondToAuthChallengeInput) SetAnalyticsMetadata(v *AnalyticsMetadataType) *AdminRespondToAuthChallengeInput

SetAnalyticsMetadata sets the AnalyticsMetadata field's value.

func (*AdminRespondToAuthChallengeInput) SetChallengeName ¶

func (s *AdminRespondToAuthChallengeInput) SetChallengeName(v string) *AdminRespondToAuthChallengeInput

SetChallengeName sets the ChallengeName field's value.

func (*AdminRespondToAuthChallengeInput) SetChallengeResponses ¶

func (s *AdminRespondToAuthChallengeInput) SetChallengeResponses(v map[string]*string) *AdminRespondToAuthChallengeInput

SetChallengeResponses sets the ChallengeResponses field's value.

func (*AdminRespondToAuthChallengeInput) SetClientId ¶

func (s *AdminRespondToAuthChallengeInput) SetClientId(v string) *AdminRespondToAuthChallengeInput

SetClientId sets the ClientId field's value.

func (*AdminRespondToAuthChallengeInput) SetClientMetadata ¶

func (s *AdminRespondToAuthChallengeInput) SetClientMetadata(v map[string]*string) *AdminRespondToAuthChallengeInput

SetClientMetadata sets the ClientMetadata field's value.

func (*AdminRespondToAuthChallengeInput) SetContextData ¶

func (s *AdminRespondToAuthChallengeInput) SetContextData(v *ContextDataType) *AdminRespondToAuthChallengeInput

SetContextData sets the ContextData field's value.

func (*AdminRespondToAuthChallengeInput) SetSession ¶

func (s *AdminRespondToAuthChallengeInput) SetSession(v string) *AdminRespondToAuthChallengeInput

SetSession sets the Session field's value.

func (*AdminRespondToAuthChallengeInput) SetUserPoolId ¶

func (s *AdminRespondToAuthChallengeInput) SetUserPoolId(v string) *AdminRespondToAuthChallengeInput

SetUserPoolId sets the UserPoolId field's value.

func (AdminRespondToAuthChallengeInput) String ¶

func (s AdminRespondToAuthChallengeInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminRespondToAuthChallengeInput) Validate ¶

func (s *AdminRespondToAuthChallengeInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminRespondToAuthChallengeOutput ¶

type AdminRespondToAuthChallengeOutput struct {

    // The result returned by the server in response to the authentication request.
    AuthenticationResult *AuthenticationResultType `type:"structure"`

    // The name of the challenge. For more information, see AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html).
    ChallengeName *string `type:"string" enum:"ChallengeNameType"`

    // The challenge parameters. For more information, see AdminInitiateAuth (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html).
    ChallengeParameters map[string]*string `type:"map"`

    // The session that should be passed both ways in challenge-response calls to
    // the service. If the caller must pass another challenge, they return a session
    // with other challenge parameters. This session should be passed as it is to
    // the next RespondToAuthChallenge API call.
    //
    // Session is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminRespondToAuthChallengeOutput's
    // String and GoString methods.
    Session *string `min:"20" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

Responds to the authentication challenge, as an administrator.

func (AdminRespondToAuthChallengeOutput) GoString ¶

func (s AdminRespondToAuthChallengeOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminRespondToAuthChallengeOutput) SetAuthenticationResult ¶

func (s *AdminRespondToAuthChallengeOutput) SetAuthenticationResult(v *AuthenticationResultType) *AdminRespondToAuthChallengeOutput

SetAuthenticationResult sets the AuthenticationResult field's value.

func (*AdminRespondToAuthChallengeOutput) SetChallengeName ¶

func (s *AdminRespondToAuthChallengeOutput) SetChallengeName(v string) *AdminRespondToAuthChallengeOutput

SetChallengeName sets the ChallengeName field's value.

func (*AdminRespondToAuthChallengeOutput) SetChallengeParameters ¶

func (s *AdminRespondToAuthChallengeOutput) SetChallengeParameters(v map[string]*string) *AdminRespondToAuthChallengeOutput

SetChallengeParameters sets the ChallengeParameters field's value.

func (*AdminRespondToAuthChallengeOutput) SetSession ¶

func (s *AdminRespondToAuthChallengeOutput) SetSession(v string) *AdminRespondToAuthChallengeOutput

SetSession sets the Session field's value.

func (AdminRespondToAuthChallengeOutput) String ¶

func (s AdminRespondToAuthChallengeOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminSetUserMFAPreferenceInput ¶

type AdminSetUserMFAPreferenceInput struct {

    // The SMS text message MFA settings.
    SMSMfaSettings *SMSMfaSettingsType `type:"structure"`

    // The time-based one-time password software token MFA settings.
    SoftwareTokenMfaSettings *SoftwareTokenMfaSettingsType `type:"structure"`

    // The user pool ID.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user pool username or alias.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminSetUserMFAPreferenceInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AdminSetUserMFAPreferenceInput) GoString ¶

func (s AdminSetUserMFAPreferenceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminSetUserMFAPreferenceInput) SetSMSMfaSettings ¶

func (s *AdminSetUserMFAPreferenceInput) SetSMSMfaSettings(v *SMSMfaSettingsType) *AdminSetUserMFAPreferenceInput

SetSMSMfaSettings sets the SMSMfaSettings field's value.

func (*AdminSetUserMFAPreferenceInput) SetSoftwareTokenMfaSettings ¶

func (s *AdminSetUserMFAPreferenceInput) SetSoftwareTokenMfaSettings(v *SoftwareTokenMfaSettingsType) *AdminSetUserMFAPreferenceInput

SetSoftwareTokenMfaSettings sets the SoftwareTokenMfaSettings field's value.

func (*AdminSetUserMFAPreferenceInput) SetUserPoolId ¶

func (s *AdminSetUserMFAPreferenceInput) SetUserPoolId(v string) *AdminSetUserMFAPreferenceInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminSetUserMFAPreferenceInput) SetUsername ¶

func (s *AdminSetUserMFAPreferenceInput) SetUsername(v string) *AdminSetUserMFAPreferenceInput

SetUsername sets the Username field's value.

func (AdminSetUserMFAPreferenceInput) String ¶

func (s AdminSetUserMFAPreferenceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminSetUserMFAPreferenceInput) Validate ¶

func (s *AdminSetUserMFAPreferenceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminSetUserMFAPreferenceOutput ¶

type AdminSetUserMFAPreferenceOutput struct {
    // contains filtered or unexported fields
}

func (AdminSetUserMFAPreferenceOutput) GoString ¶

func (s AdminSetUserMFAPreferenceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminSetUserMFAPreferenceOutput) String ¶

func (s AdminSetUserMFAPreferenceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminSetUserPasswordInput ¶

type AdminSetUserPasswordInput struct {

    // The password for the user.
    //
    // Password is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminSetUserPasswordInput's
    // String and GoString methods.
    //
    // Password is a required field
    Password *string `type:"string" required:"true" sensitive:"true"`

    // True if the password is permanent, False if it is temporary.
    Permanent *bool `type:"boolean"`

    // The user pool ID for the user pool where you want to set the user's password.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user whose password you want to set.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminSetUserPasswordInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AdminSetUserPasswordInput) GoString ¶

func (s AdminSetUserPasswordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminSetUserPasswordInput) SetPassword ¶

func (s *AdminSetUserPasswordInput) SetPassword(v string) *AdminSetUserPasswordInput

SetPassword sets the Password field's value.

func (*AdminSetUserPasswordInput) SetPermanent ¶

func (s *AdminSetUserPasswordInput) SetPermanent(v bool) *AdminSetUserPasswordInput

SetPermanent sets the Permanent field's value.

func (*AdminSetUserPasswordInput) SetUserPoolId ¶

func (s *AdminSetUserPasswordInput) SetUserPoolId(v string) *AdminSetUserPasswordInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminSetUserPasswordInput) SetUsername ¶

func (s *AdminSetUserPasswordInput) SetUsername(v string) *AdminSetUserPasswordInput

SetUsername sets the Username field's value.

func (AdminSetUserPasswordInput) String ¶

func (s AdminSetUserPasswordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminSetUserPasswordInput) Validate ¶

func (s *AdminSetUserPasswordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminSetUserPasswordOutput ¶

type AdminSetUserPasswordOutput struct {
    // contains filtered or unexported fields
}

func (AdminSetUserPasswordOutput) GoString ¶

func (s AdminSetUserPasswordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminSetUserPasswordOutput) String ¶

func (s AdminSetUserPasswordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminSetUserSettingsInput ¶

type AdminSetUserSettingsInput struct {

    // You can use this parameter only to set an SMS configuration that uses SMS
    // for delivery.
    //
    // MFAOptions is a required field
    MFAOptions []*MFAOptionType `type:"list" required:"true"`

    // The ID of the user pool that contains the user whose options you're setting.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user whose options you're setting.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminSetUserSettingsInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

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

func (AdminSetUserSettingsInput) GoString ¶

func (s AdminSetUserSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminSetUserSettingsInput) SetMFAOptions ¶

func (s *AdminSetUserSettingsInput) SetMFAOptions(v []*MFAOptionType) *AdminSetUserSettingsInput

SetMFAOptions sets the MFAOptions field's value.

func (*AdminSetUserSettingsInput) SetUserPoolId ¶

func (s *AdminSetUserSettingsInput) SetUserPoolId(v string) *AdminSetUserSettingsInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminSetUserSettingsInput) SetUsername ¶

func (s *AdminSetUserSettingsInput) SetUsername(v string) *AdminSetUserSettingsInput

SetUsername sets the Username field's value.

func (AdminSetUserSettingsInput) String ¶

func (s AdminSetUserSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminSetUserSettingsInput) Validate ¶

func (s *AdminSetUserSettingsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminSetUserSettingsOutput ¶

type AdminSetUserSettingsOutput struct {
    // contains filtered or unexported fields
}

Represents the response from the server to set user settings as an administrator.

func (AdminSetUserSettingsOutput) GoString ¶

func (s AdminSetUserSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminSetUserSettingsOutput) String ¶

func (s AdminSetUserSettingsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminUpdateAuthEventFeedbackInput ¶

type AdminUpdateAuthEventFeedbackInput struct {

    // The authentication event ID.
    //
    // EventId is a required field
    EventId *string `min:"1" type:"string" required:"true"`

    // The authentication event feedback value. When you provide a FeedbackValue
    // value of valid, you tell Amazon Cognito that you trust a user session where
    // Amazon Cognito has evaluated some level of risk. When you provide a FeedbackValue
    // value of invalid, you tell Amazon Cognito that you don't trust a user session,
    // or you don't believe that Amazon Cognito evaluated a high-enough risk level.
    //
    // FeedbackValue is a required field
    FeedbackValue *string `type:"string" required:"true" enum:"FeedbackValueType"`

    // The user pool ID.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user pool username.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminUpdateAuthEventFeedbackInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AdminUpdateAuthEventFeedbackInput) GoString ¶

func (s AdminUpdateAuthEventFeedbackInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminUpdateAuthEventFeedbackInput) SetEventId ¶

func (s *AdminUpdateAuthEventFeedbackInput) SetEventId(v string) *AdminUpdateAuthEventFeedbackInput

SetEventId sets the EventId field's value.

func (*AdminUpdateAuthEventFeedbackInput) SetFeedbackValue ¶

func (s *AdminUpdateAuthEventFeedbackInput) SetFeedbackValue(v string) *AdminUpdateAuthEventFeedbackInput

SetFeedbackValue sets the FeedbackValue field's value.

func (*AdminUpdateAuthEventFeedbackInput) SetUserPoolId ¶

func (s *AdminUpdateAuthEventFeedbackInput) SetUserPoolId(v string) *AdminUpdateAuthEventFeedbackInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminUpdateAuthEventFeedbackInput) SetUsername ¶

func (s *AdminUpdateAuthEventFeedbackInput) SetUsername(v string) *AdminUpdateAuthEventFeedbackInput

SetUsername sets the Username field's value.

func (AdminUpdateAuthEventFeedbackInput) String ¶

func (s AdminUpdateAuthEventFeedbackInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminUpdateAuthEventFeedbackInput) Validate ¶

func (s *AdminUpdateAuthEventFeedbackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminUpdateAuthEventFeedbackOutput ¶

type AdminUpdateAuthEventFeedbackOutput struct {
    // contains filtered or unexported fields
}

func (AdminUpdateAuthEventFeedbackOutput) GoString ¶

func (s AdminUpdateAuthEventFeedbackOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminUpdateAuthEventFeedbackOutput) String ¶

func (s AdminUpdateAuthEventFeedbackOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminUpdateDeviceStatusInput ¶

type AdminUpdateDeviceStatusInput struct {

    // The device key.
    //
    // DeviceKey is a required field
    DeviceKey *string `min:"1" type:"string" required:"true"`

    // The status indicating whether a device has been remembered or not.
    DeviceRememberedStatus *string `type:"string" enum:"DeviceRememberedStatusType"`

    // The user pool ID.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminUpdateDeviceStatusInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

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

func (AdminUpdateDeviceStatusInput) GoString ¶

func (s AdminUpdateDeviceStatusInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminUpdateDeviceStatusInput) SetDeviceKey ¶

func (s *AdminUpdateDeviceStatusInput) SetDeviceKey(v string) *AdminUpdateDeviceStatusInput

SetDeviceKey sets the DeviceKey field's value.

func (*AdminUpdateDeviceStatusInput) SetDeviceRememberedStatus ¶

func (s *AdminUpdateDeviceStatusInput) SetDeviceRememberedStatus(v string) *AdminUpdateDeviceStatusInput

SetDeviceRememberedStatus sets the DeviceRememberedStatus field's value.

func (*AdminUpdateDeviceStatusInput) SetUserPoolId ¶

func (s *AdminUpdateDeviceStatusInput) SetUserPoolId(v string) *AdminUpdateDeviceStatusInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminUpdateDeviceStatusInput) SetUsername ¶

func (s *AdminUpdateDeviceStatusInput) SetUsername(v string) *AdminUpdateDeviceStatusInput

SetUsername sets the Username field's value.

func (AdminUpdateDeviceStatusInput) String ¶

func (s AdminUpdateDeviceStatusInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminUpdateDeviceStatusInput) Validate ¶

func (s *AdminUpdateDeviceStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminUpdateDeviceStatusOutput ¶

type AdminUpdateDeviceStatusOutput struct {
    // contains filtered or unexported fields
}

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

func (AdminUpdateDeviceStatusOutput) GoString ¶

func (s AdminUpdateDeviceStatusOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminUpdateDeviceStatusOutput) String ¶

func (s AdminUpdateDeviceStatusOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminUpdateUserAttributesInput ¶

type AdminUpdateUserAttributesInput struct {

    // A map of custom key-value pairs that you can provide as input for any custom
    // workflows that this action triggers.
    //
    // You create custom workflows by assigning Lambda functions to user pool triggers.
    // When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes
    // the function that is assigned to the custom message trigger. When Amazon
    // Cognito invokes this function, it passes a JSON payload, which the function
    // receives as input. This payload contains a clientMetadata attribute, which
    // provides the data that you assigned to the ClientMetadata parameter in your
    // AdminUpdateUserAttributes request. In your function code in Lambda, you can
    // process the clientMetadata value to enhance your workflow for your specific
    // needs.
    //
    // For more information, see Customizing user pool Workflows with Lambda Triggers
    // (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
    // in the Amazon Cognito Developer Guide.
    //
    // When you use the ClientMetadata parameter, remember that Amazon Cognito won't
    // do the following:
    //
    //    * Store the ClientMetadata value. This data is available only to Lambda
    //    triggers that are assigned to a user pool to support custom workflows.
    //    If your user pool configuration doesn't include triggers, the ClientMetadata
    //    parameter serves no purpose.
    //
    //    * Validate the ClientMetadata value.
    //
    //    * Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide
    //    sensitive information.
    ClientMetadata map[string]*string `type:"map"`

    // An array of name-value pairs representing user attributes.
    //
    // For custom attributes, you must prepend the custom: prefix to the attribute
    // name.
    //
    // If your user pool requires verification before Amazon Cognito updates an
    // attribute value that you specify in this request, Amazon Cognito doesn’t
    // immediately update the value of that attribute. After your user receives
    // and responds to a verification message to verify the new value, Amazon Cognito
    // updates the attribute value. Your user can sign in and receive messages with
    // the original attribute value until they verify the new value.
    //
    // To update the value of an attribute that requires verification in the same
    // API request, include the email_verified or phone_number_verified attribute,
    // with a value of true. If you set the email_verified or phone_number_verified
    // value for an email or phone_number attribute that requires verification to
    // true, Amazon Cognito doesn’t send a verification message to your user.
    //
    // UserAttributes is a required field
    UserAttributes []*AttributeType `type:"list" required:"true"`

    // The user pool ID for the user pool where you want to update user attributes.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user for whom you want to update user attributes.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminUpdateUserAttributesInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

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

func (AdminUpdateUserAttributesInput) GoString ¶

func (s AdminUpdateUserAttributesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminUpdateUserAttributesInput) SetClientMetadata ¶

func (s *AdminUpdateUserAttributesInput) SetClientMetadata(v map[string]*string) *AdminUpdateUserAttributesInput

SetClientMetadata sets the ClientMetadata field's value.

func (*AdminUpdateUserAttributesInput) SetUserAttributes ¶

func (s *AdminUpdateUserAttributesInput) SetUserAttributes(v []*AttributeType) *AdminUpdateUserAttributesInput

SetUserAttributes sets the UserAttributes field's value.

func (*AdminUpdateUserAttributesInput) SetUserPoolId ¶

func (s *AdminUpdateUserAttributesInput) SetUserPoolId(v string) *AdminUpdateUserAttributesInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminUpdateUserAttributesInput) SetUsername ¶

func (s *AdminUpdateUserAttributesInput) SetUsername(v string) *AdminUpdateUserAttributesInput

SetUsername sets the Username field's value.

func (AdminUpdateUserAttributesInput) String ¶

func (s AdminUpdateUserAttributesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminUpdateUserAttributesInput) Validate ¶

func (s *AdminUpdateUserAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminUpdateUserAttributesOutput ¶

type AdminUpdateUserAttributesOutput struct {
    // contains filtered or unexported fields
}

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

func (AdminUpdateUserAttributesOutput) GoString ¶

func (s AdminUpdateUserAttributesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminUpdateUserAttributesOutput) String ¶

func (s AdminUpdateUserAttributesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdminUserGlobalSignOutInput ¶

type AdminUserGlobalSignOutInput struct {

    // The user pool ID.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name.
    //
    // Username is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AdminUserGlobalSignOutInput's
    // String and GoString methods.
    //
    // Username is a required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

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

func (AdminUserGlobalSignOutInput) GoString ¶

func (s AdminUserGlobalSignOutInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminUserGlobalSignOutInput) SetUserPoolId ¶

func (s *AdminUserGlobalSignOutInput) SetUserPoolId(v string) *AdminUserGlobalSignOutInput

SetUserPoolId sets the UserPoolId field's value.

func (*AdminUserGlobalSignOutInput) SetUsername ¶

func (s *AdminUserGlobalSignOutInput) SetUsername(v string) *AdminUserGlobalSignOutInput

SetUsername sets the Username field's value.

func (AdminUserGlobalSignOutInput) String ¶

func (s AdminUserGlobalSignOutInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdminUserGlobalSignOutInput) Validate ¶

func (s *AdminUserGlobalSignOutInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AdminUserGlobalSignOutOutput ¶

type AdminUserGlobalSignOutOutput struct {
    // contains filtered or unexported fields
}

The global sign-out response, as an administrator.

func (AdminUserGlobalSignOutOutput) GoString ¶

func (s AdminUserGlobalSignOutOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AdminUserGlobalSignOutOutput) String ¶

func (s AdminUserGlobalSignOutOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AliasExistsException ¶

type AliasExistsException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // The message that Amazon Cognito sends to the user when the value of an alias
    // attribute is already linked to another user profile.
    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.

func (*AliasExistsException) Code ¶

func (s *AliasExistsException) Code() string

Code returns the exception type name.

func (*AliasExistsException) Error ¶

func (s *AliasExistsException) Error() string

func (AliasExistsException) GoString ¶

func (s AliasExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AliasExistsException) Message ¶

func (s *AliasExistsException) Message() string

Message returns the exception's message.

func (*AliasExistsException) OrigErr ¶

func (s *AliasExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AliasExistsException) RequestID ¶

func (s *AliasExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AliasExistsException) StatusCode ¶

func (s *AliasExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AliasExistsException) String ¶

func (s AliasExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AnalyticsConfigurationType ¶

type AnalyticsConfigurationType struct {

    // The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use
    // the Amazon Pinpoint project to integrate with the chosen user pool Client.
    // Amazon Cognito publishes events to the Amazon Pinpoint project that the app
    // ARN declares.
    ApplicationArn *string `min:"20" type:"string"`

    // The application ID for an Amazon Pinpoint application.
    ApplicationId *string `type:"string"`

    // The external ID.
    ExternalId *string `type:"string"`

    // The ARN of an Identity and Access Management role that authorizes Amazon
    // Cognito to publish events to Amazon Pinpoint analytics.
    RoleArn *string `min:"20" type:"string"`

    // If UserDataShared is true, Amazon Cognito includes user data in the events
    // that it publishes to Amazon Pinpoint analytics.
    UserDataShared *bool `type:"boolean"`
    // contains filtered or unexported fields
}

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.

func (AnalyticsConfigurationType) GoString ¶

func (s AnalyticsConfigurationType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyticsConfigurationType) SetApplicationArn ¶

func (s *AnalyticsConfigurationType) SetApplicationArn(v string) *AnalyticsConfigurationType

SetApplicationArn sets the ApplicationArn field's value.

func (*AnalyticsConfigurationType) SetApplicationId ¶

func (s *AnalyticsConfigurationType) SetApplicationId(v string) *AnalyticsConfigurationType

SetApplicationId sets the ApplicationId field's value.

func (*AnalyticsConfigurationType) SetExternalId ¶

func (s *AnalyticsConfigurationType) SetExternalId(v string) *AnalyticsConfigurationType

SetExternalId sets the ExternalId field's value.

func (*AnalyticsConfigurationType) SetRoleArn ¶

func (s *AnalyticsConfigurationType) SetRoleArn(v string) *AnalyticsConfigurationType

SetRoleArn sets the RoleArn field's value.

func (*AnalyticsConfigurationType) SetUserDataShared ¶

func (s *AnalyticsConfigurationType) SetUserDataShared(v bool) *AnalyticsConfigurationType

SetUserDataShared sets the UserDataShared field's value.

func (AnalyticsConfigurationType) String ¶

func (s AnalyticsConfigurationType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyticsConfigurationType) Validate ¶

func (s *AnalyticsConfigurationType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AnalyticsMetadataType ¶

type AnalyticsMetadataType struct {

    // The endpoint ID.
    AnalyticsEndpointId *string `type:"string"`
    // contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-pinpoint-integration.html).

func (AnalyticsMetadataType) GoString ¶

func (s AnalyticsMetadataType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnalyticsMetadataType) SetAnalyticsEndpointId ¶

func (s *AnalyticsMetadataType) SetAnalyticsEndpointId(v string) *AnalyticsMetadataType

SetAnalyticsEndpointId sets the AnalyticsEndpointId field's value.

func (AnalyticsMetadataType) String ¶

func (s AnalyticsMetadataType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateSoftwareTokenInput ¶

type AssociateSoftwareTokenInput struct {

    // A valid access token that Amazon Cognito issued to the user whose software
    // token you want to generate.
    //
    // AccessToken is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AssociateSoftwareTokenInput's
    // String and GoString methods.
    AccessToken *string `type:"string" sensitive:"true"`

    // The session that should be passed both ways in challenge-response calls to
    // the service. This allows authentication of the user as part of the MFA setup
    // process.
    //
    // Session is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AssociateSoftwareTokenInput's
    // String and GoString methods.
    Session *string `min:"20" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AssociateSoftwareTokenInput) GoString ¶

func (s AssociateSoftwareTokenInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateSoftwareTokenInput) SetAccessToken ¶

func (s *AssociateSoftwareTokenInput) SetAccessToken(v string) *AssociateSoftwareTokenInput

SetAccessToken sets the AccessToken field's value.

func (*AssociateSoftwareTokenInput) SetSession ¶

func (s *AssociateSoftwareTokenInput) SetSession(v string) *AssociateSoftwareTokenInput

SetSession sets the Session field's value.

func (AssociateSoftwareTokenInput) String ¶

func (s AssociateSoftwareTokenInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateSoftwareTokenInput) Validate ¶

func (s *AssociateSoftwareTokenInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateSoftwareTokenOutput ¶

type AssociateSoftwareTokenOutput struct {

    // A unique generated shared secret code that is used in the TOTP algorithm
    // to generate a one-time code.
    //
    // SecretCode is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AssociateSoftwareTokenOutput's
    // String and GoString methods.
    SecretCode *string `min:"16" type:"string" sensitive:"true"`

    // The session that should be passed both ways in challenge-response calls to
    // the service. This allows authentication of the user as part of the MFA setup
    // process.
    //
    // Session is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AssociateSoftwareTokenOutput's
    // String and GoString methods.
    Session *string `min:"20" type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

func (AssociateSoftwareTokenOutput) GoString ¶

func (s AssociateSoftwareTokenOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateSoftwareTokenOutput) SetSecretCode ¶

func (s *AssociateSoftwareTokenOutput) SetSecretCode(v string) *AssociateSoftwareTokenOutput

SetSecretCode sets the SecretCode field's value.

func (*AssociateSoftwareTokenOutput) SetSession ¶

func (s *AssociateSoftwareTokenOutput) SetSession(v string) *AssociateSoftwareTokenOutput

SetSession sets the Session field's value.

func (AssociateSoftwareTokenOutput) String ¶

func (s AssociateSoftwareTokenOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AttributeType ¶

type AttributeType struct {

    // The name of the attribute.
    //
    // Name is a required field
    Name *string `min:"1" type:"string" required:"true"`

    // The value of the attribute.
    //
    // Value is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AttributeType's
    // String and GoString methods.
    Value *string `type:"string" sensitive:"true"`
    // contains filtered or unexported fields
}

Specifies whether the attribute is standard or custom.

func (AttributeType) GoString ¶

func (s AttributeType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeType) SetName ¶

func (s *AttributeType) SetName(v string) *AttributeType

SetName sets the Name field's value.

func (*AttributeType) SetValue ¶

func (s *AttributeType) SetValue(v string) *AttributeType

SetValue sets the Value field's value.

func (AttributeType) String ¶

func (s AttributeType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AttributeType) Validate ¶

func (s *AttributeType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AuthEventType ¶

type AuthEventType struct {

    // The challenge responses.
    ChallengeResponses []*ChallengeResponseType `type:"list"`

    // The date and time, in ISO 8601 (https://www.iso.org/iso-8601-date-and-time-format.html)
    // format, when the item was created.
    CreationDate *time.Time `type:"timestamp"`

    // The user context data captured at the time of an event request. This value
    // provides additional information about the client from which event the request
    // is received.
    EventContextData *EventContextDataType `type:"structure"`

    // A flag specifying the user feedback captured at the time of an event request
    // is good or bad.
    EventFeedback *EventFeedbackType `type:"structure"`

    // The event ID.
    EventId *string `type:"string"`

    // The event response.
    EventResponse *string `type:"string" enum:"EventResponseType"`

    // The event risk.
    EventRisk *EventRiskType `type:"structure"`

    // The event type.
    EventType *string `type:"string" enum:"EventType"`
    // contains filtered or unexported fields
}

The authentication event type.

func (AuthEventType) GoString ¶

func (s AuthEventType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthEventType) SetChallengeResponses ¶

func (s *AuthEventType) SetChallengeResponses(v []*ChallengeResponseType) *AuthEventType

SetChallengeResponses sets the ChallengeResponses field's value.

func (*AuthEventType) SetCreationDate ¶

func (s *AuthEventType) SetCreationDate(v time.Time) *AuthEventType

SetCreationDate sets the CreationDate field's value.

func (*AuthEventType) SetEventContextData ¶

func (s *AuthEventType) SetEventContextData(v *EventContextDataType) *AuthEventType

SetEventContextData sets the EventContextData field's value.

func (*AuthEventType) SetEventFeedback ¶

func (s *AuthEventType) SetEventFeedback(v *EventFeedbackType) *AuthEventType

SetEventFeedback sets the EventFeedback field's value.

func (*AuthEventType) SetEventId ¶

func (s *AuthEventType) SetEventId(v string) *AuthEventType

SetEventId sets the EventId field's value.

func (*AuthEventType) SetEventResponse ¶

func (s *AuthEventType) SetEventResponse(v string) *AuthEventType

SetEventResponse sets the EventResponse field's value.

func (*AuthEventType) SetEventRisk ¶

func (s *AuthEventType) SetEventRisk(v *EventRiskType) *AuthEventType

SetEventRisk sets the EventRisk field's value.

func (*AuthEventType) SetEventType ¶

func (s *AuthEventType) SetEventType(v string) *AuthEventType

SetEventType sets the EventType field's value.

func (AuthEventType) String ¶

func (s AuthEventType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthenticationResultType ¶

type AuthenticationResultType struct {

    // A valid access token that Amazon Cognito issued to the user who you want
    // to authenticate.
    //
    // AccessToken is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AuthenticationResultType's
    // String and GoString methods.
    AccessToken *string `type:"string" sensitive:"true"`

    // The expiration period of the authentication result in seconds.
    ExpiresIn *int64 `type:"integer"`

    // The ID token.
    //
    // IdToken is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AuthenticationResultType's
    // String and GoString methods.
    IdToken *string `type:"string" sensitive:"true"`

    // The new device metadata from an authentication result.
    NewDeviceMetadata *NewDeviceMetadataType `type:"structure"`

    // The refresh token.
    //
    // RefreshToken is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by AuthenticationResultType's
    // String and GoString methods.
    RefreshToken *string `type:"string" sensitive:"true"`

    // The token type.
    TokenType *string `type:"string"`
    // contains filtered or unexported fields
}

The authentication result.

func (AuthenticationResultType) GoString ¶

func (s AuthenticationResultType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationResultType) SetAccessToken ¶

func (s *AuthenticationResultType) SetAccessToken(v string) *AuthenticationResultType

SetAccessToken sets the AccessToken field's value.

func (*AuthenticationResultType) SetExpiresIn ¶

func (s *AuthenticationResultType) SetExpiresIn(v int64) *AuthenticationResultType

SetExpiresIn sets the ExpiresIn field's value.

func (*AuthenticationResultType) SetIdToken ¶

func (s *AuthenticationResultType) SetIdToken(v string) *AuthenticationResultType

SetIdToken sets the IdToken field's value.

func (*AuthenticationResultType) SetNewDeviceMetadata ¶

func (s *AuthenticationResultType) SetNewDeviceMetadata(v *NewDeviceMetadataType) *AuthenticationResultType

SetNewDeviceMetadata sets the NewDeviceMetadata field's value.

func (*AuthenticationResultType) SetRefreshToken ¶

func (s *AuthenticationResultType) SetRefreshToken(v string) *AuthenticationResultType

SetRefreshToken sets the RefreshToken field's value.

func (*AuthenticationResultType) SetTokenType ¶

func (s *AuthenticationResultType) SetTokenType(v string) *AuthenticationResultType

SetTokenType sets the TokenType field's value.

func (AuthenticationResultType) String ¶

func (s AuthenticationResultType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChallengeResponseType ¶

type ChallengeResponseType struct {

    // The challenge name.
    ChallengeName *string `type:"string" enum:"ChallengeName"`

    // The challenge response.
    ChallengeResponse *string `type:"string" enum:"ChallengeResponse"`
    // contains filtered or unexported fields
}

The challenge response type.

func (ChallengeResponseType) GoString ¶

func (s ChallengeResponseType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChallengeResponseType) SetChallengeName ¶

func (s *ChallengeResponseType) SetChallengeName(v string) *ChallengeResponseType

SetChallengeName sets the ChallengeName field's value.

func (*ChallengeResponseType) SetChallengeResponse ¶

func (s *ChallengeResponseType) SetChallengeResponse(v string) *ChallengeResponseType

SetChallengeResponse sets the ChallengeResponse field's value.

func (ChallengeResponseType) String ¶

func (s ChallengeResponseType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChangePasswordInput ¶

type ChangePasswordInput struct {

    // A valid access token that Amazon Cognito issued to the user whose password
    // you want to change.
    //
    // AccessToken is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ChangePasswordInput's
    // String and GoString methods.
    //
    // AccessToken is a required field
    AccessToken *string `type:"string" required:"true" sensitive:"true"`

    // The old password.
    //
    // PreviousPassword is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ChangePasswordInput's
    // String and GoString methods.
    //
    // PreviousPassword is a required field
    PreviousPassword *string `type:"string" required:"true" sensitive:"true"`

    // The new password.
    //
    // ProposedPassword is a sensitive parameter and its value will be
    // replaced with "sensitive" in string returned by ChangePasswordInput's
    // String and GoString methods.
    //
    // ProposedPassword is a required field
    ProposedPassword *string `type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Represents the request to change a user password.

func (ChangePasswordInput) GoString ¶

func (s ChangePasswordInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangePasswordInput) SetAccessToken ¶

func (s *ChangePasswordInput) SetAccessToken(v string) *ChangePasswordInput

SetAccessToken sets the AccessToken field's value.

func (*ChangePasswordInput) SetPreviousPassword ¶

func (s *ChangePasswordInput) SetPreviousPassword(v string) *ChangePasswordInput

SetPreviousPassword sets the PreviousPassword field's value.

func (*ChangePasswordInput) SetProposedPassword ¶

func (s *ChangePasswordInput) SetProposedPassword(v string) *ChangePasswordInput

SetProposedPassword sets the ProposedPassword field's value.

func (ChangePasswordInput) String ¶

func (s ChangePasswordInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChangePasswordInput) Validate ¶

func (s *ChangePasswordInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ChangePasswordOutput ¶

type ChangePasswordOutput struct {
    // contains filtered or unexported fields
}

The response from the server to the change password request.

func (ChangePasswordOutput) GoString ¶

func (s ChangePasswordOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (ChangePasswordOutput) String ¶

func (s ChangePasswordOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CloudWatchLogsConfigurationType ¶

type CloudWatchLogsConfigurationType struct {

    // The Amazon Resource Name (arn) of a CloudWatch Logs log group where your
    // user pool sends logs. The log group must not be encrypted with Key Management
    // Service and must be in the same Amazon Web Services account as your user
    // pool.
    //
    // To send logs to log groups with a resource policy of a size greater than
    // 5120 characters, configure a log group with a path that starts with /aws/vendedlogs.
    // For more information, see Enabling logging from certain Amazon Web Services
    // services (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html).
    LogGroupArn *string `min:"20" type:"string"`
    // contains filtered or unexported fields
}

The CloudWatch logging destination of a user pool detailed activity logging configuration.

func (CloudWatchLogsConfigurationType) GoString ¶

func (s CloudWatchLogsConfigurationType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchLogsConfigurationType) SetLogGroupArn ¶

func (s *CloudWatchLogsConfigurationType) SetLogGroupArn(v string) *CloudWatchLogsConfigurationType

SetLogGroupArn sets the LogGroupArn field's value.

func (CloudWatchLogsConfigurationType) String ¶

func (s CloudWatchLogsConfigurationType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CloudWatchLogsConfigurationType) Validate ¶

func (s *CloudWatchLogsConfigurationType) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CodeDeliveryDetailsType ¶

type CodeDeliveryDetailsType struct {

    // The name of the attribute that Amazon Cognito verifies with the code.
    AttributeName *string `min:"1" type:"string"`

    // The method that Amazon Cognito used to send the code.
    DeliveryMedium *string `type:"string" enum:"DeliveryMediumType"`

    // The email address or phone number destination where Amazon Cognito sent the
    // code.
    Destination *string `type:"string"`
    // contains filtered or unexported fields
}

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

func (CodeDeliveryDetailsType) GoString ¶

func (s CodeDeliveryDetailsType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CodeDeliveryDetailsType) SetAttributeName ¶

func (s *CodeDeliveryDetailsType) SetAttributeName(v string) *CodeDeliveryDetailsType

SetAttributeName sets the AttributeName field's value.

func (*CodeDeliveryDetailsType) SetDeliveryMedium ¶

func (s *CodeDeliveryDetailsType) SetDeliveryMedium(v string) *CodeDeliveryDetailsType

SetDeliveryMedium sets the DeliveryMedium field's value.

func (*CodeDeliveryDetailsType) SetDestination ¶

func (s *CodeDeliveryDetailsType) SetDestination(v string) *CodeDeliveryDetailsType

SetDestination sets the Destination field's value.

func (CodeDeliveryDetailsType) String ¶

func (s CodeDeliveryDetailsType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CodeDeliveryFailureException ¶

type CodeDeliveryFailureException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // The message sent when a verification code fails to deliver successfully.
    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

This exception is thrown when a verification code fails to deliver successfully.

func (*CodeDeliveryFailureException) Code ¶

func (s *CodeDeliveryFailureException) Code() string

Code returns the exception type name.

func (*CodeDeliveryFailureException) Error ¶

func (s *CodeDeliveryFailureException) Error() string

func (CodeDeliveryFailureException) GoString ¶

func (s CodeDeliveryFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CodeDeliveryFailureException) Message ¶

func (s *CodeDeliveryFailureException) Message() string

Message returns the exception's message.

func (*CodeDeliveryFailureException) OrigErr ¶

func (s *CodeDeliveryFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CodeDeliveryFailureException) RequestID ¶

func (s *CodeDeliveryFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CodeDeliveryFailureException) StatusCode ¶

func (s *CodeDeliveryFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CodeDeliveryFailureException) String ¶

func (s CodeDeliveryFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CodeMismatchException ¶

type CodeMismatchException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    // The message provided when the code mismatch exception is thrown.
    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

This exception is thrown if the provided code doesn't match what the server was expecting.

func (*CodeMismatchException) Code ¶

func (s *CodeMismatchException) Code() string

Code returns the exception type name.

func (*CodeMismatchException) Error ¶

func (s *CodeMismatchException) Error() string

func (CodeMismatchException) GoString ¶

func (s CodeMismatchException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CodeMismatchException) Message ¶

func (s *CodeMismatchException) Message() string

Message returns the exception's message.

func (*CodeMismatchException) OrigErr ¶

func (s *CodeMismatchException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CodeMismatchException) RequestID ¶

func (s *CodeMismatchException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CodeMismatchException) StatusCode ¶

func (s *CodeMismatchException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CodeMismatchException) String ¶

func (s CodeMismatchException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CognitoIdentityProvider ¶

type CognitoIdentityProvider struct {
    *client.Client
}

CognitoIdentityProvider provides the API operation methods for making requests to Amazon Cognito Identity Provider. See this package's package overview docs for details on the service.

CognitoIdentityProvider methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New ¶

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CognitoIdentityProvider

New creates a new instance of the CognitoIdentityProvider client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a CognitoIdentityProvider client from just a session.
svc := cognitoidentityprovider.New(mySession)

// Create a CognitoIdentityProvider client with additional configuration
svc := cognitoidentityprovider.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CognitoIdentityProvider) AddCustomAttributes ¶

func (c *CognitoIdentityProvider) AddCustomAttributes(input *AddCustomAttributesInput) (*AddCustomAttributesOutput, error)

AddCustomAttributes API operation for Amazon Cognito Identity Provider.

Adds additional user attributes to the user pool schema.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AddCustomAttributes for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserImportInProgressException This exception is thrown when you're trying to modify a user pool while a user import job is in progress for that pool.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AddCustomAttributes

func (*CognitoIdentityProvider) AddCustomAttributesRequest ¶

func (c *CognitoIdentityProvider) AddCustomAttributesRequest(input *AddCustomAttributesInput) (req *request.Request, output *AddCustomAttributesOutput)

AddCustomAttributesRequest generates a "aws/request.Request" representing the client's request for the AddCustomAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddCustomAttributes for more information on using the AddCustomAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddCustomAttributesRequest method.
req, resp := client.AddCustomAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AddCustomAttributes

func (*CognitoIdentityProvider) AddCustomAttributesWithContext ¶

func (c *CognitoIdentityProvider) AddCustomAttributesWithContext(ctx aws.Context, input *AddCustomAttributesInput, opts ...request.Option) (*AddCustomAttributesOutput, error)

AddCustomAttributesWithContext is the same as AddCustomAttributes with the addition of the ability to pass a context and additional request options.

See AddCustomAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminAddUserToGroup ¶

func (c *CognitoIdentityProvider) AdminAddUserToGroup(input *AdminAddUserToGroupInput) (*AdminAddUserToGroupOutput, error)

AdminAddUserToGroup API operation for Amazon Cognito Identity Provider.

Adds the specified user to the specified group.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminAddUserToGroup for usage and error information.

Returned Error Types:

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminAddUserToGroup

func (*CognitoIdentityProvider) AdminAddUserToGroupRequest ¶

func (c *CognitoIdentityProvider) AdminAddUserToGroupRequest(input *AdminAddUserToGroupInput) (req *request.Request, output *AdminAddUserToGroupOutput)

AdminAddUserToGroupRequest generates a "aws/request.Request" representing the client's request for the AdminAddUserToGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminAddUserToGroup for more information on using the AdminAddUserToGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminAddUserToGroupRequest method.
req, resp := client.AdminAddUserToGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminAddUserToGroup

func (*CognitoIdentityProvider) AdminAddUserToGroupWithContext ¶

func (c *CognitoIdentityProvider) AdminAddUserToGroupWithContext(ctx aws.Context, input *AdminAddUserToGroupInput, opts ...request.Option) (*AdminAddUserToGroupOutput, error)

AdminAddUserToGroupWithContext is the same as AdminAddUserToGroup with the addition of the ability to pass a context and additional request options.

See AdminAddUserToGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminConfirmSignUp ¶

func (c *CognitoIdentityProvider) AdminConfirmSignUp(input *AdminConfirmSignUpInput) (*AdminConfirmSignUpOutput, error)

AdminConfirmSignUp API operation for Amazon Cognito Identity Provider.

Confirms user registration as an admin without using a confirmation code. Works on any user.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminConfirmSignUp for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• UnexpectedLambdaException This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.

• UserLambdaValidationException This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• TooManyFailedAttemptsException This exception is thrown when the user has made too many failed attempts for a given action, such as sign-in.

• InvalidLambdaResponseException This exception is thrown when Amazon Cognito encounters an invalid Lambda response.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• LimitExceededException This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminConfirmSignUp

func (*CognitoIdentityProvider) AdminConfirmSignUpRequest ¶

func (c *CognitoIdentityProvider) AdminConfirmSignUpRequest(input *AdminConfirmSignUpInput) (req *request.Request, output *AdminConfirmSignUpOutput)

AdminConfirmSignUpRequest generates a "aws/request.Request" representing the client's request for the AdminConfirmSignUp operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminConfirmSignUp for more information on using the AdminConfirmSignUp API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminConfirmSignUpRequest method.
req, resp := client.AdminConfirmSignUpRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminConfirmSignUp

func (*CognitoIdentityProvider) AdminConfirmSignUpWithContext ¶

func (c *CognitoIdentityProvider) AdminConfirmSignUpWithContext(ctx aws.Context, input *AdminConfirmSignUpInput, opts ...request.Option) (*AdminConfirmSignUpOutput, error)

AdminConfirmSignUpWithContext is the same as AdminConfirmSignUp with the addition of the ability to pass a context and additional request options.

See AdminConfirmSignUp for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminCreateUser ¶

func (c *CognitoIdentityProvider) AdminCreateUser(input *AdminCreateUserInput) (*AdminCreateUserOutput, error)

AdminCreateUser API operation for Amazon Cognito Identity Provider.

Creates a new user in the specified user pool.

If MessageAction isn't set, the default is to send a welcome message via email or phone (SMS).

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) in the Amazon Cognito Developer Guide.

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 won't send any email.

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminCreateUser for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• UserNotFoundException This exception is thrown when a user isn't found.

• UsernameExistsException This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.

• InvalidPasswordException This exception is thrown when Amazon Cognito encounters an invalid password.

• CodeDeliveryFailureException This exception is thrown when a verification code fails to deliver successfully.

• UnexpectedLambdaException This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.

• UserLambdaValidationException This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.

• InvalidLambdaResponseException This exception is thrown when Amazon Cognito encounters an invalid Lambda response.

• PreconditionNotMetException This exception is thrown when a precondition is not met.

• InvalidSmsRoleAccessPolicyException This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.

• InvalidSmsRoleTrustRelationshipException This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UnsupportedUserStateException The request failed because the user is in an unsupported state.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUser

svc := cognitoidentityprovider.New(session.New())
input := &cognitoidentityprovider.AdminCreateUserInput{
    DesiredDeliveryMediums: []*string{
        aws.String("SMS"),
    },
    MessageAction:     aws.String("SUPPRESS"),
    TemporaryPassword: aws.String("This-is-my-test-99!"),
    UserAttributes: []*cognitoidentityprovider.AttributeType{
        {
            Name:  aws.String("name"),
            Value: aws.String("John"),
        },
        {
            Name:  aws.String("phone_number"),
            Value: aws.String("+12065551212"),
        },
        {
            Name:  aws.String("email"),
            Value: aws.String("testuser@example.com"),
        },
    },
    UserPoolId: aws.String("us-east-1_EXAMPLE"),
    Username:   aws.String("testuser"),
}

result, err := svc.AdminCreateUser(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case cognitoidentityprovider.ErrCodeResourceNotFoundException:
            fmt.Println(cognitoidentityprovider.ErrCodeResourceNotFoundException, aerr.Error())
        case cognitoidentityprovider.ErrCodeInvalidParameterException:
            fmt.Println(cognitoidentityprovider.ErrCodeInvalidParameterException, aerr.Error())
        case cognitoidentityprovider.ErrCodeUserNotFoundException:
            fmt.Println(cognitoidentityprovider.ErrCodeUserNotFoundException, aerr.Error())
        case cognitoidentityprovider.ErrCodeUsernameExistsException:
            fmt.Println(cognitoidentityprovider.ErrCodeUsernameExistsException, aerr.Error())
        case cognitoidentityprovider.ErrCodeInvalidPasswordException:
            fmt.Println(cognitoidentityprovider.ErrCodeInvalidPasswordException, aerr.Error())
        case cognitoidentityprovider.ErrCodeCodeDeliveryFailureException:
            fmt.Println(cognitoidentityprovider.ErrCodeCodeDeliveryFailureException, aerr.Error())
        case cognitoidentityprovider.ErrCodeUnexpectedLambdaException:
            fmt.Println(cognitoidentityprovider.ErrCodeUnexpectedLambdaException, aerr.Error())
        case cognitoidentityprovider.ErrCodeUserLambdaValidationException:
            fmt.Println(cognitoidentityprovider.ErrCodeUserLambdaValidationException, aerr.Error())
        case cognitoidentityprovider.ErrCodeInvalidLambdaResponseException:
            fmt.Println(cognitoidentityprovider.ErrCodeInvalidLambdaResponseException, aerr.Error())
        case cognitoidentityprovider.ErrCodePreconditionNotMetException:
            fmt.Println(cognitoidentityprovider.ErrCodePreconditionNotMetException, aerr.Error())
        case cognitoidentityprovider.ErrCodeInvalidSmsRoleAccessPolicyException:
            fmt.Println(cognitoidentityprovider.ErrCodeInvalidSmsRoleAccessPolicyException, aerr.Error())
        case cognitoidentityprovider.ErrCodeInvalidSmsRoleTrustRelationshipException:
            fmt.Println(cognitoidentityprovider.ErrCodeInvalidSmsRoleTrustRelationshipException, aerr.Error())
        case cognitoidentityprovider.ErrCodeTooManyRequestsException:
            fmt.Println(cognitoidentityprovider.ErrCodeTooManyRequestsException, aerr.Error())
        case cognitoidentityprovider.ErrCodeNotAuthorizedException:
            fmt.Println(cognitoidentityprovider.ErrCodeNotAuthorizedException, aerr.Error())
        case cognitoidentityprovider.ErrCodeUnsupportedUserStateException:
            fmt.Println(cognitoidentityprovider.ErrCodeUnsupportedUserStateException, aerr.Error())
        case cognitoidentityprovider.ErrCodeInternalErrorException:
            fmt.Println(cognitoidentityprovider.ErrCodeInternalErrorException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*CognitoIdentityProvider) AdminCreateUserRequest ¶

func (c *CognitoIdentityProvider) AdminCreateUserRequest(input *AdminCreateUserInput) (req *request.Request, output *AdminCreateUserOutput)

AdminCreateUserRequest generates a "aws/request.Request" representing the client's request for the AdminCreateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminCreateUser for more information on using the AdminCreateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminCreateUserRequest method.
req, resp := client.AdminCreateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUser

func (*CognitoIdentityProvider) AdminCreateUserWithContext ¶

func (c *CognitoIdentityProvider) AdminCreateUserWithContext(ctx aws.Context, input *AdminCreateUserInput, opts ...request.Option) (*AdminCreateUserOutput, error)

AdminCreateUserWithContext is the same as AdminCreateUser with the addition of the ability to pass a context and additional request options.

See AdminCreateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminDeleteUser ¶

func (c *CognitoIdentityProvider) AdminDeleteUser(input *AdminDeleteUserInput) (*AdminDeleteUserOutput, error)

AdminDeleteUser API operation for Amazon Cognito Identity Provider.

Deletes a user as an administrator. Works on any user.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminDeleteUser for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUser

func (*CognitoIdentityProvider) AdminDeleteUserAttributes ¶

func (c *CognitoIdentityProvider) AdminDeleteUserAttributes(input *AdminDeleteUserAttributesInput) (*AdminDeleteUserAttributesOutput, error)

AdminDeleteUserAttributes API operation for Amazon Cognito Identity Provider.

Deletes the user attributes in a user pool as an administrator. Works on any user.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminDeleteUserAttributes for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserAttributes

func (*CognitoIdentityProvider) AdminDeleteUserAttributesRequest ¶

func (c *CognitoIdentityProvider) AdminDeleteUserAttributesRequest(input *AdminDeleteUserAttributesInput) (req *request.Request, output *AdminDeleteUserAttributesOutput)

AdminDeleteUserAttributesRequest generates a "aws/request.Request" representing the client's request for the AdminDeleteUserAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminDeleteUserAttributes for more information on using the AdminDeleteUserAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminDeleteUserAttributesRequest method.
req, resp := client.AdminDeleteUserAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserAttributes

func (*CognitoIdentityProvider) AdminDeleteUserAttributesWithContext ¶

func (c *CognitoIdentityProvider) AdminDeleteUserAttributesWithContext(ctx aws.Context, input *AdminDeleteUserAttributesInput, opts ...request.Option) (*AdminDeleteUserAttributesOutput, error)

AdminDeleteUserAttributesWithContext is the same as AdminDeleteUserAttributes with the addition of the ability to pass a context and additional request options.

See AdminDeleteUserAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminDeleteUserRequest ¶

func (c *CognitoIdentityProvider) AdminDeleteUserRequest(input *AdminDeleteUserInput) (req *request.Request, output *AdminDeleteUserOutput)

AdminDeleteUserRequest generates a "aws/request.Request" representing the client's request for the AdminDeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminDeleteUser for more information on using the AdminDeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminDeleteUserRequest method.
req, resp := client.AdminDeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUser

func (*CognitoIdentityProvider) AdminDeleteUserWithContext ¶

func (c *CognitoIdentityProvider) AdminDeleteUserWithContext(ctx aws.Context, input *AdminDeleteUserInput, opts ...request.Option) (*AdminDeleteUserOutput, error)

AdminDeleteUserWithContext is the same as AdminDeleteUser with the addition of the ability to pass a context and additional request options.

See AdminDeleteUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminDisableProviderForUser ¶

func (c *CognitoIdentityProvider) AdminDisableProviderForUser(input *AdminDisableProviderForUserInput) (*AdminDisableProviderForUserOutput, error)

AdminDisableProviderForUser API operation for Amazon Cognito Identity Provider.

Prevents the user from signing in with the specified external (SAML or social) identity provider (IdP). If the user that you want to deactivate is a Amazon Cognito user pools native username + password user, they can't use their password to sign in. If the user to deactivate is a linked external IdP user, any link between that user and an existing user is removed. When the external user signs in again, and the user is no longer attached to the previously linked DestinationUser, the user must create a new user account. See AdminLinkProviderForUser (https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html).

The ProviderName must match the value specified when creating an IdP for the pool.

To deactivate a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject. The ProviderAttributeValue must be the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social IdPs. 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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminDisableProviderForUser for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• AliasExistsException This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableProviderForUser

func (*CognitoIdentityProvider) AdminDisableProviderForUserRequest ¶

func (c *CognitoIdentityProvider) AdminDisableProviderForUserRequest(input *AdminDisableProviderForUserInput) (req *request.Request, output *AdminDisableProviderForUserOutput)

AdminDisableProviderForUserRequest generates a "aws/request.Request" representing the client's request for the AdminDisableProviderForUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminDisableProviderForUser for more information on using the AdminDisableProviderForUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminDisableProviderForUserRequest method.
req, resp := client.AdminDisableProviderForUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableProviderForUser

func (*CognitoIdentityProvider) AdminDisableProviderForUserWithContext ¶

func (c *CognitoIdentityProvider) AdminDisableProviderForUserWithContext(ctx aws.Context, input *AdminDisableProviderForUserInput, opts ...request.Option) (*AdminDisableProviderForUserOutput, error)

AdminDisableProviderForUserWithContext is the same as AdminDisableProviderForUser with the addition of the ability to pass a context and additional request options.

See AdminDisableProviderForUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminDisableUser ¶

func (c *CognitoIdentityProvider) AdminDisableUser(input *AdminDisableUserInput) (*AdminDisableUserOutput, error)

AdminDisableUser API operation for Amazon Cognito Identity Provider.

Deactivates a user and revokes all access tokens for the user. A deactivated user can't sign in, but still appears in the responses to GetUser and ListUsers API requests.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminDisableUser for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableUser

func (*CognitoIdentityProvider) AdminDisableUserRequest ¶

func (c *CognitoIdentityProvider) AdminDisableUserRequest(input *AdminDisableUserInput) (req *request.Request, output *AdminDisableUserOutput)

AdminDisableUserRequest generates a "aws/request.Request" representing the client's request for the AdminDisableUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminDisableUser for more information on using the AdminDisableUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminDisableUserRequest method.
req, resp := client.AdminDisableUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableUser

func (*CognitoIdentityProvider) AdminDisableUserWithContext ¶

func (c *CognitoIdentityProvider) AdminDisableUserWithContext(ctx aws.Context, input *AdminDisableUserInput, opts ...request.Option) (*AdminDisableUserOutput, error)

AdminDisableUserWithContext is the same as AdminDisableUser with the addition of the ability to pass a context and additional request options.

See AdminDisableUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminEnableUser ¶

func (c *CognitoIdentityProvider) AdminEnableUser(input *AdminEnableUserInput) (*AdminEnableUserOutput, error)

AdminEnableUser API operation for Amazon Cognito Identity Provider.

Enables the specified user as an administrator. Works on any user.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminEnableUser for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminEnableUser

func (*CognitoIdentityProvider) AdminEnableUserRequest ¶

func (c *CognitoIdentityProvider) AdminEnableUserRequest(input *AdminEnableUserInput) (req *request.Request, output *AdminEnableUserOutput)

AdminEnableUserRequest generates a "aws/request.Request" representing the client's request for the AdminEnableUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminEnableUser for more information on using the AdminEnableUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminEnableUserRequest method.
req, resp := client.AdminEnableUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminEnableUser

func (*CognitoIdentityProvider) AdminEnableUserWithContext ¶

func (c *CognitoIdentityProvider) AdminEnableUserWithContext(ctx aws.Context, input *AdminEnableUserInput, opts ...request.Option) (*AdminEnableUserOutput, error)

AdminEnableUserWithContext is the same as AdminEnableUser with the addition of the ability to pass a context and additional request options.

See AdminEnableUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminForgetDevice ¶

func (c *CognitoIdentityProvider) AdminForgetDevice(input *AdminForgetDeviceInput) (*AdminForgetDeviceOutput, error)

AdminForgetDevice API operation for Amazon Cognito Identity Provider.

Forgets the device, as an administrator.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminForgetDevice for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• InvalidUserPoolConfigurationException This exception is thrown when the user pool configuration is not valid.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminForgetDevice

func (*CognitoIdentityProvider) AdminForgetDeviceRequest ¶

func (c *CognitoIdentityProvider) AdminForgetDeviceRequest(input *AdminForgetDeviceInput) (req *request.Request, output *AdminForgetDeviceOutput)

AdminForgetDeviceRequest generates a "aws/request.Request" representing the client's request for the AdminForgetDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminForgetDevice for more information on using the AdminForgetDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminForgetDeviceRequest method.
req, resp := client.AdminForgetDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminForgetDevice

func (*CognitoIdentityProvider) AdminForgetDeviceWithContext ¶

func (c *CognitoIdentityProvider) AdminForgetDeviceWithContext(ctx aws.Context, input *AdminForgetDeviceInput, opts ...request.Option) (*AdminForgetDeviceOutput, error)

AdminForgetDeviceWithContext is the same as AdminForgetDevice with the addition of the ability to pass a context and additional request options.

See AdminForgetDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminGetDevice ¶

func (c *CognitoIdentityProvider) AdminGetDevice(input *AdminGetDeviceInput) (*AdminGetDeviceOutput, error)

AdminGetDevice API operation for Amazon Cognito Identity Provider.

Gets the device, as an administrator.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminGetDevice for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• InvalidUserPoolConfigurationException This exception is thrown when the user pool configuration is not valid.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetDevice

func (*CognitoIdentityProvider) AdminGetDeviceRequest ¶

func (c *CognitoIdentityProvider) AdminGetDeviceRequest(input *AdminGetDeviceInput) (req *request.Request, output *AdminGetDeviceOutput)

AdminGetDeviceRequest generates a "aws/request.Request" representing the client's request for the AdminGetDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminGetDevice for more information on using the AdminGetDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminGetDeviceRequest method.
req, resp := client.AdminGetDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetDevice

func (*CognitoIdentityProvider) AdminGetDeviceWithContext ¶

func (c *CognitoIdentityProvider) AdminGetDeviceWithContext(ctx aws.Context, input *AdminGetDeviceInput, opts ...request.Option) (*AdminGetDeviceOutput, error)

AdminGetDeviceWithContext is the same as AdminGetDevice with the addition of the ability to pass a context and additional request options.

See AdminGetDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminGetUser ¶

func (c *CognitoIdentityProvider) AdminGetUser(input *AdminGetUserInput) (*AdminGetUserOutput, error)

AdminGetUser API operation for Amazon Cognito Identity Provider.

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminGetUser for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUser

func (*CognitoIdentityProvider) AdminGetUserRequest ¶

func (c *CognitoIdentityProvider) AdminGetUserRequest(input *AdminGetUserInput) (req *request.Request, output *AdminGetUserOutput)

AdminGetUserRequest generates a "aws/request.Request" representing the client's request for the AdminGetUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminGetUser for more information on using the AdminGetUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminGetUserRequest method.
req, resp := client.AdminGetUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUser

func (*CognitoIdentityProvider) AdminGetUserWithContext ¶

func (c *CognitoIdentityProvider) AdminGetUserWithContext(ctx aws.Context, input *AdminGetUserInput, opts ...request.Option) (*AdminGetUserOutput, error)

AdminGetUserWithContext is the same as AdminGetUser with the addition of the ability to pass a context and additional request options.

See AdminGetUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminInitiateAuth ¶

func (c *CognitoIdentityProvider) AdminInitiateAuth(input *AdminInitiateAuthInput) (*AdminInitiateAuthOutput, error)

AdminInitiateAuth API operation for Amazon Cognito Identity Provider.

Initiates the authentication flow, as an administrator.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint (https://console.aws.amazon.com/pinpoint/home/). Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html) in the Amazon Cognito Developer Guide.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminInitiateAuth for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

• UnexpectedLambdaException This exception is thrown when Amazon Cognito encounters an unexpected exception with Lambda.

• InvalidUserPoolConfigurationException This exception is thrown when the user pool configuration is not valid.

• UserLambdaValidationException This exception is thrown when the Amazon Cognito service encounters a user validation exception with the Lambda service.

• InvalidLambdaResponseException This exception is thrown when Amazon Cognito encounters an invalid Lambda response.

• MFAMethodNotFoundException This exception is thrown when Amazon Cognito can't find a multi-factor authentication (MFA) method.

• InvalidSmsRoleAccessPolicyException This exception is returned when the role provided for SMS configuration doesn't have permission to publish using Amazon SNS.

• InvalidSmsRoleTrustRelationshipException This exception is thrown when the trust relationship is not valid for the role provided for SMS configuration. This can happen if you don't trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.

• PasswordResetRequiredException This exception is thrown when a password reset is required.

• UserNotFoundException This exception is thrown when a user isn't found.

• UserNotConfirmedException This exception is thrown when a user isn't confirmed successfully.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminInitiateAuth

func (*CognitoIdentityProvider) AdminInitiateAuthRequest ¶

func (c *CognitoIdentityProvider) AdminInitiateAuthRequest(input *AdminInitiateAuthInput) (req *request.Request, output *AdminInitiateAuthOutput)

AdminInitiateAuthRequest generates a "aws/request.Request" representing the client's request for the AdminInitiateAuth operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminInitiateAuth for more information on using the AdminInitiateAuth API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminInitiateAuthRequest method.
req, resp := client.AdminInitiateAuthRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminInitiateAuth

func (*CognitoIdentityProvider) AdminInitiateAuthWithContext ¶

func (c *CognitoIdentityProvider) AdminInitiateAuthWithContext(ctx aws.Context, input *AdminInitiateAuthInput, opts ...request.Option) (*AdminInitiateAuthOutput, error)

AdminInitiateAuthWithContext is the same as AdminInitiateAuth with the addition of the ability to pass a context and additional request options.

See AdminInitiateAuth for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminLinkProviderForUser ¶

func (c *CognitoIdentityProvider) AdminLinkProviderForUser(input *AdminLinkProviderForUserInput) (*AdminLinkProviderForUserOutput, error)

AdminLinkProviderForUser API operation for Amazon Cognito Identity Provider.

Links an existing user account in a user pool (DestinationUser) to an identity from an external IdP (SourceUser) based on a specified attribute name and value from the external IdP. 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. You can then use the federated user identity 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. When the user signs in with a federated user identity, they sign in as the existing user account.

The maximum number of federated identities linked to a user is five.

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 IdPs and provider attributes that have been trusted by the application owner.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminLinkProviderForUser for usage and error information.

Returned Error Types:

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• AliasExistsException This exception is thrown when a user tries to confirm the account with an email address or phone number that has already been supplied as an alias for a different user profile. This exception indicates that an account with this email address or phone already exists in a user pool that you've configured to use email address or phone number as a sign-in alias.

• LimitExceededException This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminLinkProviderForUser

func (*CognitoIdentityProvider) AdminLinkProviderForUserRequest ¶

func (c *CognitoIdentityProvider) AdminLinkProviderForUserRequest(input *AdminLinkProviderForUserInput) (req *request.Request, output *AdminLinkProviderForUserOutput)

AdminLinkProviderForUserRequest generates a "aws/request.Request" representing the client's request for the AdminLinkProviderForUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminLinkProviderForUser for more information on using the AdminLinkProviderForUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminLinkProviderForUserRequest method.
req, resp := client.AdminLinkProviderForUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminLinkProviderForUser

func (*CognitoIdentityProvider) AdminLinkProviderForUserWithContext ¶

func (c *CognitoIdentityProvider) AdminLinkProviderForUserWithContext(ctx aws.Context, input *AdminLinkProviderForUserInput, opts ...request.Option) (*AdminLinkProviderForUserOutput, error)

AdminLinkProviderForUserWithContext is the same as AdminLinkProviderForUser with the addition of the ability to pass a context and additional request options.

See AdminLinkProviderForUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminListDevices ¶

func (c *CognitoIdentityProvider) AdminListDevices(input *AdminListDevicesInput) (*AdminListDevicesOutput, error)

AdminListDevices API operation for Amazon Cognito Identity Provider.

Lists devices, as an administrator.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminListDevices for usage and error information.

Returned Error Types:

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• InvalidUserPoolConfigurationException This exception is thrown when the user pool configuration is not valid.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListDevices

func (*CognitoIdentityProvider) AdminListDevicesRequest ¶

func (c *CognitoIdentityProvider) AdminListDevicesRequest(input *AdminListDevicesInput) (req *request.Request, output *AdminListDevicesOutput)

AdminListDevicesRequest generates a "aws/request.Request" representing the client's request for the AdminListDevices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminListDevices for more information on using the AdminListDevices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminListDevicesRequest method.
req, resp := client.AdminListDevicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListDevices

func (*CognitoIdentityProvider) AdminListDevicesWithContext ¶

func (c *CognitoIdentityProvider) AdminListDevicesWithContext(ctx aws.Context, input *AdminListDevicesInput, opts ...request.Option) (*AdminListDevicesOutput, error)

AdminListDevicesWithContext is the same as AdminListDevices with the addition of the ability to pass a context and additional request options.

See AdminListDevices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminListGroupsForUser ¶

func (c *CognitoIdentityProvider) AdminListGroupsForUser(input *AdminListGroupsForUserInput) (*AdminListGroupsForUserOutput, error)

AdminListGroupsForUser API operation for Amazon Cognito Identity Provider.

Lists the groups that the user belongs to.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminListGroupsForUser for usage and error information.

Returned Error Types:

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUser

func (*CognitoIdentityProvider) AdminListGroupsForUserPages ¶

func (c *CognitoIdentityProvider) AdminListGroupsForUserPages(input *AdminListGroupsForUserInput, fn func(*AdminListGroupsForUserOutput, bool) bool) error

AdminListGroupsForUserPages iterates over the pages of a AdminListGroupsForUser operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See AdminListGroupsForUser method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a AdminListGroupsForUser operation.
pageNum := 0
err := client.AdminListGroupsForUserPages(params,
    func(page *cognitoidentityprovider.AdminListGroupsForUserOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CognitoIdentityProvider) AdminListGroupsForUserPagesWithContext ¶

func (c *CognitoIdentityProvider) AdminListGroupsForUserPagesWithContext(ctx aws.Context, input *AdminListGroupsForUserInput, fn func(*AdminListGroupsForUserOutput, bool) bool, opts ...request.Option) error

AdminListGroupsForUserPagesWithContext same as AdminListGroupsForUserPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminListGroupsForUserRequest ¶

func (c *CognitoIdentityProvider) AdminListGroupsForUserRequest(input *AdminListGroupsForUserInput) (req *request.Request, output *AdminListGroupsForUserOutput)

AdminListGroupsForUserRequest generates a "aws/request.Request" representing the client's request for the AdminListGroupsForUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminListGroupsForUser for more information on using the AdminListGroupsForUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminListGroupsForUserRequest method.
req, resp := client.AdminListGroupsForUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUser

func (*CognitoIdentityProvider) AdminListGroupsForUserWithContext ¶

func (c *CognitoIdentityProvider) AdminListGroupsForUserWithContext(ctx aws.Context, input *AdminListGroupsForUserInput, opts ...request.Option) (*AdminListGroupsForUserOutput, error)

AdminListGroupsForUserWithContext is the same as AdminListGroupsForUser with the addition of the ability to pass a context and additional request options.

See AdminListGroupsForUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminListUserAuthEvents ¶

func (c *CognitoIdentityProvider) AdminListUserAuthEvents(input *AdminListUserAuthEventsInput) (*AdminListUserAuthEventsOutput, error)

AdminListUserAuthEvents API operation for Amazon Cognito Identity Provider.

A history of user activity and any risks detected as part of Amazon Cognito advanced security.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminListUserAuthEvents for usage and error information.

Returned Error Types:

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• UserPoolAddOnNotEnabledException This exception is thrown when user pool add-ons aren't enabled.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListUserAuthEvents

func (*CognitoIdentityProvider) AdminListUserAuthEventsPages ¶

func (c *CognitoIdentityProvider) AdminListUserAuthEventsPages(input *AdminListUserAuthEventsInput, fn func(*AdminListUserAuthEventsOutput, bool) bool) error

AdminListUserAuthEventsPages iterates over the pages of a AdminListUserAuthEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See AdminListUserAuthEvents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a AdminListUserAuthEvents operation.
pageNum := 0
err := client.AdminListUserAuthEventsPages(params,
    func(page *cognitoidentityprovider.AdminListUserAuthEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CognitoIdentityProvider) AdminListUserAuthEventsPagesWithContext ¶

func (c *CognitoIdentityProvider) AdminListUserAuthEventsPagesWithContext(ctx aws.Context, input *AdminListUserAuthEventsInput, fn func(*AdminListUserAuthEventsOutput, bool) bool, opts ...request.Option) error

AdminListUserAuthEventsPagesWithContext same as AdminListUserAuthEventsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminListUserAuthEventsRequest ¶

func (c *CognitoIdentityProvider) AdminListUserAuthEventsRequest(input *AdminListUserAuthEventsInput) (req *request.Request, output *AdminListUserAuthEventsOutput)

AdminListUserAuthEventsRequest generates a "aws/request.Request" representing the client's request for the AdminListUserAuthEvents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminListUserAuthEvents for more information on using the AdminListUserAuthEvents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminListUserAuthEventsRequest method.
req, resp := client.AdminListUserAuthEventsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListUserAuthEvents

func (*CognitoIdentityProvider) AdminListUserAuthEventsWithContext ¶

func (c *CognitoIdentityProvider) AdminListUserAuthEventsWithContext(ctx aws.Context, input *AdminListUserAuthEventsInput, opts ...request.Option) (*AdminListUserAuthEventsOutput, error)

AdminListUserAuthEventsWithContext is the same as AdminListUserAuthEvents with the addition of the ability to pass a context and additional request options.

See AdminListUserAuthEvents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminRemoveUserFromGroup ¶

func (c *CognitoIdentityProvider) AdminRemoveUserFromGroup(input *AdminRemoveUserFromGroupInput) (*AdminRemoveUserFromGroupOutput, error)

AdminRemoveUserFromGroup API operation for Amazon Cognito Identity Provider.

Removes the specified user from the specified group.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html)

• Using the Amazon Cognito user pools API and user pool endpoints (https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Cognito Identity Provider's API operation AdminRemoveUserFromGroup for usage and error information.

Returned Error Types:

• InvalidParameterException This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

• ResourceNotFoundException This exception is thrown when the Amazon Cognito service can't find the requested resource.

• TooManyRequestsException This exception is thrown when the user has made too many requests for a given operation.

• NotAuthorizedException This exception is thrown when a user isn't authorized.

• UserNotFoundException This exception is thrown when a user isn't found.

• InternalErrorException This exception is thrown when Amazon Cognito encounters an internal error.

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRemoveUserFromGroup

func (*CognitoIdentityProvider) AdminRemoveUserFromGroupRequest ¶

func (c *CognitoIdentityProvider) AdminRemoveUserFromGroupRequest(input *AdminRemoveUserFromGroupInput) (req *request.Request, output *AdminRemoveUserFromGroupOutput)

AdminRemoveUserFromGroupRequest generates a "aws/request.Request" representing the client's request for the AdminRemoveUserFromGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AdminRemoveUserFromGroup for more information on using the AdminRemoveUserFromGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AdminRemoveUserFromGroupRequest method.
req, resp := client.AdminRemoveUserFromGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRemoveUserFromGroup

func (*CognitoIdentityProvider) AdminRemoveUserFromGroupWithContext ¶

func (c *CognitoIdentityProvider) AdminRemoveUserFromGroupWithContext(ctx aws.Context, input *AdminRemoveUserFromGroupInput, opts ...request.Option) (*AdminRemoveUserFromGroupOutput, error)

AdminRemoveUserFromGroupWithContext is the same as AdminRemoveUserFromGroup with the addition of the ability to pass a context and additional request options.

See AdminRemoveUserFromGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CognitoIdentityProvider) AdminResetUserPassword ¶

func (c *CognitoIdentityProvider) AdminResetUserPassword(input *AdminResetUserPasswordInput) (*AdminResetUserPasswordOutput, error)