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"
)

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 (
    // 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 (
    // EventResponseTypeSuccess is a EventResponseType enum value
    EventResponseTypeSuccess = "Success"

    // EventResponseTypeFailure is a EventResponseType enum value
    EventResponseTypeFailure = "Failure"
)

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"
)

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"
)

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"

    // 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 (
    // 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 (
    // 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 or phone number that has already been supplied as an alias from a different
    // account. This exception tells user that an account with this email or phone
    // already exists.
    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 does not 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"

    // 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 is not allowed to use your email
    // identity. HTTP status code: 400.
    ErrCodeInvalidEmailRoleAccessPolicyException = "InvalidEmailRoleAccessPolicyException"

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

    // ErrCodeInvalidOAuthFlowException for service response error code
    // "InvalidOAuthFlowException".
    //
    // This exception is thrown when the specified OAuth flow is invalid.
    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 the Amazon Cognito service encounters an invalid
    // password.
    ErrCodeInvalidPasswordException = "InvalidPasswordException"

    // ErrCodeInvalidSmsRoleAccessPolicyException for service response error code
    // "InvalidSmsRoleAccessPolicyException".
    //
    // This exception is returned when the role provided for SMS configuration does
    // not 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 invalid for the role
    // provided for SMS configuration. This can happen if you do not 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 invalid.
    ErrCodeInvalidUserPoolConfigurationException = "InvalidUserPoolConfigurationException"

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

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

    // ErrCodeNotAuthorizedException for service response error code
    // "NotAuthorizedException".
    //
    // This exception is thrown when a user is not 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 cannot find the
    // requested resource.
    ErrCodeResourceNotFoundException = "ResourceNotFoundException"

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

    // ErrCodeSoftwareTokenMFANotFoundException for service response error code
    // "SoftwareTokenMFANotFoundException".
    //
    // This exception is thrown when the software token TOTP multi-factor authentication
    // (MFA) is not enabled 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 (e.g., 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"

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

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

    // 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 are 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 AWS Lambda service.
    ErrCodeUserLambdaValidationException = "UserLambdaValidationException"

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

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

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

    // ErrCodeUserPoolTaggingException for service response error code
    // "UserPoolTaggingException".
    //
    // This exception is thrown when a user pool tag cannot 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 identifer of a specific service.
)

type AccountTakeoverActionType ¶

type AccountTakeoverActionType struct {

    // The event action.
    //
    //    * BLOCK Choosing this action will block the request.
    //
    //    * MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else
    //    allow the request.
    //
    //    * MFA_REQUIRED Throw MFA challenge if user has configured it, else block
    //    the request.
    //
    //    * NO_ACTION Allow the user 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

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

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

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

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

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

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

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

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

func (AddCustomAttributesOutput) String ¶

func (s AddCustomAttributesOutput) String() string

String returns the string representation

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 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

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

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

func (AdminAddUserToGroupOutput) String ¶

func (s AdminAddUserToGroupOutput) String() string

String returns the string representation

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 AWS 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 AWS
    // 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.
    //
    // Take the following limitations into consideration when you use the ClientMetadata
    // parameter:
    //
    //    * Amazon Cognito does not store the ClientMetadata value. This data is
    //    available only to AWS Lambda triggers that are assigned to a user pool
    //    to support custom workflows. If your user pool configuration does not
    //    include triggers, the ClientMetadata parameter serves no purpose.
    //
    //    * Amazon Cognito does not validate the ClientMetadata value.
    //
    //    * Amazon Cognito does not encrypt the the ClientMetadata value, so don't
    //    use it 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 required field
    Username *string `min:"1" type:"string" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

Represents the request to confirm user registration.

func (AdminConfirmSignUpInput) GoString ¶

func (s AdminConfirmSignUpInput) GoString() string

GoString returns the string representation

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

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

func (AdminConfirmSignUpOutput) String ¶

func (s AdminConfirmSignUpOutput) String() string

String returns the string representation

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 the account 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 deprecated 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

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

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 AWS 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 AWS 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.
    //
    // Take the following limitations into consideration when you use the ClientMetadata
    // parameter:
    //
    //    * Amazon Cognito does not store the ClientMetadata value. This data is
    //    available only to AWS Lambda triggers that are assigned to a user pool
    //    to support custom workflows. If your user pool configuration does not
    //    include triggers, the ClientMetadata parameter serves no purpose.
    //
    //    * Amazon Cognito does not validate the ClientMetadata value.
    //
    //    * Amazon Cognito does not encrypt the the ClientMetadata value, so don't
    //    use it 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". More
    // than one value can be specified.
    DesiredDeliveryMediums []*string `type:"list"`

    // This parameter is only used 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. Only one value can be specified.
    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 is not required. If you do not specify a value, Amazon Cognito
    // generates one for you.
    //
    // The temporary password can only be used until the user account expiration
    // limit that you specified when you created the user pool. To reset the account
    // after that time limit, you must call AdminCreateUser again, specifying "RESEND"
    // for the MessageAction parameter.
    TemporaryPassword *string `min:"6" 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 (in or in the Attributes tab of the console) must be supplied
    // either by you (in your call to AdminCreateUser) or by the user (when he or
    // she signs 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. This can be done 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 .)
    //
    //    * 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 username for the user. Must be unique within the user pool. Must be a
    // UTF-8 string between 1 and 128 characters. After the user is created, the
    // username cannot be changed.
    //
    // 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 is not 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

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

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

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

type AdminDeleteUserAttributesInput ¶

type AdminDeleteUserAttributesInput struct {

    // An array of strings representing the user attribute names you wish 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 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

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

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

func (AdminDeleteUserAttributesOutput) String ¶

func (s AdminDeleteUserAttributesOutput) String() string

String returns the string representation

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 wish to delete.
    //
    // 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

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

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

func (AdminDeleteUserOutput) String ¶

func (s AdminDeleteUserOutput) String() string

String returns the string representation

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

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

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

func (AdminDisableProviderForUserOutput) String ¶

func (s AdminDisableProviderForUserOutput) String() string

String returns the string representation

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 wish to disable.
    //
    // 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 any user as an administrator.

func (AdminDisableUserInput) GoString ¶

func (s AdminDisableUserInput) GoString() string

GoString returns the string representation

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

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

func (AdminDisableUserOutput) String ¶

func (s AdminDisableUserOutput) String() string

String returns the string representation

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 wish to enable.
    //
    // 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

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

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

func (AdminEnableUserOutput) String ¶

func (s AdminEnableUserOutput) String() string

String returns the string representation

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 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

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

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

func (AdminForgetDeviceOutput) String ¶

func (s AdminForgetDeviceOutput) String() string

String returns the string representation

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 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

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

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

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

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 wish to retrieve.
    //
    // 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

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

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 TOTP software
    // token MFA configurations. To look up information about either type of MFA
    // configuration, use the AdminGetUserResponse$UserMFASettingList response 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 the user was last modified.
    UserLastModifiedDate *time.Time `type:"timestamp"`

    // The MFA options that are enabled 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.
    //
    //    * ARCHIVED - User is no longer active.
    //
    //    * COMPROMISED - User is disabled due to a potential security threat.
    //
    //    * UNKNOWN - User status is not known.
    //
    //    * RESET_REQUIRED - User is confirmed, but the user must request a code
    //    and reset his or her password before he or she 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
    //    his or her password to a new value before doing anything else.
    UserStatus *string `type:"string" enum:"UserStatusType"`

    // The user name of the user about whom you are receiving information.
    //
    // 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

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

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 execute. 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 SRP variables
    //    to be used for next challenge execution.
    //
    //    * 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.
    //
    //    * USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD
    //    are passed directly. If a user migration Lambda trigger is set, this flow
    //    will invoke the user migration Lambda if the USERNAME is not found in
    //    the user pool.
    //
    // 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 are 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 REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH
    //    (required if the app client is configured with a client secret), DEVICE_KEY
    //
    //    * For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client
    //    is configured with client secret), PASSWORD (required), DEVICE_KEY
    //
    //    * For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
    //    configured with client secret), DEVICE_KEY
    AuthParameters map[string]*string `type:"map"`

    // The app client ID.
    //
    // 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 AWS Lambda functions to user pool
    // triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes
    // the AWS 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 AWS 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 does not 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.
    //
    // Take the following limitations into consideration when you use the ClientMetadata
    // parameter:
    //
    //    * Amazon Cognito does not store the ClientMetadata value. This data is
    //    available only to AWS Lambda triggers that are assigned to a user pool
    //    to support custom workflows. If your user pool configuration does not
    //    include triggers, the ClientMetadata parameter serves no purpose.
    //
    //    * Amazon Cognito does not validate the ClientMetadata value.
    //
    //    * Amazon Cognito does not encrypt the the ClientMetadata value, so don't
    //    use it to provide sensitive information.
    ClientMetadata map[string]*string `type:"map"`

    // Contextual data such as the user's device fingerprint, IP address, or location
    // used for evaluating the risk of an unexpected event by Amazon Cognito advanced
    // security.
    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

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

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
    // does not 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 which you are responding to with this call. This
    // is returned to you in the AdminInitiateAuth response if you need to pass
    // another challenge.
    //
    //    * MFA_SETUP: If MFA is required, users who do not 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 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 enabled on 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 need to authenticate with
    //    USERNAME and PASSWORD directly. An app client must be enabled to use this
    //    flow.
    //
    //    * NEW_PASSWORD_REQUIRED: For users which are required to change their
    //    passwords after successful first login. This challenge should be passed
    //    with NEW_PASSWORD and any other required attributes.
    ChallengeName *string `type:"string" enum:"ChallengeNameType"`

    // The challenge parameters. These are returned to you in the AdminInitiateAuth
    // response if you need to 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 will be 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 is because, in the AdminRespondToAuthChallenge
    // API ChallengeResponses, the USERNAME attribute cannot be an alias.
    ChallengeParameters map[string]*string `type:"map"`

    // The session which should be passed both ways in challenge-response calls
    // to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call
    // determines that the caller needs to go through 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 *string `min:"20" type:"string"`
    // 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

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

type AdminLinkProviderForUserInput ¶

type AdminLinkProviderForUserInput struct {

    // The existing user in the user pool to be linked to the external identity
    // provider user account. Can be a native (Username + Password) Cognito User
    // Pools user or a federated user (for example, a SAML or Facebook user). If
    // the user doesn't exist, an exception is thrown. This is the user that is
    // returned when the new user (with the linked identity provider 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.
    //
    // DestinationUser is a required field
    DestinationUser *ProviderUserIdentifierType `type:"structure" required:"true"`

    // An external identity provider account for a user who does not currently 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 a federated social identity provider user (Facebook,
    // Google, or Login with Amazon), you must set the ProviderAttributeName to
    // Cognito_Subject. For social identity providers, the ProviderName will be
    // Facebook, Google, or LoginWithAmazon, and 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 identity provider token.
    //
    // For SAML, the ProviderAttributeName can be any value that matches a claim
    // in the SAML assertion. If you wish to link SAML users based on the subject
    // of the SAML assertion, you should map the subject to a claim through the
    // SAML identity provider and submit that claim name as the ProviderAttributeName.
    // If you set ProviderAttributeName to Cognito_Subject, Cognito will automatically
    // parse the default unique identifier found in the subject from the SAML 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

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

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

func (AdminLinkProviderForUserOutput) String ¶

func (s AdminLinkProviderForUserOutput) String() string

String returns the string representation

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 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

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

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

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

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 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

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

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

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

type AdminListUserAuthEventsInput ¶

type AdminListUserAuthEventsInput struct {

    // The maximum number of authentication events to return.
    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 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

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

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

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

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 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

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

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

func (AdminRemoveUserFromGroupOutput) String ¶

func (s AdminRemoveUserFromGroupOutput) String() string

String returns the string representation

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 AWS 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 AWS 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.
    //
    // Take the following limitations into consideration when you use the ClientMetadata
    // parameter:
    //
    //    * Amazon Cognito does not store the ClientMetadata value. This data is
    //    available only to AWS Lambda triggers that are assigned to a user pool
    //    to support custom workflows. If your user pool configuration does not
    //    include triggers, the ClientMetadata parameter serves no purpose.
    //
    //    * Amazon Cognito does not validate the ClientMetadata value.
    //
    //    * Amazon Cognito does not encrypt the the ClientMetadata value, so don't
    //    use it 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 wish to reset.
    //
    // 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

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

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

func (AdminResetUserPasswordOutput) String ¶

func (s AdminResetUserPasswordOutput) String() string

String returns the string representation

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 .
    //
    // 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).
    //
    //    * ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is
    //    configured with client secret).
    //
    //    * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes,
    //    USERNAME, SECRET_HASH (if app client is configured with client secret).
    //
    // The value of the USERNAME attribute must be the user's actual username, not
    // an alias (such as email address or phone number). To make this easier, the
    // AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP
    // attribute, even if you specified an alias in your call to AdminInitiateAuth.
    ChallengeResponses map[string]*string `type:"map"`

    // The app client ID.
    //
    // 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 AWS Lambda functions to user pool
    // triggers. When you use the AdminRespondToAuthChallenge API action, Amazon
    // Cognito invokes any functions that are assigned to the following triggers:
    // pre sign-up, custom message, post authentication, user migration, pre token
    // generation, define auth challenge, create auth challenge, and 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, which provides the data that you assigned
    // to the ClientMetadata parameter in your AdminRespondToAuthChallenge request.
    // In your function code in AWS 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.
    //
    // Take the following limitations into consideration when you use the ClientMetadata
    // parameter:
    //
    //    * Amazon Cognito does not store the ClientMetadata value. This data is
    //    available only to AWS Lambda triggers that are assigned to a user pool
    //    to support custom workflows. If your user pool configuration does not
    //    include triggers, the ClientMetadata parameter serves no purpose.
    //
    //    * Amazon Cognito does not validate the ClientMetadata value.
    //
    //    * Amazon Cognito does not encrypt the the ClientMetadata value, so don't
    //    use it to provide sensitive information.
    ClientMetadata map[string]*string `type:"map"`

    // Contextual data such as the user's device fingerprint, IP address, or location
    // used for evaluating the risk of an unexpected event by Amazon Cognito advanced
    // security.
    ContextData *ContextDataType `type:"structure"`

    // The session which should be passed both ways in challenge-response calls
    // to the service. If InitiateAuth or RespondToAuthChallenge API call determines
    // that the caller needs to go through 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 *string `min:"20" type:"string"`

    // 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

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

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 .
    ChallengeName *string `type:"string" enum:"ChallengeNameType"`

    // The challenge parameters. For more information, see .
    ChallengeParameters map[string]*string `type:"map"`

    // The session which should be passed both ways in challenge-response calls
    // to the service. If the or API call determines that the caller needs to go
    // through 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 *string `min:"20" type:"string"`
    // 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

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

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 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

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

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

func (AdminSetUserMFAPreferenceOutput) String ¶

func (s AdminSetUserMFAPreferenceOutput) String() string

String returns the string representation

type AdminSetUserPasswordInput ¶

type AdminSetUserPasswordInput struct {

    // The password for the user.
    //
    // Password is a required field
    Password *string `min:"6" 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 wish to set.
    //
    // 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

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

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

func (AdminSetUserPasswordOutput) String ¶

func (s AdminSetUserPasswordOutput) String() string

String returns the string representation

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 that you are setting options
    // for.
    //
    // UserPoolId is a required field
    UserPoolId *string `min:"1" type:"string" required:"true"`

    // The user name of the user that you are setting options for.
    //
    // 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

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

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

func (AdminSetUserSettingsOutput) String ¶

func (s AdminSetUserSettingsOutput) String() string

String returns the string representation

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.
    //
    // 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 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

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

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

func (AdminUpdateAuthEventFeedbackOutput) String ¶

func (s AdminUpdateAuthEventFeedbackOutput) String() string

String returns the string representation

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 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

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

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 from the request to update the device, as an administrator.

func (AdminUpdateDeviceStatusOutput) GoString ¶

func (s AdminUpdateDeviceStatusOutput) GoString() string

GoString returns the string representation

func (AdminUpdateDeviceStatusOutput) String ¶

func (s AdminUpdateDeviceStatusOutput) String() string

String returns the string representation

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 AWS 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 AWS 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.
    //
    // Take the following limitations into consideration when you use the ClientMetadata
    // parameter:
    //
    //    * Amazon Cognito does not store the ClientMetadata value. This data is
    //    available only to AWS Lambda triggers that are assigned to a user pool
    //    to support custom workflows. If your user pool configuration does not
    //    include triggers, the ClientMetadata parameter serves no purpose.
    //
    //    * Amazon Cognito does not validate the ClientMetadata value.
    //
    //    * Amazon Cognito does not encrypt the the ClientMetadata value, so don't
    //    use it 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.
    //
    // 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 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

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

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

func (AdminUpdateUserAttributesOutput) String ¶

func (s AdminUpdateUserAttributesOutput) String() string

String returns the string representation

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 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

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

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

func (AdminUserGlobalSignOutOutput) String ¶

func (s AdminUserGlobalSignOutOutput) String() string

String returns the string representation

type AnalyticsConfigurationType ¶

type AnalyticsConfigurationType struct {

    // The application ID for an Amazon Pinpoint application.
    //
    // ApplicationId is a required field
    ApplicationId *string `type:"string" required:"true"`

    // The external ID.
    //
    // ExternalId is a required field
    ExternalId *string `type:"string" required:"true"`

    // The ARN of an IAM role that authorizes Amazon Cognito to publish events to
    // Amazon Pinpoint analytics.
    //
    // RoleArn is a required field
    RoleArn *string `min:"20" type:"string" required:"true"`

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

The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

func (AnalyticsConfigurationType) GoString ¶

func (s AnalyticsConfigurationType) GoString() string

GoString returns the string representation

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

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.

func (AnalyticsMetadataType) GoString ¶

func (s AnalyticsMetadataType) GoString() string

GoString returns the string representation

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

type AssociateSoftwareTokenInput ¶

type AssociateSoftwareTokenInput struct {

    // The access token.
    AccessToken *string `type:"string" sensitive:"true"`

    // The session which 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 *string `min:"20" type:"string"`
    // contains filtered or unexported fields
}

func (AssociateSoftwareTokenInput) GoString ¶

func (s AssociateSoftwareTokenInput) GoString() string

GoString returns the string representation

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

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 *string `min:"16" type:"string" sensitive:"true"`

    // The session which 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 *string `min:"20" type:"string"`
    // contains filtered or unexported fields
}

func (AssociateSoftwareTokenOutput) GoString ¶

func (s AssociateSoftwareTokenOutput) GoString() string

GoString returns the string representation

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

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 *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

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

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 creation date
    CreationDate *time.Time `type:"timestamp"`

    // The user context data captured at the time of an event request. It 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

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

type AuthenticationResultType ¶

type AuthenticationResultType struct {

    // The access token.
    AccessToken *string `type:"string" sensitive:"true"`

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

    // The ID token.
    IdToken *string `type:"string" sensitive:"true"`

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

    // The refresh token.
    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

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

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

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

type ChangePasswordInput ¶

type ChangePasswordInput struct {

    // The access token.
    //
    // AccessToken is a required field
    AccessToken *string `type:"string" required:"true" sensitive:"true"`

    // The old password.
    //
    // PreviousPassword is a required field
    PreviousPassword *string `min:"6" type:"string" required:"true" sensitive:"true"`

    // The new password.
    //
    // ProposedPassword is a required field
    ProposedPassword *string `min:"6" 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

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

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

func (ChangePasswordOutput) String ¶

func (s ChangePasswordOutput) String() string

String returns the string representation

type CodeDeliveryDetailsType ¶

type CodeDeliveryDetailsType struct {

    // The attribute name.
    AttributeName *string `min:"1" type:"string"`

    // The delivery medium (email message or phone number).
    DeliveryMedium *string `type:"string" enum:"DeliveryMediumType"`

    // The destination for the code delivery details.
    Destination *string `type:"string"`
    // contains filtered or unexported fields
}

The code delivery details being returned from the server.

func (CodeDeliveryDetailsType) GoString ¶

func (s CodeDeliveryDetailsType) GoString() string

GoString returns the string representation

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

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:

// 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.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserImportInProgressException "UserImportInProgressException"
This exception is thrown when you are trying to modify a user pool while
a user import job is in progress for that pool.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeUnexpectedLambdaException "UnexpectedLambdaException"
This exception is thrown when the Amazon Cognito service encounters an unexpected
exception with the AWS Lambda service.

* ErrCodeUserLambdaValidationException "UserLambdaValidationException"
This exception is thrown when the Amazon Cognito service encounters a user
validation exception with the AWS Lambda service.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeTooManyFailedAttemptsException "TooManyFailedAttemptsException"
This exception is thrown when the user has made too many failed attempts
for a given action (e.g., sign in).

* ErrCodeInvalidLambdaResponseException "InvalidLambdaResponseException"
This exception is thrown when the Amazon Cognito service encounters an invalid
AWS Lambda response.

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

* ErrCodeLimitExceededException "LimitExceededException"
This exception is thrown when a user exceeds the limit for a requested AWS
resource.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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 is not set, the default is to send a welcome message via email or phone (SMS).

This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email.

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

AdminCreateUser requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUsernameExistsException "UsernameExistsException"
This exception is thrown when Amazon Cognito encounters a user name that
already exists in the user pool.

* ErrCodeInvalidPasswordException "InvalidPasswordException"
This exception is thrown when the Amazon Cognito service encounters an invalid
password.

* ErrCodeCodeDeliveryFailureException "CodeDeliveryFailureException"
This exception is thrown when a verification code fails to deliver successfully.

* ErrCodeUnexpectedLambdaException "UnexpectedLambdaException"
This exception is thrown when the Amazon Cognito service encounters an unexpected
exception with the AWS Lambda service.

* ErrCodeUserLambdaValidationException "UserLambdaValidationException"
This exception is thrown when the Amazon Cognito service encounters a user
validation exception with the AWS Lambda service.

* ErrCodeInvalidLambdaResponseException "InvalidLambdaResponseException"
This exception is thrown when the Amazon Cognito service encounters an invalid
AWS Lambda response.

* ErrCodePreconditionNotMetException "PreconditionNotMetException"
This exception is thrown when a precondition is not met.

* ErrCodeInvalidSmsRoleAccessPolicyException "InvalidSmsRoleAccessPolicyException"
This exception is returned when the role provided for SMS configuration does
not have permission to publish using Amazon SNS.

* ErrCodeInvalidSmsRoleTrustRelationshipException "InvalidSmsRoleTrustRelationshipException"
This exception is thrown when the trust relationship is invalid for the role
provided for SMS configuration. This can happen if you do not 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.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUnsupportedUserStateException "UnsupportedUserStateException"
The request failed because the user is in an unsupported state.

* ErrCodeInternalErrorException "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

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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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.

Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See .

This action is enabled only for admin access and requires developer credentials.

The ProviderName must match the value specified when creating an IdP for the pool.

To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the 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.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeAliasExistsException "AliasExistsException"
This exception is thrown when a user tries to confirm the account with an
email or phone number that has already been supplied as an alias from a different
account. This exception tells user that an account with this email or phone
already exists.

* ErrCodeInternalErrorException "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.

Disables the specified user.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeInvalidUserPoolConfigurationException "InvalidUserPoolConfigurationException"
This exception is thrown when the user pool configuration is invalid.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeInvalidUserPoolConfigurationException "InvalidUserPoolConfigurationException"
This exception is thrown when the user pool configuration is invalid.

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

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown when Amazon Cognito encounters an internal error.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not 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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

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

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown when Amazon Cognito encounters an internal error.

* ErrCodeUnexpectedLambdaException "UnexpectedLambdaException"
This exception is thrown when the Amazon Cognito service encounters an unexpected
exception with the AWS Lambda service.

* ErrCodeInvalidUserPoolConfigurationException "InvalidUserPoolConfigurationException"
This exception is thrown when the user pool configuration is invalid.

* ErrCodeUserLambdaValidationException "UserLambdaValidationException"
This exception is thrown when the Amazon Cognito service encounters a user
validation exception with the AWS Lambda service.

* ErrCodeInvalidLambdaResponseException "InvalidLambdaResponseException"
This exception is thrown when the Amazon Cognito service encounters an invalid
AWS Lambda response.

* ErrCodeMFAMethodNotFoundException "MFAMethodNotFoundException"
This exception is thrown when Amazon Cognito cannot find a multi-factor authentication
(MFA) method.

* ErrCodeInvalidSmsRoleAccessPolicyException "InvalidSmsRoleAccessPolicyException"
This exception is returned when the role provided for SMS configuration does
not have permission to publish using Amazon SNS.

* ErrCodeInvalidSmsRoleTrustRelationshipException "InvalidSmsRoleTrustRelationshipException"
This exception is thrown when the trust relationship is invalid for the role
provided for SMS configuration. This can happen if you do not 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.

* ErrCodePasswordResetRequiredException "PasswordResetRequiredException"
This exception is thrown when a password reset is required.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUserNotConfirmedException "UserNotConfirmedException"
This exception is thrown when a user is not 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 identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account.

For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.

See also .

This action is enabled only for admin access and requires developer credentials.

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 Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeAliasExistsException "AliasExistsException"
This exception is thrown when a user tries to confirm the account with an
email or phone number that has already been supplied as an alias from a different
account. This exception tells user that an account with this email or phone
already exists.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidUserPoolConfigurationException "InvalidUserPoolConfigurationException"
This exception is thrown when the user pool configuration is invalid.

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

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown when Amazon Cognito encounters an internal error.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not 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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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.

Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUserPoolAddOnNotEnabledException "UserPoolAddOnNotEnabledException"
This exception is thrown when user pool add-ons are not enabled.

* ErrCodeInternalErrorException "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.

Calling this action requires developer credentials.

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 Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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)

AdminResetUserPassword API operation for Amazon Cognito Identity Provider.

Resets the specified user's password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Calling this action requires developer credentials.

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 AdminResetUserPassword for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeUnexpectedLambdaException "UnexpectedLambdaException"
This exception is thrown when the Amazon Cognito service encounters an unexpected
exception with the AWS Lambda service.

* ErrCodeUserLambdaValidationException "UserLambdaValidationException"
This exception is thrown when the Amazon Cognito service encounters a user
validation exception with the AWS Lambda service.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeInvalidLambdaResponseException "InvalidLambdaResponseException"
This exception is thrown when the Amazon Cognito service encounters an invalid
AWS Lambda response.

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

* ErrCodeLimitExceededException "LimitExceededException"
This exception is thrown when a user exceeds the limit for a requested AWS
resource.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInvalidSmsRoleAccessPolicyException "InvalidSmsRoleAccessPolicyException"
This exception is returned when the role provided for SMS configuration does
not have permission to publish using Amazon SNS.

* ErrCodeInvalidEmailRoleAccessPolicyException "InvalidEmailRoleAccessPolicyException"
This exception is thrown when Amazon Cognito is not allowed to use your email
identity. HTTP status code: 400.

* ErrCodeInvalidSmsRoleTrustRelationshipException "InvalidSmsRoleTrustRelationshipException"
This exception is thrown when the trust relationship is invalid for the role
provided for SMS configuration. This can happen if you do not 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.

* ErrCodeInternalErrorException "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/AdminResetUserPassword

func (*CognitoIdentityProvider) AdminResetUserPasswordRequest ¶

func (c *CognitoIdentityProvider) AdminResetUserPasswordRequest(input *AdminResetUserPasswordInput) (req *request.Request, output *AdminResetUserPasswordOutput)

AdminResetUserPasswordRequest generates a "aws/request.Request" representing the client's request for the AdminResetUserPassword 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 AdminResetUserPassword for more information on using the AdminResetUserPassword 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 AdminResetUserPasswordRequest method.
req, resp := client.AdminResetUserPasswordRequest(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/AdminResetUserPassword

func (*CognitoIdentityProvider) AdminResetUserPasswordWithContext ¶

func (c *CognitoIdentityProvider) AdminResetUserPasswordWithContext(ctx aws.Context, input *AdminResetUserPasswordInput, opts ...request.Option) (*AdminResetUserPasswordOutput, error)

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

See AdminResetUserPassword 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) AdminRespondToAuthChallenge ¶

func (c *CognitoIdentityProvider) AdminRespondToAuthChallenge(input *AdminRespondToAuthChallengeInput) (*AdminRespondToAuthChallengeOutput, error)

AdminRespondToAuthChallenge API operation for Amazon Cognito Identity Provider.

Responds to an authentication challenge, as an administrator.

Calling this action requires developer credentials.

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 AdminRespondToAuthChallenge for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeCodeMismatchException "CodeMismatchException"
This exception is thrown if the provided code does not match what the server
was expecting.

* ErrCodeExpiredCodeException "ExpiredCodeException"
This exception is thrown if a code has expired.

* ErrCodeUnexpectedLambdaException "UnexpectedLambdaException"
This exception is thrown when the Amazon Cognito service encounters an unexpected
exception with the AWS Lambda service.

* ErrCodeInvalidPasswordException "InvalidPasswordException"
This exception is thrown when the Amazon Cognito service encounters an invalid
password.

* ErrCodeUserLambdaValidationException "UserLambdaValidationException"
This exception is thrown when the Amazon Cognito service encounters a user
validation exception with the AWS Lambda service.

* ErrCodeInvalidLambdaResponseException "InvalidLambdaResponseException"
This exception is thrown when the Amazon Cognito service encounters an invalid
AWS Lambda response.

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

* ErrCodeInvalidUserPoolConfigurationException "InvalidUserPoolConfigurationException"
This exception is thrown when the user pool configuration is invalid.

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown when Amazon Cognito encounters an internal error.

* ErrCodeMFAMethodNotFoundException "MFAMethodNotFoundException"
This exception is thrown when Amazon Cognito cannot find a multi-factor authentication
(MFA) method.

* ErrCodeInvalidSmsRoleAccessPolicyException "InvalidSmsRoleAccessPolicyException"
This exception is returned when the role provided for SMS configuration does
not have permission to publish using Amazon SNS.

* ErrCodeInvalidSmsRoleTrustRelationshipException "InvalidSmsRoleTrustRelationshipException"
This exception is thrown when the trust relationship is invalid for the role
provided for SMS configuration. This can happen if you do not 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.

* ErrCodeAliasExistsException "AliasExistsException"
This exception is thrown when a user tries to confirm the account with an
email or phone number that has already been supplied as an alias from a different
account. This exception tells user that an account with this email or phone
already exists.

* ErrCodePasswordResetRequiredException "PasswordResetRequiredException"
This exception is thrown when a password reset is required.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUserNotConfirmedException "UserNotConfirmedException"
This exception is thrown when a user is not confirmed successfully.

* ErrCodeSoftwareTokenMFANotFoundException "SoftwareTokenMFANotFoundException"
This exception is thrown when the software token TOTP multi-factor authentication
(MFA) is not enabled for the user pool.

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

func (*CognitoIdentityProvider) AdminRespondToAuthChallengeRequest ¶

func (c *CognitoIdentityProvider) AdminRespondToAuthChallengeRequest(input *AdminRespondToAuthChallengeInput) (req *request.Request, output *AdminRespondToAuthChallengeOutput)

AdminRespondToAuthChallengeRequest generates a "aws/request.Request" representing the client's request for the AdminRespondToAuthChallenge 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 AdminRespondToAuthChallenge for more information on using the AdminRespondToAuthChallenge 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 AdminRespondToAuthChallengeRequest method.
req, resp := client.AdminRespondToAuthChallengeRequest(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/AdminRespondToAuthChallenge

func (*CognitoIdentityProvider) AdminRespondToAuthChallengeWithContext ¶

func (c *CognitoIdentityProvider) AdminRespondToAuthChallengeWithContext(ctx aws.Context, input *AdminRespondToAuthChallengeInput, opts ...request.Option) (*AdminRespondToAuthChallengeOutput, error)

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

See AdminRespondToAuthChallenge 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) AdminSetUserMFAPreference ¶

func (c *CognitoIdentityProvider) AdminSetUserMFAPreference(input *AdminSetUserMFAPreferenceInput) (*AdminSetUserMFAPreferenceOutput, error)

AdminSetUserMFAPreference API operation for Amazon Cognito Identity Provider.

Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.

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 AdminSetUserMFAPreference for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodePasswordResetRequiredException "PasswordResetRequiredException"
This exception is thrown when a password reset is required.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUserNotConfirmedException "UserNotConfirmedException"
This exception is thrown when a user is not confirmed successfully.

* ErrCodeInternalErrorException "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/AdminSetUserMFAPreference

func (*CognitoIdentityProvider) AdminSetUserMFAPreferenceRequest ¶

func (c *CognitoIdentityProvider) AdminSetUserMFAPreferenceRequest(input *AdminSetUserMFAPreferenceInput) (req *request.Request, output *AdminSetUserMFAPreferenceOutput)

AdminSetUserMFAPreferenceRequest generates a "aws/request.Request" representing the client's request for the AdminSetUserMFAPreference 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 AdminSetUserMFAPreference for more information on using the AdminSetUserMFAPreference 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 AdminSetUserMFAPreferenceRequest method.
req, resp := client.AdminSetUserMFAPreferenceRequest(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/AdminSetUserMFAPreference

func (*CognitoIdentityProvider) AdminSetUserMFAPreferenceWithContext ¶

func (c *CognitoIdentityProvider) AdminSetUserMFAPreferenceWithContext(ctx aws.Context, input *AdminSetUserMFAPreferenceInput, opts ...request.Option) (*AdminSetUserMFAPreferenceOutput, error)

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

See AdminSetUserMFAPreference 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) AdminSetUserPassword ¶

func (c *CognitoIdentityProvider) AdminSetUserPassword(input *AdminSetUserPasswordInput) (*AdminSetUserPasswordOutput, error)

AdminSetUserPassword API operation for Amazon Cognito Identity Provider.

Sets the specified user's password in a user pool as an administrator. Works on any user.

The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator.

Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed.

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 AdminSetUserPassword for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown when Amazon Cognito encounters an internal error.

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

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeInvalidPasswordException "InvalidPasswordException"
This exception is thrown when the Amazon Cognito service encounters an invalid
password.

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

func (*CognitoIdentityProvider) AdminSetUserPasswordRequest ¶

func (c *CognitoIdentityProvider) AdminSetUserPasswordRequest(input *AdminSetUserPasswordInput) (req *request.Request, output *AdminSetUserPasswordOutput)

AdminSetUserPasswordRequest generates a "aws/request.Request" representing the client's request for the AdminSetUserPassword 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 AdminSetUserPassword for more information on using the AdminSetUserPassword 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 AdminSetUserPasswordRequest method.
req, resp := client.AdminSetUserPasswordRequest(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/AdminSetUserPassword

func (*CognitoIdentityProvider) AdminSetUserPasswordWithContext ¶

func (c *CognitoIdentityProvider) AdminSetUserPasswordWithContext(ctx aws.Context, input *AdminSetUserPasswordInput, opts ...request.Option) (*AdminSetUserPasswordOutput, error)

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

See AdminSetUserPassword 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) AdminSetUserSettings ¶

func (c *CognitoIdentityProvider) AdminSetUserSettings(input *AdminSetUserSettingsInput) (*AdminSetUserSettingsOutput, error)

AdminSetUserSettings API operation for Amazon Cognito Identity Provider.

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.

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 AdminSetUserSettings for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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/AdminSetUserSettings

func (*CognitoIdentityProvider) AdminSetUserSettingsRequest ¶

func (c *CognitoIdentityProvider) AdminSetUserSettingsRequest(input *AdminSetUserSettingsInput) (req *request.Request, output *AdminSetUserSettingsOutput)

AdminSetUserSettingsRequest generates a "aws/request.Request" representing the client's request for the AdminSetUserSettings 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 AdminSetUserSettings for more information on using the AdminSetUserSettings 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 AdminSetUserSettingsRequest method.
req, resp := client.AdminSetUserSettingsRequest(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/AdminSetUserSettings

func (*CognitoIdentityProvider) AdminSetUserSettingsWithContext ¶

func (c *CognitoIdentityProvider) AdminSetUserSettingsWithContext(ctx aws.Context, input *AdminSetUserSettingsInput, opts ...request.Option) (*AdminSetUserSettingsOutput, error)

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

See AdminSetUserSettings 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) AdminUpdateAuthEventFeedback ¶

func (c *CognitoIdentityProvider) AdminUpdateAuthEventFeedback(input *AdminUpdateAuthEventFeedbackInput) (*AdminUpdateAuthEventFeedbackOutput, error)

AdminUpdateAuthEventFeedback API operation for Amazon Cognito Identity Provider.

Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

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 AdminUpdateAuthEventFeedback for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUserPoolAddOnNotEnabledException "UserPoolAddOnNotEnabledException"
This exception is thrown when user pool add-ons are not enabled.

* ErrCodeInternalErrorException "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/AdminUpdateAuthEventFeedback

func (*CognitoIdentityProvider) AdminUpdateAuthEventFeedbackRequest ¶

func (c *CognitoIdentityProvider) AdminUpdateAuthEventFeedbackRequest(input *AdminUpdateAuthEventFeedbackInput) (req *request.Request, output *AdminUpdateAuthEventFeedbackOutput)

AdminUpdateAuthEventFeedbackRequest generates a "aws/request.Request" representing the client's request for the AdminUpdateAuthEventFeedback 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 AdminUpdateAuthEventFeedback for more information on using the AdminUpdateAuthEventFeedback 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 AdminUpdateAuthEventFeedbackRequest method.
req, resp := client.AdminUpdateAuthEventFeedbackRequest(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/AdminUpdateAuthEventFeedback

func (*CognitoIdentityProvider) AdminUpdateAuthEventFeedbackWithContext ¶

func (c *CognitoIdentityProvider) AdminUpdateAuthEventFeedbackWithContext(ctx aws.Context, input *AdminUpdateAuthEventFeedbackInput, opts ...request.Option) (*AdminUpdateAuthEventFeedbackOutput, error)

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

See AdminUpdateAuthEventFeedback 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) AdminUpdateDeviceStatus ¶

func (c *CognitoIdentityProvider) AdminUpdateDeviceStatus(input *AdminUpdateDeviceStatusInput) (*AdminUpdateDeviceStatusOutput, error)

AdminUpdateDeviceStatus API operation for Amazon Cognito Identity Provider.

Updates the device status as an administrator.

Calling this action requires developer credentials.

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 AdminUpdateDeviceStatus for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidUserPoolConfigurationException "InvalidUserPoolConfigurationException"
This exception is thrown when the user pool configuration is invalid.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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/AdminUpdateDeviceStatus

func (*CognitoIdentityProvider) AdminUpdateDeviceStatusRequest ¶

func (c *CognitoIdentityProvider) AdminUpdateDeviceStatusRequest(input *AdminUpdateDeviceStatusInput) (req *request.Request, output *AdminUpdateDeviceStatusOutput)

AdminUpdateDeviceStatusRequest generates a "aws/request.Request" representing the client's request for the AdminUpdateDeviceStatus 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 AdminUpdateDeviceStatus for more information on using the AdminUpdateDeviceStatus 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 AdminUpdateDeviceStatusRequest method.
req, resp := client.AdminUpdateDeviceStatusRequest(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/AdminUpdateDeviceStatus

func (*CognitoIdentityProvider) AdminUpdateDeviceStatusWithContext ¶

func (c *CognitoIdentityProvider) AdminUpdateDeviceStatusWithContext(ctx aws.Context, input *AdminUpdateDeviceStatusInput, opts ...request.Option) (*AdminUpdateDeviceStatusOutput, error)

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

See AdminUpdateDeviceStatus 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) AdminUpdateUserAttributes ¶

func (c *CognitoIdentityProvider) AdminUpdateUserAttributes(input *AdminUpdateUserAttributesInput) (*AdminUpdateUserAttributesOutput, error)

AdminUpdateUserAttributes API operation for Amazon Cognito Identity Provider.

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

For custom attributes, you must prepend the custom: prefix to the attribute name.

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Calling this action requires developer credentials.

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 AdminUpdateUserAttributes for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeUnexpectedLambdaException "UnexpectedLambdaException"
This exception is thrown when the Amazon Cognito service encounters an unexpected
exception with the AWS Lambda service.

* ErrCodeUserLambdaValidationException "UserLambdaValidationException"
This exception is thrown when the Amazon Cognito service encounters a user
validation exception with the AWS Lambda service.

* ErrCodeInvalidLambdaResponseException "InvalidLambdaResponseException"
This exception is thrown when the Amazon Cognito service encounters an invalid
AWS Lambda response.

* ErrCodeAliasExistsException "AliasExistsException"
This exception is thrown when a user tries to confirm the account with an
email or phone number that has already been supplied as an alias from a different
account. This exception tells user that an account with this email or phone
already exists.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown when Amazon Cognito encounters an internal error.

* ErrCodeInvalidSmsRoleAccessPolicyException "InvalidSmsRoleAccessPolicyException"
This exception is returned when the role provided for SMS configuration does
not have permission to publish using Amazon SNS.

* ErrCodeInvalidEmailRoleAccessPolicyException "InvalidEmailRoleAccessPolicyException"
This exception is thrown when Amazon Cognito is not allowed to use your email
identity. HTTP status code: 400.

* ErrCodeInvalidSmsRoleTrustRelationshipException "InvalidSmsRoleTrustRelationshipException"
This exception is thrown when the trust relationship is invalid for the role
provided for SMS configuration. This can happen if you do not 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.

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

func (*CognitoIdentityProvider) AdminUpdateUserAttributesRequest ¶

func (c *CognitoIdentityProvider) AdminUpdateUserAttributesRequest(input *AdminUpdateUserAttributesInput) (req *request.Request, output *AdminUpdateUserAttributesOutput)

AdminUpdateUserAttributesRequest generates a "aws/request.Request" representing the client's request for the AdminUpdateUserAttributes 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 AdminUpdateUserAttributes for more information on using the AdminUpdateUserAttributes 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 AdminUpdateUserAttributesRequest method.
req, resp := client.AdminUpdateUserAttributesRequest(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/AdminUpdateUserAttributes

func (*CognitoIdentityProvider) AdminUpdateUserAttributesWithContext ¶

func (c *CognitoIdentityProvider) AdminUpdateUserAttributesWithContext(ctx aws.Context, input *AdminUpdateUserAttributesInput, opts ...request.Option) (*AdminUpdateUserAttributesOutput, error)

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

See AdminUpdateUserAttributes 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) AdminUserGlobalSignOut ¶

func (c *CognitoIdentityProvider) AdminUserGlobalSignOut(input *AdminUserGlobalSignOutInput) (*AdminUserGlobalSignOutOutput, error)

AdminUserGlobalSignOut API operation for Amazon Cognito Identity Provider.

Signs out users from all devices, as an administrator.

Calling this action requires developer credentials.

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 AdminUserGlobalSignOut for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

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

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeInternalErrorException "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/AdminUserGlobalSignOut

func (*CognitoIdentityProvider) AdminUserGlobalSignOutRequest ¶

func (c *CognitoIdentityProvider) AdminUserGlobalSignOutRequest(input *AdminUserGlobalSignOutInput) (req *request.Request, output *AdminUserGlobalSignOutOutput)

AdminUserGlobalSignOutRequest generates a "aws/request.Request" representing the client's request for the AdminUserGlobalSignOut 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 AdminUserGlobalSignOut for more information on using the AdminUserGlobalSignOut 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 AdminUserGlobalSignOutRequest method.
req, resp := client.AdminUserGlobalSignOutRequest(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/AdminUserGlobalSignOut

func (*CognitoIdentityProvider) AdminUserGlobalSignOutWithContext ¶

func (c *CognitoIdentityProvider) AdminUserGlobalSignOutWithContext(ctx aws.Context, input *AdminUserGlobalSignOutInput, opts ...request.Option) (*AdminUserGlobalSignOutOutput, error)

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

See AdminUserGlobalSignOut 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) AssociateSoftwareToken ¶

func (c *CognitoIdentityProvider) AssociateSoftwareToken(input *AssociateSoftwareTokenInput) (*AssociateSoftwareTokenOutput, error)

AssociateSoftwareToken API operation for Amazon Cognito Identity Provider.

Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.

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 AssociateSoftwareToken for usage and error information.

Returned Error Codes:

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInternalErrorException "InternalErrorException"
This exception is thrown when Amazon Cognito encounters an internal error.

* ErrCodeSoftwareTokenMFANotFoundException "SoftwareTokenMFANotFoundException"
This exception is thrown when the software token TOTP multi-factor authentication
(MFA) is not enabled for the user pool.

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

func (*CognitoIdentityProvider) AssociateSoftwareTokenRequest ¶

func (c *CognitoIdentityProvider) AssociateSoftwareTokenRequest(input *AssociateSoftwareTokenInput) (req *request.Request, output *AssociateSoftwareTokenOutput)

AssociateSoftwareTokenRequest generates a "aws/request.Request" representing the client's request for the AssociateSoftwareToken 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 AssociateSoftwareToken for more information on using the AssociateSoftwareToken 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 AssociateSoftwareTokenRequest method.
req, resp := client.AssociateSoftwareTokenRequest(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/AssociateSoftwareToken

func (*CognitoIdentityProvider) AssociateSoftwareTokenWithContext ¶

func (c *CognitoIdentityProvider) AssociateSoftwareTokenWithContext(ctx aws.Context, input *AssociateSoftwareTokenInput, opts ...request.Option) (*AssociateSoftwareTokenOutput, error)

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

See AssociateSoftwareToken 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) ChangePassword ¶

func (c *CognitoIdentityProvider) ChangePassword(input *ChangePasswordInput) (*ChangePasswordOutput, error)

ChangePassword API operation for Amazon Cognito Identity Provider.

Changes the password for a specified user in a user pool.

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 ChangePassword for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeInvalidPasswordException "InvalidPasswordException"
This exception is thrown when the Amazon Cognito service encounters an invalid
password.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

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

* ErrCodeLimitExceededException "LimitExceededException"
This exception is thrown when a user exceeds the limit for a requested AWS
resource.

* ErrCodePasswordResetRequiredException "PasswordResetRequiredException"
This exception is thrown when a password reset is required.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUserNotConfirmedException "UserNotConfirmedException"
This exception is thrown when a user is not confirmed successfully.

* ErrCodeInternalErrorException "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/ChangePassword

func (*CognitoIdentityProvider) ChangePasswordRequest ¶

func (c *CognitoIdentityProvider) ChangePasswordRequest(input *ChangePasswordInput) (req *request.Request, output *ChangePasswordOutput)

ChangePasswordRequest generates a "aws/request.Request" representing the client's request for the ChangePassword 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 ChangePassword for more information on using the ChangePassword 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 ChangePasswordRequest method.
req, resp := client.ChangePasswordRequest(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/ChangePassword

func (*CognitoIdentityProvider) ChangePasswordWithContext ¶

func (c *CognitoIdentityProvider) ChangePasswordWithContext(ctx aws.Context, input *ChangePasswordInput, opts ...request.Option) (*ChangePasswordOutput, error)

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

See ChangePassword 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) ConfirmDevice ¶

func (c *CognitoIdentityProvider) ConfirmDevice(input *ConfirmDeviceInput) (*ConfirmDeviceOutput, error)

ConfirmDevice API operation for Amazon Cognito Identity Provider.

Confirms tracking of the device. This API call is the call that begins device tracking.

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 ConfirmDevice for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeInvalidPasswordException "InvalidPasswordException"
This exception is thrown when the Amazon Cognito service encounters an invalid
password.

* ErrCodeInvalidLambdaResponseException "InvalidLambdaResponseException"
This exception is thrown when the Amazon Cognito service encounters an invalid
AWS Lambda response.

* ErrCodeUsernameExistsException "UsernameExistsException"
This exception is thrown when Amazon Cognito encounters a user name that
already exists in the user pool.

* ErrCodeInvalidUserPoolConfigurationException "InvalidUserPoolConfigurationException"
This exception is thrown when the user pool configuration is invalid.

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

* ErrCodePasswordResetRequiredException "PasswordResetRequiredException"
This exception is thrown when a password reset is required.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUserNotConfirmedException "UserNotConfirmedException"
This exception is thrown when a user is not confirmed successfully.

* ErrCodeInternalErrorException "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/ConfirmDevice

func (*CognitoIdentityProvider) ConfirmDeviceRequest ¶

func (c *CognitoIdentityProvider) ConfirmDeviceRequest(input *ConfirmDeviceInput) (req *request.Request, output *ConfirmDeviceOutput)

ConfirmDeviceRequest generates a "aws/request.Request" representing the client's request for the ConfirmDevice 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 ConfirmDevice for more information on using the ConfirmDevice 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 ConfirmDeviceRequest method.
req, resp := client.ConfirmDeviceRequest(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/ConfirmDevice

func (*CognitoIdentityProvider) ConfirmDeviceWithContext ¶

func (c *CognitoIdentityProvider) ConfirmDeviceWithContext(ctx aws.Context, input *ConfirmDeviceInput, opts ...request.Option) (*ConfirmDeviceOutput, error)

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

See ConfirmDevice 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) ConfirmForgotPassword ¶

func (c *CognitoIdentityProvider) ConfirmForgotPassword(input *ConfirmForgotPasswordInput) (*ConfirmForgotPasswordOutput, error)

ConfirmForgotPassword API operation for Amazon Cognito Identity Provider.

Allows a user to enter a confirmation code to reset a forgotten password.

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 ConfirmForgotPassword for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
This exception is thrown when the Amazon Cognito service cannot find the
requested resource.

* ErrCodeUnexpectedLambdaException "UnexpectedLambdaException"
This exception is thrown when the Amazon Cognito service encounters an unexpected
exception with the AWS Lambda service.

* ErrCodeUserLambdaValidationException "UserLambdaValidationException"
This exception is thrown when the Amazon Cognito service encounters a user
validation exception with the AWS Lambda service.

* ErrCodeInvalidParameterException "InvalidParameterException"
This exception is thrown when the Amazon Cognito service encounters an invalid
parameter.

* ErrCodeInvalidPasswordException "InvalidPasswordException"
This exception is thrown when the Amazon Cognito service encounters an invalid
password.

* ErrCodeNotAuthorizedException "NotAuthorizedException"
This exception is thrown when a user is not authorized.

* ErrCodeCodeMismatchException "CodeMismatchException"
This exception is thrown if the provided code does not match what the server
was expecting.

* ErrCodeExpiredCodeException "ExpiredCodeException"
This exception is thrown if a code has expired.

* ErrCodeTooManyFailedAttemptsException "TooManyFailedAttemptsException"
This exception is thrown when the user has made too many failed attempts
for a given action (e.g., sign in).

* ErrCodeInvalidLambdaResponseException "InvalidLambdaResponseException"
This exception is thrown when the Amazon Cognito service encounters an invalid
AWS Lambda response.

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

* ErrCodeLimitExceededException "LimitExceededException"
This exception is thrown when a user exceeds the limit for a requested AWS
resource.

* ErrCodeUserNotFoundException "UserNotFoundException"
This exception is thrown when a user is not found.

* ErrCodeUserNotConfirmedException "UserNotConfirmedException"
This exception is thrown when a user is not confirmed successfully.

* ErrCodeInternalErrorException "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/ConfirmForgotPassword

func (*CognitoIdentityProvider) ConfirmForgotPasswordRequest ¶

func (c *CognitoIdentityProvider) ConfirmForgotPasswordRequest(input *ConfirmForgotPasswordInput) (req *request.Request, output *ConfirmForgotPasswordOutput)

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