type AccountRecoverySettingType struct { // The list of RecoveryOptionTypes. RecoveryMechanisms []*RecoveryOptionType `min:"1" type:"list"` // contains filtered or unexported fields }
The data type for AccountRecoverySetting.
func (s AccountRecoverySettingType) GoString() string
GoString returns the string representation
func (s *AccountRecoverySettingType) SetRecoveryMechanisms(v []*RecoveryOptionType) *AccountRecoverySettingType
SetRecoveryMechanisms sets the RecoveryMechanisms field's value.
func (s AccountRecoverySettingType) String() string
String returns the string representation
func (s *AccountRecoverySettingType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AccountTakeoverActionType) GoString() string
GoString returns the string representation
func (s *AccountTakeoverActionType) SetEventAction(v string) *AccountTakeoverActionType
SetEventAction sets the EventAction field's value.
func (s *AccountTakeoverActionType) SetNotify(v bool) *AccountTakeoverActionType
SetNotify sets the Notify field's value.
func (s AccountTakeoverActionType) String() string
String returns the string representation
func (s *AccountTakeoverActionType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AccountTakeoverActionsType) GoString() string
GoString returns the string representation
func (s *AccountTakeoverActionsType) SetHighAction(v *AccountTakeoverActionType) *AccountTakeoverActionsType
SetHighAction sets the HighAction field's value.
func (s *AccountTakeoverActionsType) SetLowAction(v *AccountTakeoverActionType) *AccountTakeoverActionsType
SetLowAction sets the LowAction field's value.
func (s *AccountTakeoverActionsType) SetMediumAction(v *AccountTakeoverActionType) *AccountTakeoverActionsType
SetMediumAction sets the MediumAction field's value.
func (s AccountTakeoverActionsType) String() string
String returns the string representation
func (s *AccountTakeoverActionsType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AccountTakeoverRiskConfigurationType) GoString() string
GoString returns the string representation
func (s *AccountTakeoverRiskConfigurationType) SetActions(v *AccountTakeoverActionsType) *AccountTakeoverRiskConfigurationType
SetActions sets the Actions field's value.
func (s *AccountTakeoverRiskConfigurationType) SetNotifyConfiguration(v *NotifyConfigurationType) *AccountTakeoverRiskConfigurationType
SetNotifyConfiguration sets the NotifyConfiguration field's value.
func (s AccountTakeoverRiskConfigurationType) String() string
String returns the string representation
func (s *AccountTakeoverRiskConfigurationType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AddCustomAttributesInput) GoString() string
GoString returns the string representation
func (s *AddCustomAttributesInput) SetCustomAttributes(v []*SchemaAttributeType) *AddCustomAttributesInput
SetCustomAttributes sets the CustomAttributes field's value.
func (s *AddCustomAttributesInput) SetUserPoolId(v string) *AddCustomAttributesInput
SetUserPoolId sets the UserPoolId field's value.
func (s AddCustomAttributesInput) String() string
String returns the string representation
func (s *AddCustomAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddCustomAttributesOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server for the request to add custom attributes.
func (s AddCustomAttributesOutput) GoString() string
GoString returns the string representation
func (s AddCustomAttributesOutput) String() string
String returns the string representation
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 (s AdminAddUserToGroupInput) GoString() string
GoString returns the string representation
func (s *AdminAddUserToGroupInput) SetGroupName(v string) *AdminAddUserToGroupInput
SetGroupName sets the GroupName field's value.
func (s *AdminAddUserToGroupInput) SetUserPoolId(v string) *AdminAddUserToGroupInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminAddUserToGroupInput) SetUsername(v string) *AdminAddUserToGroupInput
SetUsername sets the Username field's value.
func (s AdminAddUserToGroupInput) String() string
String returns the string representation
func (s *AdminAddUserToGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminAddUserToGroupOutput struct {
// contains filtered or unexported fields
}
func (s AdminAddUserToGroupOutput) GoString() string
GoString returns the string representation
func (s AdminAddUserToGroupOutput) String() string
String returns the string representation
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 (s AdminConfirmSignUpInput) GoString() string
GoString returns the string representation
func (s *AdminConfirmSignUpInput) SetClientMetadata(v map[string]*string) *AdminConfirmSignUpInput
SetClientMetadata sets the ClientMetadata field's value.
func (s *AdminConfirmSignUpInput) SetUserPoolId(v string) *AdminConfirmSignUpInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminConfirmSignUpInput) SetUsername(v string) *AdminConfirmSignUpInput
SetUsername sets the Username field's value.
func (s AdminConfirmSignUpInput) String() string
String returns the string representation
func (s *AdminConfirmSignUpInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminConfirmSignUpOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server for the request to confirm registration.
func (s AdminConfirmSignUpOutput) GoString() string
GoString returns the string representation
func (s AdminConfirmSignUpOutput) String() string
String returns the string representation
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 (s AdminCreateUserConfigType) GoString() string
GoString returns the string representation
func (s *AdminCreateUserConfigType) SetAllowAdminCreateUserOnly(v bool) *AdminCreateUserConfigType
SetAllowAdminCreateUserOnly sets the AllowAdminCreateUserOnly field's value.
func (s *AdminCreateUserConfigType) SetInviteMessageTemplate(v *MessageTemplateType) *AdminCreateUserConfigType
SetInviteMessageTemplate sets the InviteMessageTemplate field's value.
func (s *AdminCreateUserConfigType) SetUnusedAccountValidityDays(v int64) *AdminCreateUserConfigType
SetUnusedAccountValidityDays sets the UnusedAccountValidityDays field's value.
func (s AdminCreateUserConfigType) String() string
String returns the string representation
func (s *AdminCreateUserConfigType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminCreateUserInput) GoString() string
GoString returns the string representation
func (s *AdminCreateUserInput) SetClientMetadata(v map[string]*string) *AdminCreateUserInput
SetClientMetadata sets the ClientMetadata field's value.
func (s *AdminCreateUserInput) SetDesiredDeliveryMediums(v []*string) *AdminCreateUserInput
SetDesiredDeliveryMediums sets the DesiredDeliveryMediums field's value.
func (s *AdminCreateUserInput) SetForceAliasCreation(v bool) *AdminCreateUserInput
SetForceAliasCreation sets the ForceAliasCreation field's value.
func (s *AdminCreateUserInput) SetMessageAction(v string) *AdminCreateUserInput
SetMessageAction sets the MessageAction field's value.
func (s *AdminCreateUserInput) SetTemporaryPassword(v string) *AdminCreateUserInput
SetTemporaryPassword sets the TemporaryPassword field's value.
func (s *AdminCreateUserInput) SetUserAttributes(v []*AttributeType) *AdminCreateUserInput
SetUserAttributes sets the UserAttributes field's value.
func (s *AdminCreateUserInput) SetUserPoolId(v string) *AdminCreateUserInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminCreateUserInput) SetUsername(v string) *AdminCreateUserInput
SetUsername sets the Username field's value.
func (s *AdminCreateUserInput) SetValidationData(v []*AttributeType) *AdminCreateUserInput
SetValidationData sets the ValidationData field's value.
func (s AdminCreateUserInput) String() string
String returns the string representation
func (s *AdminCreateUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminCreateUserOutput) GoString() string
GoString returns the string representation
func (s *AdminCreateUserOutput) SetUser(v *UserType) *AdminCreateUserOutput
SetUser sets the User field's value.
func (s AdminCreateUserOutput) String() string
String returns the string representation
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 (s AdminDeleteUserAttributesInput) GoString() string
GoString returns the string representation
func (s *AdminDeleteUserAttributesInput) SetUserAttributeNames(v []*string) *AdminDeleteUserAttributesInput
SetUserAttributeNames sets the UserAttributeNames field's value.
func (s *AdminDeleteUserAttributesInput) SetUserPoolId(v string) *AdminDeleteUserAttributesInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminDeleteUserAttributesInput) SetUsername(v string) *AdminDeleteUserAttributesInput
SetUsername sets the Username field's value.
func (s AdminDeleteUserAttributesInput) String() string
String returns the string representation
func (s *AdminDeleteUserAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminDeleteUserAttributesOutput struct {
// contains filtered or unexported fields
}
Represents the response received from the server for a request to delete user attributes.
func (s AdminDeleteUserAttributesOutput) GoString() string
GoString returns the string representation
func (s AdminDeleteUserAttributesOutput) String() string
String returns the string representation
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 (s AdminDeleteUserInput) GoString() string
GoString returns the string representation
func (s *AdminDeleteUserInput) SetUserPoolId(v string) *AdminDeleteUserInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminDeleteUserInput) SetUsername(v string) *AdminDeleteUserInput
SetUsername sets the Username field's value.
func (s AdminDeleteUserInput) String() string
String returns the string representation
func (s *AdminDeleteUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminDeleteUserOutput struct {
// contains filtered or unexported fields
}
func (s AdminDeleteUserOutput) GoString() string
GoString returns the string representation
func (s AdminDeleteUserOutput) String() string
String returns the string representation
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 (s AdminDisableProviderForUserInput) GoString() string
GoString returns the string representation
func (s *AdminDisableProviderForUserInput) SetUser(v *ProviderUserIdentifierType) *AdminDisableProviderForUserInput
SetUser sets the User field's value.
func (s *AdminDisableProviderForUserInput) SetUserPoolId(v string) *AdminDisableProviderForUserInput
SetUserPoolId sets the UserPoolId field's value.
func (s AdminDisableProviderForUserInput) String() string
String returns the string representation
func (s *AdminDisableProviderForUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminDisableProviderForUserOutput struct {
// contains filtered or unexported fields
}
func (s AdminDisableProviderForUserOutput) GoString() string
GoString returns the string representation
func (s AdminDisableProviderForUserOutput) String() string
String returns the string representation
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 (s AdminDisableUserInput) GoString() string
GoString returns the string representation
func (s *AdminDisableUserInput) SetUserPoolId(v string) *AdminDisableUserInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminDisableUserInput) SetUsername(v string) *AdminDisableUserInput
SetUsername sets the Username field's value.
func (s AdminDisableUserInput) String() string
String returns the string representation
func (s *AdminDisableUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminDisableUserOutput struct {
// contains filtered or unexported fields
}
Represents the response received from the server to disable the user as an administrator.
func (s AdminDisableUserOutput) GoString() string
GoString returns the string representation
func (s AdminDisableUserOutput) String() string
String returns the string representation
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 (s AdminEnableUserInput) GoString() string
GoString returns the string representation
func (s *AdminEnableUserInput) SetUserPoolId(v string) *AdminEnableUserInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminEnableUserInput) SetUsername(v string) *AdminEnableUserInput
SetUsername sets the Username field's value.
func (s AdminEnableUserInput) String() string
String returns the string representation
func (s *AdminEnableUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminEnableUserOutput) GoString() string
GoString returns the string representation
func (s AdminEnableUserOutput) String() string
String returns the string representation
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 (s AdminForgetDeviceInput) GoString() string
GoString returns the string representation
func (s *AdminForgetDeviceInput) SetDeviceKey(v string) *AdminForgetDeviceInput
SetDeviceKey sets the DeviceKey field's value.
func (s *AdminForgetDeviceInput) SetUserPoolId(v string) *AdminForgetDeviceInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminForgetDeviceInput) SetUsername(v string) *AdminForgetDeviceInput
SetUsername sets the Username field's value.
func (s AdminForgetDeviceInput) String() string
String returns the string representation
func (s *AdminForgetDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminForgetDeviceOutput struct {
// contains filtered or unexported fields
}
func (s AdminForgetDeviceOutput) GoString() string
GoString returns the string representation
func (s AdminForgetDeviceOutput) String() string
String returns the string representation
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 (s AdminGetDeviceInput) GoString() string
GoString returns the string representation
func (s *AdminGetDeviceInput) SetDeviceKey(v string) *AdminGetDeviceInput
SetDeviceKey sets the DeviceKey field's value.
func (s *AdminGetDeviceInput) SetUserPoolId(v string) *AdminGetDeviceInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminGetDeviceInput) SetUsername(v string) *AdminGetDeviceInput
SetUsername sets the Username field's value.
func (s AdminGetDeviceInput) String() string
String returns the string representation
func (s *AdminGetDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminGetDeviceOutput) GoString() string
GoString returns the string representation
func (s *AdminGetDeviceOutput) SetDevice(v *DeviceType) *AdminGetDeviceOutput
SetDevice sets the Device field's value.
func (s AdminGetDeviceOutput) String() string
String returns the string representation
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 (s AdminGetUserInput) GoString() string
GoString returns the string representation
func (s *AdminGetUserInput) SetUserPoolId(v string) *AdminGetUserInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminGetUserInput) SetUsername(v string) *AdminGetUserInput
SetUsername sets the Username field's value.
func (s AdminGetUserInput) String() string
String returns the string representation
func (s *AdminGetUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminGetUserOutput) GoString() string
GoString returns the string representation
func (s *AdminGetUserOutput) SetEnabled(v bool) *AdminGetUserOutput
SetEnabled sets the Enabled field's value.
func (s *AdminGetUserOutput) SetMFAOptions(v []*MFAOptionType) *AdminGetUserOutput
SetMFAOptions sets the MFAOptions field's value.
func (s *AdminGetUserOutput) SetPreferredMfaSetting(v string) *AdminGetUserOutput
SetPreferredMfaSetting sets the PreferredMfaSetting field's value.
func (s *AdminGetUserOutput) SetUserAttributes(v []*AttributeType) *AdminGetUserOutput
SetUserAttributes sets the UserAttributes field's value.
func (s *AdminGetUserOutput) SetUserCreateDate(v time.Time) *AdminGetUserOutput
SetUserCreateDate sets the UserCreateDate field's value.
func (s *AdminGetUserOutput) SetUserLastModifiedDate(v time.Time) *AdminGetUserOutput
SetUserLastModifiedDate sets the UserLastModifiedDate field's value.
func (s *AdminGetUserOutput) SetUserMFASettingList(v []*string) *AdminGetUserOutput
SetUserMFASettingList sets the UserMFASettingList field's value.
func (s *AdminGetUserOutput) SetUserStatus(v string) *AdminGetUserOutput
SetUserStatus sets the UserStatus field's value.
func (s *AdminGetUserOutput) SetUsername(v string) *AdminGetUserOutput
SetUsername sets the Username field's value.
func (s AdminGetUserOutput) String() string
String returns the string representation
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. // // * ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. // This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, // Cognito receives the password in the request instead of using the SRP // process to verify passwords. // // AuthFlow is a required field AuthFlow *string `type:"string" required:"true" enum:"AuthFlowType"` // The authentication parameters. These are inputs corresponding to the AuthFlow // that you 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 (s AdminInitiateAuthInput) GoString() string
GoString returns the string representation
func (s *AdminInitiateAuthInput) SetAnalyticsMetadata(v *AnalyticsMetadataType) *AdminInitiateAuthInput
SetAnalyticsMetadata sets the AnalyticsMetadata field's value.
func (s *AdminInitiateAuthInput) SetAuthFlow(v string) *AdminInitiateAuthInput
SetAuthFlow sets the AuthFlow field's value.
func (s *AdminInitiateAuthInput) SetAuthParameters(v map[string]*string) *AdminInitiateAuthInput
SetAuthParameters sets the AuthParameters field's value.
func (s *AdminInitiateAuthInput) SetClientId(v string) *AdminInitiateAuthInput
SetClientId sets the ClientId field's value.
func (s *AdminInitiateAuthInput) SetClientMetadata(v map[string]*string) *AdminInitiateAuthInput
SetClientMetadata sets the ClientMetadata field's value.
func (s *AdminInitiateAuthInput) SetContextData(v *ContextDataType) *AdminInitiateAuthInput
SetContextData sets the ContextData field's value.
func (s *AdminInitiateAuthInput) SetUserPoolId(v string) *AdminInitiateAuthInput
SetUserPoolId sets the UserPoolId field's value.
func (s AdminInitiateAuthInput) String() string
String returns the string representation
func (s *AdminInitiateAuthInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminInitiateAuthOutput) GoString() string
GoString returns the string representation
func (s *AdminInitiateAuthOutput) SetAuthenticationResult(v *AuthenticationResultType) *AdminInitiateAuthOutput
SetAuthenticationResult sets the AuthenticationResult field's value.
func (s *AdminInitiateAuthOutput) SetChallengeName(v string) *AdminInitiateAuthOutput
SetChallengeName sets the ChallengeName field's value.
func (s *AdminInitiateAuthOutput) SetChallengeParameters(v map[string]*string) *AdminInitiateAuthOutput
SetChallengeParameters sets the ChallengeParameters field's value.
func (s *AdminInitiateAuthOutput) SetSession(v string) *AdminInitiateAuthOutput
SetSession sets the Session field's value.
func (s AdminInitiateAuthOutput) String() string
String returns the string representation
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 (s AdminLinkProviderForUserInput) GoString() string
GoString returns the string representation
func (s *AdminLinkProviderForUserInput) SetDestinationUser(v *ProviderUserIdentifierType) *AdminLinkProviderForUserInput
SetDestinationUser sets the DestinationUser field's value.
func (s *AdminLinkProviderForUserInput) SetSourceUser(v *ProviderUserIdentifierType) *AdminLinkProviderForUserInput
SetSourceUser sets the SourceUser field's value.
func (s *AdminLinkProviderForUserInput) SetUserPoolId(v string) *AdminLinkProviderForUserInput
SetUserPoolId sets the UserPoolId field's value.
func (s AdminLinkProviderForUserInput) String() string
String returns the string representation
func (s *AdminLinkProviderForUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminLinkProviderForUserOutput struct {
// contains filtered or unexported fields
}
func (s AdminLinkProviderForUserOutput) GoString() string
GoString returns the string representation
func (s AdminLinkProviderForUserOutput) String() string
String returns the string representation
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 (s AdminListDevicesInput) GoString() string
GoString returns the string representation
func (s *AdminListDevicesInput) SetLimit(v int64) *AdminListDevicesInput
SetLimit sets the Limit field's value.
func (s *AdminListDevicesInput) SetPaginationToken(v string) *AdminListDevicesInput
SetPaginationToken sets the PaginationToken field's value.
func (s *AdminListDevicesInput) SetUserPoolId(v string) *AdminListDevicesInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminListDevicesInput) SetUsername(v string) *AdminListDevicesInput
SetUsername sets the Username field's value.
func (s AdminListDevicesInput) String() string
String returns the string representation
func (s *AdminListDevicesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminListDevicesOutput) GoString() string
GoString returns the string representation
func (s *AdminListDevicesOutput) SetDevices(v []*DeviceType) *AdminListDevicesOutput
SetDevices sets the Devices field's value.
func (s *AdminListDevicesOutput) SetPaginationToken(v string) *AdminListDevicesOutput
SetPaginationToken sets the PaginationToken field's value.
func (s AdminListDevicesOutput) String() string
String returns the string representation
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 (s AdminListGroupsForUserInput) GoString() string
GoString returns the string representation
func (s *AdminListGroupsForUserInput) SetLimit(v int64) *AdminListGroupsForUserInput
SetLimit sets the Limit field's value.
func (s *AdminListGroupsForUserInput) SetNextToken(v string) *AdminListGroupsForUserInput
SetNextToken sets the NextToken field's value.
func (s *AdminListGroupsForUserInput) SetUserPoolId(v string) *AdminListGroupsForUserInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminListGroupsForUserInput) SetUsername(v string) *AdminListGroupsForUserInput
SetUsername sets the Username field's value.
func (s AdminListGroupsForUserInput) String() string
String returns the string representation
func (s *AdminListGroupsForUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminListGroupsForUserOutput) GoString() string
GoString returns the string representation
func (s *AdminListGroupsForUserOutput) SetGroups(v []*GroupType) *AdminListGroupsForUserOutput
SetGroups sets the Groups field's value.
func (s *AdminListGroupsForUserOutput) SetNextToken(v string) *AdminListGroupsForUserOutput
SetNextToken sets the NextToken field's value.
func (s AdminListGroupsForUserOutput) String() string
String returns the string representation
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 (s AdminListUserAuthEventsInput) GoString() string
GoString returns the string representation
func (s *AdminListUserAuthEventsInput) SetMaxResults(v int64) *AdminListUserAuthEventsInput
SetMaxResults sets the MaxResults field's value.
func (s *AdminListUserAuthEventsInput) SetNextToken(v string) *AdminListUserAuthEventsInput
SetNextToken sets the NextToken field's value.
func (s *AdminListUserAuthEventsInput) SetUserPoolId(v string) *AdminListUserAuthEventsInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminListUserAuthEventsInput) SetUsername(v string) *AdminListUserAuthEventsInput
SetUsername sets the Username field's value.
func (s AdminListUserAuthEventsInput) String() string
String returns the string representation
func (s *AdminListUserAuthEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminListUserAuthEventsOutput) GoString() string
GoString returns the string representation
func (s *AdminListUserAuthEventsOutput) SetAuthEvents(v []*AuthEventType) *AdminListUserAuthEventsOutput
SetAuthEvents sets the AuthEvents field's value.
func (s *AdminListUserAuthEventsOutput) SetNextToken(v string) *AdminListUserAuthEventsOutput
SetNextToken sets the NextToken field's value.
func (s AdminListUserAuthEventsOutput) String() string
String returns the string representation
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 (s AdminRemoveUserFromGroupInput) GoString() string
GoString returns the string representation
func (s *AdminRemoveUserFromGroupInput) SetGroupName(v string) *AdminRemoveUserFromGroupInput
SetGroupName sets the GroupName field's value.
func (s *AdminRemoveUserFromGroupInput) SetUserPoolId(v string) *AdminRemoveUserFromGroupInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminRemoveUserFromGroupInput) SetUsername(v string) *AdminRemoveUserFromGroupInput
SetUsername sets the Username field's value.
func (s AdminRemoveUserFromGroupInput) String() string
String returns the string representation
func (s *AdminRemoveUserFromGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminRemoveUserFromGroupOutput struct {
// contains filtered or unexported fields
}
func (s AdminRemoveUserFromGroupOutput) GoString() string
GoString returns the string representation
func (s AdminRemoveUserFromGroupOutput) String() string
String returns the string representation
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 (s AdminResetUserPasswordInput) GoString() string
GoString returns the string representation
func (s *AdminResetUserPasswordInput) SetClientMetadata(v map[string]*string) *AdminResetUserPasswordInput
SetClientMetadata sets the ClientMetadata field's value.
func (s *AdminResetUserPasswordInput) SetUserPoolId(v string) *AdminResetUserPasswordInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminResetUserPasswordInput) SetUsername(v string) *AdminResetUserPasswordInput
SetUsername sets the Username field's value.
func (s AdminResetUserPasswordInput) String() string
String returns the string representation
func (s *AdminResetUserPasswordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminResetUserPasswordOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server to reset a user password as an administrator.
func (s AdminResetUserPasswordOutput) GoString() string
GoString returns the string representation
func (s AdminResetUserPasswordOutput) String() string
String returns the string representation
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 (s AdminRespondToAuthChallengeInput) GoString() string
GoString returns the string representation
func (s *AdminRespondToAuthChallengeInput) SetAnalyticsMetadata(v *AnalyticsMetadataType) *AdminRespondToAuthChallengeInput
SetAnalyticsMetadata sets the AnalyticsMetadata field's value.
func (s *AdminRespondToAuthChallengeInput) SetChallengeName(v string) *AdminRespondToAuthChallengeInput
SetChallengeName sets the ChallengeName field's value.
func (s *AdminRespondToAuthChallengeInput) SetChallengeResponses(v map[string]*string) *AdminRespondToAuthChallengeInput
SetChallengeResponses sets the ChallengeResponses field's value.
func (s *AdminRespondToAuthChallengeInput) SetClientId(v string) *AdminRespondToAuthChallengeInput
SetClientId sets the ClientId field's value.
func (s *AdminRespondToAuthChallengeInput) SetClientMetadata(v map[string]*string) *AdminRespondToAuthChallengeInput
SetClientMetadata sets the ClientMetadata field's value.
func (s *AdminRespondToAuthChallengeInput) SetContextData(v *ContextDataType) *AdminRespondToAuthChallengeInput
SetContextData sets the ContextData field's value.
func (s *AdminRespondToAuthChallengeInput) SetSession(v string) *AdminRespondToAuthChallengeInput
SetSession sets the Session field's value.
func (s *AdminRespondToAuthChallengeInput) SetUserPoolId(v string) *AdminRespondToAuthChallengeInput
SetUserPoolId sets the UserPoolId field's value.
func (s AdminRespondToAuthChallengeInput) String() string
String returns the string representation
func (s *AdminRespondToAuthChallengeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminRespondToAuthChallengeOutput) GoString() string
GoString returns the string representation
func (s *AdminRespondToAuthChallengeOutput) SetAuthenticationResult(v *AuthenticationResultType) *AdminRespondToAuthChallengeOutput
SetAuthenticationResult sets the AuthenticationResult field's value.
func (s *AdminRespondToAuthChallengeOutput) SetChallengeName(v string) *AdminRespondToAuthChallengeOutput
SetChallengeName sets the ChallengeName field's value.
func (s *AdminRespondToAuthChallengeOutput) SetChallengeParameters(v map[string]*string) *AdminRespondToAuthChallengeOutput
SetChallengeParameters sets the ChallengeParameters field's value.
func (s *AdminRespondToAuthChallengeOutput) SetSession(v string) *AdminRespondToAuthChallengeOutput
SetSession sets the Session field's value.
func (s AdminRespondToAuthChallengeOutput) String() string
String returns the string representation
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 (s AdminSetUserMFAPreferenceInput) GoString() string
GoString returns the string representation
func (s *AdminSetUserMFAPreferenceInput) SetSMSMfaSettings(v *SMSMfaSettingsType) *AdminSetUserMFAPreferenceInput
SetSMSMfaSettings sets the SMSMfaSettings field's value.
func (s *AdminSetUserMFAPreferenceInput) SetSoftwareTokenMfaSettings(v *SoftwareTokenMfaSettingsType) *AdminSetUserMFAPreferenceInput
SetSoftwareTokenMfaSettings sets the SoftwareTokenMfaSettings field's value.
func (s *AdminSetUserMFAPreferenceInput) SetUserPoolId(v string) *AdminSetUserMFAPreferenceInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminSetUserMFAPreferenceInput) SetUsername(v string) *AdminSetUserMFAPreferenceInput
SetUsername sets the Username field's value.
func (s AdminSetUserMFAPreferenceInput) String() string
String returns the string representation
func (s *AdminSetUserMFAPreferenceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminSetUserMFAPreferenceOutput struct {
// contains filtered or unexported fields
}
func (s AdminSetUserMFAPreferenceOutput) GoString() string
GoString returns the string representation
func (s AdminSetUserMFAPreferenceOutput) String() string
String returns the string representation
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 (s AdminSetUserPasswordInput) GoString() string
GoString returns the string representation
func (s *AdminSetUserPasswordInput) SetPassword(v string) *AdminSetUserPasswordInput
SetPassword sets the Password field's value.
func (s *AdminSetUserPasswordInput) SetPermanent(v bool) *AdminSetUserPasswordInput
SetPermanent sets the Permanent field's value.
func (s *AdminSetUserPasswordInput) SetUserPoolId(v string) *AdminSetUserPasswordInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminSetUserPasswordInput) SetUsername(v string) *AdminSetUserPasswordInput
SetUsername sets the Username field's value.
func (s AdminSetUserPasswordInput) String() string
String returns the string representation
func (s *AdminSetUserPasswordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminSetUserPasswordOutput struct {
// contains filtered or unexported fields
}
func (s AdminSetUserPasswordOutput) GoString() string
GoString returns the string representation
func (s AdminSetUserPasswordOutput) String() string
String returns the string representation
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 (s AdminSetUserSettingsInput) GoString() string
GoString returns the string representation
func (s *AdminSetUserSettingsInput) SetMFAOptions(v []*MFAOptionType) *AdminSetUserSettingsInput
SetMFAOptions sets the MFAOptions field's value.
func (s *AdminSetUserSettingsInput) SetUserPoolId(v string) *AdminSetUserSettingsInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminSetUserSettingsInput) SetUsername(v string) *AdminSetUserSettingsInput
SetUsername sets the Username field's value.
func (s AdminSetUserSettingsInput) String() string
String returns the string representation
func (s *AdminSetUserSettingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminSetUserSettingsOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server to set user settings as an administrator.
func (s AdminSetUserSettingsOutput) GoString() string
GoString returns the string representation
func (s AdminSetUserSettingsOutput) String() string
String returns the string representation
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 (s AdminUpdateAuthEventFeedbackInput) GoString() string
GoString returns the string representation
func (s *AdminUpdateAuthEventFeedbackInput) SetEventId(v string) *AdminUpdateAuthEventFeedbackInput
SetEventId sets the EventId field's value.
func (s *AdminUpdateAuthEventFeedbackInput) SetFeedbackValue(v string) *AdminUpdateAuthEventFeedbackInput
SetFeedbackValue sets the FeedbackValue field's value.
func (s *AdminUpdateAuthEventFeedbackInput) SetUserPoolId(v string) *AdminUpdateAuthEventFeedbackInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminUpdateAuthEventFeedbackInput) SetUsername(v string) *AdminUpdateAuthEventFeedbackInput
SetUsername sets the Username field's value.
func (s AdminUpdateAuthEventFeedbackInput) String() string
String returns the string representation
func (s *AdminUpdateAuthEventFeedbackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminUpdateAuthEventFeedbackOutput struct {
// contains filtered or unexported fields
}
func (s AdminUpdateAuthEventFeedbackOutput) GoString() string
GoString returns the string representation
func (s AdminUpdateAuthEventFeedbackOutput) String() string
String returns the string representation
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 (s AdminUpdateDeviceStatusInput) GoString() string
GoString returns the string representation
func (s *AdminUpdateDeviceStatusInput) SetDeviceKey(v string) *AdminUpdateDeviceStatusInput
SetDeviceKey sets the DeviceKey field's value.
func (s *AdminUpdateDeviceStatusInput) SetDeviceRememberedStatus(v string) *AdminUpdateDeviceStatusInput
SetDeviceRememberedStatus sets the DeviceRememberedStatus field's value.
func (s *AdminUpdateDeviceStatusInput) SetUserPoolId(v string) *AdminUpdateDeviceStatusInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminUpdateDeviceStatusInput) SetUsername(v string) *AdminUpdateDeviceStatusInput
SetUsername sets the Username field's value.
func (s AdminUpdateDeviceStatusInput) String() string
String returns the string representation
func (s *AdminUpdateDeviceStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminUpdateDeviceStatusOutput struct {
// contains filtered or unexported fields
}
The status response from the request to update the device, as an administrator.
func (s AdminUpdateDeviceStatusOutput) GoString() string
GoString returns the string representation
func (s AdminUpdateDeviceStatusOutput) String() string
String returns the string representation
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 (s AdminUpdateUserAttributesInput) GoString() string
GoString returns the string representation
func (s *AdminUpdateUserAttributesInput) SetClientMetadata(v map[string]*string) *AdminUpdateUserAttributesInput
SetClientMetadata sets the ClientMetadata field's value.
func (s *AdminUpdateUserAttributesInput) SetUserAttributes(v []*AttributeType) *AdminUpdateUserAttributesInput
SetUserAttributes sets the UserAttributes field's value.
func (s *AdminUpdateUserAttributesInput) SetUserPoolId(v string) *AdminUpdateUserAttributesInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminUpdateUserAttributesInput) SetUsername(v string) *AdminUpdateUserAttributesInput
SetUsername sets the Username field's value.
func (s AdminUpdateUserAttributesInput) String() string
String returns the string representation
func (s *AdminUpdateUserAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AdminUpdateUserAttributesOutput) GoString() string
GoString returns the string representation
func (s AdminUpdateUserAttributesOutput) String() string
String returns the string representation
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 (s AdminUserGlobalSignOutInput) GoString() string
GoString returns the string representation
func (s *AdminUserGlobalSignOutInput) SetUserPoolId(v string) *AdminUserGlobalSignOutInput
SetUserPoolId sets the UserPoolId field's value.
func (s *AdminUserGlobalSignOutInput) SetUsername(v string) *AdminUserGlobalSignOutInput
SetUsername sets the Username field's value.
func (s AdminUserGlobalSignOutInput) String() string
String returns the string representation
func (s *AdminUserGlobalSignOutInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminUserGlobalSignOutOutput struct {
// contains filtered or unexported fields
}
The global sign-out response, as an administrator.
func (s AdminUserGlobalSignOutOutput) GoString() string
GoString returns the string representation
func (s AdminUserGlobalSignOutOutput) String() string
String returns the string representation
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 (s AnalyticsConfigurationType) GoString() string
GoString returns the string representation
func (s *AnalyticsConfigurationType) SetApplicationId(v string) *AnalyticsConfigurationType
SetApplicationId sets the ApplicationId field's value.
func (s *AnalyticsConfigurationType) SetExternalId(v string) *AnalyticsConfigurationType
SetExternalId sets the ExternalId field's value.
func (s *AnalyticsConfigurationType) SetRoleArn(v string) *AnalyticsConfigurationType
SetRoleArn sets the RoleArn field's value.
func (s *AnalyticsConfigurationType) SetUserDataShared(v bool) *AnalyticsConfigurationType
SetUserDataShared sets the UserDataShared field's value.
func (s AnalyticsConfigurationType) String() string
String returns the string representation
func (s *AnalyticsConfigurationType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AnalyticsMetadataType) GoString() string
GoString returns the string representation
func (s *AnalyticsMetadataType) SetAnalyticsEndpointId(v string) *AnalyticsMetadataType
SetAnalyticsEndpointId sets the AnalyticsEndpointId field's value.
func (s AnalyticsMetadataType) String() string
String returns the string representation
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 (s AssociateSoftwareTokenInput) GoString() string
GoString returns the string representation
func (s *AssociateSoftwareTokenInput) SetAccessToken(v string) *AssociateSoftwareTokenInput
SetAccessToken sets the AccessToken field's value.
func (s *AssociateSoftwareTokenInput) SetSession(v string) *AssociateSoftwareTokenInput
SetSession sets the Session field's value.
func (s AssociateSoftwareTokenInput) String() string
String returns the string representation
func (s *AssociateSoftwareTokenInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AssociateSoftwareTokenOutput) GoString() string
GoString returns the string representation
func (s *AssociateSoftwareTokenOutput) SetSecretCode(v string) *AssociateSoftwareTokenOutput
SetSecretCode sets the SecretCode field's value.
func (s *AssociateSoftwareTokenOutput) SetSession(v string) *AssociateSoftwareTokenOutput
SetSession sets the Session field's value.
func (s AssociateSoftwareTokenOutput) String() string
String returns the string representation
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 (s AttributeType) GoString() string
GoString returns the string representation
func (s *AttributeType) SetName(v string) *AttributeType
SetName sets the Name field's value.
func (s *AttributeType) SetValue(v string) *AttributeType
SetValue sets the Value field's value.
func (s AttributeType) String() string
String returns the string representation
func (s *AttributeType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s AuthEventType) GoString() string
GoString returns the string representation
func (s *AuthEventType) SetChallengeResponses(v []*ChallengeResponseType) *AuthEventType
SetChallengeResponses sets the ChallengeResponses field's value.
func (s *AuthEventType) SetCreationDate(v time.Time) *AuthEventType
SetCreationDate sets the CreationDate field's value.
func (s *AuthEventType) SetEventContextData(v *EventContextDataType) *AuthEventType
SetEventContextData sets the EventContextData field's value.
func (s *AuthEventType) SetEventFeedback(v *EventFeedbackType) *AuthEventType
SetEventFeedback sets the EventFeedback field's value.
func (s *AuthEventType) SetEventId(v string) *AuthEventType
SetEventId sets the EventId field's value.
func (s *AuthEventType) SetEventResponse(v string) *AuthEventType
SetEventResponse sets the EventResponse field's value.
func (s *AuthEventType) SetEventRisk(v *EventRiskType) *AuthEventType
SetEventRisk sets the EventRisk field's value.
func (s *AuthEventType) SetEventType(v string) *AuthEventType
SetEventType sets the EventType field's value.
func (s AuthEventType) String() string
String returns the string representation
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 (s AuthenticationResultType) GoString() string
GoString returns the string representation
func (s *AuthenticationResultType) SetAccessToken(v string) *AuthenticationResultType
SetAccessToken sets the AccessToken field's value.
func (s *AuthenticationResultType) SetExpiresIn(v int64) *AuthenticationResultType
SetExpiresIn sets the ExpiresIn field's value.
func (s *AuthenticationResultType) SetIdToken(v string) *AuthenticationResultType
SetIdToken sets the IdToken field's value.
func (s *AuthenticationResultType) SetNewDeviceMetadata(v *NewDeviceMetadataType) *AuthenticationResultType
SetNewDeviceMetadata sets the NewDeviceMetadata field's value.
func (s *AuthenticationResultType) SetRefreshToken(v string) *AuthenticationResultType
SetRefreshToken sets the RefreshToken field's value.
func (s *AuthenticationResultType) SetTokenType(v string) *AuthenticationResultType
SetTokenType sets the TokenType field's value.
func (s AuthenticationResultType) String() string
String returns the string representation
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 (s ChallengeResponseType) GoString() string
GoString returns the string representation
func (s *ChallengeResponseType) SetChallengeName(v string) *ChallengeResponseType
SetChallengeName sets the ChallengeName field's value.
func (s *ChallengeResponseType) SetChallengeResponse(v string) *ChallengeResponseType
SetChallengeResponse sets the ChallengeResponse field's value.
func (s ChallengeResponseType) String() string
String returns the string representation
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 (s ChangePasswordInput) GoString() string
GoString returns the string representation
func (s *ChangePasswordInput) SetAccessToken(v string) *ChangePasswordInput
SetAccessToken sets the AccessToken field's value.
func (s *ChangePasswordInput) SetPreviousPassword(v string) *ChangePasswordInput
SetPreviousPassword sets the PreviousPassword field's value.
func (s *ChangePasswordInput) SetProposedPassword(v string) *ChangePasswordInput
SetProposedPassword sets the ProposedPassword field's value.
func (s ChangePasswordInput) String() string
String returns the string representation
func (s *ChangePasswordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangePasswordOutput struct {
// contains filtered or unexported fields
}
The response from the server to the change password request.
func (s ChangePasswordOutput) GoString() string
GoString returns the string representation
func (s ChangePasswordOutput) String() string
String returns the string representation
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 (s CodeDeliveryDetailsType) GoString() string
GoString returns the string representation
func (s *CodeDeliveryDetailsType) SetAttributeName(v string) *CodeDeliveryDetailsType
SetAttributeName sets the AttributeName field's value.
func (s *CodeDeliveryDetailsType) SetDeliveryMedium(v string) *CodeDeliveryDetailsType
SetDeliveryMedium sets the DeliveryMedium field's value.
func (s *CodeDeliveryDetailsType) SetDestination(v string) *CodeDeliveryDetailsType
SetDestination sets the Destination field's value.
func (s CodeDeliveryDetailsType) String() string
String returns the string representation
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(p client.ConfigProvider, cfgs ...*aws.Config) *CognitoIdentityProvider
New creates a new instance of the CognitoIdentityProvider client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a CognitoIdentityProvider client from just a session. svc := cognitoidentityprovider.New(mySession) // Create a CognitoIdentityProvider client with additional configuration svc := cognitoidentityprovider.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (c *CognitoIdentityProvider) AdminUserGlobalSignOut(input *AdminUserGlobalSignOutInput) (*AdminUserGlobalSignOutOutput, error)
AdminUserGlobalSignOut API operation for Amazon Cognito Identity Provider.
Signs out users from all devices, as an administrator. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
Calling this action requires developer credentials.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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.
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 ConfirmForgotPassword for more information on using the ConfirmForgotPassword 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 ConfirmForgotPasswordRequest method. req, resp := client.ConfirmForgotPasswordRequest(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/ConfirmForgotPassword
func (c *CognitoIdentityProvider) ConfirmForgotPasswordWithContext(ctx aws.Context, input *ConfirmForgotPasswordInput, opts ...request.Option) (*ConfirmForgotPasswordOutput, error)
ConfirmForgotPasswordWithContext is the same as ConfirmForgotPassword with the addition of the ability to pass a context and additional request options.
See ConfirmForgotPassword 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 (c *CognitoIdentityProvider) ConfirmSignUp(input *ConfirmSignUpInput) (*ConfirmSignUpOutput, error)
ConfirmSignUp API operation for Amazon Cognito Identity Provider.
Confirms registration of a user and handles the existing alias from a previous user.
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 ConfirmSignUp 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). * 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. * 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. * 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/ConfirmSignUp
func (c *CognitoIdentityProvider) ConfirmSignUpRequest(input *ConfirmSignUpInput) (req *request.Request, output *ConfirmSignUpOutput)
ConfirmSignUpRequest generates a "aws/request.Request" representing the client's request for the ConfirmSignUp 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 ConfirmSignUp for more information on using the ConfirmSignUp 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 ConfirmSignUpRequest method. req, resp := client.ConfirmSignUpRequest(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/ConfirmSignUp
func (c *CognitoIdentityProvider) ConfirmSignUpWithContext(ctx aws.Context, input *ConfirmSignUpInput, opts ...request.Option) (*ConfirmSignUpOutput, error)
ConfirmSignUpWithContext is the same as ConfirmSignUp with the addition of the ability to pass a context and additional request options.
See ConfirmSignUp 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 (c *CognitoIdentityProvider) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)
CreateGroup API operation for Amazon Cognito Identity Provider.
Creates a new group in the specified user pool.
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 CreateGroup for usage and error information.
Returned Error Codes:
* ErrCodeInvalidParameterException "InvalidParameterException" This exception is thrown when the Amazon Cognito service encounters an invalid parameter. * ErrCodeGroupExistsException "GroupExistsException" This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool. * 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. * ErrCodeLimitExceededException "LimitExceededException" This exception is thrown when a user exceeds the limit for a requested AWS resource. * ErrCodeNotAuthorizedException "NotAuthorizedException" This exception is thrown when a user is not authorized. * 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/CreateGroup
func (c *CognitoIdentityProvider) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)
CreateGroupRequest generates a "aws/request.Request" representing the client's request for the CreateGroup 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 CreateGroup for more information on using the CreateGroup 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 CreateGroupRequest method. req, resp := client.CreateGroupRequest(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/CreateGroup
func (c *CognitoIdentityProvider) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)
CreateGroupWithContext is the same as CreateGroup with the addition of the ability to pass a context and additional request options.
See CreateGroup 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 (c *CognitoIdentityProvider) CreateIdentityProvider(input *CreateIdentityProviderInput) (*CreateIdentityProviderOutput, error)
CreateIdentityProvider API operation for Amazon Cognito Identity Provider.
Creates an identity provider for 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 CreateIdentityProvider for usage and error information.
Returned Error Codes:
* ErrCodeInvalidParameterException "InvalidParameterException" This exception is thrown when the Amazon Cognito service encounters an invalid parameter. * ErrCodeDuplicateProviderException "DuplicateProviderException" This exception is thrown when the provider is already supported by the user pool. * 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. * 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. * 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/CreateIdentityProvider
func (c *CognitoIdentityProvider) CreateIdentityProviderRequest(input *CreateIdentityProviderInput) (req *request.Request, output *CreateIdentityProviderOutput)
CreateIdentityProviderRequest generates a "aws/request.Request" representing the client's request for the CreateIdentityProvider 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 CreateIdentityProvider for more information on using the CreateIdentityProvider 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 CreateIdentityProviderRequest method. req, resp := client.CreateIdentityProviderRequest(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/CreateIdentityProvider
func (c *CognitoIdentityProvider) CreateIdentityProviderWithContext(ctx aws.Context, input *CreateIdentityProviderInput, opts ...request.Option) (*CreateIdentityProviderOutput, error)
CreateIdentityProviderWithContext is the same as CreateIdentityProvider with the addition of the ability to pass a context and additional request options.
See CreateIdentityProvider 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 (c *CognitoIdentityProvider) CreateResourceServer(input *CreateResourceServerInput) (*CreateResourceServerOutput, error)
CreateResourceServer API operation for Amazon Cognito Identity Provider.
Creates a new OAuth2.0 resource server and defines custom scopes in it.
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 CreateResourceServer 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. * 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. * 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/CreateResourceServer
func (c *CognitoIdentityProvider) CreateResourceServerRequest(input *CreateResourceServerInput) (req *request.Request, output *CreateResourceServerOutput)
CreateResourceServerRequest generates a "aws/request.Request" representing the client's request for the CreateResourceServer 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 CreateResourceServer for more information on using the CreateResourceServer 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 CreateResourceServerRequest method. req, resp := client.CreateResourceServerRequest(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/CreateResourceServer
func (c *CognitoIdentityProvider) CreateResourceServerWithContext(ctx aws.Context, input *CreateResourceServerInput, opts ...request.Option) (*CreateResourceServerOutput, error)
CreateResourceServerWithContext is the same as CreateResourceServer with the addition of the ability to pass a context and additional request options.
See CreateResourceServer 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 (c *CognitoIdentityProvider) CreateUserImportJob(input *CreateUserImportJobInput) (*CreateUserImportJobOutput, error)
CreateUserImportJob API operation for Amazon Cognito Identity Provider.
Creates the user import job.
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 CreateUserImportJob 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. * ErrCodePreconditionNotMetException "PreconditionNotMetException" This exception is thrown when a precondition is not met. * ErrCodeNotAuthorizedException "NotAuthorizedException" This exception is thrown when a user is not authorized. * ErrCodeLimitExceededException "LimitExceededException" This exception is thrown when a user exceeds the limit for a requested AWS resource. * 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/CreateUserImportJob
func (c *CognitoIdentityProvider) CreateUserImportJobRequest(input *CreateUserImportJobInput) (req *request.Request, output *CreateUserImportJobOutput)
CreateUserImportJobRequest generates a "aws/request.Request" representing the client's request for the CreateUserImportJob 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 CreateUserImportJob for more information on using the CreateUserImportJob 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 CreateUserImportJobRequest method. req, resp := client.CreateUserImportJobRequest(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/CreateUserImportJob
func (c *CognitoIdentityProvider) CreateUserImportJobWithContext(ctx aws.Context, input *CreateUserImportJobInput, opts ...request.Option) (*CreateUserImportJobOutput, error)
CreateUserImportJobWithContext is the same as CreateUserImportJob with the addition of the ability to pass a context and additional request options.
See CreateUserImportJob 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 (c *CognitoIdentityProvider) CreateUserPool(input *CreateUserPoolInput) (*CreateUserPoolOutput, error)
CreateUserPool API operation for Amazon Cognito Identity Provider.
Creates a new Amazon Cognito user pool and sets the password policy for the 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 CreateUserPool for usage and error information.
Returned Error Codes:
* 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. * ErrCodeLimitExceededException "LimitExceededException" This exception is thrown when a user exceeds the limit for a requested AWS resource. * 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. * ErrCodeInvalidEmailRoleAccessPolicyException "InvalidEmailRoleAccessPolicyException" This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400. * ErrCodeNotAuthorizedException "NotAuthorizedException" This exception is thrown when a user is not authorized. * ErrCodeUserPoolTaggingException "UserPoolTaggingException" This exception is thrown when a user pool tag cannot be set or updated. * 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/CreateUserPool
func (c *CognitoIdentityProvider) CreateUserPoolClient(input *CreateUserPoolClientInput) (*CreateUserPoolClientOutput, error)
CreateUserPoolClient API operation for Amazon Cognito Identity Provider.
Creates the user pool client.
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 CreateUserPoolClient 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. * ErrCodeLimitExceededException "LimitExceededException" This exception is thrown when a user exceeds the limit for a requested AWS resource. * ErrCodeNotAuthorizedException "NotAuthorizedException" This exception is thrown when a user is not authorized. * ErrCodeScopeDoesNotExistException "ScopeDoesNotExistException" This exception is thrown when the specified scope does not exist. * ErrCodeInvalidOAuthFlowException "InvalidOAuthFlowException" This exception is thrown when the specified OAuth flow is invalid. * 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/CreateUserPoolClient
func (c *CognitoIdentityProvider) CreateUserPoolClientRequest(input *CreateUserPoolClientInput) (req *request.Request, output *CreateUserPoolClientOutput)
CreateUserPoolClientRequest generates a "aws/request.Request" representing the client's request for the CreateUserPoolClient 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 CreateUserPoolClient for more information on using the CreateUserPoolClient 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 CreateUserPoolClientRequest method. req, resp := client.CreateUserPoolClientRequest(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/CreateUserPoolClient
func (c *CognitoIdentityProvider) CreateUserPoolClientWithContext(ctx aws.Context, input *CreateUserPoolClientInput, opts ...request.Option) (*CreateUserPoolClientOutput, error)
CreateUserPoolClientWithContext is the same as CreateUserPoolClient with the addition of the ability to pass a context and additional request options.
See CreateUserPoolClient 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 (c *CognitoIdentityProvider) CreateUserPoolDomain(input *CreateUserPoolDomainInput) (*CreateUserPoolDomainOutput, error)
CreateUserPoolDomain API operation for Amazon Cognito Identity Provider.
Creates a new domain for 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 CreateUserPoolDomain 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. * ErrCodeLimitExceededException "LimitExceededException" This exception is thrown when a user exceeds the limit for a requested AWS resource. * 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/CreateUserPoolDomain
func (c *CognitoIdentityProvider) CreateUserPoolDomainRequest(input *CreateUserPoolDomainInput) (req *request.Request, output *CreateUserPoolDomainOutput)
CreateUserPoolDomainRequest generates a "aws/request.Request" representing the client's request for the CreateUserPoolDomain 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 CreateUserPoolDomain for more information on using the CreateUserPoolDomain 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 CreateUserPoolDomainRequest method. req, resp := client.CreateUserPoolDomainRequest(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/CreateUserPoolDomain
func (c *CognitoIdentityProvider) CreateUserPoolDomainWithContext(ctx aws.Context, input *CreateUserPoolDomainInput, opts ...request.Option) (*CreateUserPoolDomainOutput, error)
CreateUserPoolDomainWithContext is the same as CreateUserPoolDomain with the addition of the ability to pass a context and additional request options.
See CreateUserPoolDomain 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 (c *CognitoIdentityProvider) CreateUserPoolRequest(input *CreateUserPoolInput) (req *request.Request, output *CreateUserPoolOutput)
CreateUserPoolRequest generates a "aws/request.Request" representing the client's request for the CreateUserPool 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 CreateUserPool for more information on using the CreateUserPool 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 CreateUserPoolRequest method. req, resp := client.CreateUserPoolRequest(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/CreateUserPool
func (c *CognitoIdentityProvider) CreateUserPoolWithContext(ctx aws.Context, input *CreateUserPoolInput, opts ...request.Option) (*CreateUserPoolOutput, error)
CreateUserPoolWithContext is the same as CreateUserPool with the addition of the ability to pass a context and additional request options.
See CreateUserPool 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 (c *CognitoIdentityProvider) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)
DeleteGroup API operation for Amazon Cognito Identity Provider.
Deletes a group. Currently only groups with no members can be deleted.
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 DeleteGroup 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. * 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/DeleteGroup
func (c *CognitoIdentityProvider) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)
DeleteGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGroup 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 DeleteGroup for more information on using the DeleteGroup 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 DeleteGroupRequest method. req, resp := client.DeleteGroupRequest(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/DeleteGroup
func (c *CognitoIdentityProvider) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)
DeleteGroupWithContext is the same as DeleteGroup with the addition of the ability to pass a context and additional request options.
See DeleteGroup 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 (c *CognitoIdentityProvider) DeleteIdentityProvider(input *DeleteIdentityProviderInput) (*DeleteIdentityProviderOutput, error)
DeleteIdentityProvider API operation for Amazon Cognito Identity Provider.
Deletes an identity provider for 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 DeleteIdentityProvider for usage and error information.
Returned Error Codes:
* ErrCodeInvalidParameterException "InvalidParameterException" This exception is thrown when the Amazon Cognito service encounters an invalid parameter. * ErrCodeUnsupportedIdentityProviderException "UnsupportedIdentityProviderException" This exception is thrown when the specified identifier is not supported. * 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteIdentityProvider
func (c *CognitoIdentityProvider) DeleteIdentityProviderRequest(input *DeleteIdentityProviderInput) (req *request.Request, output *DeleteIdentityProviderOutput)
DeleteIdentityProviderRequest generates a "aws/request.Request" representing the client's request for the DeleteIdentityProvider 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 DeleteIdentityProvider for more information on using the DeleteIdentityProvider 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 DeleteIdentityProviderRequest method. req, resp := client.DeleteIdentityProviderRequest(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/DeleteIdentityProvider
func (c *CognitoIdentityProvider) DeleteIdentityProviderWithContext(ctx aws.Context, input *DeleteIdentityProviderInput, opts ...request.Option) (*DeleteIdentityProviderOutput, error)
DeleteIdentityProviderWithContext is the same as DeleteIdentityProvider with the addition of the ability to pass a context and additional request options.
See DeleteIdentityProvider 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 (c *CognitoIdentityProvider) DeleteResourceServer(input *DeleteResourceServerInput) (*DeleteResourceServerOutput, error)
DeleteResourceServer API operation for Amazon Cognito Identity Provider.
Deletes a resource server.
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 DeleteResourceServer 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteResourceServer
func (c *CognitoIdentityProvider) DeleteResourceServerRequest(input *DeleteResourceServerInput) (req *request.Request, output *DeleteResourceServerOutput)
DeleteResourceServerRequest generates a "aws/request.Request" representing the client's request for the DeleteResourceServer 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 DeleteResourceServer for more information on using the DeleteResourceServer 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 DeleteResourceServerRequest method. req, resp := client.DeleteResourceServerRequest(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/DeleteResourceServer
func (c *CognitoIdentityProvider) DeleteResourceServerWithContext(ctx aws.Context, input *DeleteResourceServerInput, opts ...request.Option) (*DeleteResourceServerOutput, error)
DeleteResourceServerWithContext is the same as DeleteResourceServer with the addition of the ability to pass a context and additional request options.
See DeleteResourceServer 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 (c *CognitoIdentityProvider) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)
DeleteUser API operation for Amazon Cognito Identity Provider.
Allows a user to delete himself or herself.
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 DeleteUser 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. * 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/DeleteUser
func (c *CognitoIdentityProvider) DeleteUserAttributes(input *DeleteUserAttributesInput) (*DeleteUserAttributesOutput, error)
DeleteUserAttributes API operation for Amazon Cognito Identity Provider.
Deletes the attributes for a user.
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 DeleteUserAttributes 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. * 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/DeleteUserAttributes
func (c *CognitoIdentityProvider) DeleteUserAttributesRequest(input *DeleteUserAttributesInput) (req *request.Request, output *DeleteUserAttributesOutput)
DeleteUserAttributesRequest generates a "aws/request.Request" representing the client's request for the DeleteUserAttributes 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 DeleteUserAttributes for more information on using the DeleteUserAttributes 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 DeleteUserAttributesRequest method. req, resp := client.DeleteUserAttributesRequest(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/DeleteUserAttributes
func (c *CognitoIdentityProvider) DeleteUserAttributesWithContext(ctx aws.Context, input *DeleteUserAttributesInput, opts ...request.Option) (*DeleteUserAttributesOutput, error)
DeleteUserAttributesWithContext is the same as DeleteUserAttributes with the addition of the ability to pass a context and additional request options.
See DeleteUserAttributes 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 (c *CognitoIdentityProvider) DeleteUserPool(input *DeleteUserPoolInput) (*DeleteUserPoolOutput, error)
DeleteUserPool API operation for Amazon Cognito Identity Provider.
Deletes the specified Amazon Cognito 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 DeleteUserPool 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/DeleteUserPool
func (c *CognitoIdentityProvider) DeleteUserPoolClient(input *DeleteUserPoolClientInput) (*DeleteUserPoolClientOutput, error)
DeleteUserPoolClient API operation for Amazon Cognito Identity Provider.
Allows the developer to delete the user pool client.
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 DeleteUserPoolClient 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. * 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/DeleteUserPoolClient
func (c *CognitoIdentityProvider) DeleteUserPoolClientRequest(input *DeleteUserPoolClientInput) (req *request.Request, output *DeleteUserPoolClientOutput)
DeleteUserPoolClientRequest generates a "aws/request.Request" representing the client's request for the DeleteUserPoolClient 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 DeleteUserPoolClient for more information on using the DeleteUserPoolClient 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 DeleteUserPoolClientRequest method. req, resp := client.DeleteUserPoolClientRequest(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/DeleteUserPoolClient
func (c *CognitoIdentityProvider) DeleteUserPoolClientWithContext(ctx aws.Context, input *DeleteUserPoolClientInput, opts ...request.Option) (*DeleteUserPoolClientOutput, error)
DeleteUserPoolClientWithContext is the same as DeleteUserPoolClient with the addition of the ability to pass a context and additional request options.
See DeleteUserPoolClient 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 (c *CognitoIdentityProvider) DeleteUserPoolDomain(input *DeleteUserPoolDomainInput) (*DeleteUserPoolDomainOutput, error)
DeleteUserPoolDomain API operation for Amazon Cognito Identity Provider.
Deletes a domain for 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 DeleteUserPoolDomain for usage and error information.
Returned Error Codes:
* ErrCodeNotAuthorizedException "NotAuthorizedException" This exception is thrown when a user is not authorized. * 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. * 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/DeleteUserPoolDomain
func (c *CognitoIdentityProvider) DeleteUserPoolDomainRequest(input *DeleteUserPoolDomainInput) (req *request.Request, output *DeleteUserPoolDomainOutput)
DeleteUserPoolDomainRequest generates a "aws/request.Request" representing the client's request for the DeleteUserPoolDomain 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 DeleteUserPoolDomain for more information on using the DeleteUserPoolDomain 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 DeleteUserPoolDomainRequest method. req, resp := client.DeleteUserPoolDomainRequest(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/DeleteUserPoolDomain
func (c *CognitoIdentityProvider) DeleteUserPoolDomainWithContext(ctx aws.Context, input *DeleteUserPoolDomainInput, opts ...request.Option) (*DeleteUserPoolDomainOutput, error)
DeleteUserPoolDomainWithContext is the same as DeleteUserPoolDomain with the addition of the ability to pass a context and additional request options.
See DeleteUserPoolDomain 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 (c *CognitoIdentityProvider) DeleteUserPoolRequest(input *DeleteUserPoolInput) (req *request.Request, output *DeleteUserPoolOutput)
DeleteUserPoolRequest generates a "aws/request.Request" representing the client's request for the DeleteUserPool 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 DeleteUserPool for more information on using the DeleteUserPool 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 DeleteUserPoolRequest method. req, resp := client.DeleteUserPoolRequest(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/DeleteUserPool
func (c *CognitoIdentityProvider) DeleteUserPoolWithContext(ctx aws.Context, input *DeleteUserPoolInput, opts ...request.Option) (*DeleteUserPoolOutput, error)
DeleteUserPoolWithContext is the same as DeleteUserPool with the addition of the ability to pass a context and additional request options.
See DeleteUserPool 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 (c *CognitoIdentityProvider) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)
DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser 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 DeleteUser for more information on using the DeleteUser 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 DeleteUserRequest method. req, resp := client.DeleteUserRequest(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/DeleteUser
func (c *CognitoIdentityProvider) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)
DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.
See DeleteUser 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 (c *CognitoIdentityProvider) DescribeIdentityProvider(input *DescribeIdentityProviderInput) (*DescribeIdentityProviderOutput, error)
DescribeIdentityProvider API operation for Amazon Cognito Identity Provider.
Gets information about a specific identity provider.
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 DescribeIdentityProvider 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeIdentityProvider
func (c *CognitoIdentityProvider) DescribeIdentityProviderRequest(input *DescribeIdentityProviderInput) (req *request.Request, output *DescribeIdentityProviderOutput)
DescribeIdentityProviderRequest generates a "aws/request.Request" representing the client's request for the DescribeIdentityProvider 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 DescribeIdentityProvider for more information on using the DescribeIdentityProvider 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 DescribeIdentityProviderRequest method. req, resp := client.DescribeIdentityProviderRequest(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/DescribeIdentityProvider
func (c *CognitoIdentityProvider) DescribeIdentityProviderWithContext(ctx aws.Context, input *DescribeIdentityProviderInput, opts ...request.Option) (*DescribeIdentityProviderOutput, error)
DescribeIdentityProviderWithContext is the same as DescribeIdentityProvider with the addition of the ability to pass a context and additional request options.
See DescribeIdentityProvider 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 (c *CognitoIdentityProvider) DescribeResourceServer(input *DescribeResourceServerInput) (*DescribeResourceServerOutput, error)
DescribeResourceServer API operation for Amazon Cognito Identity Provider.
Describes a resource server.
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 DescribeResourceServer 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeResourceServer
func (c *CognitoIdentityProvider) DescribeResourceServerRequest(input *DescribeResourceServerInput) (req *request.Request, output *DescribeResourceServerOutput)
DescribeResourceServerRequest generates a "aws/request.Request" representing the client's request for the DescribeResourceServer 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 DescribeResourceServer for more information on using the DescribeResourceServer 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 DescribeResourceServerRequest method. req, resp := client.DescribeResourceServerRequest(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/DescribeResourceServer
func (c *CognitoIdentityProvider) DescribeResourceServerWithContext(ctx aws.Context, input *DescribeResourceServerInput, opts ...request.Option) (*DescribeResourceServerOutput, error)
DescribeResourceServerWithContext is the same as DescribeResourceServer with the addition of the ability to pass a context and additional request options.
See DescribeResourceServer 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 (c *CognitoIdentityProvider) DescribeRiskConfiguration(input *DescribeRiskConfigurationInput) (*DescribeRiskConfigurationOutput, error)
DescribeRiskConfiguration API operation for Amazon Cognito Identity Provider.
Describes the risk configuration.
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 DescribeRiskConfiguration 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. * 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/DescribeRiskConfiguration
func (c *CognitoIdentityProvider) DescribeRiskConfigurationRequest(input *DescribeRiskConfigurationInput) (req *request.Request, output *DescribeRiskConfigurationOutput)
DescribeRiskConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeRiskConfiguration 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 DescribeRiskConfiguration for more information on using the DescribeRiskConfiguration 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 DescribeRiskConfigurationRequest method. req, resp := client.DescribeRiskConfigurationRequest(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/DescribeRiskConfiguration
func (c *CognitoIdentityProvider) DescribeRiskConfigurationWithContext(ctx aws.Context, input *DescribeRiskConfigurationInput, opts ...request.Option) (*DescribeRiskConfigurationOutput, error)
DescribeRiskConfigurationWithContext is the same as DescribeRiskConfiguration with the addition of the ability to pass a context and additional request options.
See DescribeRiskConfiguration 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 (c *CognitoIdentityProvider) DescribeUserImportJob(input *DescribeUserImportJobInput) (*DescribeUserImportJobOutput, error)
DescribeUserImportJob API operation for Amazon Cognito Identity Provider.
Describes the user import job.
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 DescribeUserImportJob 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. * 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/DescribeUserImportJob
func (c *CognitoIdentityProvider) DescribeUserImportJobRequest(input *DescribeUserImportJobInput) (req *request.Request, output *DescribeUserImportJobOutput)
DescribeUserImportJobRequest generates a "aws/request.Request" representing the client's request for the DescribeUserImportJob 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 DescribeUserImportJob for more information on using the DescribeUserImportJob 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 DescribeUserImportJobRequest method. req, resp := client.DescribeUserImportJobRequest(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/DescribeUserImportJob
func (c *CognitoIdentityProvider) DescribeUserImportJobWithContext(ctx aws.Context, input *DescribeUserImportJobInput, opts ...request.Option) (*DescribeUserImportJobOutput, error)
DescribeUserImportJobWithContext is the same as DescribeUserImportJob with the addition of the ability to pass a context and additional request options.
See DescribeUserImportJob 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 (c *CognitoIdentityProvider) DescribeUserPool(input *DescribeUserPoolInput) (*DescribeUserPoolOutput, error)
DescribeUserPool API operation for Amazon Cognito Identity Provider.
Returns the configuration information and metadata of the specified 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 DescribeUserPool 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. * ErrCodeUserPoolTaggingException "UserPoolTaggingException" This exception is thrown when a user pool tag cannot be set or updated. * 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/DescribeUserPool
func (c *CognitoIdentityProvider) DescribeUserPoolClient(input *DescribeUserPoolClientInput) (*DescribeUserPoolClientOutput, error)
DescribeUserPoolClient API operation for Amazon Cognito Identity Provider.
Client method for returning the configuration information and metadata of the specified user pool app client.
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 DescribeUserPoolClient 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. * 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/DescribeUserPoolClient
func (c *CognitoIdentityProvider) DescribeUserPoolClientRequest(input *DescribeUserPoolClientInput) (req *request.Request, output *DescribeUserPoolClientOutput)
DescribeUserPoolClientRequest generates a "aws/request.Request" representing the client's request for the DescribeUserPoolClient 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 DescribeUserPoolClient for more information on using the DescribeUserPoolClient 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 DescribeUserPoolClientRequest method. req, resp := client.DescribeUserPoolClientRequest(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/DescribeUserPoolClient
func (c *CognitoIdentityProvider) DescribeUserPoolClientWithContext(ctx aws.Context, input *DescribeUserPoolClientInput, opts ...request.Option) (*DescribeUserPoolClientOutput, error)
DescribeUserPoolClientWithContext is the same as DescribeUserPoolClient with the addition of the ability to pass a context and additional request options.
See DescribeUserPoolClient 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 (c *CognitoIdentityProvider) DescribeUserPoolDomain(input *DescribeUserPoolDomainInput) (*DescribeUserPoolDomainOutput, error)
DescribeUserPoolDomain API operation for Amazon Cognito Identity Provider.
Gets information about a domain.
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 DescribeUserPoolDomain for usage and error information.
Returned Error Codes:
* ErrCodeNotAuthorizedException "NotAuthorizedException" This exception is thrown when a user is not authorized. * 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. * 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/DescribeUserPoolDomain
func (c *CognitoIdentityProvider) DescribeUserPoolDomainRequest(input *DescribeUserPoolDomainInput) (req *request.Request, output *DescribeUserPoolDomainOutput)
DescribeUserPoolDomainRequest generates a "aws/request.Request" representing the client's request for the DescribeUserPoolDomain 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 DescribeUserPoolDomain for more information on using the DescribeUserPoolDomain 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 DescribeUserPoolDomainRequest method. req, resp := client.DescribeUserPoolDomainRequest(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/DescribeUserPoolDomain
func (c *CognitoIdentityProvider) DescribeUserPoolDomainWithContext(ctx aws.Context, input *DescribeUserPoolDomainInput, opts ...request.Option) (*DescribeUserPoolDomainOutput, error)
DescribeUserPoolDomainWithContext is the same as DescribeUserPoolDomain with the addition of the ability to pass a context and additional request options.
See DescribeUserPoolDomain 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 (c *CognitoIdentityProvider) DescribeUserPoolRequest(input *DescribeUserPoolInput) (req *request.Request, output *DescribeUserPoolOutput)
DescribeUserPoolRequest generates a "aws/request.Request" representing the client's request for the DescribeUserPool 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 DescribeUserPool for more information on using the DescribeUserPool 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 DescribeUserPoolRequest method. req, resp := client.DescribeUserPoolRequest(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/DescribeUserPool
func (c *CognitoIdentityProvider) DescribeUserPoolWithContext(ctx aws.Context, input *DescribeUserPoolInput, opts ...request.Option) (*DescribeUserPoolOutput, error)
DescribeUserPoolWithContext is the same as DescribeUserPool with the addition of the ability to pass a context and additional request options.
See DescribeUserPool 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 (c *CognitoIdentityProvider) ForgetDevice(input *ForgetDeviceInput) (*ForgetDeviceOutput, error)
ForgetDevice API operation for Amazon Cognito Identity Provider.
Forgets the specified device.
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 ForgetDevice 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. * ErrCodeInvalidUserPoolConfigurationException "InvalidUserPoolConfigurationException" This exception is thrown when the user pool configuration is invalid. * 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/ForgetDevice
func (c *CognitoIdentityProvider) ForgetDeviceRequest(input *ForgetDeviceInput) (req *request.Request, output *ForgetDeviceOutput)
ForgetDeviceRequest generates a "aws/request.Request" representing the client's request for the ForgetDevice 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 ForgetDevice for more information on using the ForgetDevice 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 ForgetDeviceRequest method. req, resp := client.ForgetDeviceRequest(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/ForgetDevice
func (c *CognitoIdentityProvider) ForgetDeviceWithContext(ctx aws.Context, input *ForgetDeviceInput, opts ...request.Option) (*ForgetDeviceOutput, error)
ForgetDeviceWithContext is the same as ForgetDevice with the addition of the ability to pass a context and additional request options.
See ForgetDevice 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 (c *CognitoIdentityProvider) ForgotPassword(input *ForgotPasswordInput) (*ForgotPasswordOutput, error)
ForgotPassword API operation for Amazon Cognito Identity Provider.
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .
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 ForgotPassword 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. * 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. * ErrCodeInvalidEmailRoleAccessPolicyException "InvalidEmailRoleAccessPolicyException" This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400. * ErrCodeCodeDeliveryFailureException "CodeDeliveryFailureException" This exception is thrown when a verification code fails to deliver successfully. * 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/ForgotPassword
func (c *CognitoIdentityProvider) ForgotPasswordRequest(input *ForgotPasswordInput) (req *request.Request, output *ForgotPasswordOutput)
ForgotPasswordRequest generates a "aws/request.Request" representing the client's request for the ForgotPassword 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 ForgotPassword for more information on using the ForgotPassword 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 ForgotPasswordRequest method. req, resp := client.ForgotPasswordRequest(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/ForgotPassword
func (c *CognitoIdentityProvider) ForgotPasswordWithContext(ctx aws.Context, input *ForgotPasswordInput, opts ...request.Option) (*ForgotPasswordOutput, error)
ForgotPasswordWithContext is the same as ForgotPassword with the addition of the ability to pass a context and additional request options.
See ForgotPassword 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 (c *CognitoIdentityProvider) GetCSVHeader(input *GetCSVHeaderInput) (*GetCSVHeaderOutput, error)
GetCSVHeader API operation for Amazon Cognito Identity Provider.
Gets the header information for the .csv file to be used as input for the user import job.
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 GetCSVHeader 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. * 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/GetCSVHeader
func (c *CognitoIdentityProvider) GetCSVHeaderRequest(input *GetCSVHeaderInput) (req *request.Request, output *GetCSVHeaderOutput)
GetCSVHeaderRequest generates a "aws/request.Request" representing the client's request for the GetCSVHeader 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 GetCSVHeader for more information on using the GetCSVHeader 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 GetCSVHeaderRequest method. req, resp := client.GetCSVHeaderRequest(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/GetCSVHeader
func (c *CognitoIdentityProvider) GetCSVHeaderWithContext(ctx aws.Context, input *GetCSVHeaderInput, opts ...request.Option) (*GetCSVHeaderOutput, error)
GetCSVHeaderWithContext is the same as GetCSVHeader with the addition of the ability to pass a context and additional request options.
See GetCSVHeader 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 (c *CognitoIdentityProvider) GetDevice(input *GetDeviceInput) (*GetDeviceOutput, error)
GetDevice API operation for Amazon Cognito Identity Provider.
Gets the device.
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 GetDevice 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. * 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. * 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/GetDevice
func (c *CognitoIdentityProvider) GetDeviceRequest(input *GetDeviceInput) (req *request.Request, output *GetDeviceOutput)
GetDeviceRequest generates a "aws/request.Request" representing the client's request for the GetDevice 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 GetDevice for more information on using the GetDevice 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 GetDeviceRequest method. req, resp := client.GetDeviceRequest(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/GetDevice
func (c *CognitoIdentityProvider) GetDeviceWithContext(ctx aws.Context, input *GetDeviceInput, opts ...request.Option) (*GetDeviceOutput, error)
GetDeviceWithContext is the same as GetDevice with the addition of the ability to pass a context and additional request options.
See GetDevice 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 (c *CognitoIdentityProvider) GetGroup(input *GetGroupInput) (*GetGroupOutput, error)
GetGroup API operation for Amazon Cognito Identity Provider.
Gets a 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 GetGroup 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. * 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/GetGroup
func (c *CognitoIdentityProvider) GetGroupRequest(input *GetGroupInput) (req *request.Request, output *GetGroupOutput)
GetGroupRequest generates a "aws/request.Request" representing the client's request for the GetGroup 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 GetGroup for more information on using the GetGroup 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 GetGroupRequest method. req, resp := client.GetGroupRequest(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/GetGroup
func (c *CognitoIdentityProvider) GetGroupWithContext(ctx aws.Context, input *GetGroupInput, opts ...request.Option) (*GetGroupOutput, error)
GetGroupWithContext is the same as GetGroup with the addition of the ability to pass a context and additional request options.
See GetGroup 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 (c *CognitoIdentityProvider) GetIdentityProviderByIdentifier(input *GetIdentityProviderByIdentifierInput) (*GetIdentityProviderByIdentifierOutput, error)
GetIdentityProviderByIdentifier API operation for Amazon Cognito Identity Provider.
Gets the specified identity provider.
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 GetIdentityProviderByIdentifier 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetIdentityProviderByIdentifier
func (c *CognitoIdentityProvider) GetIdentityProviderByIdentifierRequest(input *GetIdentityProviderByIdentifierInput) (req *request.Request, output *GetIdentityProviderByIdentifierOutput)
GetIdentityProviderByIdentifierRequest generates a "aws/request.Request" representing the client's request for the GetIdentityProviderByIdentifier 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 GetIdentityProviderByIdentifier for more information on using the GetIdentityProviderByIdentifier 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 GetIdentityProviderByIdentifierRequest method. req, resp := client.GetIdentityProviderByIdentifierRequest(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/GetIdentityProviderByIdentifier
func (c *CognitoIdentityProvider) GetIdentityProviderByIdentifierWithContext(ctx aws.Context, input *GetIdentityProviderByIdentifierInput, opts ...request.Option) (*GetIdentityProviderByIdentifierOutput, error)
GetIdentityProviderByIdentifierWithContext is the same as GetIdentityProviderByIdentifier with the addition of the ability to pass a context and additional request options.
See GetIdentityProviderByIdentifier 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 (c *CognitoIdentityProvider) GetSigningCertificate(input *GetSigningCertificateInput) (*GetSigningCertificateOutput, error)
GetSigningCertificate API operation for Amazon Cognito Identity Provider.
This method takes a user pool ID, and returns the signing certificate.
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 GetSigningCertificate for usage and error information.
Returned Error Codes:
* ErrCodeInternalErrorException "InternalErrorException" This exception is thrown when Amazon Cognito encounters an internal error. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetSigningCertificate
func (c *CognitoIdentityProvider) GetSigningCertificateRequest(input *GetSigningCertificateInput) (req *request.Request, output *GetSigningCertificateOutput)
GetSigningCertificateRequest generates a "aws/request.Request" representing the client's request for the GetSigningCertificate 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 GetSigningCertificate for more information on using the GetSigningCertificate 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 GetSigningCertificateRequest method. req, resp := client.GetSigningCertificateRequest(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/GetSigningCertificate
func (c *CognitoIdentityProvider) GetSigningCertificateWithContext(ctx aws.Context, input *GetSigningCertificateInput, opts ...request.Option) (*GetSigningCertificateOutput, error)
GetSigningCertificateWithContext is the same as GetSigningCertificate with the addition of the ability to pass a context and additional request options.
See GetSigningCertificate 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 (c *CognitoIdentityProvider) GetUICustomization(input *GetUICustomizationInput) (*GetUICustomizationOutput, error)
GetUICustomization API operation for Amazon Cognito Identity Provider.
Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.
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 GetUICustomization 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUICustomization
func (c *CognitoIdentityProvider) GetUICustomizationRequest(input *GetUICustomizationInput) (req *request.Request, output *GetUICustomizationOutput)
GetUICustomizationRequest generates a "aws/request.Request" representing the client's request for the GetUICustomization 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 GetUICustomization for more information on using the GetUICustomization 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 GetUICustomizationRequest method. req, resp := client.GetUICustomizationRequest(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/GetUICustomization
func (c *CognitoIdentityProvider) GetUICustomizationWithContext(ctx aws.Context, input *GetUICustomizationInput, opts ...request.Option) (*GetUICustomizationOutput, error)
GetUICustomizationWithContext is the same as GetUICustomization with the addition of the ability to pass a context and additional request options.
See GetUICustomization 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 (c *CognitoIdentityProvider) GetUser(input *GetUserInput) (*GetUserOutput, error)
GetUser API operation for Amazon Cognito Identity Provider.
Gets the user attributes and metadata for a user.
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 GetUser 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. * 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/GetUser
func (c *CognitoIdentityProvider) GetUserAttributeVerificationCode(input *GetUserAttributeVerificationCodeInput) (*GetUserAttributeVerificationCodeOutput, error)
GetUserAttributeVerificationCode API operation for Amazon Cognito Identity Provider.
Gets the user attribute verification code for the specified attribute name.
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 GetUserAttributeVerificationCode 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. * 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. * 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. * ErrCodeInvalidEmailRoleAccessPolicyException "InvalidEmailRoleAccessPolicyException" This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400. * ErrCodeCodeDeliveryFailureException "CodeDeliveryFailureException" This exception is thrown when a verification code fails to deliver successfully. * 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/GetUserAttributeVerificationCode
func (c *CognitoIdentityProvider) GetUserAttributeVerificationCodeRequest(input *GetUserAttributeVerificationCodeInput) (req *request.Request, output *GetUserAttributeVerificationCodeOutput)
GetUserAttributeVerificationCodeRequest generates a "aws/request.Request" representing the client's request for the GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCode for more information on using the GetUserAttributeVerificationCode 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 GetUserAttributeVerificationCodeRequest method. req, resp := client.GetUserAttributeVerificationCodeRequest(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/GetUserAttributeVerificationCode
func (c *CognitoIdentityProvider) GetUserAttributeVerificationCodeWithContext(ctx aws.Context, input *GetUserAttributeVerificationCodeInput, opts ...request.Option) (*GetUserAttributeVerificationCodeOutput, error)
GetUserAttributeVerificationCodeWithContext is the same as GetUserAttributeVerificationCode with the addition of the ability to pass a context and additional request options.
See GetUserAttributeVerificationCode 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 (c *CognitoIdentityProvider) GetUserPoolMfaConfig(input *GetUserPoolMfaConfigInput) (*GetUserPoolMfaConfigOutput, error)
GetUserPoolMfaConfig API operation for Amazon Cognito Identity Provider.
Gets the user pool multi-factor authentication (MFA) configuration.
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 GetUserPoolMfaConfig for usage and error information.
Returned Error Codes:
* 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. * 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. * 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/GetUserPoolMfaConfig
func (c *CognitoIdentityProvider) GetUserPoolMfaConfigRequest(input *GetUserPoolMfaConfigInput) (req *request.Request, output *GetUserPoolMfaConfigOutput)
GetUserPoolMfaConfigRequest generates a "aws/request.Request" representing the client's request for the GetUserPoolMfaConfig 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 GetUserPoolMfaConfig for more information on using the GetUserPoolMfaConfig 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 GetUserPoolMfaConfigRequest method. req, resp := client.GetUserPoolMfaConfigRequest(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/GetUserPoolMfaConfig
func (c *CognitoIdentityProvider) GetUserPoolMfaConfigWithContext(ctx aws.Context, input *GetUserPoolMfaConfigInput, opts ...request.Option) (*GetUserPoolMfaConfigOutput, error)
GetUserPoolMfaConfigWithContext is the same as GetUserPoolMfaConfig with the addition of the ability to pass a context and additional request options.
See GetUserPoolMfaConfig 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 (c *CognitoIdentityProvider) GetUserRequest(input *GetUserInput) (req *request.Request, output *GetUserOutput)
GetUserRequest generates a "aws/request.Request" representing the client's request for the GetUser 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 GetUser for more information on using the GetUser 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 GetUserRequest method. req, resp := client.GetUserRequest(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/GetUser
func (c *CognitoIdentityProvider) GetUserWithContext(ctx aws.Context, input *GetUserInput, opts ...request.Option) (*GetUserOutput, error)
GetUserWithContext is the same as GetUser with the addition of the ability to pass a context and additional request options.
See GetUser 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 (c *CognitoIdentityProvider) GlobalSignOut(input *GlobalSignOutInput) (*GlobalSignOutOutput, error)
GlobalSignOut API operation for Amazon Cognito Identity Provider.
Signs out users from all devices. It also invalidates all refresh tokens issued to a user. The user's current access and Id tokens remain valid until their expiry. Access and Id tokens expire one hour after they are issued.
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 GlobalSignOut 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. * ErrCodePasswordResetRequiredException "PasswordResetRequiredException" This exception is thrown when a password reset is required. * 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/GlobalSignOut
func (c *CognitoIdentityProvider) GlobalSignOutRequest(input *GlobalSignOutInput) (req *request.Request, output *GlobalSignOutOutput)
GlobalSignOutRequest generates a "aws/request.Request" representing the client's request for the GlobalSignOut 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 GlobalSignOut for more information on using the GlobalSignOut 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 GlobalSignOutRequest method. req, resp := client.GlobalSignOutRequest(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/GlobalSignOut
func (c *CognitoIdentityProvider) GlobalSignOutWithContext(ctx aws.Context, input *GlobalSignOutInput, opts ...request.Option) (*GlobalSignOutOutput, error)
GlobalSignOutWithContext is the same as GlobalSignOut with the addition of the ability to pass a context and additional request options.
See GlobalSignOut 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 (c *CognitoIdentityProvider) InitiateAuth(input *InitiateAuthInput) (*InitiateAuthOutput, error)
InitiateAuth API operation for Amazon Cognito Identity Provider.
Initiates the authentication flow.
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 InitiateAuth 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. * 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. * 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuth
func (c *CognitoIdentityProvider) InitiateAuthRequest(input *InitiateAuthInput) (req *request.Request, output *InitiateAuthOutput)
InitiateAuthRequest generates a "aws/request.Request" representing the client's request for the InitiateAuth 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 InitiateAuth for more information on using the InitiateAuth 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 InitiateAuthRequest method. req, resp := client.InitiateAuthRequest(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/InitiateAuth
func (c *CognitoIdentityProvider) InitiateAuthWithContext(ctx aws.Context, input *InitiateAuthInput, opts ...request.Option) (*InitiateAuthOutput, error)
InitiateAuthWithContext is the same as InitiateAuth with the addition of the ability to pass a context and additional request options.
See InitiateAuth 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 (c *CognitoIdentityProvider) ListDevices(input *ListDevicesInput) (*ListDevicesOutput, error)
ListDevices API operation for Amazon Cognito Identity Provider.
Lists the devices.
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 ListDevices 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. * ErrCodeNotAuthorizedException "NotAuthorizedException" This exception is thrown when a user is not authorized. * 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/ListDevices
func (c *CognitoIdentityProvider) ListDevicesRequest(input *ListDevicesInput) (req *request.Request, output *ListDevicesOutput)
ListDevicesRequest generates a "aws/request.Request" representing the client's request for the ListDevices 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 ListDevices for more information on using the ListDevices 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 ListDevicesRequest method. req, resp := client.ListDevicesRequest(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/ListDevices
func (c *CognitoIdentityProvider) ListDevicesWithContext(ctx aws.Context, input *ListDevicesInput, opts ...request.Option) (*ListDevicesOutput, error)
ListDevicesWithContext is the same as ListDevices with the addition of the ability to pass a context and additional request options.
See ListDevices 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 (c *CognitoIdentityProvider) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)
ListGroups API operation for Amazon Cognito Identity Provider.
Lists the groups associated with a user pool.
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 ListGroups 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. * 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/ListGroups
func (c *CognitoIdentityProvider) ListGroupsPages(input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool) error
ListGroupsPages iterates over the pages of a ListGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListGroups 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 ListGroups operation. pageNum := 0 err := client.ListGroupsPages(params, func(page *cognitoidentityprovider.ListGroupsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CognitoIdentityProvider) ListGroupsPagesWithContext(ctx aws.Context, input *ListGroupsInput, fn func(*ListGroupsOutput, bool) bool, opts ...request.Option) error
ListGroupsPagesWithContext same as ListGroupsPages 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 (c *CognitoIdentityProvider) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)
ListGroupsRequest generates a "aws/request.Request" representing the client's request for the ListGroups 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 ListGroups for more information on using the ListGroups 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 ListGroupsRequest method. req, resp := client.ListGroupsRequest(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/ListGroups
func (c *CognitoIdentityProvider) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)
ListGroupsWithContext is the same as ListGroups with the addition of the ability to pass a context and additional request options.
See ListGroups 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 (c *CognitoIdentityProvider) ListIdentityProviders(input *ListIdentityProvidersInput) (*ListIdentityProvidersOutput, error)
ListIdentityProviders API operation for Amazon Cognito Identity Provider.
Lists information about all identity providers for 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 ListIdentityProviders 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListIdentityProviders
func (c *CognitoIdentityProvider) ListIdentityProvidersPages(input *ListIdentityProvidersInput, fn func(*ListIdentityProvidersOutput, bool) bool) error
ListIdentityProvidersPages iterates over the pages of a ListIdentityProviders operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListIdentityProviders 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 ListIdentityProviders operation. pageNum := 0 err := client.ListIdentityProvidersPages(params, func(page *cognitoidentityprovider.ListIdentityProvidersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CognitoIdentityProvider) ListIdentityProvidersPagesWithContext(ctx aws.Context, input *ListIdentityProvidersInput, fn func(*ListIdentityProvidersOutput, bool) bool, opts ...request.Option) error
ListIdentityProvidersPagesWithContext same as ListIdentityProvidersPages 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 (c *CognitoIdentityProvider) ListIdentityProvidersRequest(input *ListIdentityProvidersInput) (req *request.Request, output *ListIdentityProvidersOutput)
ListIdentityProvidersRequest generates a "aws/request.Request" representing the client's request for the ListIdentityProviders 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 ListIdentityProviders for more information on using the ListIdentityProviders 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 ListIdentityProvidersRequest method. req, resp := client.ListIdentityProvidersRequest(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/ListIdentityProviders
func (c *CognitoIdentityProvider) ListIdentityProvidersWithContext(ctx aws.Context, input *ListIdentityProvidersInput, opts ...request.Option) (*ListIdentityProvidersOutput, error)
ListIdentityProvidersWithContext is the same as ListIdentityProviders with the addition of the ability to pass a context and additional request options.
See ListIdentityProviders 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 (c *CognitoIdentityProvider) ListResourceServers(input *ListResourceServersInput) (*ListResourceServersOutput, error)
ListResourceServers API operation for Amazon Cognito Identity Provider.
Lists the resource servers for 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 ListResourceServers 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListResourceServers
func (c *CognitoIdentityProvider) ListResourceServersPages(input *ListResourceServersInput, fn func(*ListResourceServersOutput, bool) bool) error
ListResourceServersPages iterates over the pages of a ListResourceServers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListResourceServers 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 ListResourceServers operation. pageNum := 0 err := client.ListResourceServersPages(params, func(page *cognitoidentityprovider.ListResourceServersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CognitoIdentityProvider) ListResourceServersPagesWithContext(ctx aws.Context, input *ListResourceServersInput, fn func(*ListResourceServersOutput, bool) bool, opts ...request.Option) error
ListResourceServersPagesWithContext same as ListResourceServersPages 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 (c *CognitoIdentityProvider) ListResourceServersRequest(input *ListResourceServersInput) (req *request.Request, output *ListResourceServersOutput)
ListResourceServersRequest generates a "aws/request.Request" representing the client's request for the ListResourceServers 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 ListResourceServers for more information on using the ListResourceServers 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 ListResourceServersRequest method. req, resp := client.ListResourceServersRequest(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/ListResourceServers
func (c *CognitoIdentityProvider) ListResourceServersWithContext(ctx aws.Context, input *ListResourceServersInput, opts ...request.Option) (*ListResourceServersOutput, error)
ListResourceServersWithContext is the same as ListResourceServers with the addition of the ability to pass a context and additional request options.
See ListResourceServers 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 (c *CognitoIdentityProvider) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for Amazon Cognito Identity Provider.
Lists the tags that are assigned to an Amazon Cognito user pool.
A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
You can use this action up to 10 times per second, per account.
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 ListTagsForResource 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. * 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. * 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/ListTagsForResource
func (c *CognitoIdentityProvider) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource
func (c *CognitoIdentityProvider) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.
See ListTagsForResource 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 (c *CognitoIdentityProvider) ListUserImportJobs(input *ListUserImportJobsInput) (*ListUserImportJobsOutput, error)
ListUserImportJobs API operation for Amazon Cognito Identity Provider.
Lists the user import jobs.
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 ListUserImportJobs 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. * 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/ListUserImportJobs
func (c *CognitoIdentityProvider) ListUserImportJobsRequest(input *ListUserImportJobsInput) (req *request.Request, output *ListUserImportJobsOutput)
ListUserImportJobsRequest generates a "aws/request.Request" representing the client's request for the ListUserImportJobs 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 ListUserImportJobs for more information on using the ListUserImportJobs 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 ListUserImportJobsRequest method. req, resp := client.ListUserImportJobsRequest(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/ListUserImportJobs
func (c *CognitoIdentityProvider) ListUserImportJobsWithContext(ctx aws.Context, input *ListUserImportJobsInput, opts ...request.Option) (*ListUserImportJobsOutput, error)
ListUserImportJobsWithContext is the same as ListUserImportJobs with the addition of the ability to pass a context and additional request options.
See ListUserImportJobs 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 (c *CognitoIdentityProvider) ListUserPoolClients(input *ListUserPoolClientsInput) (*ListUserPoolClientsOutput, error)
ListUserPoolClients API operation for Amazon Cognito Identity Provider.
Lists the clients that have been created for the specified 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 ListUserPoolClients 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. * 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/ListUserPoolClients
func (c *CognitoIdentityProvider) ListUserPoolClientsPages(input *ListUserPoolClientsInput, fn func(*ListUserPoolClientsOutput, bool) bool) error
ListUserPoolClientsPages iterates over the pages of a ListUserPoolClients operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListUserPoolClients 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 ListUserPoolClients operation. pageNum := 0 err := client.ListUserPoolClientsPages(params, func(page *cognitoidentityprovider.ListUserPoolClientsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CognitoIdentityProvider) ListUserPoolClientsPagesWithContext(ctx aws.Context, input *ListUserPoolClientsInput, fn func(*ListUserPoolClientsOutput, bool) bool, opts ...request.Option) error
ListUserPoolClientsPagesWithContext same as ListUserPoolClientsPages 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 (c *CognitoIdentityProvider) ListUserPoolClientsRequest(input *ListUserPoolClientsInput) (req *request.Request, output *ListUserPoolClientsOutput)
ListUserPoolClientsRequest generates a "aws/request.Request" representing the client's request for the ListUserPoolClients 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 ListUserPoolClients for more information on using the ListUserPoolClients 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 ListUserPoolClientsRequest method. req, resp := client.ListUserPoolClientsRequest(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/ListUserPoolClients
func (c *CognitoIdentityProvider) ListUserPoolClientsWithContext(ctx aws.Context, input *ListUserPoolClientsInput, opts ...request.Option) (*ListUserPoolClientsOutput, error)
ListUserPoolClientsWithContext is the same as ListUserPoolClients with the addition of the ability to pass a context and additional request options.
See ListUserPoolClients 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 (c *CognitoIdentityProvider) ListUserPools(input *ListUserPoolsInput) (*ListUserPoolsOutput, error)
ListUserPools API operation for Amazon Cognito Identity Provider.
Lists the user pools associated with an AWS account.
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 ListUserPools for usage and error information.
Returned Error Codes:
* 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. * 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/ListUserPools
func (c *CognitoIdentityProvider) ListUserPoolsPages(input *ListUserPoolsInput, fn func(*ListUserPoolsOutput, bool) bool) error
ListUserPoolsPages iterates over the pages of a ListUserPools operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListUserPools 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 ListUserPools operation. pageNum := 0 err := client.ListUserPoolsPages(params, func(page *cognitoidentityprovider.ListUserPoolsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CognitoIdentityProvider) ListUserPoolsPagesWithContext(ctx aws.Context, input *ListUserPoolsInput, fn func(*ListUserPoolsOutput, bool) bool, opts ...request.Option) error
ListUserPoolsPagesWithContext same as ListUserPoolsPages 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 (c *CognitoIdentityProvider) ListUserPoolsRequest(input *ListUserPoolsInput) (req *request.Request, output *ListUserPoolsOutput)
ListUserPoolsRequest generates a "aws/request.Request" representing the client's request for the ListUserPools 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 ListUserPools for more information on using the ListUserPools 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 ListUserPoolsRequest method. req, resp := client.ListUserPoolsRequest(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/ListUserPools
func (c *CognitoIdentityProvider) ListUserPoolsWithContext(ctx aws.Context, input *ListUserPoolsInput, opts ...request.Option) (*ListUserPoolsOutput, error)
ListUserPoolsWithContext is the same as ListUserPools with the addition of the ability to pass a context and additional request options.
See ListUserPools 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 (c *CognitoIdentityProvider) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)
ListUsers API operation for Amazon Cognito Identity Provider.
Lists the users in the Amazon Cognito 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 ListUsers 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. * 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/ListUsers
func (c *CognitoIdentityProvider) ListUsersInGroup(input *ListUsersInGroupInput) (*ListUsersInGroupOutput, error)
ListUsersInGroup API operation for Amazon Cognito Identity Provider.
Lists the users in 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 ListUsersInGroup 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. * 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/ListUsersInGroup
func (c *CognitoIdentityProvider) ListUsersInGroupPages(input *ListUsersInGroupInput, fn func(*ListUsersInGroupOutput, bool) bool) error
ListUsersInGroupPages iterates over the pages of a ListUsersInGroup operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListUsersInGroup 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 ListUsersInGroup operation. pageNum := 0 err := client.ListUsersInGroupPages(params, func(page *cognitoidentityprovider.ListUsersInGroupOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CognitoIdentityProvider) ListUsersInGroupPagesWithContext(ctx aws.Context, input *ListUsersInGroupInput, fn func(*ListUsersInGroupOutput, bool) bool, opts ...request.Option) error
ListUsersInGroupPagesWithContext same as ListUsersInGroupPages 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 (c *CognitoIdentityProvider) ListUsersInGroupRequest(input *ListUsersInGroupInput) (req *request.Request, output *ListUsersInGroupOutput)
ListUsersInGroupRequest generates a "aws/request.Request" representing the client's request for the ListUsersInGroup 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 ListUsersInGroup for more information on using the ListUsersInGroup 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 ListUsersInGroupRequest method. req, resp := client.ListUsersInGroupRequest(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/ListUsersInGroup
func (c *CognitoIdentityProvider) ListUsersInGroupWithContext(ctx aws.Context, input *ListUsersInGroupInput, opts ...request.Option) (*ListUsersInGroupOutput, error)
ListUsersInGroupWithContext is the same as ListUsersInGroup with the addition of the ability to pass a context and additional request options.
See ListUsersInGroup 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 (c *CognitoIdentityProvider) ListUsersPages(input *ListUsersInput, fn func(*ListUsersOutput, bool) bool) error
ListUsersPages iterates over the pages of a ListUsers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListUsers 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 ListUsers operation. pageNum := 0 err := client.ListUsersPages(params, func(page *cognitoidentityprovider.ListUsersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CognitoIdentityProvider) ListUsersPagesWithContext(ctx aws.Context, input *ListUsersInput, fn func(*ListUsersOutput, bool) bool, opts ...request.Option) error
ListUsersPagesWithContext same as ListUsersPages 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 (c *CognitoIdentityProvider) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)
ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers 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 ListUsers for more information on using the ListUsers 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 ListUsersRequest method. req, resp := client.ListUsersRequest(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/ListUsers
func (c *CognitoIdentityProvider) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)
ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.
See ListUsers 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 (c *CognitoIdentityProvider) ResendConfirmationCode(input *ResendConfirmationCodeInput) (*ResendConfirmationCodeOutput, error)
ResendConfirmationCode API operation for Amazon Cognito Identity Provider.
Resends the confirmation (for confirmation of registration) to a specific user in the 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 ResendConfirmationCode 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. * 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. * ErrCodeInvalidEmailRoleAccessPolicyException "InvalidEmailRoleAccessPolicyException" This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400. * ErrCodeCodeDeliveryFailureException "CodeDeliveryFailureException" This exception is thrown when a verification code fails to deliver successfully. * 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/ResendConfirmationCode
func (c *CognitoIdentityProvider) ResendConfirmationCodeRequest(input *ResendConfirmationCodeInput) (req *request.Request, output *ResendConfirmationCodeOutput)
ResendConfirmationCodeRequest generates a "aws/request.Request" representing the client's request for the ResendConfirmationCode 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 ResendConfirmationCode for more information on using the ResendConfirmationCode 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 ResendConfirmationCodeRequest method. req, resp := client.ResendConfirmationCodeRequest(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/ResendConfirmationCode
func (c *CognitoIdentityProvider) ResendConfirmationCodeWithContext(ctx aws.Context, input *ResendConfirmationCodeInput, opts ...request.Option) (*ResendConfirmationCodeOutput, error)
ResendConfirmationCodeWithContext is the same as ResendConfirmationCode with the addition of the ability to pass a context and additional request options.
See ResendConfirmationCode 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 (c *CognitoIdentityProvider) RespondToAuthChallenge(input *RespondToAuthChallengeInput) (*RespondToAuthChallengeOutput, error)
RespondToAuthChallenge API operation for Amazon Cognito Identity Provider.
Responds to the authentication challenge.
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 RespondToAuthChallenge 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. * ErrCodeUserLambdaValidationException "UserLambdaValidationException" This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service. * 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. * 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. * ErrCodeMFAMethodNotFoundException "MFAMethodNotFoundException" This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method. * 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. * 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. * 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/RespondToAuthChallenge
func (c *CognitoIdentityProvider) RespondToAuthChallengeRequest(input *RespondToAuthChallengeInput) (req *request.Request, output *RespondToAuthChallengeOutput)
RespondToAuthChallengeRequest generates a "aws/request.Request" representing the client's request for the RespondToAuthChallenge 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 RespondToAuthChallenge for more information on using the RespondToAuthChallenge 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 RespondToAuthChallengeRequest method. req, resp := client.RespondToAuthChallengeRequest(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/RespondToAuthChallenge
func (c *CognitoIdentityProvider) RespondToAuthChallengeWithContext(ctx aws.Context, input *RespondToAuthChallengeInput, opts ...request.Option) (*RespondToAuthChallengeOutput, error)
RespondToAuthChallengeWithContext is the same as RespondToAuthChallenge with the addition of the ability to pass a context and additional request options.
See RespondToAuthChallenge 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 (c *CognitoIdentityProvider) SetRiskConfiguration(input *SetRiskConfigurationInput) (*SetRiskConfigurationOutput, error)
SetRiskConfiguration API operation for Amazon Cognito Identity Provider.
Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.
To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
See .
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 SetRiskConfiguration 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. * ErrCodeUserPoolAddOnNotEnabledException "UserPoolAddOnNotEnabledException" This exception is thrown when user pool add-ons are not enabled. * ErrCodeCodeDeliveryFailureException "CodeDeliveryFailureException" This exception is thrown when a verification code fails to deliver successfully. * ErrCodeInvalidEmailRoleAccessPolicyException "InvalidEmailRoleAccessPolicyException" This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400. * 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/SetRiskConfiguration
func (c *CognitoIdentityProvider) SetRiskConfigurationRequest(input *SetRiskConfigurationInput) (req *request.Request, output *SetRiskConfigurationOutput)
SetRiskConfigurationRequest generates a "aws/request.Request" representing the client's request for the SetRiskConfiguration 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 SetRiskConfiguration for more information on using the SetRiskConfiguration 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 SetRiskConfigurationRequest method. req, resp := client.SetRiskConfigurationRequest(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/SetRiskConfiguration
func (c *CognitoIdentityProvider) SetRiskConfigurationWithContext(ctx aws.Context, input *SetRiskConfigurationInput, opts ...request.Option) (*SetRiskConfigurationOutput, error)
SetRiskConfigurationWithContext is the same as SetRiskConfiguration with the addition of the ability to pass a context and additional request options.
See SetRiskConfiguration 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 (c *CognitoIdentityProvider) SetUICustomization(input *SetUICustomizationInput) (*SetUICustomizationOutput, error)
SetUICustomization API operation for Amazon Cognito Identity Provider.
Sets the UI customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
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 SetUICustomization 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. * 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUICustomization
func (c *CognitoIdentityProvider) SetUICustomizationRequest(input *SetUICustomizationInput) (req *request.Request, output *SetUICustomizationOutput)
SetUICustomizationRequest generates a "aws/request.Request" representing the client's request for the SetUICustomization 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 SetUICustomization for more information on using the SetUICustomization 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 SetUICustomizationRequest method. req, resp := client.SetUICustomizationRequest(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/SetUICustomization
func (c *CognitoIdentityProvider) SetUICustomizationWithContext(ctx aws.Context, input *SetUICustomizationInput, opts ...request.Option) (*SetUICustomizationOutput, error)
SetUICustomizationWithContext is the same as SetUICustomization with the addition of the ability to pass a context and additional request options.
See SetUICustomization 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 (c *CognitoIdentityProvider) SetUserMFAPreference(input *SetUserMFAPreferenceInput) (*SetUserMFAPreferenceOutput, error)
SetUserMFAPreference API operation for Amazon Cognito Identity Provider.
Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
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 SetUserMFAPreference 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/SetUserMFAPreference
func (c *CognitoIdentityProvider) SetUserMFAPreferenceRequest(input *SetUserMFAPreferenceInput) (req *request.Request, output *SetUserMFAPreferenceOutput)
SetUserMFAPreferenceRequest generates a "aws/request.Request" representing the client's request for the SetUserMFAPreference 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 SetUserMFAPreference for more information on using the SetUserMFAPreference 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 SetUserMFAPreferenceRequest method. req, resp := client.SetUserMFAPreferenceRequest(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/SetUserMFAPreference
func (c *CognitoIdentityProvider) SetUserMFAPreferenceWithContext(ctx aws.Context, input *SetUserMFAPreferenceInput, opts ...request.Option) (*SetUserMFAPreferenceOutput, error)
SetUserMFAPreferenceWithContext is the same as SetUserMFAPreference with the addition of the ability to pass a context and additional request options.
See SetUserMFAPreference 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 (c *CognitoIdentityProvider) SetUserPoolMfaConfig(input *SetUserPoolMfaConfigInput) (*SetUserPoolMfaConfigOutput, error)
SetUserPoolMfaConfig API operation for Amazon Cognito Identity Provider.
Set the user pool multi-factor authentication (MFA) configuration.
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 SetUserPoolMfaConfig for usage and error information.
Returned Error Codes:
* 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. * ErrCodeResourceNotFoundException "ResourceNotFoundException" This exception is thrown when the Amazon Cognito service cannot find the requested resource. * 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. * ErrCodeNotAuthorizedException "NotAuthorizedException" This exception is thrown when a user is not authorized. * 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/SetUserPoolMfaConfig
func (c *CognitoIdentityProvider) SetUserPoolMfaConfigRequest(input *SetUserPoolMfaConfigInput) (req *request.Request, output *SetUserPoolMfaConfigOutput)
SetUserPoolMfaConfigRequest generates a "aws/request.Request" representing the client's request for the SetUserPoolMfaConfig 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 SetUserPoolMfaConfig for more information on using the SetUserPoolMfaConfig 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 SetUserPoolMfaConfigRequest method. req, resp := client.SetUserPoolMfaConfigRequest(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/SetUserPoolMfaConfig
func (c *CognitoIdentityProvider) SetUserPoolMfaConfigWithContext(ctx aws.Context, input *SetUserPoolMfaConfigInput, opts ...request.Option) (*SetUserPoolMfaConfigOutput, error)
SetUserPoolMfaConfigWithContext is the same as SetUserPoolMfaConfig with the addition of the ability to pass a context and additional request options.
See SetUserPoolMfaConfig 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 (c *CognitoIdentityProvider) SetUserSettings(input *SetUserSettingsInput) (*SetUserSettingsOutput, error)
SetUserSettings 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 SetUserMFAPreference 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 SetUserSettings 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/SetUserSettings
func (c *CognitoIdentityProvider) SetUserSettingsRequest(input *SetUserSettingsInput) (req *request.Request, output *SetUserSettingsOutput)
SetUserSettingsRequest generates a "aws/request.Request" representing the client's request for the SetUserSettings 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 SetUserSettings for more information on using the SetUserSettings 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 SetUserSettingsRequest method. req, resp := client.SetUserSettingsRequest(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/SetUserSettings
func (c *CognitoIdentityProvider) SetUserSettingsWithContext(ctx aws.Context, input *SetUserSettingsInput, opts ...request.Option) (*SetUserSettingsOutput, error)
SetUserSettingsWithContext is the same as SetUserSettings with the addition of the ability to pass a context and additional request options.
See SetUserSettings 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 (c *CognitoIdentityProvider) SignUp(input *SignUpInput) (*SignUpOutput, error)
SignUp API operation for Amazon Cognito Identity Provider.
Registers the user in the specified user pool and creates a user name, password, and user attributes.
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 SignUp 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. * 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. * 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. * 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. * ErrCodeInvalidEmailRoleAccessPolicyException "InvalidEmailRoleAccessPolicyException" This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400. * ErrCodeCodeDeliveryFailureException "CodeDeliveryFailureException" This exception is thrown when a verification code fails to deliver successfully.
See also, https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SignUp
func (c *CognitoIdentityProvider) SignUpRequest(input *SignUpInput) (req *request.Request, output *SignUpOutput)
SignUpRequest generates a "aws/request.Request" representing the client's request for the SignUp 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 SignUp for more information on using the SignUp 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 SignUpRequest method. req, resp := client.SignUpRequest(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/SignUp
func (c *CognitoIdentityProvider) SignUpWithContext(ctx aws.Context, input *SignUpInput, opts ...request.Option) (*SignUpOutput, error)
SignUpWithContext is the same as SignUp with the addition of the ability to pass a context and additional request options.
See SignUp 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 (c *CognitoIdentityProvider) StartUserImportJob(input *StartUserImportJobInput) (*StartUserImportJobOutput, error)
StartUserImportJob API operation for Amazon Cognito Identity Provider.
Starts the user import.
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 StartUserImportJob 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. * ErrCodeInternalErrorException "InternalErrorException" This exception is thrown when Amazon Cognito encounters an internal error. * ErrCodePreconditionNotMetException "PreconditionNotMetException" This exception is thrown when a precondition is not met. * 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/StartUserImportJob
func (c *CognitoIdentityProvider) StartUserImportJobRequest(input *StartUserImportJobInput) (req *request.Request, output *StartUserImportJobOutput)
StartUserImportJobRequest generates a "aws/request.Request" representing the client's request for the StartUserImportJob 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 StartUserImportJob for more information on using the StartUserImportJob 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 StartUserImportJobRequest method. req, resp := client.StartUserImportJobRequest(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/StartUserImportJob
func (c *CognitoIdentityProvider) StartUserImportJobWithContext(ctx aws.Context, input *StartUserImportJobInput, opts ...request.Option) (*StartUserImportJobOutput, error)
StartUserImportJobWithContext is the same as StartUserImportJob with the addition of the ability to pass a context and additional request options.
See StartUserImportJob 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 (c *CognitoIdentityProvider) StopUserImportJob(input *StopUserImportJobInput) (*StopUserImportJobOutput, error)
StopUserImportJob API operation for Amazon Cognito Identity Provider.
Stops the user import job.
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 StopUserImportJob 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. * ErrCodeInternalErrorException "InternalErrorException" This exception is thrown when Amazon Cognito encounters an internal error. * ErrCodePreconditionNotMetException "PreconditionNotMetException" This exception is thrown when a precondition is not met. * 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/StopUserImportJob
func (c *CognitoIdentityProvider) StopUserImportJobRequest(input *StopUserImportJobInput) (req *request.Request, output *StopUserImportJobOutput)
StopUserImportJobRequest generates a "aws/request.Request" representing the client's request for the StopUserImportJob 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 StopUserImportJob for more information on using the StopUserImportJob 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 StopUserImportJobRequest method. req, resp := client.StopUserImportJobRequest(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/StopUserImportJob
func (c *CognitoIdentityProvider) StopUserImportJobWithContext(ctx aws.Context, input *StopUserImportJobInput, opts ...request.Option) (*StopUserImportJobOutput, error)
StopUserImportJobWithContext is the same as StopUserImportJob with the addition of the ability to pass a context and additional request options.
See StopUserImportJob 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 (c *CognitoIdentityProvider) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for Amazon Cognito Identity Provider.
Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by