cognitoidentityprovider

package module
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2020 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2016-04-18"
View Source
const ServiceID = "Cognito Identity Provider"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type AddCustomAttributesInput

type AddCustomAttributesInput struct {
	// The user pool ID for the user pool where you want to add custom attributes.
	UserPoolId *string
	// An array of custom attributes, such as Mutable and Name.
	CustomAttributes []*types.SchemaAttributeType
}

Represents the request to add custom attributes.

type AddCustomAttributesOutput

type AddCustomAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminAddUserToGroupInput

type AdminAddUserToGroupInput struct {
	// The user pool ID for the user pool.
	UserPoolId *string
	// The group name.
	GroupName *string
	// The username for the user.
	Username *string
}

type AdminAddUserToGroupOutput

type AdminAddUserToGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminConfirmSignUpInput

type AdminConfirmSignUpInput struct {
	// The user name for which you want to confirm user registration.
	Username *string
	// The user pool ID for which you want to confirm user registration.
	UserPoolId *string
	// 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
}

Represents the request to confirm user registration.

type AdminConfirmSignUpOutput

type AdminConfirmSignUpOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminCreateUserInput

type AdminCreateUserInput struct {
	// A map of custom key-value pairs that you can provide as input for any custom
	// workflows that this action triggers. You create custom workflows by assigning
	// AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API
	// action, Amazon Cognito invokes the function that is assigned to the pre sign-up
	// trigger. When Amazon Cognito invokes this function, it passes a JSON payload,
	// which the function receives as input. This payload contains a clientMetadata
	// attribute, which provides the data that you assigned to the ClientMetadata
	// parameter in your AdminCreateUser request. In your function code in AWS Lambda,
	// you can process the clientMetadata value to enhance your workflow for your
	// specific needs. For more information, see Customizing User Pool Workflows with
	// Lambda Triggers
	// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
	// in the Amazon Cognito Developer Guide. Take the following limitations into
	// consideration when you use the ClientMetadata parameter:
	//
	//     * Amazon Cognito
	// does not store the ClientMetadata value. This data is available only to AWS
	// Lambda triggers that are assigned to a user pool to support custom workflows. If
	// your user pool configuration does not include triggers, the ClientMetadata
	// parameter serves no purpose.
	//
	//     * Amazon Cognito does not validate the
	// ClientMetadata value.
	//
	//     * Amazon Cognito does not encrypt the the
	// ClientMetadata value, so don't use it to provide sensitive information.
	ClientMetadata map[string]*string
	// 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
	// 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 types.MessageActionType
	// 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 []*types.AttributeType
	// The user pool ID for the user pool where the user will be created.
	UserPoolId *string
	// 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 *string
	// 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 []*types.AttributeType
	// 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
	// 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 []types.DeliveryMediumType
}

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

type AdminCreateUserOutput

type AdminCreateUserOutput struct {
	// The newly created user.
	User *types.UserType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminDeleteUserAttributesInput

type AdminDeleteUserAttributesInput struct {
	// An array of strings representing the user attribute names you wish to delete.
	// For custom attributes, you must prepend the custom: prefix to the attribute
	// name.
	UserAttributeNames []*string
	// The user pool ID for the user pool where you want to delete user attributes.
	UserPoolId *string
	// The user name of the user from which you would like to delete attributes.
	Username *string
}

Represents the request to delete user attributes as an administrator.

type AdminDeleteUserAttributesOutput

type AdminDeleteUserAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminDeleteUserInput

type AdminDeleteUserInput struct {
	// The user pool ID for the user pool where you want to delete the user.
	UserPoolId *string
	// The user name of the user you wish to delete.
	Username *string
}

Represents the request to delete a user as an administrator.

type AdminDeleteUserOutput

type AdminDeleteUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminDisableProviderForUserInput

type AdminDisableProviderForUserInput struct {
	// The user to be disabled.
	User *types.ProviderUserIdentifierType
	// The user pool ID for the user pool.
	UserPoolId *string
}

type AdminDisableProviderForUserOutput

type AdminDisableProviderForUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminDisableUserInput

type AdminDisableUserInput struct {
	// The user pool ID for the user pool where you want to disable the user.
	UserPoolId *string
	// The user name of the user you wish to disable.
	Username *string
}

Represents the request to disable any user as an administrator.

type AdminDisableUserOutput

type AdminDisableUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminEnableUserInput

type AdminEnableUserInput struct {
	// The user name of the user you wish to enable.
	Username *string
	// The user pool ID for the user pool where you want to enable the user.
	UserPoolId *string
}

Represents the request that enables the user as an administrator.

type AdminEnableUserOutput

type AdminEnableUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminForgetDeviceInput

type AdminForgetDeviceInput struct {
	// The device key.
	DeviceKey *string
	// The user name.
	Username *string
	// The user pool ID.
	UserPoolId *string
}

Sends the forgot device request, as an administrator.

type AdminForgetDeviceOutput

type AdminForgetDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminGetDeviceInput

type AdminGetDeviceInput struct {
	// The user name.
	Username *string
	// The device key.
	DeviceKey *string
	// The user pool ID.
	UserPoolId *string
}

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

type AdminGetDeviceOutput

type AdminGetDeviceOutput struct {
	// The device.
	Device *types.DeviceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Gets the device response, as an administrator.

type AdminGetUserInput

type AdminGetUserInput struct {
	// The user pool ID for the user pool where you want to get information about the
	// user.
	UserPoolId *string
	// The user name of the user you wish to retrieve.
	Username *string
}

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

type AdminGetUserOutput

type AdminGetUserOutput struct {
	// The user's preferred MFA setting.
	PreferredMfaSetting *string
	// The date the user was created.
	UserCreateDate *time.Time
	// The user name of the user about whom you are receiving information.
	Username *string
	// The MFA options that are enabled for the user. The possible values in this list
	// are SMS_MFA and SOFTWARE_TOKEN_MFA.
	UserMFASettingList []*string
	// Indicates that the status is enabled.
	Enabled *bool
	// An array of name-value pairs representing user attributes.
	UserAttributes []*types.AttributeType
	// 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 types.UserStatusType
	// 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 []*types.MFAOptionType
	// The date the user was last modified.
	UserLastModifiedDate *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminInitiateAuthInput

type AdminInitiateAuthInput struct {
	// 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 types.AuthFlowType
	// The ID of the Amazon Cognito user pool.
	UserPoolId *string
	// 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
	//
	//     <p>When Amazon Cognito invokes the
	// functions for these triggers, it passes a JSON payload, which the function
	// receives as input. This payload contains a <code>validationData</code>
	// 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 <code>validationData</code> value to enhance your
	// workflow for your specific needs.</p> <p>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:</p> <ul> <li> <p>Post
	// authentication</p> </li> <li> <p>Custom message</p> </li> <li> <p>Pre token
	// generation</p> </li> <li> <p>Create auth challenge</p> </li> <li> <p>Define auth
	// challenge</p> </li> <li> <p>Verify auth challenge</p> </li> </ul> <p>For more
	// information, see <a
	// href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
	// User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
	// Guide</i>.</p> <note> <p>Take the following limitations into consideration when
	// you use the ClientMetadata parameter:</p> <ul> <li> <p>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.</p> </li> <li> <p>Amazon Cognito does not validate the
	// ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
	// ClientMetadata value, so don't use it to provide sensitive information.</p>
	// </li> </ul> </note>
	ClientMetadata map[string]*string
	// The analytics metadata for collecting Amazon Pinpoint metrics for
	// AdminInitiateAuth calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
	// 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 *types.ContextDataType
	// 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
	// The app client ID.
	ClientId *string
}

Initiates the authorization request, as an administrator.

type AdminInitiateAuthOutput

type AdminInitiateAuthOutput struct {
	// The result of the authentication response. This is only returned if the caller
	// does not need to pass another challenge. If the caller does need to pass another
	// challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session
	// are returned.
	AuthenticationResult *types.AuthenticationResultType
	// 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 types.ChallengeNameType
	// 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
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Initiates the authentication response, as an administrator.

type AdminLinkProviderForUserInput

type AdminLinkProviderForUserInput struct {
	// The existing user in the user pool to be linked to the external identity
	// provider user account. Can be a native (Username + Password) Cognito User Pools
	// user or a federated user (for example, a SAML or Facebook user). If the user
	// doesn't exist, an exception is thrown. This is the user that is returned when
	// the new user (with the linked identity provider attribute) signs in. For a
	// native username + password user, the ProviderAttributeValue for the
	// DestinationUser should be the username in the user pool. For a federated user,
	// it should be the provider-specific user_id. The ProviderAttributeName of the
	// DestinationUser is ignored. The ProviderName should be set to Cognito for users
	// in Cognito user pools.
	DestinationUser *types.ProviderUserIdentifierType
	// The user pool ID for the user pool.
	UserPoolId *string
	// 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 *types.ProviderUserIdentifierType
}

type AdminLinkProviderForUserOutput

type AdminLinkProviderForUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminListDevicesInput

type AdminListDevicesInput struct {
	// The user pool ID.
	UserPoolId *string
	// The user name.
	Username *string
	// The pagination token.
	PaginationToken *string
	// The limit of the devices request.
	Limit *int32
}

Represents the request to list devices, as an administrator.

type AdminListDevicesOutput

type AdminListDevicesOutput struct {
	// The pagination token.
	PaginationToken *string
	// The devices in the list of devices response.
	Devices []*types.DeviceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Lists the device's response, as an administrator.

type AdminListGroupsForUserInput

type AdminListGroupsForUserInput struct {
	// The user pool ID for the user pool.
	UserPoolId *string
	// The username for the user.
	Username *string
	// 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
	// The limit of the request to list groups.
	Limit *int32
}

type AdminListGroupsForUserOutput

type AdminListGroupsForUserOutput struct {
	// 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
	// The groups that the user belongs to.
	Groups []*types.GroupType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminListUserAuthEventsInput

type AdminListUserAuthEventsInput struct {
	// The maximum number of authentication events to return.
	MaxResults *int32
	// A pagination token.
	NextToken *string
	// The user pool username or an alias.
	Username *string
	// The user pool ID.
	UserPoolId *string
}

type AdminListUserAuthEventsOutput

type AdminListUserAuthEventsOutput struct {
	// The response object. It includes the EventID, EventType, CreationDate,
	// EventRisk, and EventResponse.
	AuthEvents []*types.AuthEventType
	// A pagination token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminRemoveUserFromGroupInput

type AdminRemoveUserFromGroupInput struct {
	// The username for the user.
	Username *string
	// The user pool ID for the user pool.
	UserPoolId *string
	// The group name.
	GroupName *string
}

type AdminRemoveUserFromGroupOutput

type AdminRemoveUserFromGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminResetUserPasswordInput

type AdminResetUserPasswordInput struct {
	// The user pool ID for the user pool where you want to reset the user's password.
	UserPoolId *string
	// 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
	// The user name of the user whose password you wish to reset.
	Username *string
}

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

type AdminResetUserPasswordOutput

type AdminResetUserPasswordOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminRespondToAuthChallengeInput

type AdminRespondToAuthChallengeInput 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
	// 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
	// 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
	// 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 *types.ContextDataType
	// The challenge name. For more information, see .
	ChallengeName types.ChallengeNameType
	// The analytics metadata for collecting Amazon Pinpoint metrics for
	// AdminRespondToAuthChallenge calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
	// 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
	// The ID of the Amazon Cognito user pool.
	UserPoolId *string
	// The app client ID.
	ClientId *string
}

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

type AdminRespondToAuthChallengeOutput

type AdminRespondToAuthChallengeOutput struct {
	// The challenge parameters. For more information, see .
	ChallengeParameters map[string]*string
	// The result returned by the server in response to the authentication request.
	AuthenticationResult *types.AuthenticationResultType
	// The name of the challenge. For more information, see .
	ChallengeName types.ChallengeNameType
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Responds to the authentication challenge, as an administrator.

type AdminSetUserMFAPreferenceInput

type AdminSetUserMFAPreferenceInput struct {
	// The SMS text message MFA settings.
	SMSMfaSettings *types.SMSMfaSettingsType
	// The user pool ID.
	UserPoolId *string
	// The user pool username or alias.
	Username *string
	// The time-based one-time password software token MFA settings.
	SoftwareTokenMfaSettings *types.SoftwareTokenMfaSettingsType
}

type AdminSetUserMFAPreferenceOutput

type AdminSetUserMFAPreferenceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminSetUserPasswordInput

type AdminSetUserPasswordInput struct {
	// The user pool ID for the user pool where you want to set the user's password.
	UserPoolId *string
	// The password for the user.
	Password *string
	// True if the password is permanent, False if it is temporary.
	Permanent *bool
	// The user name of the user whose password you wish to set.
	Username *string
}

type AdminSetUserPasswordOutput

type AdminSetUserPasswordOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminSetUserSettingsInput

type AdminSetUserSettingsInput struct {
	// The user name of the user that you are setting options for.
	Username *string
	// You can use this parameter only to set an SMS configuration that uses SMS for
	// delivery.
	MFAOptions []*types.MFAOptionType
	// The ID of the user pool that contains the user that you are setting options for.
	UserPoolId *string
}

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

type AdminSetUserSettingsOutput

type AdminSetUserSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminUpdateAuthEventFeedbackInput

type AdminUpdateAuthEventFeedbackInput struct {
	// The user pool username.
	Username *string
	// The authentication event feedback value.
	FeedbackValue types.FeedbackValueType
	// The authentication event ID.
	EventId *string
	// The user pool ID.
	UserPoolId *string
}

type AdminUpdateAuthEventFeedbackOutput

type AdminUpdateAuthEventFeedbackOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type AdminUpdateDeviceStatusInput

type AdminUpdateDeviceStatusInput struct {
	// The user pool ID.
	UserPoolId *string
	// The status indicating whether a device has been remembered or not.
	DeviceRememberedStatus types.DeviceRememberedStatusType
	// The user name.
	Username *string
	// The device key.
	DeviceKey *string
}

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

type AdminUpdateDeviceStatusOutput

type AdminUpdateDeviceStatusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminUpdateUserAttributesInput

type AdminUpdateUserAttributesInput struct {
	// A map of custom key-value pairs that you can provide as input for any custom
	// workflows that this action triggers. You create custom workflows by assigning
	// AWS Lambda functions to user pool triggers. When you use the
	// AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that
	// is assigned to the custom message trigger. When Amazon Cognito invokes this
	// function, it passes a JSON payload, which the function receives as input. This
	// payload contains a clientMetadata attribute, which provides the data that you
	// assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes
	// request. In your function code in AWS Lambda, you can process the clientMetadata
	// value to enhance your workflow for your specific needs. For more information,
	// see Customizing User Pool Workflows with Lambda Triggers
	// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html)
	// in the Amazon Cognito Developer Guide. Take the following limitations into
	// consideration when you use the ClientMetadata parameter:
	//
	//     * Amazon Cognito
	// does not store the ClientMetadata value. This data is available only to AWS
	// Lambda triggers that are assigned to a user pool to support custom workflows. If
	// your user pool configuration does not include triggers, the ClientMetadata
	// parameter serves no purpose.
	//
	//     * Amazon Cognito does not validate the
	// ClientMetadata value.
	//
	//     * Amazon Cognito does not encrypt the the
	// ClientMetadata value, so don't use it to provide sensitive information.
	ClientMetadata map[string]*string
	// An array of name-value pairs representing user attributes. For custom
	// attributes, you must prepend the custom: prefix to the attribute name.
	UserAttributes []*types.AttributeType
	// The user pool ID for the user pool where you want to update user attributes.
	UserPoolId *string
	// The user name of the user for whom you want to update user attributes.
	Username *string
}

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

type AdminUpdateUserAttributesOutput

type AdminUpdateUserAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type AdminUserGlobalSignOutInput

type AdminUserGlobalSignOutInput struct {
	// The user name.
	Username *string
	// The user pool ID.
	UserPoolId *string
}

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

type AdminUserGlobalSignOutOutput

type AdminUserGlobalSignOutOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The global sign-out response, as an administrator.

type AssociateSoftwareTokenInput

type AssociateSoftwareTokenInput struct {
	// 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
	// The access token.
	AccessToken *string
}

type AssociateSoftwareTokenOutput

type AssociateSoftwareTokenOutput struct {
	// A unique generated shared secret code that is used in the TOTP algorithm to
	// generate a one time code.
	SecretCode *string
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ChangePasswordInput

type ChangePasswordInput struct {
	// The old password.
	PreviousPassword *string
	// The access token.
	AccessToken *string
	// The new password.
	ProposedPassword *string
}

Represents the request to change a user password.

type ChangePasswordOutput

type ChangePasswordOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response from the server to the change password request.

type Client

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

Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies. This API reference provides information about user pools in Amazon Cognito User Pools. For more information, see the Amazon Cognito Documentation.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AddCustomAttributes

func (c *Client) AddCustomAttributes(ctx context.Context, params *AddCustomAttributesInput, optFns ...func(*Options)) (*AddCustomAttributesOutput, error)

Adds additional user attributes to the user pool schema.

func (*Client) AdminAddUserToGroup

func (c *Client) AdminAddUserToGroup(ctx context.Context, params *AdminAddUserToGroupInput, optFns ...func(*Options)) (*AdminAddUserToGroupOutput, error)

Adds the specified user to the specified group. Calling this action requires developer credentials.

func (*Client) AdminConfirmSignUp

func (c *Client) AdminConfirmSignUp(ctx context.Context, params *AdminConfirmSignUpInput, optFns ...func(*Options)) (*AdminConfirmSignUpOutput, error)

Confirms user registration as an admin without using a confirmation code. Works on any user. Calling this action requires developer credentials.

func (*Client) AdminCreateUser

func (c *Client) AdminCreateUser(ctx context.Context, params *AdminCreateUserInput, optFns ...func(*Options)) (*AdminCreateUserOutput, error)

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.

func (*Client) AdminDeleteUser

func (c *Client) AdminDeleteUser(ctx context.Context, params *AdminDeleteUserInput, optFns ...func(*Options)) (*AdminDeleteUserOutput, error)

Deletes a user as an administrator. Works on any user. Calling this action requires developer credentials.

func (*Client) AdminDeleteUserAttributes

func (c *Client) AdminDeleteUserAttributes(ctx context.Context, params *AdminDeleteUserAttributesInput, optFns ...func(*Options)) (*AdminDeleteUserAttributesOutput, error)

Deletes the user attributes in a user pool as an administrator. Works on any user. Calling this action requires developer credentials.

func (*Client) AdminDisableProviderForUser

func (c *Client) AdminDisableProviderForUser(ctx context.Context, params *AdminDisableProviderForUserInput, optFns ...func(*Options)) (*AdminDisableProviderForUserOutput, error)

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.

func (*Client) AdminDisableUser

func (c *Client) AdminDisableUser(ctx context.Context, params *AdminDisableUserInput, optFns ...func(*Options)) (*AdminDisableUserOutput, error)

Disables the specified user. Calling this action requires developer credentials.

func (*Client) AdminEnableUser

func (c *Client) AdminEnableUser(ctx context.Context, params *AdminEnableUserInput, optFns ...func(*Options)) (*AdminEnableUserOutput, error)

Enables the specified user as an administrator. Works on any user. Calling this action requires developer credentials.

func (*Client) AdminForgetDevice

func (c *Client) AdminForgetDevice(ctx context.Context, params *AdminForgetDeviceInput, optFns ...func(*Options)) (*AdminForgetDeviceOutput, error)

Forgets the device, as an administrator. Calling this action requires developer credentials.

func (*Client) AdminGetDevice

func (c *Client) AdminGetDevice(ctx context.Context, params *AdminGetDeviceInput, optFns ...func(*Options)) (*AdminGetDeviceOutput, error)

Gets the device, as an administrator. Calling this action requires developer credentials.

func (*Client) AdminGetUser

func (c *Client) AdminGetUser(ctx context.Context, params *AdminGetUserInput, optFns ...func(*Options)) (*AdminGetUserOutput, error)

Gets the specified user by user name in a user pool as an administrator. Works on any user. Calling this action requires developer credentials.

func (*Client) AdminInitiateAuth

func (c *Client) AdminInitiateAuth(ctx context.Context, params *AdminInitiateAuthInput, optFns ...func(*Options)) (*AdminInitiateAuthOutput, error)

Initiates the authentication flow, as an administrator. Calling this action requires developer credentials.

func (*Client) AdminLinkProviderForUser

func (c *Client) AdminLinkProviderForUser(ctx context.Context, params *AdminLinkProviderForUserInput, optFns ...func(*Options)) (*AdminLinkProviderForUserOutput, error)

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.

func (*Client) AdminListDevices

func (c *Client) AdminListDevices(ctx context.Context, params *AdminListDevicesInput, optFns ...func(*Options)) (*AdminListDevicesOutput, error)

Lists devices, as an administrator. Calling this action requires developer credentials.

func (*Client) AdminListGroupsForUser

func (c *Client) AdminListGroupsForUser(ctx context.Context, params *AdminListGroupsForUserInput, optFns ...func(*Options)) (*AdminListGroupsForUserOutput, error)

Lists the groups that the user belongs to. Calling this action requires developer credentials.

func (*Client) AdminListUserAuthEvents

func (c *Client) AdminListUserAuthEvents(ctx context.Context, params *AdminListUserAuthEventsInput, optFns ...func(*Options)) (*AdminListUserAuthEventsOutput, error)

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

func (*Client) AdminRemoveUserFromGroup

func (c *Client) AdminRemoveUserFromGroup(ctx context.Context, params *AdminRemoveUserFromGroupInput, optFns ...func(*Options)) (*AdminRemoveUserFromGroupOutput, error)

Removes the specified user from the specified group. Calling this action requires developer credentials.

func (*Client) AdminResetUserPassword

func (c *Client) AdminResetUserPassword(ctx context.Context, params *AdminResetUserPasswordInput, optFns ...func(*Options)) (*AdminResetUserPasswordOutput, error)

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.

func (*Client) AdminRespondToAuthChallenge

func (c *Client) AdminRespondToAuthChallenge(ctx context.Context, params *AdminRespondToAuthChallengeInput, optFns ...func(*Options)) (*AdminRespondToAuthChallengeOutput, error)

Responds to an authentication challenge, as an administrator. Calling this action requires developer credentials.

func (*Client) AdminSetUserMFAPreference

func (c *Client) AdminSetUserMFAPreference(ctx context.Context, params *AdminSetUserMFAPreferenceInput, optFns ...func(*Options)) (*AdminSetUserMFAPreferenceOutput, error)

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.

func (*Client) AdminSetUserPassword

func (c *Client) AdminSetUserPassword(ctx context.Context, params *AdminSetUserPasswordInput, optFns ...func(*Options)) (*AdminSetUserPasswordOutput, error)

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.

func (*Client) AdminSetUserSettings

func (c *Client) AdminSetUserSettings(ctx context.Context, params *AdminSetUserSettingsInput, optFns ...func(*Options)) (*AdminSetUserSettingsOutput, error)

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.

func (*Client) AdminUpdateAuthEventFeedback

func (c *Client) AdminUpdateAuthEventFeedback(ctx context.Context, params *AdminUpdateAuthEventFeedbackInput, optFns ...func(*Options)) (*AdminUpdateAuthEventFeedbackOutput, error)

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.

func (*Client) AdminUpdateDeviceStatus

func (c *Client) AdminUpdateDeviceStatus(ctx context.Context, params *AdminUpdateDeviceStatusInput, optFns ...func(*Options)) (*AdminUpdateDeviceStatusOutput, error)

Updates the device status as an administrator. Calling this action requires developer credentials.

func (*Client) AdminUpdateUserAttributes

func (c *Client) AdminUpdateUserAttributes(ctx context.Context, params *AdminUpdateUserAttributesInput, optFns ...func(*Options)) (*AdminUpdateUserAttributesOutput, error)

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.

func (*Client) AdminUserGlobalSignOut

func (c *Client) AdminUserGlobalSignOut(ctx context.Context, params *AdminUserGlobalSignOutInput, optFns ...func(*Options)) (*AdminUserGlobalSignOutOutput, error)

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.

func (*Client) AssociateSoftwareToken

func (c *Client) AssociateSoftwareToken(ctx context.Context, params *AssociateSoftwareTokenInput, optFns ...func(*Options)) (*AssociateSoftwareTokenOutput, error)

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.

func (*Client) ChangePassword

func (c *Client) ChangePassword(ctx context.Context, params *ChangePasswordInput, optFns ...func(*Options)) (*ChangePasswordOutput, error)

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

func (*Client) ConfirmDevice

func (c *Client) ConfirmDevice(ctx context.Context, params *ConfirmDeviceInput, optFns ...func(*Options)) (*ConfirmDeviceOutput, error)

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

func (*Client) ConfirmForgotPassword

func (c *Client) ConfirmForgotPassword(ctx context.Context, params *ConfirmForgotPasswordInput, optFns ...func(*Options)) (*ConfirmForgotPasswordOutput, error)

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

func (*Client) ConfirmSignUp

func (c *Client) ConfirmSignUp(ctx context.Context, params *ConfirmSignUpInput, optFns ...func(*Options)) (*ConfirmSignUpOutput, error)

Confirms registration of a user and handles the existing alias from a previous user.

func (*Client) CreateGroup

func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)

Creates a new group in the specified user pool. Calling this action requires developer credentials.

func (*Client) CreateIdentityProvider

func (c *Client) CreateIdentityProvider(ctx context.Context, params *CreateIdentityProviderInput, optFns ...func(*Options)) (*CreateIdentityProviderOutput, error)

Creates an identity provider for a user pool.

func (*Client) CreateResourceServer

func (c *Client) CreateResourceServer(ctx context.Context, params *CreateResourceServerInput, optFns ...func(*Options)) (*CreateResourceServerOutput, error)

Creates a new OAuth2.0 resource server and defines custom scopes in it.

func (*Client) CreateUserImportJob

func (c *Client) CreateUserImportJob(ctx context.Context, params *CreateUserImportJobInput, optFns ...func(*Options)) (*CreateUserImportJobOutput, error)

Creates the user import job.

func (*Client) CreateUserPool

func (c *Client) CreateUserPool(ctx context.Context, params *CreateUserPoolInput, optFns ...func(*Options)) (*CreateUserPoolOutput, error)

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

func (*Client) CreateUserPoolClient

func (c *Client) CreateUserPoolClient(ctx context.Context, params *CreateUserPoolClientInput, optFns ...func(*Options)) (*CreateUserPoolClientOutput, error)

Creates the user pool client.

func (*Client) CreateUserPoolDomain

func (c *Client) CreateUserPoolDomain(ctx context.Context, params *CreateUserPoolDomainInput, optFns ...func(*Options)) (*CreateUserPoolDomainOutput, error)

Creates a new domain for a user pool.

func (*Client) DeleteGroup

func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)

Deletes a group. Currently only groups with no members can be deleted. Calling this action requires developer credentials.

func (*Client) DeleteIdentityProvider

func (c *Client) DeleteIdentityProvider(ctx context.Context, params *DeleteIdentityProviderInput, optFns ...func(*Options)) (*DeleteIdentityProviderOutput, error)

Deletes an identity provider for a user pool.

func (*Client) DeleteResourceServer

func (c *Client) DeleteResourceServer(ctx context.Context, params *DeleteResourceServerInput, optFns ...func(*Options)) (*DeleteResourceServerOutput, error)

Deletes a resource server.

func (*Client) DeleteUser

func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)

Allows a user to delete himself or herself.

func (*Client) DeleteUserAttributes

func (c *Client) DeleteUserAttributes(ctx context.Context, params *DeleteUserAttributesInput, optFns ...func(*Options)) (*DeleteUserAttributesOutput, error)

Deletes the attributes for a user.

func (*Client) DeleteUserPool

func (c *Client) DeleteUserPool(ctx context.Context, params *DeleteUserPoolInput, optFns ...func(*Options)) (*DeleteUserPoolOutput, error)

Deletes the specified Amazon Cognito user pool.

func (*Client) DeleteUserPoolClient

func (c *Client) DeleteUserPoolClient(ctx context.Context, params *DeleteUserPoolClientInput, optFns ...func(*Options)) (*DeleteUserPoolClientOutput, error)

Allows the developer to delete the user pool client.

func (*Client) DeleteUserPoolDomain

func (c *Client) DeleteUserPoolDomain(ctx context.Context, params *DeleteUserPoolDomainInput, optFns ...func(*Options)) (*DeleteUserPoolDomainOutput, error)

Deletes a domain for a user pool.

func (*Client) DescribeIdentityProvider

func (c *Client) DescribeIdentityProvider(ctx context.Context, params *DescribeIdentityProviderInput, optFns ...func(*Options)) (*DescribeIdentityProviderOutput, error)

Gets information about a specific identity provider.

func (*Client) DescribeResourceServer

func (c *Client) DescribeResourceServer(ctx context.Context, params *DescribeResourceServerInput, optFns ...func(*Options)) (*DescribeResourceServerOutput, error)

Describes a resource server.

func (*Client) DescribeRiskConfiguration

func (c *Client) DescribeRiskConfiguration(ctx context.Context, params *DescribeRiskConfigurationInput, optFns ...func(*Options)) (*DescribeRiskConfigurationOutput, error)

Describes the risk configuration.

func (*Client) DescribeUserImportJob

func (c *Client) DescribeUserImportJob(ctx context.Context, params *DescribeUserImportJobInput, optFns ...func(*Options)) (*DescribeUserImportJobOutput, error)

Describes the user import job.

func (*Client) DescribeUserPool

func (c *Client) DescribeUserPool(ctx context.Context, params *DescribeUserPoolInput, optFns ...func(*Options)) (*DescribeUserPoolOutput, error)

Returns the configuration information and metadata of the specified user pool.

func (*Client) DescribeUserPoolClient

func (c *Client) DescribeUserPoolClient(ctx context.Context, params *DescribeUserPoolClientInput, optFns ...func(*Options)) (*DescribeUserPoolClientOutput, error)

Client method for returning the configuration information and metadata of the specified user pool app client.

func (*Client) DescribeUserPoolDomain

func (c *Client) DescribeUserPoolDomain(ctx context.Context, params *DescribeUserPoolDomainInput, optFns ...func(*Options)) (*DescribeUserPoolDomainOutput, error)

Gets information about a domain.

func (*Client) ForgetDevice

func (c *Client) ForgetDevice(ctx context.Context, params *ForgetDeviceInput, optFns ...func(*Options)) (*ForgetDeviceOutput, error)

Forgets the specified device.

func (*Client) ForgotPassword

func (c *Client) ForgotPassword(ctx context.Context, params *ForgotPasswordInput, optFns ...func(*Options)) (*ForgotPasswordOutput, error)

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. The method used to send the confirmation code is sent according to the specified AccountRecoverySetting. For more information, see Recovering User Accounts () in the Amazon Cognito Developer Guide. If neither a verified phone number nor a verified email exists, an InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .

func (*Client) GetCSVHeader

func (c *Client) GetCSVHeader(ctx context.Context, params *GetCSVHeaderInput, optFns ...func(*Options)) (*GetCSVHeaderOutput, error)

Gets the header information for the .csv file to be used as input for the user import job.

func (*Client) GetDevice

func (c *Client) GetDevice(ctx context.Context, params *GetDeviceInput, optFns ...func(*Options)) (*GetDeviceOutput, error)

Gets the device.

func (*Client) GetGroup

func (c *Client) GetGroup(ctx context.Context, params *GetGroupInput, optFns ...func(*Options)) (*GetGroupOutput, error)

Gets a group. Calling this action requires developer credentials.

func (*Client) GetIdentityProviderByIdentifier

func (c *Client) GetIdentityProviderByIdentifier(ctx context.Context, params *GetIdentityProviderByIdentifierInput, optFns ...func(*Options)) (*GetIdentityProviderByIdentifierOutput, error)

Gets the specified identity provider.

func (*Client) GetSigningCertificate

func (c *Client) GetSigningCertificate(ctx context.Context, params *GetSigningCertificateInput, optFns ...func(*Options)) (*GetSigningCertificateOutput, error)

This method takes a user pool ID, and returns the signing certificate.

func (*Client) GetUICustomization

func (c *Client) GetUICustomization(ctx context.Context, params *GetUICustomizationInput, optFns ...func(*Options)) (*GetUICustomizationOutput, error)

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.

func (*Client) GetUser

func (c *Client) GetUser(ctx context.Context, params *GetUserInput, optFns ...func(*Options)) (*GetUserOutput, error)

Gets the user attributes and metadata for a user.

func (*Client) GetUserAttributeVerificationCode

func (c *Client) GetUserAttributeVerificationCode(ctx context.Context, params *GetUserAttributeVerificationCodeInput, optFns ...func(*Options)) (*GetUserAttributeVerificationCodeOutput, error)

Gets the user attribute verification code for the specified attribute name.

func (*Client) GetUserPoolMfaConfig

func (c *Client) GetUserPoolMfaConfig(ctx context.Context, params *GetUserPoolMfaConfigInput, optFns ...func(*Options)) (*GetUserPoolMfaConfigOutput, error)

Gets the user pool multi-factor authentication (MFA) configuration.

func (*Client) GlobalSignOut

func (c *Client) GlobalSignOut(ctx context.Context, params *GlobalSignOutInput, optFns ...func(*Options)) (*GlobalSignOutOutput, error)

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.

func (*Client) InitiateAuth

func (c *Client) InitiateAuth(ctx context.Context, params *InitiateAuthInput, optFns ...func(*Options)) (*InitiateAuthOutput, error)

Initiates the authentication flow.

func (*Client) ListDevices

func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optFns ...func(*Options)) (*ListDevicesOutput, error)

Lists the devices.

func (*Client) ListGroups

func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)

Lists the groups associated with a user pool. Calling this action requires developer credentials.

func (*Client) ListIdentityProviders

func (c *Client) ListIdentityProviders(ctx context.Context, params *ListIdentityProvidersInput, optFns ...func(*Options)) (*ListIdentityProvidersOutput, error)

Lists information about all identity providers for a user pool.

func (*Client) ListResourceServers

func (c *Client) ListResourceServers(ctx context.Context, params *ListResourceServersInput, optFns ...func(*Options)) (*ListResourceServersOutput, error)

Lists the resource servers for a user pool.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

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.

func (*Client) ListUserImportJobs

func (c *Client) ListUserImportJobs(ctx context.Context, params *ListUserImportJobsInput, optFns ...func(*Options)) (*ListUserImportJobsOutput, error)

Lists the user import jobs.

func (*Client) ListUserPoolClients

func (c *Client) ListUserPoolClients(ctx context.Context, params *ListUserPoolClientsInput, optFns ...func(*Options)) (*ListUserPoolClientsOutput, error)

Lists the clients that have been created for the specified user pool.

func (*Client) ListUserPools

func (c *Client) ListUserPools(ctx context.Context, params *ListUserPoolsInput, optFns ...func(*Options)) (*ListUserPoolsOutput, error)

Lists the user pools associated with an AWS account.

func (*Client) ListUsers

func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)

Lists the users in the Amazon Cognito user pool.

func (*Client) ListUsersInGroup

func (c *Client) ListUsersInGroup(ctx context.Context, params *ListUsersInGroupInput, optFns ...func(*Options)) (*ListUsersInGroupOutput, error)

Lists the users in the specified group. Calling this action requires developer credentials.

func (*Client) ResendConfirmationCode

func (c *Client) ResendConfirmationCode(ctx context.Context, params *ResendConfirmationCodeInput, optFns ...func(*Options)) (*ResendConfirmationCodeOutput, error)

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

func (*Client) RespondToAuthChallenge

func (c *Client) RespondToAuthChallenge(ctx context.Context, params *RespondToAuthChallengeInput, optFns ...func(*Options)) (*RespondToAuthChallengeOutput, error)

Responds to the authentication challenge.

func (*Client) SetRiskConfiguration

func (c *Client) SetRiskConfiguration(ctx context.Context, params *SetRiskConfigurationInput, optFns ...func(*Options)) (*SetRiskConfigurationOutput, error)

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 .

func (*Client) SetUICustomization

func (c *Client) SetUICustomization(ctx context.Context, params *SetUICustomizationInput, optFns ...func(*Options)) (*SetUICustomizationOutput, error)

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.

func (*Client) SetUserMFAPreference

func (c *Client) SetUserMFAPreference(ctx context.Context, params *SetUserMFAPreferenceInput, optFns ...func(*Options)) (*SetUserMFAPreferenceOutput, error)

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.

func (*Client) SetUserPoolMfaConfig

func (c *Client) SetUserPoolMfaConfig(ctx context.Context, params *SetUserPoolMfaConfigInput, optFns ...func(*Options)) (*SetUserPoolMfaConfigOutput, error)

Set the user pool multi-factor authentication (MFA) configuration.

func (*Client) SetUserSettings

func (c *Client) SetUserSettings(ctx context.Context, params *SetUserSettingsInput, optFns ...func(*Options)) (*SetUserSettingsOutput, error)

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.

func (*Client) SignUp

func (c *Client) SignUp(ctx context.Context, params *SignUpInput, optFns ...func(*Options)) (*SignUpOutput, error)

Registers the user in the specified user pool and creates a user name, password, and user attributes.

func (*Client) StartUserImportJob

func (c *Client) StartUserImportJob(ctx context.Context, params *StartUserImportJobInput, optFns ...func(*Options)) (*StartUserImportJobOutput, error)

Starts the user import.

func (*Client) StopUserImportJob

func (c *Client) StopUserImportJob(ctx context.Context, params *StopUserImportJobInput, optFns ...func(*Options)) (*StopUserImportJobOutput, error)

Stops the user import job.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

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 purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account

func (*Client) UpdateAuthEventFeedback

func (c *Client) UpdateAuthEventFeedback(ctx context.Context, params *UpdateAuthEventFeedbackInput, optFns ...func(*Options)) (*UpdateAuthEventFeedbackOutput, error)

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

func (*Client) UpdateDeviceStatus

func (c *Client) UpdateDeviceStatus(ctx context.Context, params *UpdateDeviceStatusInput, optFns ...func(*Options)) (*UpdateDeviceStatusOutput, error)

Updates the device status.

func (*Client) UpdateGroup

func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)

Updates the specified group with the specified attributes. Calling this action requires developer credentials. If you don't provide a value for an attribute, it will be set to the default value.

func (*Client) UpdateIdentityProvider

func (c *Client) UpdateIdentityProvider(ctx context.Context, params *UpdateIdentityProviderInput, optFns ...func(*Options)) (*UpdateIdentityProviderOutput, error)

Updates identity provider information for a user pool.

func (*Client) UpdateResourceServer

func (c *Client) UpdateResourceServer(ctx context.Context, params *UpdateResourceServerInput, optFns ...func(*Options)) (*UpdateResourceServerOutput, error)

Updates the name and scopes of resource server. All other fields are read-only. If you don't provide a value for an attribute, it will be set to the default value.

func (*Client) UpdateUserAttributes

func (c *Client) UpdateUserAttributes(ctx context.Context, params *UpdateUserAttributesInput, optFns ...func(*Options)) (*UpdateUserAttributesOutput, error)

Allows a user to update a specific attribute (one at a time).

func (*Client) UpdateUserPool

func (c *Client) UpdateUserPool(ctx context.Context, params *UpdateUserPoolInput, optFns ...func(*Options)) (*UpdateUserPoolOutput, error)

Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings with . If you don't provide a value for an attribute, it will be set to the default value.

func (*Client) UpdateUserPoolClient

func (c *Client) UpdateUserPoolClient(ctx context.Context, params *UpdateUserPoolClientInput, optFns ...func(*Options)) (*UpdateUserPoolClientOutput, error)

Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings with . If you don't provide a value for an attribute, it will be set to the default value.

func (*Client) UpdateUserPoolDomain

func (c *Client) UpdateUserPoolDomain(ctx context.Context, params *UpdateUserPoolDomainInput, optFns ...func(*Options)) (*UpdateUserPoolDomainOutput, error)

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-add-custom-domain.html).

func (*Client) VerifySoftwareToken

func (c *Client) VerifySoftwareToken(ctx context.Context, params *VerifySoftwareTokenInput, optFns ...func(*Options)) (*VerifySoftwareTokenOutput, error)

Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.

func (*Client) VerifyUserAttribute

func (c *Client) VerifyUserAttribute(ctx context.Context, params *VerifyUserAttributeInput, optFns ...func(*Options)) (*VerifyUserAttributeOutput, error)

Verifies the specified user attributes in the user pool.

type ConfirmDeviceInput

type ConfirmDeviceInput struct {
	// The access token.
	AccessToken *string
	// The device name.
	DeviceName *string
	// The device key.
	DeviceKey *string
	// The configuration of the device secret verifier.
	DeviceSecretVerifierConfig *types.DeviceSecretVerifierConfigType
}

Confirms the device request.

type ConfirmDeviceOutput

type ConfirmDeviceOutput struct {
	// Indicates whether the user confirmation is necessary to confirm the device
	// response.
	UserConfirmationNecessary *bool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Confirms the device response.

type ConfirmForgotPasswordInput

type ConfirmForgotPasswordInput struct {
	// A keyed-hash message authentication code (HMAC) calculated using the secret key
	// of a user pool client and username plus the client ID in the message.
	SecretHash *string
	// The app client ID of the app associated with the user pool.
	ClientId *string
	// 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
	// ConfirmForgotPassword API action, Amazon Cognito invokes the function that is
	// assigned to the post confirmation 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 ConfirmForgotPassword 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
	// The confirmation code sent by a user's request to retrieve a forgotten password.
	// For more information, see
	ConfirmationCode *string
	// The user name of the user for whom you want to enter a code to retrieve a
	// forgotten password.
	Username *string
	// 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.
	UserContextData *types.UserContextDataType
	// The password sent by a user's request to retrieve a forgotten password.
	Password *string
	// The Amazon Pinpoint analytics metadata for collecting metrics for
	// ConfirmForgotPassword calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
}

The request representing the confirmation for a password reset.

type ConfirmForgotPasswordOutput

type ConfirmForgotPasswordOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response from the server that results from a user's request to retrieve a forgotten password.

type ConfirmSignUpInput

type ConfirmSignUpInput struct {
	// Boolean to be specified to force user confirmation irrespective of existing
	// alias. By default set to False. If this parameter is set to True and the phone
	// number/email used for sign up confirmation 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 being confirmed. If set to False, the API will throw an
	// AliasExistsException error.
	ForceAliasCreation *bool
	// 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 ConfirmSignUp API
	// action, Amazon Cognito invokes the function that is assigned to the post
	// confirmation 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 ConfirmSignUp 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
	// A keyed-hash message authentication code (HMAC) calculated using the secret key
	// of a user pool client and username plus the client ID in the message.
	SecretHash *string
	// The ID of the app client associated with the user pool.
	ClientId *string
	// 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.
	UserContextData *types.UserContextDataType
	// The confirmation code sent by a user's request to confirm registration.
	ConfirmationCode *string
	// The user name of the user whose registration you wish to confirm.
	Username *string
	// The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp
	// calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
}

Represents the request to confirm registration of a user.

type ConfirmSignUpOutput

type ConfirmSignUpOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response from the server for the registration confirmation.

type CreateGroupInput

type CreateGroupInput struct {
	// A nonnegative integer value that specifies the precedence of this group relative
	// to the other groups that a user can belong to in the user pool. Zero is the
	// highest precedence value. Groups with lower Precedence values take precedence
	// over groups with higher or null Precedence values. If a user belongs to two or
	// more groups, it is the group with the lowest precedence value whose role ARN
	// will be used in the cognito:roles and cognito:preferred_role claims in the
	// user's tokens. Two groups can have the same Precedence value. If this happens,
	// neither group takes precedence over the other. If two groups with the same
	// Precedence have the same role ARN, that role is used in the
	// cognito:preferred_role claim in tokens for users in each group. If the two
	// groups have different role ARNs, the cognito:preferred_role claim is not set in
	// users' tokens. The default Precedence value is null.
	Precedence *int32
	// The name of the group. Must be unique.
	GroupName *string
	// The user pool ID for the user pool.
	UserPoolId *string
	// The role ARN for the group.
	RoleArn *string
	// A string containing the description of the group.
	Description *string
}

type CreateGroupOutput

type CreateGroupOutput struct {
	// The group object for the group.
	Group *types.GroupType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateIdentityProviderInput

type CreateIdentityProviderInput struct {
	// The user pool ID.
	UserPoolId *string
	// The identity provider type.
	ProviderType types.IdentityProviderTypeType
	// A mapping of identity provider attributes to standard and custom user pool
	// attributes.
	AttributeMapping map[string]*string
	// A list of identity provider identifiers.
	IdpIdentifiers []*string
	// The identity provider name.
	ProviderName *string
	// The identity provider details. The following list describes the provider detail
	// keys for each identity provider type.
	//
	//     * For Google, Facebook and Login with
	// Amazon:
	//
	//         * client_id
	//
	//         * client_secret
	//
	//         *
	// authorize_scopes
	//
	//     * For Sign in with Apple:
	//
	//         * client_id
	//
	//         *
	// team_id
	//
	//         * key_id
	//
	//         * private_key
	//
	//         * authorize_scopes
	//
	//
	// * For OIDC providers:
	//
	//         * client_id
	//
	//         * client_secret
	//
	//         *
	// attributes_request_method
	//
	//         * oidc_issuer
	//
	//         * authorize_scopes
	//
	//
	// * authorize_url if not available from discovery URL specified by oidc_issuer
	// key
	//
	//         * token_url if not available from discovery URL specified by
	// oidc_issuer key
	//
	//         * attributes_url if not available from discovery URL
	// specified by oidc_issuer key
	//
	//         * jwks_uri if not available from discovery
	// URL specified by oidc_issuer key
	//
	//         * authorize_scopes
	//
	//     * For SAML
	// providers:
	//
	//         * MetadataFile OR MetadataURL
	//
	//         * IDPSignout optional
	ProviderDetails map[string]*string
}

type CreateIdentityProviderOutput

type CreateIdentityProviderOutput struct {
	// The newly created identity provider object.
	IdentityProvider *types.IdentityProviderType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateResourceServerInput

type CreateResourceServerInput struct {
	// A unique resource server identifier for the resource server. This could be an
	// HTTPS endpoint where the resource server is located. For example,
	// https://my-weather-api.example.com.
	Identifier *string
	// A list of scopes. Each scope is map, where the keys are name and description.
	Scopes []*types.ResourceServerScopeType
	// A friendly name for the resource server.
	Name *string
	// The user pool ID for the user pool.
	UserPoolId *string
}

type CreateResourceServerOutput

type CreateResourceServerOutput struct {
	// The newly created resource server.
	ResourceServer *types.ResourceServerType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateUserImportJobInput

type CreateUserImportJobInput struct {
	// The user pool ID for the user pool that the users are being imported into.
	UserPoolId *string
	// The role ARN for the Amazon CloudWatch Logging role for the user import job.
	CloudWatchLogsRoleArn *string
	// The job name for the user import job.
	JobName *string
}

Represents the request to create the user import job.

type CreateUserImportJobOutput

type CreateUserImportJobOutput struct {
	// The job object that represents the user import job.
	UserImportJob *types.UserImportJobType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CreateUserPoolClientInput

type CreateUserPoolClientInput struct {
	// The default redirect URI. Must be in the CallbackURLs list. A redirect URI
	// must:
	//
	//     * Be an absolute URI.
	//
	//     * Be registered with the authorization
	// server.
	//
	//     * Not include a fragment component.
	//
	// See OAuth 2.0 - Redirection
	// Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito
	// requires HTTPS over HTTP except for http://localhost for testing purposes only.
	// App callback URLs such as myapp://example are also supported.
	DefaultRedirectURI *string
	// The allowed OAuth flows. Set to code to initiate a code grant flow, which
	// provides an authorization code as the response. This code can be exchanged for
	// access tokens with the token endpoint. Set to implicit to specify that the
	// client should get the access token (and, optionally, ID token, based on scopes)
	// directly. Set to client_credentials to specify that the client should get the
	// access token (and, optionally, ID token, based on scopes) from the token
	// endpoint using a combination of client and client_secret.
	AllowedOAuthFlows []types.OAuthFlowType
	// The user pool ID for the user pool where you want to create a user pool client.
	UserPoolId *string
	// The client name for the user pool client you would like to create.
	ClientName *string
	// Use this setting to choose which errors and responses are returned by Cognito
	// APIs during authentication, account confirmation, and password recovery when the
	// user does not exist in the user pool. When set to ENABLED and the user does not
	// exist, authentication returns an error indicating either the username or
	// password was incorrect, and account confirmation and password recovery return a
	// response indicating a code was sent to a simulated destination. When set to
	// LEGACY, those APIs will return a UserNotFoundException exception if the user
	// does not exist in the user pool. Valid values include:
	//
	//     * ENABLED - This
	// prevents user existence-related errors.
	//
	//     * LEGACY - This represents the old
	// behavior of Cognito where user existence related errors are not prevented.
	//
	// This
	// setting affects the behavior of following APIs:
	//
	//     * AdminInitiateAuth ()
	//
	//
	// * AdminRespondToAuthChallenge ()
	//
	//     * InitiateAuth ()
	//
	//     *
	// RespondToAuthChallenge ()
	//
	//     * ForgotPassword ()
	//
	//     * ConfirmForgotPassword
	// ()
	//
	//     * ConfirmSignUp ()
	//
	//     * ResendConfirmationCode ()
	//
	// After February 15th
	// 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly
	// created user pool clients if no value is provided.
	PreventUserExistenceErrors types.PreventUserExistenceErrorTypes
	// The user pool attributes that the app client can write to. If your app client
	// allows users to sign in through an identity provider, this array must include
	// all attributes that are mapped to identity provider attributes. Amazon Cognito
	// updates mapped attributes when users sign in to your application through an
	// identity provider. If your app client lacks write access to a mapped attribute,
	// Amazon Cognito throws an error when it attempts to update the attribute. For
	// more information, see Specifying Identity Provider Attribute Mappings for Your
	// User Pool
	// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-specifying-attribute-mapping.html).
	WriteAttributes []*string
	// The read attributes.
	ReadAttributes []*string
	// The time limit, in days, after which the refresh token is no longer valid and
	// cannot be used.
	RefreshTokenValidity *int32
	// The allowed OAuth scopes. Possible values provided by OAuth are: phone, email,
	// openid, and profile. Possible values provided by AWS are:
	// aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are
	// also supported.
	AllowedOAuthScopes []*string
	// A list of provider names for the identity providers that are supported on this
	// client. The following are supported: COGNITO, Facebook, Google and
	// LoginWithAmazon.
	SupportedIdentityProviders []*string
	// A list of allowed redirect (callback) URLs for the identity providers. A
	// redirect URI must:
	//
	//     * Be an absolute URI.
	//
	//     * Be registered with the
	// authorization server.
	//
	//     * Not include a fragment component.
	//
	// See OAuth 2.0 -
	// Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon
	// Cognito requires HTTPS over HTTP except for http://localhost for testing
	// purposes only. App callback URLs such as myapp://example are also supported.
	CallbackURLs []*string
	// Set to true if the client is allowed to follow the OAuth protocol when
	// interacting with Cognito user pools.
	AllowedOAuthFlowsUserPoolClient *bool
	// The Amazon Pinpoint analytics configuration for collecting metrics for this user
	// pool. Cognito User Pools only supports sending events to Amazon Pinpoint
	// projects in the US East (N. Virginia) us-east-1 Region, regardless of the region
	// in which the user pool resides.
	AnalyticsConfiguration *types.AnalyticsConfigurationType
	// A list of allowed logout URLs for the identity providers.
	LogoutURLs []*string
	// The authentication flows that are supported by the user pool clients. Flow names
	// without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_
	// prefix. Note that values with ALLOW_ prefix cannot be used along with values
	// without ALLOW_ prefix. Valid values include:
	//
	//     *
	// ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication
	// flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH
	// setting. With this authentication flow, Cognito receives the password in the
	// request instead of using the SRP (Secure Remote Password protocol) protocol to
	// verify passwords.
	//
	//     * ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
	// authentication.
	//
	//     * ALLOW_USER_PASSWORD_AUTH: Enable user password-based
	// authentication. In this flow, Cognito receives the password in the request
	// instead of using the SRP protocol to verify passwords.
	//
	//     *
	// ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
	//
	//     *
	// ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
	ExplicitAuthFlows []types.ExplicitAuthFlowsType
	// Boolean to specify whether you want to generate a secret for the user pool
	// client being created.
	GenerateSecret *bool
}

Represents the request to create a user pool client.

type CreateUserPoolClientOutput

type CreateUserPoolClientOutput struct {
	// The user pool client that was just created.
	UserPoolClient *types.UserPoolClientType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type CreateUserPoolDomainInput

type CreateUserPoolDomainInput struct {
	// The domain string.
	Domain *string
	// The user pool ID.
	UserPoolId *string
	// The configuration for a custom domain that hosts the sign-up and sign-in
	// webpages for your application. Provide this parameter only if you want to use a
	// custom domain for your user pool. Otherwise, you can exclude this parameter and
	// use the Amazon Cognito hosted domain instead. For more information about the
	// hosted domain and custom domains, see Configuring a User Pool Domain
	// (https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html).
	CustomDomainConfig *types.CustomDomainConfigType
}

type CreateUserPoolDomainOutput

type CreateUserPoolDomainOutput struct {
	// The Amazon CloudFront endpoint that you use as the target of the alias that you
	// set up with your Domain Name Service (DNS) provider.
	CloudFrontDomain *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateUserPoolInput

type CreateUserPoolInput struct {
	// The email configuration.
	EmailConfiguration *types.EmailConfigurationType
	// The configuration for AdminCreateUser requests.
	AdminCreateUserConfig *types.AdminCreateUserConfigType
	// A string representing the email verification message.
	EmailVerificationMessage *string
	// The device configuration.
	DeviceConfiguration *types.DeviceConfigurationType
	// The SMS configuration.
	SmsConfiguration *types.SmsConfigurationType
	// The tag keys and values to assign to the user pool. A tag is a label that you
	// can use to categorize and manage user pools in different ways, such as by
	// purpose, owner, environment, or other criteria.
	UserPoolTags map[string]*string
	// A string representing the email verification subject.
	EmailVerificationSubject *string
	// Used to enable advanced security risk detection. Set the key
	// AdvancedSecurityMode to the value "AUDIT".
	UserPoolAddOns *types.UserPoolAddOnsType
	// The policies associated with the new user pool.
	Policies *types.UserPoolPolicyType
	// An array of schema attributes for the new user pool. These attributes can be
	// standard or custom attributes.
	Schema []*types.SchemaAttributeType
	// The attributes to be auto-verified. Possible values: email, phone_number.
	AutoVerifiedAttributes []types.VerifiedAttributeType
	// A string representing the SMS authentication message.
	SmsAuthenticationMessage *string
	// Use this setting to define which verified available method a user can use to
	// recover their password when they call ForgotPassword. It allows you to define a
	// preferred method when a user has more than one method available. With this
	// setting, SMS does not qualify for a valid password recovery mechanism if the
	// user also has SMS MFA enabled. In the absence of this setting, Cognito uses the
	// legacy behavior to determine the recovery method where SMS is preferred over
	// email. Starting February 1, 2020, the value of AccountRecoverySetting will
	// default to verified_email first and verified_phone_number as the second option
	// for newly created user pools if no value is provided.
	AccountRecoverySetting *types.AccountRecoverySettingType
	// Specifies whether email addresses or phone numbers can be specified as usernames
	// when a user signs up.
	UsernameAttributes []types.UsernameAttributeType
	// The Lambda trigger configuration information for the new user pool. In a push
	// model, event sources (such as Amazon S3 and custom applications) need permission
	// to invoke a function. So you will need to make an extra call to add permission
	// for these event sources to invoke your Lambda function. For more information on
	// using the Lambda API to add permission, see  AddPermission
	// (https://docs.aws.amazon.com/lambda/latest/dg/API_AddPermission.html). For
	// adding permission using the AWS CLI, see  add-permission
	// (https://docs.aws.amazon.com/cli/latest/reference/lambda/add-permission.html).
	LambdaConfig *types.LambdaConfigType
	// The template for the verification message that the user sees when the app
	// requests permission to access the user's information.
	VerificationMessageTemplate *types.VerificationMessageTemplateType
	// A string used to name the user pool.
	PoolName *string
	// You can choose to set case sensitivity on the username input for the selected
	// sign-in option. For example, when this is set to False, users will be able to
	// sign in using either "username" or "Username". This configuration is immutable
	// once it has been set. For more information, see .
	UsernameConfiguration *types.UsernameConfigurationType
	// Attributes supported as an alias for this user pool. Possible values:
	// phone_number, email, or preferred_username.
	AliasAttributes []types.AliasAttributeType
	// A string representing the SMS verification message.
	SmsVerificationMessage *string
	// Specifies MFA configuration details.
	MfaConfiguration types.UserPoolMfaType
}

Represents the request to create a user pool.

type CreateUserPoolOutput

type CreateUserPoolOutput struct {
	// A container for the user pool details.
	UserPool *types.UserPoolType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DeleteGroupInput

type DeleteGroupInput struct {
	// The user pool ID for the user pool.
	UserPoolId *string
	// The name of the group.
	GroupName *string
}

type DeleteGroupOutput

type DeleteGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteIdentityProviderInput

type DeleteIdentityProviderInput struct {
	// The identity provider name.
	ProviderName *string
	// The user pool ID.
	UserPoolId *string
}

type DeleteIdentityProviderOutput

type DeleteIdentityProviderOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteResourceServerInput

type DeleteResourceServerInput struct {
	// The user pool ID for the user pool that hosts the resource server.
	UserPoolId *string
	// The identifier for the resource server.
	Identifier *string
}

type DeleteResourceServerOutput

type DeleteResourceServerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteUserAttributesInput

type DeleteUserAttributesInput struct {
	// The access token used in the request to delete user attributes.
	AccessToken *string
	// 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 []*string
}

Represents the request to delete user attributes.

type DeleteUserAttributesOutput

type DeleteUserAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response from the server to delete user attributes.

type DeleteUserInput

type DeleteUserInput struct {
	// The access token from a request to delete a user.
	AccessToken *string
}

Represents the request to delete a user.

type DeleteUserOutput

type DeleteUserOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteUserPoolClientInput

type DeleteUserPoolClientInput struct {
	// The app client ID of the app associated with the user pool.
	ClientId *string
	// The user pool ID for the user pool where you want to delete the client.
	UserPoolId *string
}

Represents the request to delete a user pool client.

type DeleteUserPoolClientOutput

type DeleteUserPoolClientOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteUserPoolDomainInput

type DeleteUserPoolDomainInput struct {
	// The domain string.
	Domain *string
	// The user pool ID.
	UserPoolId *string
}

type DeleteUserPoolDomainOutput

type DeleteUserPoolDomainOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteUserPoolInput

type DeleteUserPoolInput struct {
	// The user pool ID for the user pool you want to delete.
	UserPoolId *string
}

Represents the request to delete a user pool.

type DeleteUserPoolOutput

type DeleteUserPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeIdentityProviderInput

type DescribeIdentityProviderInput struct {
	// The identity provider name.
	ProviderName *string
	// The user pool ID.
	UserPoolId *string
}

type DescribeIdentityProviderOutput

type DescribeIdentityProviderOutput struct {
	// The identity provider that was deleted.
	IdentityProvider *types.IdentityProviderType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeResourceServerInput

type DescribeResourceServerInput struct {
	// The identifier for the resource server
	Identifier *string
	// The user pool ID for the user pool that hosts the resource server.
	UserPoolId *string
}

type DescribeResourceServerOutput

type DescribeResourceServerOutput struct {
	// The resource server.
	ResourceServer *types.ResourceServerType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeRiskConfigurationInput

type DescribeRiskConfigurationInput struct {
	// The app client ID.
	ClientId *string
	// The user pool ID.
	UserPoolId *string
}

type DescribeRiskConfigurationOutput

type DescribeRiskConfigurationOutput struct {
	// The risk configuration.
	RiskConfiguration *types.RiskConfigurationType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeUserImportJobInput

type DescribeUserImportJobInput struct {
	// The job ID for the user import job.
	JobId *string
	// The user pool ID for the user pool that the users are being imported into.
	UserPoolId *string
}

Represents the request to describe the user import job.

type DescribeUserImportJobOutput

type DescribeUserImportJobOutput struct {
	// The job object that represents the user import job.
	UserImportJob *types.UserImportJobType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeUserPoolClientInput

type DescribeUserPoolClientInput struct {
	// The app client ID of the app associated with the user pool.
	ClientId *string
	// The user pool ID for the user pool you want to describe.
	UserPoolId *string
}

Represents the request to describe a user pool client.

type DescribeUserPoolClientOutput

type DescribeUserPoolClientOutput struct {
	// The user pool client from a server response to describe the user pool client.
	UserPoolClient *types.UserPoolClientType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type DescribeUserPoolDomainInput

type DescribeUserPoolDomainInput struct {
	// The domain string.
	Domain *string
}

type DescribeUserPoolDomainOutput

type DescribeUserPoolDomainOutput struct {
	// A domain description object containing information about the domain.
	DomainDescription *types.DomainDescriptionType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DescribeUserPoolInput

type DescribeUserPoolInput struct {
	// The user pool ID for the user pool you want to describe.
	UserPoolId *string
}

Represents the request to describe the user pool.

type DescribeUserPoolOutput

type DescribeUserPoolOutput struct {
	// The container of metadata returned by the server to describe the pool.
	UserPool *types.UserPoolType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response to describe the user pool.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type ForgetDeviceInput

type ForgetDeviceInput struct {
	// The device key.
	DeviceKey *string
	// The access token for the forgotten device request.
	AccessToken *string
}

Represents the request to forget the device.

type ForgetDeviceOutput

type ForgetDeviceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ForgotPasswordInput

type ForgotPasswordInput struct {
	// The user name of the user for whom you want to enter a code to reset a forgotten
	// password.
	Username *string
	// 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.
	UserContextData *types.UserContextDataType
	// 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 ForgotPassword API
	// action, Amazon Cognito invokes any functions that are assigned to the following
	// triggers: pre sign-up, custom message, and user migration. 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
	// ForgotPassword 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
	// The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword
	// calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
	// A keyed-hash message authentication code (HMAC) calculated using the secret key
	// of a user pool client and username plus the client ID in the message.
	SecretHash *string
	// The ID of the client associated with the user pool.
	ClientId *string
}

Represents the request to reset a user's password.

type ForgotPasswordOutput

type ForgotPasswordOutput struct {
	// The code delivery details returned by the server in response to the request to
	// reset a password.
	CodeDeliveryDetails *types.CodeDeliveryDetailsType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Respresents the response from the server regarding the request to reset a password.

type GetCSVHeaderInput

type GetCSVHeaderInput struct {
	// The user pool ID for the user pool that the users are to be imported into.
	UserPoolId *string
}

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

type GetCSVHeaderOutput

type GetCSVHeaderOutput struct {
	// The header information for the .csv file for the user import job.
	CSVHeader []*string
	// The user pool ID for the user pool that the users are to be imported into.
	UserPoolId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type GetDeviceInput

type GetDeviceInput struct {
	// The access token.
	AccessToken *string
	// The device key.
	DeviceKey *string
}

Represents the request to get the device.

type GetDeviceOutput

type GetDeviceOutput struct {
	// The device.
	Device *types.DeviceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Gets the device response.

type GetGroupInput

type GetGroupInput struct {
	// The user pool ID for the user pool.
	UserPoolId *string
	// The name of the group.
	GroupName *string
}

type GetGroupOutput

type GetGroupOutput struct {
	// The group object for the group.
	Group *types.GroupType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetIdentityProviderByIdentifierInput

type GetIdentityProviderByIdentifierInput struct {
	// The user pool ID.
	UserPoolId *string
	// The identity provider ID.
	IdpIdentifier *string
}

type GetIdentityProviderByIdentifierOutput

type GetIdentityProviderByIdentifierOutput struct {
	// The identity provider object.
	IdentityProvider *types.IdentityProviderType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetSigningCertificateInput

type GetSigningCertificateInput struct {
	// The user pool ID.
	UserPoolId *string
}

Request to get a signing certificate from Cognito.

type GetSigningCertificateOutput

type GetSigningCertificateOutput struct {
	// The signing certificate.
	Certificate *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Response from Cognito for a signing certificate request.

type GetUICustomizationInput

type GetUICustomizationInput struct {
	// The client ID for the client app.
	ClientId *string
	// The user pool ID for the user pool.
	UserPoolId *string
}

type GetUICustomizationOutput

type GetUICustomizationOutput struct {
	// The UI customization information.
	UICustomization *types.UICustomizationType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetUserAttributeVerificationCodeInput

type GetUserAttributeVerificationCodeInput struct {
	// The access token returned by the server response to get the user attribute
	// verification code.
	AccessToken *string
	// The attribute name returned by the server response to get the user attribute
	// verification code.
	AttributeName *string
	// 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
	// GetUserAttributeVerificationCode 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
	// GetUserAttributeVerificationCode 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
}

Represents the request to get user attribute verification.

type GetUserAttributeVerificationCodeOutput

type GetUserAttributeVerificationCodeOutput struct {
	// The code delivery details returned by the server in response to the request to
	// get the user attribute verification code.
	CodeDeliveryDetails *types.CodeDeliveryDetailsType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type GetUserInput

type GetUserInput struct {
	// The access token returned by the server response to get information about the
	// user.
	AccessToken *string
}

Represents the request to get information about the user.

type GetUserOutput

type GetUserOutput struct {
	// The user name of the user you wish to retrieve from the get user request.
	Username *string
	// The MFA options that are enabled for the user. The possible values in this list
	// are SMS_MFA and SOFTWARE_TOKEN_MFA.
	UserMFASettingList []*string
	// An array of name-value pairs representing user attributes. For custom
	// attributes, you must prepend the custom: prefix to the attribute name.
	UserAttributes []*types.AttributeType
	// 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 use the GetUserResponse$UserMFASettingList () response
	// instead.
	MFAOptions []*types.MFAOptionType
	// The user's preferred MFA setting.
	PreferredMfaSetting *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type GetUserPoolMfaConfigInput

type GetUserPoolMfaConfigInput struct {
	// The user pool ID.
	UserPoolId *string
}

type GetUserPoolMfaConfigOutput

type GetUserPoolMfaConfigOutput struct {
	// The SMS text message multi-factor (MFA) configuration.
	SmsMfaConfiguration *types.SmsMfaConfigType
	// The software token multi-factor (MFA) configuration.
	SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType
	// The multi-factor (MFA) configuration. Valid values include:
	//
	//     * OFF MFA will
	// not be used for any users.
	//
	//     * ON MFA is required for all users to sign in.
	//
	//
	// * OPTIONAL MFA will be required only for individual users who have an MFA factor
	// enabled.
	MfaConfiguration types.UserPoolMfaType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GlobalSignOutInput

type GlobalSignOutInput struct {
	// The access token.
	AccessToken *string
}

Represents the request to sign out all devices.

type GlobalSignOutOutput

type GlobalSignOutOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response to the request to sign out all devices.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type InitiateAuthInput

type InitiateAuthInput struct {
	// 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 CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured
	// with client secret), DEVICE_KEY
	AuthParameters map[string]*string
	// 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 InitiateAuth 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
	//
	//     <p>When Amazon Cognito invokes the functions for these
	// triggers, it passes a JSON payload, which the function receives as input. This
	// payload contains a <code>validationData</code> attribute, which provides the
	// data that you assigned to the ClientMetadata parameter in your InitiateAuth
	// request. In your function code in AWS Lambda, you can process the
	// <code>validationData</code> value to enhance your workflow for your specific
	// needs.</p> <p>When you use the InitiateAuth API action, Amazon Cognito also
	// invokes the functions for the following triggers, but it does not provide the
	// ClientMetadata value as input:</p> <ul> <li> <p>Post authentication</p> </li>
	// <li> <p>Custom message</p> </li> <li> <p>Pre token generation</p> </li> <li>
	// <p>Create auth challenge</p> </li> <li> <p>Define auth challenge</p> </li> <li>
	// <p>Verify auth challenge</p> </li> </ul> <p>For more information, see <a
	// href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html">Customizing
	// User Pool Workflows with Lambda Triggers</a> in the <i>Amazon Cognito Developer
	// Guide</i>.</p> <note> <p>Take the following limitations into consideration when
	// you use the ClientMetadata parameter:</p> <ul> <li> <p>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.</p> </li> <li> <p>Amazon Cognito does not validate the
	// ClientMetadata value.</p> </li> <li> <p>Amazon Cognito does not encrypt the the
	// ClientMetadata value, so don't use it to provide sensitive information.</p>
	// </li> </ul> </note>
	ClientMetadata map[string]*string
	// The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth
	// calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
	// The app client ID.
	ClientId *string
	// 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.
	UserContextData *types.UserContextDataType
	// 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.
	//
	//     * 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.
	//
	// ADMIN_NO_SRP_AUTH is not a valid
	// value.
	AuthFlow types.AuthFlowType
}

Initiates the authentication request.

type InitiateAuthOutput

type InitiateAuthOutput struct {
	// 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
	// The challenge parameters. These are returned to you in the InitiateAuth response
	// if you need to pass another challenge. The responses in this parameter should be
	// used to compute inputs to the next call (RespondToAuthChallenge). All challenges
	// require USERNAME and SECRET_HASH (if applicable).
	ChallengeParameters map[string]*string
	// 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. Valid values include the following. Note that all of these challenges
	// require USERNAME and SECRET_HASH (if applicable) in the parameters.
	//
	//     *
	// 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.
	//
	//
	// * 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 types.ChallengeNameType
	// 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 *types.AuthenticationResultType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Initiates the authentication response.

type ListDevicesInput

type ListDevicesInput struct {
	// The pagination token for the list request.
	PaginationToken *string
	// The limit of the device request.
	Limit *int32
	// The access tokens for the request to list devices.
	AccessToken *string
}

Represents the request to list the devices.

type ListDevicesOutput

type ListDevicesOutput struct {
	// The pagination token for the list device response.
	PaginationToken *string
	// The devices returned in the list devices response.
	Devices []*types.DeviceType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response to list devices.

type ListGroupsInput

type ListGroupsInput struct {
	// 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
	// The user pool ID for the user pool.
	UserPoolId *string
	// The limit of the request to list groups.
	Limit *int32
}

type ListGroupsOutput

type ListGroupsOutput struct {
	// The group objects for the groups.
	Groups []*types.GroupType
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListIdentityProvidersInput

type ListIdentityProvidersInput struct {
	// A pagination token.
	NextToken *string
	// The maximum number of identity providers to return.
	MaxResults *int32
	// The user pool ID.
	UserPoolId *string
}

type ListIdentityProvidersOutput

type ListIdentityProvidersOutput struct {
	// A pagination token.
	NextToken *string
	// A list of identity provider objects.
	Providers []*types.ProviderDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListResourceServersInput

type ListResourceServersInput struct {
	// A pagination token.
	NextToken *string
	// The user pool ID for the user pool.
	UserPoolId *string
	// The maximum number of resource servers to return.
	MaxResults *int32
}

type ListResourceServersOutput

type ListResourceServersOutput struct {
	// The resource servers.
	ResourceServers []*types.ResourceServerType
	// A pagination token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
	ResourceArn *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// The tags that are assigned to the user pool.
	Tags map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListUserImportJobsInput

type ListUserImportJobsInput struct {
	// The user pool ID for the user pool that the users are being imported into.
	UserPoolId *string
	// An identifier that was returned from the previous call to ListUserImportJobs,
	// which can be used to return the next set of import jobs in the list.
	PaginationToken *string
	// The maximum number of import jobs you want the request to return.
	MaxResults *int32
}

Represents the request to list the user import jobs.

type ListUserImportJobsOutput

type ListUserImportJobsOutput struct {
	// The user import jobs.
	UserImportJobs []*types.UserImportJobType
	// An identifier that can be used to return the next set of user import jobs in the
	// list.
	PaginationToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type ListUserPoolClientsInput

type ListUserPoolClientsInput struct {
	// The user pool ID for the user pool where you want to list user pool clients.
	UserPoolId *string
	// The maximum number of results you want the request to return when listing the
	// user pool clients.
	MaxResults *int32
	// 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
}

Represents the request to list the user pool clients.

type ListUserPoolClientsOutput

type ListUserPoolClientsOutput struct {
	// 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
	// The user pool clients in the response that lists user pool clients.
	UserPoolClients []*types.UserPoolClientDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type ListUserPoolsInput

type ListUserPoolsInput struct {
	// 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
	// The maximum number of results you want the request to return when listing the
	// user pools.
	MaxResults *int32
}

Represents the request to list user pools.

type ListUserPoolsOutput

type ListUserPoolsOutput struct {
	// The user pools from the response to list users.
	UserPools []*types.UserPoolDescriptionType
	// 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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response to list user pools.

type ListUsersInGroupInput

type ListUsersInGroupInput struct {
	// The name of the group.
	GroupName *string
	// The user pool ID for the user pool.
	UserPoolId *string
	// The limit of the request to list users.
	Limit *int32
	// 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
}

type ListUsersInGroupOutput

type ListUsersInGroupOutput struct {
	// 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
	// The users returned in the request to list users.
	Users []*types.UserType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListUsersInput

type ListUsersInput struct {
	// An array of strings, where each string is the name of a user attribute to be
	// returned for each user in the search results. If the array is null, all
	// attributes are returned.
	AttributesToGet []*string
	// The user pool ID for the user pool on which the search should be performed.
	UserPoolId *string
	// 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.
	PaginationToken *string
	// Maximum number of users to be returned.
	Limit *int32
	// A filter string of the form "AttributeName Filter-Type "AttributeValue"".
	// Quotation marks within the filter string must be escaped using the backslash (\)
	// character. For example, "family_name = \"Reddy\"".
	//
	//     * AttributeName: The
	// name of the attribute to search for. You can only search for one attribute at a
	// time.
	//
	//     * Filter-Type: For an exact match, use =, for example, "given_name =
	// \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name
	// ^= \"Jon\"".
	//
	//     * AttributeValue: The attribute value that must be matched for
	// each user.
	//
	// If the filter string is empty, ListUsers returns all users in the
	// user pool. You can only search for the following standard attributes:
	//
	//     *
	// username (case-sensitive)
	//
	//     * email
	//
	//     * phone_number
	//
	//     * name
	//
	//     *
	// given_name
	//
	//     * family_name
	//
	//     * preferred_username
	//
	//     *
	// cognito:user_status (called Status in the Console) (case-insensitive)
	//
	//     *
	// status (called Enabled in the Console) (case-sensitive)
	//
	//     * sub
	//
	// Custom
	// attributes are not searchable. For more information, see Searching for Users
	// Using the ListUsers API
	// (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api)
	// and Examples of Using the ListUsers API
	// (https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples)
	// in the Amazon Cognito Developer Guide.
	Filter *string
}

Represents the request to list users.

type ListUsersOutput

type ListUsersOutput struct {
	// The users returned in the request to list users.
	Users []*types.UserType
	// 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.
	PaginationToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response from the request to list users.

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type ResendConfirmationCodeInput

type ResendConfirmationCodeInput struct {
	// 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.
	UserContextData *types.UserContextDataType
	// The user name of the user to whom you wish to resend a confirmation code.
	Username *string
	// The ID of the client associated with the user pool.
	ClientId *string
	// A keyed-hash message authentication code (HMAC) calculated using the secret key
	// of a user pool client and username plus the client ID in the message.
	SecretHash *string
	// 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
	// ResendConfirmationCode 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 ResendConfirmationCode 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
	// The Amazon Pinpoint analytics metadata for collecting metrics for
	// ResendConfirmationCode calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
}

Represents the request to resend the confirmation code.

type ResendConfirmationCodeOutput

type ResendConfirmationCodeOutput struct {
	// The code delivery details returned by the server in response to the request to
	// resend the confirmation code.
	CodeDeliveryDetails *types.CodeDeliveryDetailsType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type RespondToAuthChallengeInput

type RespondToAuthChallengeInput struct {
	// The challenge responses. These are inputs corresponding to the value of
	// ChallengeName, for example: SECRET_HASH (if app client is configured with client
	// secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).
	//
	//     *
	// SMS_MFA: SMS_MFA_CODE, USERNAME.
	//
	//     * PASSWORD_VERIFIER:
	// PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.
	//
	//
	// * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes,
	// USERNAME.
	//
	//     * SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are
	// required attributes.
	//
	//     * DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A
	// (and SECRET_HASH).
	//
	//     * DEVICE_PASSWORD_VERIFIER requires everything that
	// PASSWORD_VERIFIER requires plus DEVICE_KEY.
	ChallengeResponses map[string]*string
	// The app client ID.
	ClientId *string
	// 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
	// RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are
	// assigned to the following triggers: post authentication, pre token generation,
	// define auth challenge, create auth challenge, and verify auth challenge. 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 RespondToAuthChallenge 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
	// The challenge name. For more information, see . ADMIN_NO_SRP_AUTH is not a valid
	// value.
	ChallengeName types.ChallengeNameType
	// The Amazon Pinpoint analytics metadata for collecting metrics for
	// RespondToAuthChallenge calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
	// 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
	// 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.
	UserContextData *types.UserContextDataType
}

The request to respond to an authentication challenge.

type RespondToAuthChallengeOutput

type RespondToAuthChallengeOutput struct {
	// The result returned by the server in response to the request to respond to the
	// authentication challenge.
	AuthenticationResult *types.AuthenticationResultType
	// The challenge name. For more information, see .
	ChallengeName types.ChallengeNameType
	// 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
	// The challenge parameters. For more information, see .
	ChallengeParameters map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response to respond to the authentication challenge.

type SetRiskConfigurationInput

type SetRiskConfigurationInput struct {
	// The configuration to override the risk decision.
	RiskExceptionConfiguration *types.RiskExceptionConfigurationType
	// The account takeover risk configuration.
	AccountTakeoverRiskConfiguration *types.AccountTakeoverRiskConfigurationType
	// The user pool ID.
	UserPoolId *string
	// The compromised credentials risk configuration.
	CompromisedCredentialsRiskConfiguration *types.CompromisedCredentialsRiskConfigurationType
	// The app client ID. If ClientId is null, then the risk configuration is mapped to
	// userPoolId. When the client ID is null, the same risk configuration is applied
	// to all the clients in the userPool. Otherwise, ClientId is mapped to the client.
	// When the client ID is not null, the user pool configuration is overridden and
	// the risk configuration for the client is used instead.
	ClientId *string
}

type SetRiskConfigurationOutput

type SetRiskConfigurationOutput struct {
	// The risk configuration.
	RiskConfiguration *types.RiskConfigurationType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetUICustomizationInput

type SetUICustomizationInput struct {
	// The client ID for the client app.
	ClientId *string
	// The user pool ID for the user pool.
	UserPoolId *string
	// The CSS values in the UI customization.
	CSS *string
	// The uploaded logo image for the UI customization.
	ImageFile []byte
}

type SetUICustomizationOutput

type SetUICustomizationOutput struct {
	// The UI customization information.
	UICustomization *types.UICustomizationType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetUserMFAPreferenceInput

type SetUserMFAPreferenceInput struct {
	// The access token for the user.
	AccessToken *string
	// The time-based one-time password software token MFA settings.
	SoftwareTokenMfaSettings *types.SoftwareTokenMfaSettingsType
	// The SMS text message multi-factor authentication (MFA) settings.
	SMSMfaSettings *types.SMSMfaSettingsType
}

type SetUserMFAPreferenceOutput

type SetUserMFAPreferenceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetUserPoolMfaConfigInput

type SetUserPoolMfaConfigInput struct {
	// The user pool ID.
	UserPoolId *string
	// The MFA configuration. Valid values include:
	//
	//     * OFF MFA will not be used for
	// any users.
	//
	//     * ON MFA is required for all users to sign in.
	//
	//     * OPTIONAL
	// MFA will be required only for individual users who have an MFA factor enabled.
	MfaConfiguration types.UserPoolMfaType
	// The software token MFA configuration.
	SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType
	// The SMS text message MFA configuration.
	SmsMfaConfiguration *types.SmsMfaConfigType
}

type SetUserPoolMfaConfigOutput

type SetUserPoolMfaConfigOutput struct {
	// The MFA configuration. Valid values include:
	//
	//     * OFF MFA will not be used for
	// any users.
	//
	//     * ON MFA is required for all users to sign in.
	//
	//     * OPTIONAL
	// MFA will be required only for individual users who have an MFA factor enabled.
	MfaConfiguration types.UserPoolMfaType
	// The software token MFA configuration.
	SoftwareTokenMfaConfiguration *types.SoftwareTokenMfaConfigType
	// The SMS text message MFA configuration.
	SmsMfaConfiguration *types.SmsMfaConfigType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type SetUserSettingsInput

type SetUserSettingsInput struct {
	// The access token for the set user settings request.
	AccessToken *string
	// You can use this parameter only to set an SMS configuration that uses SMS for
	// delivery.
	MFAOptions []*types.MFAOptionType
}

Represents the request to set user settings.

type SetUserSettingsOutput

type SetUserSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response from the server for a set user settings request.

type SignUpInput

type SignUpInput struct {
	// The user name of the user you wish to register.
	Username *string
	// 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 SignUp API action,
	// Amazon Cognito invokes any functions that are assigned to the following
	// triggers: pre sign-up, custom message, and post confirmation. 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 SignUp 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
	// The password of the user you wish to register.
	Password *string
	// The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
	AnalyticsMetadata *types.AnalyticsMetadataType
	// An array of name-value pairs representing user attributes. For custom
	// attributes, you must prepend the custom: prefix to the attribute name.
	UserAttributes []*types.AttributeType
	// The ID of the client associated with the user pool.
	ClientId *string
	// 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.
	UserContextData *types.UserContextDataType
	// A keyed-hash message authentication code (HMAC) calculated using the secret key
	// of a user pool client and username plus the client ID in the message.
	SecretHash *string
	// The validation data in the request to register a user.
	ValidationData []*types.AttributeType
}

Represents the request to register a user.

type SignUpOutput

type SignUpOutput struct {
	// A response from the server indicating that a user registration has been
	// confirmed.
	UserConfirmed *bool
	// The UUID of the authenticated user. This is not the same as username.
	UserSub *string
	// The code delivery details returned by the server response to the user
	// registration request.
	CodeDeliveryDetails *types.CodeDeliveryDetailsType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response from the server for a registration request.

type StartUserImportJobInput

type StartUserImportJobInput struct {
	// The job ID for the user import job.
	JobId *string
	// The user pool ID for the user pool that the users are being imported into.
	UserPoolId *string
}

Represents the request to start the user import job.

type StartUserImportJobOutput

type StartUserImportJobOutput struct {
	// The job object that represents the user import job.
	UserImportJob *types.UserImportJobType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type StopUserImportJobInput

type StopUserImportJobInput struct {
	// The job ID for the user import job.
	JobId *string
	// The user pool ID for the user pool that the users are being imported into.
	UserPoolId *string
}

Represents the request to stop the user import job.

type StopUserImportJobOutput

type StopUserImportJobOutput struct {
	// The job object that represents the user import job.
	UserImportJob *types.UserImportJobType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type TagResourceInput

type TagResourceInput struct {
	// The tags to assign to the user pool.
	Tags map[string]*string
	// The Amazon Resource Name (ARN) of the user pool to assign the tags to.
	ResourceArn *string
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {
	// The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
	ResourceArn *string
	// The keys of the tags to remove from the user pool.
	TagKeys []*string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAuthEventFeedbackInput

type UpdateAuthEventFeedbackInput struct {
	// The user pool ID.
	UserPoolId *string
	// The authentication event feedback value.
	FeedbackValue types.FeedbackValueType
	// The event ID.
	EventId *string
	// The feedback token.
	FeedbackToken *string
	// The user pool username.
	Username *string
}

type UpdateAuthEventFeedbackOutput

type UpdateAuthEventFeedbackOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDeviceStatusInput

type UpdateDeviceStatusInput struct {
	// The access token.
	AccessToken *string
	// The device key.
	DeviceKey *string
	// The status of whether a device is remembered.
	DeviceRememberedStatus types.DeviceRememberedStatusType
}

Represents the request to update the device status.

type UpdateDeviceStatusOutput

type UpdateDeviceStatusOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response to the request to update the device status.

type UpdateGroupInput

type UpdateGroupInput struct {
	// The name of the group.
	GroupName *string
	// The user pool ID for the user pool.
	UserPoolId *string
	// The new precedence value for the group. For more information about this
	// parameter, see .
	Precedence *int32
	// The new role ARN for the group. This is used for setting the cognito:roles and
	// cognito:preferred_role claims in the token.
	RoleArn *string
	// A string containing the new description of the group.
	Description *string
}

type UpdateGroupOutput

type UpdateGroupOutput struct {
	// The group object for the group.
	Group *types.GroupType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateIdentityProviderInput

type UpdateIdentityProviderInput struct {
	// A list of identity provider identifiers.
	IdpIdentifiers []*string
	// The identity provider name.
	ProviderName *string
	// The identity provider attribute mapping to be changed.
	AttributeMapping map[string]*string
	// The user pool ID.
	UserPoolId *string
	// The identity provider details to be updated, such as MetadataURL and
	// MetadataFile.
	ProviderDetails map[string]*string
}

type UpdateIdentityProviderOutput

type UpdateIdentityProviderOutput struct {
	// The identity provider object.
	IdentityProvider *types.IdentityProviderType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateResourceServerInput

type UpdateResourceServerInput struct {
	// The identifier for the resource server.
	Identifier *string
	// The user pool ID for the user pool.
	UserPoolId *string
	// The name of the resource server.
	Name *string
	// The scope values to be set for the resource server.
	Scopes []*types.ResourceServerScopeType
}

type UpdateResourceServerOutput

type UpdateResourceServerOutput struct {
	// The resource server.
	ResourceServer *types.ResourceServerType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateUserAttributesInput

type UpdateUserAttributesInput 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
	// UpdateUserAttributes 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 UpdateUserAttributes 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
	// An array of name-value pairs representing user attributes. For custom
	// attributes, you must prepend the custom: prefix to the attribute name.
	UserAttributes []*types.AttributeType
	// The access token for the request to update user attributes.
	AccessToken *string
}

Represents the request to update user attributes.

type UpdateUserAttributesOutput

type UpdateUserAttributesOutput struct {
	// The code delivery details list from the server for the request to update user
	// attributes.
	CodeDeliveryDetailsList []*types.CodeDeliveryDetailsType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type UpdateUserPoolClientInput

type UpdateUserPoolClientInput struct {
	// A list of provider names for the identity providers that are supported on this
	// client.
	SupportedIdentityProviders []*string
	// A list of allowed redirect (callback) URLs for the identity providers. A
	// redirect URI must:
	//
	//     * Be an absolute URI.
	//
	//     * Be registered with the
	// authorization server.
	//
	//     * Not include a fragment component.
	//
	// See OAuth 2.0 -
	// Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon
	// Cognito requires HTTPS over HTTP except for http://localhost for testing
	// purposes only. App callback URLs such as myapp://example are also supported.
	CallbackURLs []*string
	// The allowed OAuth scopes. Possible values provided by OAuth are: phone, email,
	// openid, and profile. Possible values provided by AWS are:
	// aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are
	// also supported.
	AllowedOAuthScopes []*string
	// The ID of the client associated with the user pool.
	ClientId *string
	// A list of allowed logout URLs for the identity providers.
	LogoutURLs []*string
	// The time limit, in days, after which the refresh token is no longer valid and
	// cannot be used.
	RefreshTokenValidity *int32
	// Use this setting to choose which errors and responses are returned by Cognito
	// APIs during authentication, account confirmation, and password recovery when the
	// user does not exist in the user pool. When set to ENABLED and the user does not
	// exist, authentication returns an error indicating either the username or
	// password was incorrect, and account confirmation and password recovery return a
	// response indicating a code was sent to a simulated destination. When set to
	// LEGACY, those APIs will return a UserNotFoundException exception if the user
	// does not exist in the user pool. Valid values include:
	//
	//     * ENABLED - This
	// prevents user existence-related errors.
	//
	//     * LEGACY - This represents the old
	// behavior of Cognito where user existence related errors are not prevented.
	//
	// This
	// setting affects the behavior of following APIs:
	//
	//     * AdminInitiateAuth ()
	//
	//
	// * AdminRespondToAuthChallenge ()
	//
	//     * InitiateAuth ()
	//
	//     *
	// RespondToAuthChallenge ()
	//
	//     * ForgotPassword ()
	//
	//     * ConfirmForgotPassword
	// ()
	//
	//     * ConfirmSignUp ()
	//
	//     * ResendConfirmationCode ()
	//
	// After February 15th
	// 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly
	// created user pool clients if no value is provided.
	PreventUserExistenceErrors types.PreventUserExistenceErrorTypes
	// The writeable attributes of the user pool.
	WriteAttributes []*string
	// The Amazon Pinpoint analytics configuration for collecting metrics for this user
	// pool. Cognito User Pools only supports sending events to Amazon Pinpoint
	// projects in the US East (N. Virginia) us-east-1 Region, regardless of the region
	// in which the user pool resides.
	AnalyticsConfiguration *types.AnalyticsConfigurationType
	// The user pool ID for the user pool where you want to update the user pool
	// client.
	UserPoolId *string
	// The allowed OAuth flows. Set to code to initiate a code grant flow, which
	// provides an authorization code as the response. This code can be exchanged for
	// access tokens with the token endpoint. Set to implicit to specify that the
	// client should get the access token (and, optionally, ID token, based on scopes)
	// directly. Set to client_credentials to specify that the client should get the
	// access token (and, optionally, ID token, based on scopes) from the token
	// endpoint using a combination of client and client_secret.
	AllowedOAuthFlows []types.OAuthFlowType
	// The client name from the update user pool client request.
	ClientName *string
	// The authentication flows that are supported by the user pool clients. Flow names
	// without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_
	// prefix. Note that values with ALLOW_ prefix cannot be used along with values
	// without ALLOW_ prefix. Valid values include:
	//
	//     *
	// ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication
	// flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH
	// setting. With this authentication flow, Cognito receives the password in the
	// request instead of using the SRP (Secure Remote Password protocol) protocol to
	// verify passwords.
	//
	//     * ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
	// authentication.
	//
	//     * ALLOW_USER_PASSWORD_AUTH: Enable user password-based
	// authentication. In this flow, Cognito receives the password in the request
	// instead of using the SRP protocol to verify passwords.
	//
	//     *
	// ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
	//
	//     *
	// ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
	ExplicitAuthFlows []types.ExplicitAuthFlowsType
	// Set to true if the client is allowed to follow the OAuth protocol when
	// interacting with Cognito user pools.
	AllowedOAuthFlowsUserPoolClient *bool
	// The default redirect URI. Must be in the CallbackURLs list. A redirect URI
	// must:
	//
	//     * Be an absolute URI.
	//
	//     * Be registered with the authorization
	// server.
	//
	//     * Not include a fragment component.
	//
	// See OAuth 2.0 - Redirection
	// Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). Amazon Cognito
	// requires HTTPS over HTTP except for http://localhost for testing purposes only.
	// App callback URLs such as myapp://example are also supported.
	DefaultRedirectURI *string
	// The read-only attributes of the user pool.
	ReadAttributes []*string
}

Represents the request to update the user pool client.

type UpdateUserPoolClientOutput

type UpdateUserPoolClientOutput struct {
	// The user pool client value from the response from the server when an update user
	// pool client request is made.
	UserPoolClient *types.UserPoolClientType

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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

type UpdateUserPoolDomainInput

type UpdateUserPoolDomainInput struct {
	// The domain name for the custom domain that hosts the sign-up and sign-in pages
	// for your application. For example: auth.example.com. This string can include
	// only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first
	// or last character. Use periods to separate subdomain names.
	Domain *string
	// The configuration for a custom domain that hosts the sign-up and sign-in pages
	// for your application. Use this object to specify an SSL certificate that is
	// managed by ACM.
	CustomDomainConfig *types.CustomDomainConfigType
	// The ID of the user pool that is associated with the custom domain that you are
	// updating the certificate for.
	UserPoolId *string
}

The UpdateUserPoolDomain request input.

type UpdateUserPoolDomainOutput

type UpdateUserPoolDomainOutput struct {
	// The Amazon CloudFront endpoint that Amazon Cognito set up when you added the
	// custom domain to your user pool.
	CloudFrontDomain *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The UpdateUserPoolDomain response output.

type UpdateUserPoolInput

type UpdateUserPoolInput struct {
	// Used to enable advanced security risk detection. Set the key
	// AdvancedSecurityMode to the value "AUDIT".
	UserPoolAddOns *types.UserPoolAddOnsType
	// A container with information about the SMS verification message.
	SmsVerificationMessage *string
	// Email configuration.
	EmailConfiguration *types.EmailConfigurationType
	// The subject of the email verification message.
	EmailVerificationSubject *string
	// The user pool ID for the user pool you want to update.
	UserPoolId *string
	// The AWS Lambda configuration information from the request to update the user
	// pool.
	LambdaConfig *types.LambdaConfigType
	// Can be one of the following values:
	//
	//     * OFF - MFA tokens are not required and
	// cannot be specified during user registration.
	//
	//     * ON - MFA tokens are
	// required for all user registrations. You can only specify required when you are
	// initially creating a user pool.
	//
	//     * OPTIONAL - Users have the option when
	// registering to create an MFA token.
	MfaConfiguration types.UserPoolMfaType
	// The contents of the email verification message.
	EmailVerificationMessage *string
	// Device configuration.
	DeviceConfiguration *types.DeviceConfigurationType
	// The tag keys and values to assign to the user pool. A tag is a label that you
	// can use to categorize and manage user pools in different ways, such as by
	// purpose, owner, environment, or other criteria.
	UserPoolTags map[string]*string
	// The attributes that are automatically verified when the Amazon Cognito service
	// makes a request to update user pools.
	AutoVerifiedAttributes []types.VerifiedAttributeType
	// The contents of the SMS authentication message.
	SmsAuthenticationMessage *string
	// Use this setting to define which verified available method a user can use to
	// recover their password when they call ForgotPassword. It allows you to define a
	// preferred method when a user has more than one method available. With this
	// setting, SMS does not qualify for a valid password recovery mechanism if the
	// user also has SMS MFA enabled. In the absence of this setting, Cognito uses the
	// legacy behavior to determine the recovery method where SMS is preferred over
	// email.
	AccountRecoverySetting *types.AccountRecoverySettingType
	// A container with the policies you wish to update in a user pool.
	Policies *types.UserPoolPolicyType
	// The configuration for AdminCreateUser requests.
	AdminCreateUserConfig *types.AdminCreateUserConfigType
	// SMS configuration.
	SmsConfiguration *types.SmsConfigurationType
	// The template for verification messages.
	VerificationMessageTemplate *types.VerificationMessageTemplateType
}

Represents the request to update the user pool.

type UpdateUserPoolOutput

type UpdateUserPoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response from the server when you make a request to update the user pool.

type VerifySoftwareTokenInput

type VerifySoftwareTokenInput struct {
	// The friendly device name.
	FriendlyDeviceName *string
	// The session which should be passed both ways in challenge-response calls to the
	// service.
	Session *string
	// The one time password computed using the secret code returned by
	UserCode *string
	// The access token.
	AccessToken *string
}

type VerifySoftwareTokenOutput

type VerifySoftwareTokenOutput struct {
	// The status of the verify software token.
	Status types.VerifySoftwareTokenResponseType
	// The session which should be passed both ways in challenge-response calls to the
	// service.
	Session *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type VerifyUserAttributeInput

type VerifyUserAttributeInput struct {
	// Represents the access token of the request to verify user attributes.
	AccessToken *string
	// The verification code in the request to verify user attributes.
	Code *string
	// The attribute name in the request to verify user attributes.
	AttributeName *string
}

Represents the request to verify user attributes.

type VerifyUserAttributeOutput

type VerifyUserAttributeOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

A container representing the response from the server from the request to verify user attributes.

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL