Documentation ¶
Overview ¶
Package cognitoidentityprovider provides the client and types for making API requests to Amazon Cognito Identity Provider.
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.
See https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18 for more information on this service.
See cognitoidentityprovider package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/
Using the Client ¶
To Amazon Cognito Identity Provider with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon Cognito Identity Provider client CognitoIdentityProvider for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#New
Index ¶
- Constants
- type AccountTakeoverActionType
- type AccountTakeoverActionsType
- type AccountTakeoverEventActionType
- type AccountTakeoverRiskConfigurationType
- type AddCustomAttributesInput
- type AddCustomAttributesOutput
- type AddCustomAttributesRequest
- type AdminAddUserToGroupInput
- type AdminAddUserToGroupOutput
- type AdminAddUserToGroupRequest
- type AdminConfirmSignUpInput
- type AdminConfirmSignUpOutput
- type AdminConfirmSignUpRequest
- type AdminCreateUserConfigType
- type AdminCreateUserInput
- type AdminCreateUserOutput
- type AdminCreateUserRequest
- type AdminDeleteUserAttributesInput
- type AdminDeleteUserAttributesOutput
- type AdminDeleteUserAttributesRequest
- type AdminDeleteUserInput
- type AdminDeleteUserOutput
- type AdminDeleteUserRequest
- type AdminDisableProviderForUserInput
- type AdminDisableProviderForUserOutput
- type AdminDisableProviderForUserRequest
- type AdminDisableUserInput
- type AdminDisableUserOutput
- type AdminDisableUserRequest
- type AdminEnableUserInput
- type AdminEnableUserOutput
- type AdminEnableUserRequest
- type AdminForgetDeviceInput
- type AdminForgetDeviceOutput
- type AdminForgetDeviceRequest
- type AdminGetDeviceInput
- type AdminGetDeviceOutput
- type AdminGetDeviceRequest
- type AdminGetUserInput
- type AdminGetUserOutput
- type AdminGetUserRequest
- type AdminInitiateAuthInput
- type AdminInitiateAuthOutput
- type AdminInitiateAuthRequest
- type AdminLinkProviderForUserInput
- type AdminLinkProviderForUserOutput
- type AdminLinkProviderForUserRequest
- type AdminListDevicesInput
- type AdminListDevicesOutput
- type AdminListDevicesRequest
- type AdminListGroupsForUserInput
- type AdminListGroupsForUserOutput
- type AdminListGroupsForUserRequest
- type AdminListUserAuthEventsInput
- type AdminListUserAuthEventsOutput
- type AdminListUserAuthEventsRequest
- type AdminRemoveUserFromGroupInput
- type AdminRemoveUserFromGroupOutput
- type AdminRemoveUserFromGroupRequest
- type AdminResetUserPasswordInput
- type AdminResetUserPasswordOutput
- type AdminResetUserPasswordRequest
- type AdminRespondToAuthChallengeInput
- type AdminRespondToAuthChallengeOutput
- type AdminRespondToAuthChallengeRequest
- type AdminSetUserMFAPreferenceInput
- type AdminSetUserMFAPreferenceOutput
- type AdminSetUserMFAPreferenceRequest
- type AdminSetUserSettingsInput
- type AdminSetUserSettingsOutput
- type AdminSetUserSettingsRequest
- type AdminUpdateAuthEventFeedbackInput
- type AdminUpdateAuthEventFeedbackOutput
- type AdminUpdateAuthEventFeedbackRequest
- type AdminUpdateDeviceStatusInput
- type AdminUpdateDeviceStatusOutput
- type AdminUpdateDeviceStatusRequest
- type AdminUpdateUserAttributesInput
- type AdminUpdateUserAttributesOutput
- type AdminUpdateUserAttributesRequest
- type AdminUserGlobalSignOutInput
- type AdminUserGlobalSignOutOutput
- type AdminUserGlobalSignOutRequest
- type AdvancedSecurityModeType
- type AliasAttributeType
- type AnalyticsConfigurationType
- type AnalyticsMetadataType
- type AssociateSoftwareTokenInput
- type AssociateSoftwareTokenOutput
- type AssociateSoftwareTokenRequest
- type AttributeDataType
- type AttributeType
- type AuthEventType
- type AuthFlowType
- type AuthenticationResultType
- type ChallengeName
- type ChallengeNameType
- type ChallengeResponse
- type ChallengeResponseType
- type ChangePasswordInput
- type ChangePasswordOutput
- type ChangePasswordRequest
- type CodeDeliveryDetailsType
- type CognitoIdentityProvider
- func (c *CognitoIdentityProvider) AddCustomAttributesRequest(input *AddCustomAttributesInput) AddCustomAttributesRequest
- func (c *CognitoIdentityProvider) AdminAddUserToGroupRequest(input *AdminAddUserToGroupInput) AdminAddUserToGroupRequest
- func (c *CognitoIdentityProvider) AdminConfirmSignUpRequest(input *AdminConfirmSignUpInput) AdminConfirmSignUpRequest
- func (c *CognitoIdentityProvider) AdminCreateUserRequest(input *AdminCreateUserInput) AdminCreateUserRequest
- func (c *CognitoIdentityProvider) AdminDeleteUserAttributesRequest(input *AdminDeleteUserAttributesInput) AdminDeleteUserAttributesRequest
- func (c *CognitoIdentityProvider) AdminDeleteUserRequest(input *AdminDeleteUserInput) AdminDeleteUserRequest
- func (c *CognitoIdentityProvider) AdminDisableProviderForUserRequest(input *AdminDisableProviderForUserInput) AdminDisableProviderForUserRequest
- func (c *CognitoIdentityProvider) AdminDisableUserRequest(input *AdminDisableUserInput) AdminDisableUserRequest
- func (c *CognitoIdentityProvider) AdminEnableUserRequest(input *AdminEnableUserInput) AdminEnableUserRequest
- func (c *CognitoIdentityProvider) AdminForgetDeviceRequest(input *AdminForgetDeviceInput) AdminForgetDeviceRequest
- func (c *CognitoIdentityProvider) AdminGetDeviceRequest(input *AdminGetDeviceInput) AdminGetDeviceRequest
- func (c *CognitoIdentityProvider) AdminGetUserRequest(input *AdminGetUserInput) AdminGetUserRequest
- func (c *CognitoIdentityProvider) AdminInitiateAuthRequest(input *AdminInitiateAuthInput) AdminInitiateAuthRequest
- func (c *CognitoIdentityProvider) AdminLinkProviderForUserRequest(input *AdminLinkProviderForUserInput) AdminLinkProviderForUserRequest
- func (c *CognitoIdentityProvider) AdminListDevicesRequest(input *AdminListDevicesInput) AdminListDevicesRequest
- func (c *CognitoIdentityProvider) AdminListGroupsForUserRequest(input *AdminListGroupsForUserInput) AdminListGroupsForUserRequest
- func (c *CognitoIdentityProvider) AdminListUserAuthEventsRequest(input *AdminListUserAuthEventsInput) AdminListUserAuthEventsRequest
- func (c *CognitoIdentityProvider) AdminRemoveUserFromGroupRequest(input *AdminRemoveUserFromGroupInput) AdminRemoveUserFromGroupRequest
- func (c *CognitoIdentityProvider) AdminResetUserPasswordRequest(input *AdminResetUserPasswordInput) AdminResetUserPasswordRequest
- func (c *CognitoIdentityProvider) AdminRespondToAuthChallengeRequest(input *AdminRespondToAuthChallengeInput) AdminRespondToAuthChallengeRequest
- func (c *CognitoIdentityProvider) AdminSetUserMFAPreferenceRequest(input *AdminSetUserMFAPreferenceInput) AdminSetUserMFAPreferenceRequest
- func (c *CognitoIdentityProvider) AdminSetUserSettingsRequest(input *AdminSetUserSettingsInput) AdminSetUserSettingsRequest
- func (c *CognitoIdentityProvider) AdminUpdateAuthEventFeedbackRequest(input *AdminUpdateAuthEventFeedbackInput) AdminUpdateAuthEventFeedbackRequest
- func (c *CognitoIdentityProvider) AdminUpdateDeviceStatusRequest(input *AdminUpdateDeviceStatusInput) AdminUpdateDeviceStatusRequest
- func (c *CognitoIdentityProvider) AdminUpdateUserAttributesRequest(input *AdminUpdateUserAttributesInput) AdminUpdateUserAttributesRequest
- func (c *CognitoIdentityProvider) AdminUserGlobalSignOutRequest(input *AdminUserGlobalSignOutInput) AdminUserGlobalSignOutRequest
- func (c *CognitoIdentityProvider) AssociateSoftwareTokenRequest(input *AssociateSoftwareTokenInput) AssociateSoftwareTokenRequest
- func (c *CognitoIdentityProvider) ChangePasswordRequest(input *ChangePasswordInput) ChangePasswordRequest
- func (c *CognitoIdentityProvider) ConfirmDeviceRequest(input *ConfirmDeviceInput) ConfirmDeviceRequest
- func (c *CognitoIdentityProvider) ConfirmForgotPasswordRequest(input *ConfirmForgotPasswordInput) ConfirmForgotPasswordRequest
- func (c *CognitoIdentityProvider) ConfirmSignUpRequest(input *ConfirmSignUpInput) ConfirmSignUpRequest
- func (c *CognitoIdentityProvider) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest
- func (c *CognitoIdentityProvider) CreateIdentityProviderRequest(input *CreateIdentityProviderInput) CreateIdentityProviderRequest
- func (c *CognitoIdentityProvider) CreateResourceServerRequest(input *CreateResourceServerInput) CreateResourceServerRequest
- func (c *CognitoIdentityProvider) CreateUserImportJobRequest(input *CreateUserImportJobInput) CreateUserImportJobRequest
- func (c *CognitoIdentityProvider) CreateUserPoolClientRequest(input *CreateUserPoolClientInput) CreateUserPoolClientRequest
- func (c *CognitoIdentityProvider) CreateUserPoolDomainRequest(input *CreateUserPoolDomainInput) CreateUserPoolDomainRequest
- func (c *CognitoIdentityProvider) CreateUserPoolRequest(input *CreateUserPoolInput) CreateUserPoolRequest
- func (c *CognitoIdentityProvider) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest
- func (c *CognitoIdentityProvider) DeleteIdentityProviderRequest(input *DeleteIdentityProviderInput) DeleteIdentityProviderRequest
- func (c *CognitoIdentityProvider) DeleteResourceServerRequest(input *DeleteResourceServerInput) DeleteResourceServerRequest
- func (c *CognitoIdentityProvider) DeleteUserAttributesRequest(input *DeleteUserAttributesInput) DeleteUserAttributesRequest
- func (c *CognitoIdentityProvider) DeleteUserPoolClientRequest(input *DeleteUserPoolClientInput) DeleteUserPoolClientRequest
- func (c *CognitoIdentityProvider) DeleteUserPoolDomainRequest(input *DeleteUserPoolDomainInput) DeleteUserPoolDomainRequest
- func (c *CognitoIdentityProvider) DeleteUserPoolRequest(input *DeleteUserPoolInput) DeleteUserPoolRequest
- func (c *CognitoIdentityProvider) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest
- func (c *CognitoIdentityProvider) DescribeIdentityProviderRequest(input *DescribeIdentityProviderInput) DescribeIdentityProviderRequest
- func (c *CognitoIdentityProvider) DescribeResourceServerRequest(input *DescribeResourceServerInput) DescribeResourceServerRequest
- func (c *CognitoIdentityProvider) DescribeRiskConfigurationRequest(input *DescribeRiskConfigurationInput) DescribeRiskConfigurationRequest
- func (c *CognitoIdentityProvider) DescribeUserImportJobRequest(input *DescribeUserImportJobInput) DescribeUserImportJobRequest
- func (c *CognitoIdentityProvider) DescribeUserPoolClientRequest(input *DescribeUserPoolClientInput) DescribeUserPoolClientRequest
- func (c *CognitoIdentityProvider) DescribeUserPoolDomainRequest(input *DescribeUserPoolDomainInput) DescribeUserPoolDomainRequest
- func (c *CognitoIdentityProvider) DescribeUserPoolRequest(input *DescribeUserPoolInput) DescribeUserPoolRequest
- func (c *CognitoIdentityProvider) ForgetDeviceRequest(input *ForgetDeviceInput) ForgetDeviceRequest
- func (c *CognitoIdentityProvider) ForgotPasswordRequest(input *ForgotPasswordInput) ForgotPasswordRequest
- func (c *CognitoIdentityProvider) GetCSVHeaderRequest(input *GetCSVHeaderInput) GetCSVHeaderRequest
- func (c *CognitoIdentityProvider) GetDeviceRequest(input *GetDeviceInput) GetDeviceRequest
- func (c *CognitoIdentityProvider) GetGroupRequest(input *GetGroupInput) GetGroupRequest
- func (c *CognitoIdentityProvider) GetIdentityProviderByIdentifierRequest(input *GetIdentityProviderByIdentifierInput) GetIdentityProviderByIdentifierRequest
- func (c *CognitoIdentityProvider) GetSigningCertificateRequest(input *GetSigningCertificateInput) GetSigningCertificateRequest
- func (c *CognitoIdentityProvider) GetUICustomizationRequest(input *GetUICustomizationInput) GetUICustomizationRequest
- func (c *CognitoIdentityProvider) GetUserAttributeVerificationCodeRequest(input *GetUserAttributeVerificationCodeInput) GetUserAttributeVerificationCodeRequest
- func (c *CognitoIdentityProvider) GetUserPoolMfaConfigRequest(input *GetUserPoolMfaConfigInput) GetUserPoolMfaConfigRequest
- func (c *CognitoIdentityProvider) GetUserRequest(input *GetUserInput) GetUserRequest
- func (c *CognitoIdentityProvider) GlobalSignOutRequest(input *GlobalSignOutInput) GlobalSignOutRequest
- func (c *CognitoIdentityProvider) InitiateAuthRequest(input *InitiateAuthInput) InitiateAuthRequest
- func (c *CognitoIdentityProvider) ListDevicesRequest(input *ListDevicesInput) ListDevicesRequest
- func (c *CognitoIdentityProvider) ListGroupsRequest(input *ListGroupsInput) ListGroupsRequest
- func (c *CognitoIdentityProvider) ListIdentityProvidersRequest(input *ListIdentityProvidersInput) ListIdentityProvidersRequest
- func (c *CognitoIdentityProvider) ListResourceServersRequest(input *ListResourceServersInput) ListResourceServersRequest
- func (c *CognitoIdentityProvider) ListUserImportJobsRequest(input *ListUserImportJobsInput) ListUserImportJobsRequest
- func (c *CognitoIdentityProvider) ListUserPoolClientsRequest(input *ListUserPoolClientsInput) ListUserPoolClientsRequest
- func (c *CognitoIdentityProvider) ListUserPoolsRequest(input *ListUserPoolsInput) ListUserPoolsRequest
- func (c *CognitoIdentityProvider) ListUsersInGroupRequest(input *ListUsersInGroupInput) ListUsersInGroupRequest
- func (c *CognitoIdentityProvider) ListUsersRequest(input *ListUsersInput) ListUsersRequest
- func (c *CognitoIdentityProvider) ResendConfirmationCodeRequest(input *ResendConfirmationCodeInput) ResendConfirmationCodeRequest
- func (c *CognitoIdentityProvider) RespondToAuthChallengeRequest(input *RespondToAuthChallengeInput) RespondToAuthChallengeRequest
- func (c *CognitoIdentityProvider) SetRiskConfigurationRequest(input *SetRiskConfigurationInput) SetRiskConfigurationRequest
- func (c *CognitoIdentityProvider) SetUICustomizationRequest(input *SetUICustomizationInput) SetUICustomizationRequest
- func (c *CognitoIdentityProvider) SetUserMFAPreferenceRequest(input *SetUserMFAPreferenceInput) SetUserMFAPreferenceRequest
- func (c *CognitoIdentityProvider) SetUserPoolMfaConfigRequest(input *SetUserPoolMfaConfigInput) SetUserPoolMfaConfigRequest
- func (c *CognitoIdentityProvider) SetUserSettingsRequest(input *SetUserSettingsInput) SetUserSettingsRequest
- func (c *CognitoIdentityProvider) SignUpRequest(input *SignUpInput) SignUpRequest
- func (c *CognitoIdentityProvider) StartUserImportJobRequest(input *StartUserImportJobInput) StartUserImportJobRequest
- func (c *CognitoIdentityProvider) StopUserImportJobRequest(input *StopUserImportJobInput) StopUserImportJobRequest
- func (c *CognitoIdentityProvider) UpdateAuthEventFeedbackRequest(input *UpdateAuthEventFeedbackInput) UpdateAuthEventFeedbackRequest
- func (c *CognitoIdentityProvider) UpdateDeviceStatusRequest(input *UpdateDeviceStatusInput) UpdateDeviceStatusRequest
- func (c *CognitoIdentityProvider) UpdateGroupRequest(input *UpdateGroupInput) UpdateGroupRequest
- func (c *CognitoIdentityProvider) UpdateIdentityProviderRequest(input *UpdateIdentityProviderInput) UpdateIdentityProviderRequest
- func (c *CognitoIdentityProvider) UpdateResourceServerRequest(input *UpdateResourceServerInput) UpdateResourceServerRequest
- func (c *CognitoIdentityProvider) UpdateUserAttributesRequest(input *UpdateUserAttributesInput) UpdateUserAttributesRequest
- func (c *CognitoIdentityProvider) UpdateUserPoolClientRequest(input *UpdateUserPoolClientInput) UpdateUserPoolClientRequest
- func (c *CognitoIdentityProvider) UpdateUserPoolRequest(input *UpdateUserPoolInput) UpdateUserPoolRequest
- func (c *CognitoIdentityProvider) VerifySoftwareTokenRequest(input *VerifySoftwareTokenInput) VerifySoftwareTokenRequest
- func (c *CognitoIdentityProvider) VerifyUserAttributeRequest(input *VerifyUserAttributeInput) VerifyUserAttributeRequest
- type CompromisedCredentialsActionsType
- type CompromisedCredentialsEventActionType
- type CompromisedCredentialsRiskConfigurationType
- type ConfirmDeviceInput
- type ConfirmDeviceOutput
- type ConfirmDeviceRequest
- type ConfirmForgotPasswordInput
- type ConfirmForgotPasswordOutput
- type ConfirmForgotPasswordRequest
- type ConfirmSignUpInput
- type ConfirmSignUpOutput
- type ConfirmSignUpRequest
- type ContextDataType
- type CreateGroupInput
- type CreateGroupOutput
- type CreateGroupRequest
- type CreateIdentityProviderInput
- type CreateIdentityProviderOutput
- type CreateIdentityProviderRequest
- type CreateResourceServerInput
- type CreateResourceServerOutput
- type CreateResourceServerRequest
- type CreateUserImportJobInput
- type CreateUserImportJobOutput
- type CreateUserImportJobRequest
- type CreateUserPoolClientInput
- type CreateUserPoolClientOutput
- type CreateUserPoolClientRequest
- type CreateUserPoolDomainInput
- type CreateUserPoolDomainOutput
- type CreateUserPoolDomainRequest
- type CreateUserPoolInput
- type CreateUserPoolOutput
- type CreateUserPoolRequest
- type DefaultEmailOptionType
- type DeleteGroupInput
- type DeleteGroupOutput
- type DeleteGroupRequest
- type DeleteIdentityProviderInput
- type DeleteIdentityProviderOutput
- type DeleteIdentityProviderRequest
- type DeleteResourceServerInput
- type DeleteResourceServerOutput
- type DeleteResourceServerRequest
- type DeleteUserAttributesInput
- type DeleteUserAttributesOutput
- type DeleteUserAttributesRequest
- type DeleteUserInput
- type DeleteUserOutput
- type DeleteUserPoolClientInput
- type DeleteUserPoolClientOutput
- type DeleteUserPoolClientRequest
- type DeleteUserPoolDomainInput
- type DeleteUserPoolDomainOutput
- type DeleteUserPoolDomainRequest
- type DeleteUserPoolInput
- type DeleteUserPoolOutput
- type DeleteUserPoolRequest
- type DeleteUserRequest
- type DeliveryMediumType
- type DescribeIdentityProviderInput
- type DescribeIdentityProviderOutput
- type DescribeIdentityProviderRequest
- type DescribeResourceServerInput
- type DescribeResourceServerOutput
- type DescribeResourceServerRequest
- type DescribeRiskConfigurationInput
- type DescribeRiskConfigurationOutput
- type DescribeRiskConfigurationRequest
- type DescribeUserImportJobInput
- type DescribeUserImportJobOutput
- type DescribeUserImportJobRequest
- type DescribeUserPoolClientInput
- type DescribeUserPoolClientOutput
- type DescribeUserPoolClientRequest
- type DescribeUserPoolDomainInput
- type DescribeUserPoolDomainOutput
- type DescribeUserPoolDomainRequest
- type DescribeUserPoolInput
- type DescribeUserPoolOutput
- type DescribeUserPoolRequest
- type DeviceConfigurationType
- type DeviceRememberedStatusType
- type DeviceSecretVerifierConfigType
- type DeviceType
- type DomainDescriptionType
- type DomainStatusType
- type EmailConfigurationType
- type EventContextDataType
- type EventFeedbackType
- type EventFilterType
- type EventResponseType
- type EventRiskType
- type EventType
- type ExplicitAuthFlowsType
- type FeedbackValueType
- type ForgetDeviceInput
- type ForgetDeviceOutput
- type ForgetDeviceRequest
- type ForgotPasswordInput
- type ForgotPasswordOutput
- type ForgotPasswordRequest
- type GetCSVHeaderInput
- type GetCSVHeaderOutput
- type GetCSVHeaderRequest
- type GetDeviceInput
- type GetDeviceOutput
- type GetDeviceRequest
- type GetGroupInput
- type GetGroupOutput
- type GetGroupRequest
- type GetIdentityProviderByIdentifierInput
- type GetIdentityProviderByIdentifierOutput
- type GetIdentityProviderByIdentifierRequest
- type GetSigningCertificateInput
- type GetSigningCertificateOutput
- type GetSigningCertificateRequest
- type GetUICustomizationInput
- type GetUICustomizationOutput
- type GetUICustomizationRequest
- type GetUserAttributeVerificationCodeInput
- type GetUserAttributeVerificationCodeOutput
- type GetUserAttributeVerificationCodeRequest
- type GetUserInput
- type GetUserOutput
- type GetUserPoolMfaConfigInput
- type GetUserPoolMfaConfigOutput
- type GetUserPoolMfaConfigRequest
- type GetUserRequest
- type GlobalSignOutInput
- type GlobalSignOutOutput
- type GlobalSignOutRequest
- type GroupType
- type HttpHeader
- type IdentityProviderType
- type IdentityProviderTypeType
- type InitiateAuthInput
- type InitiateAuthOutput
- type InitiateAuthRequest
- type LambdaConfigType
- type ListDevicesInput
- type ListDevicesOutput
- type ListDevicesRequest
- type ListGroupsInput
- type ListGroupsOutput
- type ListGroupsRequest
- type ListIdentityProvidersInput
- type ListIdentityProvidersOutput
- type ListIdentityProvidersRequest
- type ListResourceServersInput
- type ListResourceServersOutput
- type ListResourceServersRequest
- type ListUserImportJobsInput
- type ListUserImportJobsOutput
- type ListUserImportJobsRequest
- type ListUserPoolClientsInput
- type ListUserPoolClientsOutput
- type ListUserPoolClientsRequest
- type ListUserPoolsInput
- type ListUserPoolsOutput
- type ListUserPoolsRequest
- type ListUsersInGroupInput
- type ListUsersInGroupOutput
- type ListUsersInGroupRequest
- type ListUsersInput
- type ListUsersOutput
- type ListUsersRequest
- type MFAOptionType
- type MessageActionType
- type MessageTemplateType
- type NewDeviceMetadataType
- type NotifyConfigurationType
- type NotifyEmailType
- type NumberAttributeConstraintsType
- type OAuthFlowType
- type PasswordPolicyType
- type ProviderDescription
- type ProviderUserIdentifierType
- type ResendConfirmationCodeInput
- type ResendConfirmationCodeOutput
- type ResendConfirmationCodeRequest
- type ResourceServerScopeType
- type ResourceServerType
- type RespondToAuthChallengeInput
- type RespondToAuthChallengeOutput
- type RespondToAuthChallengeRequest
- type RiskConfigurationType
- type RiskDecisionType
- type RiskExceptionConfigurationType
- type RiskLevelType
- type SMSMfaSettingsType
- type SchemaAttributeType
- type SetRiskConfigurationInput
- type SetRiskConfigurationOutput
- type SetRiskConfigurationRequest
- type SetUICustomizationInput
- type SetUICustomizationOutput
- type SetUICustomizationRequest
- type SetUserMFAPreferenceInput
- type SetUserMFAPreferenceOutput
- type SetUserMFAPreferenceRequest
- type SetUserPoolMfaConfigInput
- type SetUserPoolMfaConfigOutput
- type SetUserPoolMfaConfigRequest
- type SetUserSettingsInput
- type SetUserSettingsOutput
- type SetUserSettingsRequest
- type SignUpInput
- type SignUpOutput
- type SignUpRequest
- type SmsConfigurationType
- type SmsMfaConfigType
- type SoftwareTokenMfaConfigType
- type SoftwareTokenMfaSettingsType
- type StartUserImportJobInput
- type StartUserImportJobOutput
- type StartUserImportJobRequest
- type StatusType
- type StopUserImportJobInput
- type StopUserImportJobOutput
- type StopUserImportJobRequest
- type StringAttributeConstraintsType
- type UICustomizationType
- type UpdateAuthEventFeedbackInput
- type UpdateAuthEventFeedbackOutput
- type UpdateAuthEventFeedbackRequest
- type UpdateDeviceStatusInput
- type UpdateDeviceStatusOutput
- type UpdateDeviceStatusRequest
- type UpdateGroupInput
- type UpdateGroupOutput
- type UpdateGroupRequest
- type UpdateIdentityProviderInput
- type UpdateIdentityProviderOutput
- type UpdateIdentityProviderRequest
- type UpdateResourceServerInput
- type UpdateResourceServerOutput
- type UpdateResourceServerRequest
- type UpdateUserAttributesInput
- type UpdateUserAttributesOutput
- type UpdateUserAttributesRequest
- type UpdateUserPoolClientInput
- type UpdateUserPoolClientOutput
- type UpdateUserPoolClientRequest
- type UpdateUserPoolInput
- type UpdateUserPoolOutput
- type UpdateUserPoolRequest
- type UserContextDataType
- type UserImportJobStatusType
- type UserImportJobType
- type UserPoolAddOnsType
- type UserPoolClientDescription
- type UserPoolClientType
- type UserPoolDescriptionType
- type UserPoolMfaType
- type UserPoolPolicyType
- type UserPoolType
- type UserStatusType
- type UserType
- type UsernameAttributeType
- type VerificationMessageTemplateType
- type VerifiedAttributeType
- type VerifySoftwareTokenInput
- type VerifySoftwareTokenOutput
- type VerifySoftwareTokenRequest
- type VerifySoftwareTokenResponseType
- type VerifyUserAttributeInput
- type VerifyUserAttributeOutput
- type VerifyUserAttributeRequest
Constants ¶
const ( // ErrCodeAliasExistsException for service response error code // "AliasExistsException". // // This exception is thrown when a user tries to confirm the account with an // email or phone number that has already been supplied as an alias from a different // account. This exception tells user that an account with this email or phone // already exists. ErrCodeAliasExistsException = "AliasExistsException" // ErrCodeCodeDeliveryFailureException for service response error code // "CodeDeliveryFailureException". // // This exception is thrown when a verification code fails to deliver successfully. ErrCodeCodeDeliveryFailureException = "CodeDeliveryFailureException" // ErrCodeCodeMismatchException for service response error code // "CodeMismatchException". // // This exception is thrown if the provided code does not match what the server // was expecting. ErrCodeCodeMismatchException = "CodeMismatchException" // ErrCodeConcurrentModificationException for service response error code // "ConcurrentModificationException". // // This exception is thrown if two or more modifications are happening concurrently. ErrCodeConcurrentModificationException = "ConcurrentModificationException" // ErrCodeDuplicateProviderException for service response error code // "DuplicateProviderException". // // This exception is thrown when the provider is already supported by the user // pool. ErrCodeDuplicateProviderException = "DuplicateProviderException" // ErrCodeEnableSoftwareTokenMFAException for service response error code // "EnableSoftwareTokenMFAException". // // This exception is thrown when there is a code mismatch and the service fails // to configure the software token TOTP multi-factor authentication (MFA). ErrCodeEnableSoftwareTokenMFAException = "EnableSoftwareTokenMFAException" // ErrCodeExpiredCodeException for service response error code // "ExpiredCodeException". // // This exception is thrown if a code has expired. ErrCodeExpiredCodeException = "ExpiredCodeException" // ErrCodeGroupExistsException for service response error code // "GroupExistsException". // // This exception is thrown when Amazon Cognito encounters a group that already // exists in the user pool. ErrCodeGroupExistsException = "GroupExistsException" // ErrCodeInternalErrorException for service response error code // "InternalErrorException". // // This exception is thrown when Amazon Cognito encounters an internal error. ErrCodeInternalErrorException = "InternalErrorException" // ErrCodeInvalidEmailRoleAccessPolicyException for service response error code // "InvalidEmailRoleAccessPolicyException". // // This exception is thrown when Amazon Cognito is not allowed to use your email // identity. HTTP status code: 400. ErrCodeInvalidEmailRoleAccessPolicyException = "InvalidEmailRoleAccessPolicyException" // ErrCodeInvalidLambdaResponseException for service response error code // "InvalidLambdaResponseException". // // This exception is thrown when the Amazon Cognito service encounters an invalid // AWS Lambda response. ErrCodeInvalidLambdaResponseException = "InvalidLambdaResponseException" // ErrCodeInvalidOAuthFlowException for service response error code // "InvalidOAuthFlowException". // // This exception is thrown when the specified OAuth flow is invalid. ErrCodeInvalidOAuthFlowException = "InvalidOAuthFlowException" // ErrCodeInvalidParameterException for service response error code // "InvalidParameterException". // // This exception is thrown when the Amazon Cognito service encounters an invalid // parameter. ErrCodeInvalidParameterException = "InvalidParameterException" // ErrCodeInvalidPasswordException for service response error code // "InvalidPasswordException". // // This exception is thrown when the Amazon Cognito service encounters an invalid // password. ErrCodeInvalidPasswordException = "InvalidPasswordException" // ErrCodeInvalidSmsRoleAccessPolicyException for service response error code // "InvalidSmsRoleAccessPolicyException". // // This exception is returned when the role provided for SMS configuration does // not have permission to publish using Amazon SNS. ErrCodeInvalidSmsRoleAccessPolicyException = "InvalidSmsRoleAccessPolicyException" // ErrCodeInvalidSmsRoleTrustRelationshipException for service response error code // "InvalidSmsRoleTrustRelationshipException". // // This exception is thrown when the trust relationship is invalid for the role // provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com // or the external ID provided in the role does not match what is provided in // the SMS configuration for the user pool. ErrCodeInvalidSmsRoleTrustRelationshipException = "InvalidSmsRoleTrustRelationshipException" // ErrCodeInvalidUserPoolConfigurationException for service response error code // "InvalidUserPoolConfigurationException". // // This exception is thrown when the user pool configuration is invalid. ErrCodeInvalidUserPoolConfigurationException = "InvalidUserPoolConfigurationException" // ErrCodeLimitExceededException for service response error code // "LimitExceededException". // // This exception is thrown when a user exceeds the limit for a requested AWS // resource. ErrCodeLimitExceededException = "LimitExceededException" // ErrCodeMFAMethodNotFoundException for service response error code // "MFAMethodNotFoundException". // // This exception is thrown when Amazon Cognito cannot find a multi-factor authentication // (MFA) method. ErrCodeMFAMethodNotFoundException = "MFAMethodNotFoundException" // ErrCodeNotAuthorizedException for service response error code // "NotAuthorizedException". // // This exception is thrown when a user is not authorized. ErrCodeNotAuthorizedException = "NotAuthorizedException" // ErrCodePasswordResetRequiredException for service response error code // "PasswordResetRequiredException". // // This exception is thrown when a password reset is required. ErrCodePasswordResetRequiredException = "PasswordResetRequiredException" // ErrCodePreconditionNotMetException for service response error code // "PreconditionNotMetException". // // This exception is thrown when a precondition is not met. ErrCodePreconditionNotMetException = "PreconditionNotMetException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // This exception is thrown when the Amazon Cognito service cannot find the // requested resource. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeScopeDoesNotExistException for service response error code // "ScopeDoesNotExistException". // // This exception is thrown when the specified scope does not exist. ErrCodeScopeDoesNotExistException = "ScopeDoesNotExistException" // ErrCodeSoftwareTokenMFANotFoundException for service response error code // "SoftwareTokenMFANotFoundException". // // This exception is thrown when the software token TOTP multi-factor authentication // (MFA) is not enabled for the user pool. ErrCodeSoftwareTokenMFANotFoundException = "SoftwareTokenMFANotFoundException" // ErrCodeTooManyFailedAttemptsException for service response error code // "TooManyFailedAttemptsException". // // This exception is thrown when the user has made too many failed attempts // for a given action (e.g., sign in). ErrCodeTooManyFailedAttemptsException = "TooManyFailedAttemptsException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". // // This exception is thrown when the user has made too many requests for a given // operation. ErrCodeTooManyRequestsException = "TooManyRequestsException" // ErrCodeUnexpectedLambdaException for service response error code // "UnexpectedLambdaException". // // This exception is thrown when the Amazon Cognito service encounters an unexpected // exception with the AWS Lambda service. ErrCodeUnexpectedLambdaException = "UnexpectedLambdaException" // ErrCodeUnsupportedIdentityProviderException for service response error code // "UnsupportedIdentityProviderException". // // This exception is thrown when the specified identifier is not supported. ErrCodeUnsupportedIdentityProviderException = "UnsupportedIdentityProviderException" // ErrCodeUnsupportedUserStateException for service response error code // "UnsupportedUserStateException". // // The request failed because the user is in an unsupported state. ErrCodeUnsupportedUserStateException = "UnsupportedUserStateException" // ErrCodeUserImportInProgressException for service response error code // "UserImportInProgressException". // // This exception is thrown when you are trying to modify a user pool while // a user import job is in progress for that pool. ErrCodeUserImportInProgressException = "UserImportInProgressException" // ErrCodeUserLambdaValidationException for service response error code // "UserLambdaValidationException". // // This exception is thrown when the Amazon Cognito service encounters a user // validation exception with the AWS Lambda service. ErrCodeUserLambdaValidationException = "UserLambdaValidationException" // ErrCodeUserNotConfirmedException for service response error code // "UserNotConfirmedException". // // This exception is thrown when a user is not confirmed successfully. ErrCodeUserNotConfirmedException = "UserNotConfirmedException" // ErrCodeUserNotFoundException for service response error code // "UserNotFoundException". // // This exception is thrown when a user is not found. ErrCodeUserNotFoundException = "UserNotFoundException" // ErrCodeUserPoolAddOnNotEnabledException for service response error code // "UserPoolAddOnNotEnabledException". // // This exception is thrown when user pool add-ons are not enabled. ErrCodeUserPoolAddOnNotEnabledException = "UserPoolAddOnNotEnabledException" // ErrCodeUserPoolTaggingException for service response error code // "UserPoolTaggingException". // // This exception is thrown when a user pool tag cannot be set or updated. ErrCodeUserPoolTaggingException = "UserPoolTaggingException" // ErrCodeUsernameExistsException for service response error code // "UsernameExistsException". // // This exception is thrown when Amazon Cognito encounters a user name that // already exists in the user pool. ErrCodeUsernameExistsException = "UsernameExistsException" )
const ( ServiceName = "cognito-idp" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountTakeoverActionType ¶
type AccountTakeoverActionType struct { // The event action. // // * BLOCK Choosing this action will block the request. // // * MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else // allow the request. // // * MFA_REQUIRED Throw MFA challenge if user has configured it, else block // the request. // // * NO_ACTION Allow the user sign-in. // // EventAction is a required field EventAction AccountTakeoverEventActionType `type:"string" required:"true" enum:"true"` // Flag specifying whether to send a notification. // // Notify is a required field Notify *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
Account takeover action type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AccountTakeoverActionType
func (AccountTakeoverActionType) GoString ¶
func (s AccountTakeoverActionType) GoString() string
GoString returns the string representation
func (AccountTakeoverActionType) String ¶
func (s AccountTakeoverActionType) String() string
String returns the string representation
func (*AccountTakeoverActionType) Validate ¶
func (s *AccountTakeoverActionType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AccountTakeoverActionsType ¶
type AccountTakeoverActionsType struct { // Action to take for a high risk. HighAction *AccountTakeoverActionType `type:"structure"` // Action to take for a low risk. LowAction *AccountTakeoverActionType `type:"structure"` // Action to take for a medium risk. MediumAction *AccountTakeoverActionType `type:"structure"` // contains filtered or unexported fields }
Account takeover actions type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AccountTakeoverActionsType
func (AccountTakeoverActionsType) GoString ¶
func (s AccountTakeoverActionsType) GoString() string
GoString returns the string representation
func (AccountTakeoverActionsType) String ¶
func (s AccountTakeoverActionsType) String() string
String returns the string representation
func (*AccountTakeoverActionsType) Validate ¶
func (s *AccountTakeoverActionsType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AccountTakeoverEventActionType ¶
type AccountTakeoverEventActionType string
const ( AccountTakeoverEventActionTypeBlock AccountTakeoverEventActionType = "BLOCK" AccountTakeoverEventActionTypeMfaIfConfigured AccountTakeoverEventActionType = "MFA_IF_CONFIGURED" AccountTakeoverEventActionTypeMfaRequired AccountTakeoverEventActionType = "MFA_REQUIRED" AccountTakeoverEventActionTypeNoAction AccountTakeoverEventActionType = "NO_ACTION" )
Enum values for AccountTakeoverEventActionType
func (AccountTakeoverEventActionType) MarshalValue ¶
func (enum AccountTakeoverEventActionType) MarshalValue() (string, error)
func (AccountTakeoverEventActionType) MarshalValueBuf ¶
func (enum AccountTakeoverEventActionType) MarshalValueBuf(b []byte) ([]byte, error)
type AccountTakeoverRiskConfigurationType ¶
type AccountTakeoverRiskConfigurationType struct { // Account takeover risk configuration actions // // Actions is a required field Actions *AccountTakeoverActionsType `type:"structure" required:"true"` // The notify configuration used to construct email notifications. NotifyConfiguration *NotifyConfigurationType `type:"structure"` // contains filtered or unexported fields }
Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AccountTakeoverRiskConfigurationType
func (AccountTakeoverRiskConfigurationType) GoString ¶
func (s AccountTakeoverRiskConfigurationType) GoString() string
GoString returns the string representation
func (AccountTakeoverRiskConfigurationType) String ¶
func (s AccountTakeoverRiskConfigurationType) String() string
String returns the string representation
func (*AccountTakeoverRiskConfigurationType) Validate ¶
func (s *AccountTakeoverRiskConfigurationType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddCustomAttributesInput ¶
type AddCustomAttributesInput struct { // An array of custom attributes, such as Mutable and Name. // // CustomAttributes is a required field CustomAttributes []SchemaAttributeType `min:"1" type:"list" required:"true"` // The user pool ID for the user pool where you want to add custom attributes. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to add custom attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AddCustomAttributesRequest
func (AddCustomAttributesInput) GoString ¶
func (s AddCustomAttributesInput) GoString() string
GoString returns the string representation
func (AddCustomAttributesInput) String ¶
func (s AddCustomAttributesInput) String() string
String returns the string representation
func (*AddCustomAttributesInput) Validate ¶
func (s *AddCustomAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddCustomAttributesOutput ¶
type AddCustomAttributesOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server for the request to add custom attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AddCustomAttributesResponse
func (AddCustomAttributesOutput) GoString ¶
func (s AddCustomAttributesOutput) GoString() string
GoString returns the string representation
func (AddCustomAttributesOutput) SDKResponseMetadata ¶
func (s AddCustomAttributesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AddCustomAttributesOutput) String ¶
func (s AddCustomAttributesOutput) String() string
String returns the string representation
type AddCustomAttributesRequest ¶
type AddCustomAttributesRequest struct { *aws.Request Input *AddCustomAttributesInput Copy func(*AddCustomAttributesInput) AddCustomAttributesRequest }
AddCustomAttributesRequest is a API request type for the AddCustomAttributes API operation.
func (AddCustomAttributesRequest) Send ¶
func (r AddCustomAttributesRequest) Send() (*AddCustomAttributesOutput, error)
Send marshals and sends the AddCustomAttributes API request.
type AdminAddUserToGroupInput ¶
type AdminAddUserToGroupInput struct { // The group name. // // GroupName is a required field GroupName *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The username for the user. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminAddUserToGroupRequest
func (AdminAddUserToGroupInput) GoString ¶
func (s AdminAddUserToGroupInput) GoString() string
GoString returns the string representation
func (AdminAddUserToGroupInput) String ¶
func (s AdminAddUserToGroupInput) String() string
String returns the string representation
func (*AdminAddUserToGroupInput) Validate ¶
func (s *AdminAddUserToGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminAddUserToGroupOutput ¶
type AdminAddUserToGroupOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminAddUserToGroupOutput
func (AdminAddUserToGroupOutput) GoString ¶
func (s AdminAddUserToGroupOutput) GoString() string
GoString returns the string representation
func (AdminAddUserToGroupOutput) SDKResponseMetadata ¶
func (s AdminAddUserToGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminAddUserToGroupOutput) String ¶
func (s AdminAddUserToGroupOutput) String() string
String returns the string representation
type AdminAddUserToGroupRequest ¶
type AdminAddUserToGroupRequest struct { *aws.Request Input *AdminAddUserToGroupInput Copy func(*AdminAddUserToGroupInput) AdminAddUserToGroupRequest }
AdminAddUserToGroupRequest is a API request type for the AdminAddUserToGroup API operation.
func (AdminAddUserToGroupRequest) Send ¶
func (r AdminAddUserToGroupRequest) Send() (*AdminAddUserToGroupOutput, error)
Send marshals and sends the AdminAddUserToGroup API request.
type AdminConfirmSignUpInput ¶
type AdminConfirmSignUpInput struct { // The user pool ID for which you want to confirm user registration. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name for which you want to confirm user registration. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to confirm user registration. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminConfirmSignUpRequest
func (AdminConfirmSignUpInput) GoString ¶
func (s AdminConfirmSignUpInput) GoString() string
GoString returns the string representation
func (AdminConfirmSignUpInput) String ¶
func (s AdminConfirmSignUpInput) String() string
String returns the string representation
func (*AdminConfirmSignUpInput) Validate ¶
func (s *AdminConfirmSignUpInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminConfirmSignUpOutput ¶
type AdminConfirmSignUpOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server for the request to confirm registration. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminConfirmSignUpResponse
func (AdminConfirmSignUpOutput) GoString ¶
func (s AdminConfirmSignUpOutput) GoString() string
GoString returns the string representation
func (AdminConfirmSignUpOutput) SDKResponseMetadata ¶
func (s AdminConfirmSignUpOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminConfirmSignUpOutput) String ¶
func (s AdminConfirmSignUpOutput) String() string
String returns the string representation
type AdminConfirmSignUpRequest ¶
type AdminConfirmSignUpRequest struct { *aws.Request Input *AdminConfirmSignUpInput Copy func(*AdminConfirmSignUpInput) AdminConfirmSignUpRequest }
AdminConfirmSignUpRequest is a API request type for the AdminConfirmSignUp API operation.
func (AdminConfirmSignUpRequest) Send ¶
func (r AdminConfirmSignUpRequest) Send() (*AdminConfirmSignUpOutput, error)
Send marshals and sends the AdminConfirmSignUp API request.
type AdminCreateUserConfigType ¶
type AdminCreateUserConfigType struct { // Set to True if only the administrator is allowed to create user profiles. // Set to False if users can sign themselves up via an app. AllowAdminCreateUserOnly *bool `type:"boolean"` // The message template to be used for the welcome message to new users. // // See also Customizing User Invitation Messages (http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization). InviteMessageTemplate *MessageTemplateType `type:"structure"` // The user account expiration limit, in days, after which the account is no // longer usable. To reset the account after that time limit, you must call // AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. // The default value for this parameter is 7. UnusedAccountValidityDays *int64 `type:"integer"` // contains filtered or unexported fields }
The configuration for creating a new user profile. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUserConfigType
func (AdminCreateUserConfigType) GoString ¶
func (s AdminCreateUserConfigType) GoString() string
GoString returns the string representation
func (AdminCreateUserConfigType) String ¶
func (s AdminCreateUserConfigType) String() string
String returns the string representation
func (*AdminCreateUserConfigType) Validate ¶
func (s *AdminCreateUserConfigType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminCreateUserInput ¶
type AdminCreateUserInput struct { // 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 []DeliveryMediumType `type:"list"` // This parameter is only used if the phone_number_verified or email_verified // attribute is set to True. Otherwise, it is ignored. // // If this parameter is set to True and the phone number or email address specified // in the UserAttributes parameter already exists as an alias with a different // user, the API call will migrate the alias from the previous user to the newly // created user. The previous user will no longer be able to log in using that // alias. // // If this parameter is set to False, the API throws an AliasExistsException // error if the alias already exists. The default value is False. ForceAliasCreation *bool `type:"boolean"` // Set to "RESEND" to resend the invitation message to a user that already exists // and reset the expiration limit on the user's account. Set to "SUPPRESS" to // suppress sending the message. Only one value can be specified. MessageAction MessageActionType `type:"string" enum:"true"` // The user's temporary password. This password must conform to the password // policy that you specified when you created the user pool. // // The temporary password is valid only once. To complete the Admin Create User // flow, the user must enter the temporary password in the sign-in page along // with a new password to be used in all future sign-ins. // // This parameter is not required. If you do not specify a value, Amazon Cognito // generates one for you. // // The temporary password can only be used until the user account expiration // limit that you specified when you created the user pool. To reset the account // after that time limit, you must call AdminCreateUser again, specifying "RESEND" // for the MessageAction parameter. TemporaryPassword *string `min:"6" type:"string"` // An array of name-value pairs that contain user attributes and attribute values // to be set for the user to be created. You can create a user without specifying // any attributes other than Username. However, any attributes that you specify // as required (in or in the Attributes tab of the console) must be supplied // either by you (in your call to AdminCreateUser) or by the user (when he or // she signs up in response to your welcome message). // // For custom attributes, you must prepend the custom: prefix to the attribute // name. // // To send a message inviting the user to sign up, you must specify the user's // email address or phone number. This can be done in your call to AdminCreateUser // or in the Users tab of the Amazon Cognito console for managing your user // pools. // // In your call to AdminCreateUser, you can set the email_verified attribute // to True, and you can set the phone_number_verified attribute to True. (You // can also do this by calling .) // // * email: The email address of the user to whom the message that contains // the code and username will be sent. Required if the email_verified attribute // is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums // parameter. // // * phone_number: The phone number of the user to whom the message that // contains the code and username will be sent. Required if the phone_number_verified // attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums // parameter. UserAttributes []AttributeType `type:"list"` // The user pool ID for the user pool where the user will be created. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The username for the user. Must be unique within the user pool. Must be a // UTF-8 string between 1 and 128 characters. After the user is created, the // username cannot be changed. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // The user's validation data. This is an array of name-value pairs that contain // user attributes and attribute values that you can use for custom validation, // such as restricting the types of user accounts that can be registered. For // example, you might choose to allow or disallow user sign-up based on the // user's domain. // // To configure custom validation, you must create a Pre Sign-up Lambda trigger // for the user pool as described in the Amazon Cognito Developer Guide. The // Lambda trigger receives the validation data and uses it in the validation // process. // // The user's validation data is not persisted. ValidationData []AttributeType `type:"list"` // contains filtered or unexported fields }
Represents the request to create a user in the specified user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUserRequest
func (AdminCreateUserInput) GoString ¶
func (s AdminCreateUserInput) GoString() string
GoString returns the string representation
func (AdminCreateUserInput) String ¶
func (s AdminCreateUserInput) String() string
String returns the string representation
func (*AdminCreateUserInput) Validate ¶
func (s *AdminCreateUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminCreateUserOutput ¶
type AdminCreateUserOutput struct { // The newly created user. User *UserType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server to the request to create the user. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUserResponse
func (AdminCreateUserOutput) GoString ¶
func (s AdminCreateUserOutput) GoString() string
GoString returns the string representation
func (AdminCreateUserOutput) SDKResponseMetadata ¶
func (s AdminCreateUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminCreateUserOutput) String ¶
func (s AdminCreateUserOutput) String() string
String returns the string representation
type AdminCreateUserRequest ¶
type AdminCreateUserRequest struct { *aws.Request Input *AdminCreateUserInput Copy func(*AdminCreateUserInput) AdminCreateUserRequest }
AdminCreateUserRequest is a API request type for the AdminCreateUser API operation.
func (AdminCreateUserRequest) Send ¶
func (r AdminCreateUserRequest) Send() (*AdminCreateUserOutput, error)
Send marshals and sends the AdminCreateUser API request.
type AdminDeleteUserAttributesInput ¶
type AdminDeleteUserAttributesInput struct { // An array of strings representing the user attribute names you wish to delete. // // For custom attributes, you must prepend the custom: prefix to the attribute // name. // // UserAttributeNames is a required field UserAttributeNames []string `type:"list" required:"true"` // The user pool ID for the user pool where you want to delete user attributes. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name of the user from which you would like to delete attributes. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to delete user attributes as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserAttributesRequest
func (AdminDeleteUserAttributesInput) GoString ¶
func (s AdminDeleteUserAttributesInput) GoString() string
GoString returns the string representation
func (AdminDeleteUserAttributesInput) String ¶
func (s AdminDeleteUserAttributesInput) String() string
String returns the string representation
func (*AdminDeleteUserAttributesInput) Validate ¶
func (s *AdminDeleteUserAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminDeleteUserAttributesOutput ¶
type AdminDeleteUserAttributesOutput struct {
// contains filtered or unexported fields
}
Represents the response received from the server for a request to delete user attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserAttributesResponse
func (AdminDeleteUserAttributesOutput) GoString ¶
func (s AdminDeleteUserAttributesOutput) GoString() string
GoString returns the string representation
func (AdminDeleteUserAttributesOutput) SDKResponseMetadata ¶
func (s AdminDeleteUserAttributesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminDeleteUserAttributesOutput) String ¶
func (s AdminDeleteUserAttributesOutput) String() string
String returns the string representation
type AdminDeleteUserAttributesRequest ¶
type AdminDeleteUserAttributesRequest struct { *aws.Request Input *AdminDeleteUserAttributesInput Copy func(*AdminDeleteUserAttributesInput) AdminDeleteUserAttributesRequest }
AdminDeleteUserAttributesRequest is a API request type for the AdminDeleteUserAttributes API operation.
func (AdminDeleteUserAttributesRequest) Send ¶
func (r AdminDeleteUserAttributesRequest) Send() (*AdminDeleteUserAttributesOutput, error)
Send marshals and sends the AdminDeleteUserAttributes API request.
type AdminDeleteUserInput ¶
type AdminDeleteUserInput struct { // The user pool ID for the user pool where you want to delete the user. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name of the user you wish to delete. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to delete a user as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserRequest
func (AdminDeleteUserInput) GoString ¶
func (s AdminDeleteUserInput) GoString() string
GoString returns the string representation
func (AdminDeleteUserInput) String ¶
func (s AdminDeleteUserInput) String() string
String returns the string representation
func (*AdminDeleteUserInput) Validate ¶
func (s *AdminDeleteUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminDeleteUserOutput ¶
type AdminDeleteUserOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserOutput
func (AdminDeleteUserOutput) GoString ¶
func (s AdminDeleteUserOutput) GoString() string
GoString returns the string representation
func (AdminDeleteUserOutput) SDKResponseMetadata ¶
func (s AdminDeleteUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminDeleteUserOutput) String ¶
func (s AdminDeleteUserOutput) String() string
String returns the string representation
type AdminDeleteUserRequest ¶
type AdminDeleteUserRequest struct { *aws.Request Input *AdminDeleteUserInput Copy func(*AdminDeleteUserInput) AdminDeleteUserRequest }
AdminDeleteUserRequest is a API request type for the AdminDeleteUser API operation.
func (AdminDeleteUserRequest) Send ¶
func (r AdminDeleteUserRequest) Send() (*AdminDeleteUserOutput, error)
Send marshals and sends the AdminDeleteUser API request.
type AdminDisableProviderForUserInput ¶
type AdminDisableProviderForUserInput struct { // The user to be disabled. // // User is a required field User *ProviderUserIdentifierType `type:"structure" required:"true"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableProviderForUserRequest
func (AdminDisableProviderForUserInput) GoString ¶
func (s AdminDisableProviderForUserInput) GoString() string
GoString returns the string representation
func (AdminDisableProviderForUserInput) String ¶
func (s AdminDisableProviderForUserInput) String() string
String returns the string representation
func (*AdminDisableProviderForUserInput) Validate ¶
func (s *AdminDisableProviderForUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminDisableProviderForUserOutput ¶
type AdminDisableProviderForUserOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableProviderForUserResponse
func (AdminDisableProviderForUserOutput) GoString ¶
func (s AdminDisableProviderForUserOutput) GoString() string
GoString returns the string representation
func (AdminDisableProviderForUserOutput) SDKResponseMetadata ¶
func (s AdminDisableProviderForUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminDisableProviderForUserOutput) String ¶
func (s AdminDisableProviderForUserOutput) String() string
String returns the string representation
type AdminDisableProviderForUserRequest ¶
type AdminDisableProviderForUserRequest struct { *aws.Request Input *AdminDisableProviderForUserInput Copy func(*AdminDisableProviderForUserInput) AdminDisableProviderForUserRequest }
AdminDisableProviderForUserRequest is a API request type for the AdminDisableProviderForUser API operation.
func (AdminDisableProviderForUserRequest) Send ¶
func (r AdminDisableProviderForUserRequest) Send() (*AdminDisableProviderForUserOutput, error)
Send marshals and sends the AdminDisableProviderForUser API request.
type AdminDisableUserInput ¶
type AdminDisableUserInput struct { // The user pool ID for the user pool where you want to disable the user. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name of the user you wish to disable. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to disable any user as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableUserRequest
func (AdminDisableUserInput) GoString ¶
func (s AdminDisableUserInput) GoString() string
GoString returns the string representation
func (AdminDisableUserInput) String ¶
func (s AdminDisableUserInput) String() string
String returns the string representation
func (*AdminDisableUserInput) Validate ¶
func (s *AdminDisableUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminDisableUserOutput ¶
type AdminDisableUserOutput struct {
// contains filtered or unexported fields
}
Represents the response received from the server to disable the user as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableUserResponse
func (AdminDisableUserOutput) GoString ¶
func (s AdminDisableUserOutput) GoString() string
GoString returns the string representation
func (AdminDisableUserOutput) SDKResponseMetadata ¶
func (s AdminDisableUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminDisableUserOutput) String ¶
func (s AdminDisableUserOutput) String() string
String returns the string representation
type AdminDisableUserRequest ¶
type AdminDisableUserRequest struct { *aws.Request Input *AdminDisableUserInput Copy func(*AdminDisableUserInput) AdminDisableUserRequest }
AdminDisableUserRequest is a API request type for the AdminDisableUser API operation.
func (AdminDisableUserRequest) Send ¶
func (r AdminDisableUserRequest) Send() (*AdminDisableUserOutput, error)
Send marshals and sends the AdminDisableUser API request.
type AdminEnableUserInput ¶
type AdminEnableUserInput struct { // The user pool ID for the user pool where you want to enable the user. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name of the user you wish to enable. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request that enables the user as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminEnableUserRequest
func (AdminEnableUserInput) GoString ¶
func (s AdminEnableUserInput) GoString() string
GoString returns the string representation
func (AdminEnableUserInput) String ¶
func (s AdminEnableUserInput) String() string
String returns the string representation
func (*AdminEnableUserInput) Validate ¶
func (s *AdminEnableUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminEnableUserOutput ¶
type AdminEnableUserOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server for the request to enable a user as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminEnableUserResponse
func (AdminEnableUserOutput) GoString ¶
func (s AdminEnableUserOutput) GoString() string
GoString returns the string representation
func (AdminEnableUserOutput) SDKResponseMetadata ¶
func (s AdminEnableUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminEnableUserOutput) String ¶
func (s AdminEnableUserOutput) String() string
String returns the string representation
type AdminEnableUserRequest ¶
type AdminEnableUserRequest struct { *aws.Request Input *AdminEnableUserInput Copy func(*AdminEnableUserInput) AdminEnableUserRequest }
AdminEnableUserRequest is a API request type for the AdminEnableUser API operation.
func (AdminEnableUserRequest) Send ¶
func (r AdminEnableUserRequest) Send() (*AdminEnableUserOutput, error)
Send marshals and sends the AdminEnableUser API request.
type AdminForgetDeviceInput ¶
type AdminForgetDeviceInput struct { // The device key. // // DeviceKey is a required field DeviceKey *string `min:"1" type:"string" required:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Sends the forgot device request, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminForgetDeviceRequest
func (AdminForgetDeviceInput) GoString ¶
func (s AdminForgetDeviceInput) GoString() string
GoString returns the string representation
func (AdminForgetDeviceInput) String ¶
func (s AdminForgetDeviceInput) String() string
String returns the string representation
func (*AdminForgetDeviceInput) Validate ¶
func (s *AdminForgetDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminForgetDeviceOutput ¶
type AdminForgetDeviceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminForgetDeviceOutput
func (AdminForgetDeviceOutput) GoString ¶
func (s AdminForgetDeviceOutput) GoString() string
GoString returns the string representation
func (AdminForgetDeviceOutput) SDKResponseMetadata ¶
func (s AdminForgetDeviceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminForgetDeviceOutput) String ¶
func (s AdminForgetDeviceOutput) String() string
String returns the string representation
type AdminForgetDeviceRequest ¶
type AdminForgetDeviceRequest struct { *aws.Request Input *AdminForgetDeviceInput Copy func(*AdminForgetDeviceInput) AdminForgetDeviceRequest }
AdminForgetDeviceRequest is a API request type for the AdminForgetDevice API operation.
func (AdminForgetDeviceRequest) Send ¶
func (r AdminForgetDeviceRequest) Send() (*AdminForgetDeviceOutput, error)
Send marshals and sends the AdminForgetDevice API request.
type AdminGetDeviceInput ¶
type AdminGetDeviceInput struct { // The device key. // // DeviceKey is a required field DeviceKey *string `min:"1" type:"string" required:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to get the device, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetDeviceRequest
func (AdminGetDeviceInput) GoString ¶
func (s AdminGetDeviceInput) GoString() string
GoString returns the string representation
func (AdminGetDeviceInput) String ¶
func (s AdminGetDeviceInput) String() string
String returns the string representation
func (*AdminGetDeviceInput) Validate ¶
func (s *AdminGetDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminGetDeviceOutput ¶
type AdminGetDeviceOutput struct { // The device. // // Device is a required field Device *DeviceType `type:"structure" required:"true"` // contains filtered or unexported fields }
Gets the device response, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetDeviceResponse
func (AdminGetDeviceOutput) GoString ¶
func (s AdminGetDeviceOutput) GoString() string
GoString returns the string representation
func (AdminGetDeviceOutput) SDKResponseMetadata ¶
func (s AdminGetDeviceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminGetDeviceOutput) String ¶
func (s AdminGetDeviceOutput) String() string
String returns the string representation
type AdminGetDeviceRequest ¶
type AdminGetDeviceRequest struct { *aws.Request Input *AdminGetDeviceInput Copy func(*AdminGetDeviceInput) AdminGetDeviceRequest }
AdminGetDeviceRequest is a API request type for the AdminGetDevice API operation.
func (AdminGetDeviceRequest) Send ¶
func (r AdminGetDeviceRequest) Send() (*AdminGetDeviceOutput, error)
Send marshals and sends the AdminGetDevice API request.
type AdminGetUserInput ¶
type AdminGetUserInput struct { // The user pool ID for the user pool where you want to get information about // the user. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name of the user you wish to retrieve. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to get the specified user as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUserRequest
func (AdminGetUserInput) GoString ¶
func (s AdminGetUserInput) GoString() string
GoString returns the string representation
func (AdminGetUserInput) String ¶
func (s AdminGetUserInput) String() string
String returns the string representation
func (*AdminGetUserInput) Validate ¶
func (s *AdminGetUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminGetUserOutput ¶
type AdminGetUserOutput struct { // Indicates that the status is enabled. Enabled *bool `type:"boolean"` // Specifies the options for MFA (e.g., email or phone number). MFAOptions []MFAOptionType `type:"list"` // The user's preferred MFA setting. PreferredMfaSetting *string `type:"string"` // An array of name-value pairs representing user attributes. UserAttributes []AttributeType `type:"list"` // The date the user was created. UserCreateDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The date the user was last modified. UserLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The list of the user's MFA settings. UserMFASettingList []string `type:"list"` // The user status. Can be one of the following: // // * UNCONFIRMED - User has been created but not confirmed. // // * CONFIRMED - User has been confirmed. // // * ARCHIVED - User is no longer active. // // * COMPROMISED - User is disabled due to a potential security threat. // // * UNKNOWN - User status is not known. UserStatus UserStatusType `type:"string" enum:"true"` // The user name of the user about whom you are receiving information. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the response from the server from the request to get the specified user as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUserResponse
func (AdminGetUserOutput) GoString ¶
func (s AdminGetUserOutput) GoString() string
GoString returns the string representation
func (AdminGetUserOutput) SDKResponseMetadata ¶
func (s AdminGetUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminGetUserOutput) String ¶
func (s AdminGetUserOutput) String() string
String returns the string representation
type AdminGetUserRequest ¶
type AdminGetUserRequest struct { *aws.Request Input *AdminGetUserInput Copy func(*AdminGetUserInput) AdminGetUserRequest }
AdminGetUserRequest is a API request type for the AdminGetUser API operation.
func (AdminGetUserRequest) Send ¶
func (r AdminGetUserRequest) Send() (*AdminGetUserOutput, error)
Send marshals and sends the AdminGetUser API request.
type AdminInitiateAuthInput ¶
type AdminInitiateAuthInput struct { // The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The authentication flow for this call to execute. The API action will depend // on this value. For example: // // * REFRESH_TOKEN_AUTH will take in a valid refresh token and return new // tokens. // // * USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables // to be used for next challenge execution. // // * USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the // next challenge or tokens. // // Valid values include: // // * USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) // protocol. // // * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing // the access token and ID token by supplying a valid refresh token. // // * CUSTOM_AUTH: Custom authentication flow. // // * ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the // USERNAME and PASSWORD directly if the flow is enabled for calling the // app client. // // * USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD // are passed directly. If a user migration Lambda trigger is set, this flow // will invoke the user migration Lambda if the USERNAME is not found in // the user pool. // // AuthFlow is a required field AuthFlow AuthFlowType `type:"string" required:"true" enum:"true"` // The authentication parameters. These are inputs corresponding to the AuthFlow // that you are invoking. The required values depend on the value of AuthFlow: // // * For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH // (required if the app client is configured with a client secret), DEVICE_KEY // // * For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH // (required if the app client is configured with a client secret), DEVICE_KEY // // * For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client // is configured with client secret), PASSWORD (required), DEVICE_KEY // // * For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is // configured with client secret), DEVICE_KEY AuthParameters map[string]string `type:"map"` // The app client ID. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // This is a random key-value pair map which can contain any key and will be // passed to your PreAuthentication Lambda trigger as-is. It can be used to // implement additional validations around authentication. ClientMetadata map[string]string `type:"map"` // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. ContextData *ContextDataType `type:"structure"` // The ID of the Amazon Cognito user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Initiates the authorization request, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminInitiateAuthRequest
func (AdminInitiateAuthInput) GoString ¶
func (s AdminInitiateAuthInput) GoString() string
GoString returns the string representation
func (AdminInitiateAuthInput) String ¶
func (s AdminInitiateAuthInput) String() string
String returns the string representation
func (*AdminInitiateAuthInput) Validate ¶
func (s *AdminInitiateAuthInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminInitiateAuthOutput ¶
type AdminInitiateAuthOutput struct { // The result of the authentication response. This is only returned if the caller // does not need to pass another challenge. If the caller does need to pass // another challenge before it gets tokens, ChallengeName, ChallengeParameters, // and Session are returned. AuthenticationResult *AuthenticationResultType `type:"structure"` // The name of the challenge which you are responding to with this call. This // is returned to you in the AdminInitiateAuth response if you need to pass // another challenge. // // * MFA_SETUP: If MFA is required, users who do not have at least one of // the MFA methods set up are presented with an MFA_SETUP challenge. The // user must set up at least one MFA type to continue to authenticate. // // * SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA // for text SMS MFA, and SOFTWARE_TOKEN_MFA for TOTP software token MFA. // // * SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via // SMS. // // * PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, // PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. // // * CUSTOM_CHALLENGE: This is returned if your custom authentication flow // determines that the user should pass another challenge before tokens are // issued. // // * DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and // the previous challenges were passed, this challenge is returned so that // Amazon Cognito can start tracking this device. // // * DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices // only. // // * ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with // USERNAME and PASSWORD directly. An app client must be enabled to use this // flow. // // * NEW_PASSWORD_REQUIRED: For users which are required to change their // passwords after successful first login. This challenge should be passed // with NEW_PASSWORD and any other required attributes. ChallengeName ChallengeNameType `type:"string" enum:"true"` // The challenge parameters. These are returned to you in the AdminInitiateAuth // response if you need to pass another challenge. The responses in this parameter // should be used to compute inputs to the next call (AdminRespondToAuthChallenge). // // All challenges require USERNAME and SECRET_HASH (if applicable). // // The value of the USER_ID_FOR_SRP attribute will be the user's actual username, // not an alias (such as email address or phone number), even if you specified // an alias in your call to AdminInitiateAuth. This is because, in the AdminRespondToAuthChallenge // API ChallengeResponses, the USERNAME attribute cannot be an alias. ChallengeParameters map[string]string `type:"map"` // The session which should be passed both ways in challenge-response calls // to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call // determines that the caller needs to go through another challenge, they return // a session with other challenge parameters. This session should be passed // as it is to the next AdminRespondToAuthChallenge API call. Session *string `min:"20" type:"string"` // contains filtered or unexported fields }
Initiates the authentication response, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminInitiateAuthResponse
func (AdminInitiateAuthOutput) GoString ¶
func (s AdminInitiateAuthOutput) GoString() string
GoString returns the string representation
func (AdminInitiateAuthOutput) SDKResponseMetadata ¶
func (s AdminInitiateAuthOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminInitiateAuthOutput) String ¶
func (s AdminInitiateAuthOutput) String() string
String returns the string representation
type AdminInitiateAuthRequest ¶
type AdminInitiateAuthRequest struct { *aws.Request Input *AdminInitiateAuthInput Copy func(*AdminInitiateAuthInput) AdminInitiateAuthRequest }
AdminInitiateAuthRequest is a API request type for the AdminInitiateAuth API operation.
func (AdminInitiateAuthRequest) Send ¶
func (r AdminInitiateAuthRequest) Send() (*AdminInitiateAuthOutput, error)
Send marshals and sends the AdminInitiateAuth API request.
type AdminLinkProviderForUserInput ¶
type AdminLinkProviderForUserInput struct { // The existing user in the user pool to be linked to the external identity // provider user account. Can be a native (Username + Password) Cognito User // Pools user or a federated user (for example, a SAML or Facebook user). If // the user doesn't exist, an exception is thrown. This is the user that is // returned when the new user (with the linked identity provider attribute) // signs in. // // For a native username + password user, the ProviderAttributeValue for the // DestinationUser should be the username in the user pool. For a federated // user, it should be the provider-specific user_id. // // The ProviderAttributeName of the DestinationUser is ignored. // // The ProviderName should be set to Cognito for users in Cognito user pools. // // DestinationUser is a required field DestinationUser *ProviderUserIdentifierType `type:"structure" required:"true"` // An external identity provider account for a user who does not currently exist // yet in the user pool. This user must be a federated user (for example, a // SAML or Facebook user), not another native user. // // If the SourceUser is a federated social identity provider user (Facebook, // Google, or Login with Amazon), you must set the ProviderAttributeName to // Cognito_Subject. For social identity providers, the ProviderName will be // Facebook, Google, or LoginWithAmazon, and Cognito will automatically parse // the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, // respectively. The ProviderAttributeValue for the user must be the same value // as the id, sub, or user_id value found in the social identity provider token. // // For SAML, the ProviderAttributeNamecan 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 ProviderAttributeNameto Cognito_Subject // // SourceUser is a required field SourceUser *ProviderUserIdentifierType `type:"structure" required:"true"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminLinkProviderForUserRequest
func (AdminLinkProviderForUserInput) GoString ¶
func (s AdminLinkProviderForUserInput) GoString() string
GoString returns the string representation
func (AdminLinkProviderForUserInput) String ¶
func (s AdminLinkProviderForUserInput) String() string
String returns the string representation
func (*AdminLinkProviderForUserInput) Validate ¶
func (s *AdminLinkProviderForUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminLinkProviderForUserOutput ¶
type AdminLinkProviderForUserOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminLinkProviderForUserResponse
func (AdminLinkProviderForUserOutput) GoString ¶
func (s AdminLinkProviderForUserOutput) GoString() string
GoString returns the string representation
func (AdminLinkProviderForUserOutput) SDKResponseMetadata ¶
func (s AdminLinkProviderForUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminLinkProviderForUserOutput) String ¶
func (s AdminLinkProviderForUserOutput) String() string
String returns the string representation
type AdminLinkProviderForUserRequest ¶
type AdminLinkProviderForUserRequest struct { *aws.Request Input *AdminLinkProviderForUserInput Copy func(*AdminLinkProviderForUserInput) AdminLinkProviderForUserRequest }
AdminLinkProviderForUserRequest is a API request type for the AdminLinkProviderForUser API operation.
func (AdminLinkProviderForUserRequest) Send ¶
func (r AdminLinkProviderForUserRequest) Send() (*AdminLinkProviderForUserOutput, error)
Send marshals and sends the AdminLinkProviderForUser API request.
type AdminListDevicesInput ¶
type AdminListDevicesInput struct { // The limit of the devices request. Limit *int64 `type:"integer"` // The pagination token. PaginationToken *string `min:"1" type:"string"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to list devices, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListDevicesRequest
func (AdminListDevicesInput) GoString ¶
func (s AdminListDevicesInput) GoString() string
GoString returns the string representation
func (AdminListDevicesInput) String ¶
func (s AdminListDevicesInput) String() string
String returns the string representation
func (*AdminListDevicesInput) Validate ¶
func (s *AdminListDevicesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminListDevicesOutput ¶
type AdminListDevicesOutput struct { // The devices in the list of devices response. Devices []DeviceType `type:"list"` // The pagination token. PaginationToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Lists the device's response, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListDevicesResponse
func (AdminListDevicesOutput) GoString ¶
func (s AdminListDevicesOutput) GoString() string
GoString returns the string representation
func (AdminListDevicesOutput) SDKResponseMetadata ¶
func (s AdminListDevicesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminListDevicesOutput) String ¶
func (s AdminListDevicesOutput) String() string
String returns the string representation
type AdminListDevicesRequest ¶
type AdminListDevicesRequest struct { *aws.Request Input *AdminListDevicesInput Copy func(*AdminListDevicesInput) AdminListDevicesRequest }
AdminListDevicesRequest is a API request type for the AdminListDevices API operation.
func (AdminListDevicesRequest) Send ¶
func (r AdminListDevicesRequest) Send() (*AdminListDevicesOutput, error)
Send marshals and sends the AdminListDevices API request.
type AdminListGroupsForUserInput ¶
type AdminListGroupsForUserInput struct { // The limit of the request to list groups. Limit *int64 `type:"integer"` // An identifier that was returned from the previous call to this operation, // which can be used to return the next set of items in the list. NextToken *string `min:"1" type:"string"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The username for the user. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUserRequest
func (AdminListGroupsForUserInput) GoString ¶
func (s AdminListGroupsForUserInput) GoString() string
GoString returns the string representation
func (AdminListGroupsForUserInput) String ¶
func (s AdminListGroupsForUserInput) String() string
String returns the string representation
func (*AdminListGroupsForUserInput) Validate ¶
func (s *AdminListGroupsForUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminListGroupsForUserOutput ¶
type AdminListGroupsForUserOutput struct { // The groups that the user belongs to. Groups []GroupType `type:"list"` // An identifier that was returned from the previous call to this operation, // which can be used to return the next set of items in the list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUserResponse
func (AdminListGroupsForUserOutput) GoString ¶
func (s AdminListGroupsForUserOutput) GoString() string
GoString returns the string representation
func (AdminListGroupsForUserOutput) SDKResponseMetadata ¶
func (s AdminListGroupsForUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminListGroupsForUserOutput) String ¶
func (s AdminListGroupsForUserOutput) String() string
String returns the string representation
type AdminListGroupsForUserRequest ¶
type AdminListGroupsForUserRequest struct { *aws.Request Input *AdminListGroupsForUserInput Copy func(*AdminListGroupsForUserInput) AdminListGroupsForUserRequest }
AdminListGroupsForUserRequest is a API request type for the AdminListGroupsForUser API operation.
func (AdminListGroupsForUserRequest) Send ¶
func (r AdminListGroupsForUserRequest) Send() (*AdminListGroupsForUserOutput, error)
Send marshals and sends the AdminListGroupsForUser API request.
type AdminListUserAuthEventsInput ¶
type AdminListUserAuthEventsInput struct { // The maximum number of authentication events to return. MaxResults *int64 `type:"integer"` // A pagination token. NextToken *string `min:"1" type:"string"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user pool username or an alias. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListUserAuthEventsRequest
func (AdminListUserAuthEventsInput) GoString ¶
func (s AdminListUserAuthEventsInput) GoString() string
GoString returns the string representation
func (AdminListUserAuthEventsInput) String ¶
func (s AdminListUserAuthEventsInput) String() string
String returns the string representation
func (*AdminListUserAuthEventsInput) Validate ¶
func (s *AdminListUserAuthEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminListUserAuthEventsOutput ¶
type AdminListUserAuthEventsOutput struct { // The response object. It includes the EventID, EventType, CreationDate, EventRisk, // and EventResponse. AuthEvents []AuthEventType `type:"list"` // A pagination token. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListUserAuthEventsResponse
func (AdminListUserAuthEventsOutput) GoString ¶
func (s AdminListUserAuthEventsOutput) GoString() string
GoString returns the string representation
func (AdminListUserAuthEventsOutput) SDKResponseMetadata ¶
func (s AdminListUserAuthEventsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminListUserAuthEventsOutput) String ¶
func (s AdminListUserAuthEventsOutput) String() string
String returns the string representation
type AdminListUserAuthEventsRequest ¶
type AdminListUserAuthEventsRequest struct { *aws.Request Input *AdminListUserAuthEventsInput Copy func(*AdminListUserAuthEventsInput) AdminListUserAuthEventsRequest }
AdminListUserAuthEventsRequest is a API request type for the AdminListUserAuthEvents API operation.
func (AdminListUserAuthEventsRequest) Send ¶
func (r AdminListUserAuthEventsRequest) Send() (*AdminListUserAuthEventsOutput, error)
Send marshals and sends the AdminListUserAuthEvents API request.
type AdminRemoveUserFromGroupInput ¶
type AdminRemoveUserFromGroupInput struct { // The group name. // // GroupName is a required field GroupName *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The username for the user. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRemoveUserFromGroupRequest
func (AdminRemoveUserFromGroupInput) GoString ¶
func (s AdminRemoveUserFromGroupInput) GoString() string
GoString returns the string representation
func (AdminRemoveUserFromGroupInput) String ¶
func (s AdminRemoveUserFromGroupInput) String() string
String returns the string representation
func (*AdminRemoveUserFromGroupInput) Validate ¶
func (s *AdminRemoveUserFromGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminRemoveUserFromGroupOutput ¶
type AdminRemoveUserFromGroupOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRemoveUserFromGroupOutput
func (AdminRemoveUserFromGroupOutput) GoString ¶
func (s AdminRemoveUserFromGroupOutput) GoString() string
GoString returns the string representation
func (AdminRemoveUserFromGroupOutput) SDKResponseMetadata ¶
func (s AdminRemoveUserFromGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminRemoveUserFromGroupOutput) String ¶
func (s AdminRemoveUserFromGroupOutput) String() string
String returns the string representation
type AdminRemoveUserFromGroupRequest ¶
type AdminRemoveUserFromGroupRequest struct { *aws.Request Input *AdminRemoveUserFromGroupInput Copy func(*AdminRemoveUserFromGroupInput) AdminRemoveUserFromGroupRequest }
AdminRemoveUserFromGroupRequest is a API request type for the AdminRemoveUserFromGroup API operation.
func (AdminRemoveUserFromGroupRequest) Send ¶
func (r AdminRemoveUserFromGroupRequest) Send() (*AdminRemoveUserFromGroupOutput, error)
Send marshals and sends the AdminRemoveUserFromGroup API request.
type AdminResetUserPasswordInput ¶
type AdminResetUserPasswordInput struct { // The user pool ID for the user pool where you want to reset the user's password. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name of the user whose password you wish to reset. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to reset a user's password as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminResetUserPasswordRequest
func (AdminResetUserPasswordInput) GoString ¶
func (s AdminResetUserPasswordInput) GoString() string
GoString returns the string representation
func (AdminResetUserPasswordInput) String ¶
func (s AdminResetUserPasswordInput) String() string
String returns the string representation
func (*AdminResetUserPasswordInput) Validate ¶
func (s *AdminResetUserPasswordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminResetUserPasswordOutput ¶
type AdminResetUserPasswordOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server to reset a user password as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminResetUserPasswordResponse
func (AdminResetUserPasswordOutput) GoString ¶
func (s AdminResetUserPasswordOutput) GoString() string
GoString returns the string representation
func (AdminResetUserPasswordOutput) SDKResponseMetadata ¶
func (s AdminResetUserPasswordOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminResetUserPasswordOutput) String ¶
func (s AdminResetUserPasswordOutput) String() string
String returns the string representation
type AdminResetUserPasswordRequest ¶
type AdminResetUserPasswordRequest struct { *aws.Request Input *AdminResetUserPasswordInput Copy func(*AdminResetUserPasswordInput) AdminResetUserPasswordRequest }
AdminResetUserPasswordRequest is a API request type for the AdminResetUserPassword API operation.
func (AdminResetUserPasswordRequest) Send ¶
func (r AdminResetUserPasswordRequest) Send() (*AdminResetUserPasswordOutput, error)
Send marshals and sends the AdminResetUserPassword API request.
type AdminRespondToAuthChallengeInput ¶
type AdminRespondToAuthChallengeInput struct { // The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The challenge name. For more information, see . // // ChallengeName is a required field ChallengeName ChallengeNameType `type:"string" required:"true" enum:"true"` // The challenge responses. These are inputs corresponding to the value of ChallengeName, // for example: // // * SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured // with client secret). // // * PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, // TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client // secret). // // * ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is // configured with client secret). // // * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, // USERNAME, SECRET_HASH (if app client is configured with client secret). // // // The value of the USERNAME attribute must be the user's actual username, not // an alias (such as email address or phone number). To make this easier, the // AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP // attribute, even if you specified an alias in your call to AdminInitiateAuth. ChallengeResponses map[string]string `type:"map"` // The app client ID. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. ContextData *ContextDataType `type:"structure"` // The session which should be passed both ways in challenge-response calls // to the service. If InitiateAuth or RespondToAuthChallenge API call determines // that the caller needs to go through another challenge, they return a session // with other challenge parameters. This session should be passed as it is to // the next RespondToAuthChallenge API call. Session *string `min:"20" type:"string"` // The ID of the Amazon Cognito user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The request to respond to the authentication challenge, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRespondToAuthChallengeRequest
func (AdminRespondToAuthChallengeInput) GoString ¶
func (s AdminRespondToAuthChallengeInput) GoString() string
GoString returns the string representation
func (AdminRespondToAuthChallengeInput) String ¶
func (s AdminRespondToAuthChallengeInput) String() string
String returns the string representation
func (*AdminRespondToAuthChallengeInput) Validate ¶
func (s *AdminRespondToAuthChallengeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminRespondToAuthChallengeOutput ¶
type AdminRespondToAuthChallengeOutput struct { // The result returned by the server in response to the authentication request. AuthenticationResult *AuthenticationResultType `type:"structure"` // The name of the challenge. For more information, see . ChallengeName ChallengeNameType `type:"string" enum:"true"` // The challenge parameters. For more information, see . ChallengeParameters map[string]string `type:"map"` // The session which should be passed both ways in challenge-response calls // to the service. If the or API call determines that the caller needs to go // through another challenge, they return a session with other challenge parameters. // This session should be passed as it is to the next RespondToAuthChallenge // API call. Session *string `min:"20" type:"string"` // contains filtered or unexported fields }
Responds to the authentication challenge, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRespondToAuthChallengeResponse
func (AdminRespondToAuthChallengeOutput) GoString ¶
func (s AdminRespondToAuthChallengeOutput) GoString() string
GoString returns the string representation
func (AdminRespondToAuthChallengeOutput) SDKResponseMetadata ¶
func (s AdminRespondToAuthChallengeOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminRespondToAuthChallengeOutput) String ¶
func (s AdminRespondToAuthChallengeOutput) String() string
String returns the string representation
type AdminRespondToAuthChallengeRequest ¶
type AdminRespondToAuthChallengeRequest struct { *aws.Request Input *AdminRespondToAuthChallengeInput Copy func(*AdminRespondToAuthChallengeInput) AdminRespondToAuthChallengeRequest }
AdminRespondToAuthChallengeRequest is a API request type for the AdminRespondToAuthChallenge API operation.
func (AdminRespondToAuthChallengeRequest) Send ¶
func (r AdminRespondToAuthChallengeRequest) Send() (*AdminRespondToAuthChallengeOutput, error)
Send marshals and sends the AdminRespondToAuthChallenge API request.
type AdminSetUserMFAPreferenceInput ¶
type AdminSetUserMFAPreferenceInput struct { // The SMS text message MFA settings. SMSMfaSettings *SMSMfaSettingsType `type:"structure"` // The time-based one-time password software token MFA settings. SoftwareTokenMfaSettings *SoftwareTokenMfaSettingsType `type:"structure"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user pool username or alias. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminSetUserMFAPreferenceRequest
func (AdminSetUserMFAPreferenceInput) GoString ¶
func (s AdminSetUserMFAPreferenceInput) GoString() string
GoString returns the string representation
func (AdminSetUserMFAPreferenceInput) String ¶
func (s AdminSetUserMFAPreferenceInput) String() string
String returns the string representation
func (*AdminSetUserMFAPreferenceInput) Validate ¶
func (s *AdminSetUserMFAPreferenceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminSetUserMFAPreferenceOutput ¶
type AdminSetUserMFAPreferenceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminSetUserMFAPreferenceResponse
func (AdminSetUserMFAPreferenceOutput) GoString ¶
func (s AdminSetUserMFAPreferenceOutput) GoString() string
GoString returns the string representation
func (AdminSetUserMFAPreferenceOutput) SDKResponseMetadata ¶
func (s AdminSetUserMFAPreferenceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminSetUserMFAPreferenceOutput) String ¶
func (s AdminSetUserMFAPreferenceOutput) String() string
String returns the string representation
type AdminSetUserMFAPreferenceRequest ¶
type AdminSetUserMFAPreferenceRequest struct { *aws.Request Input *AdminSetUserMFAPreferenceInput Copy func(*AdminSetUserMFAPreferenceInput) AdminSetUserMFAPreferenceRequest }
AdminSetUserMFAPreferenceRequest is a API request type for the AdminSetUserMFAPreference API operation.
func (AdminSetUserMFAPreferenceRequest) Send ¶
func (r AdminSetUserMFAPreferenceRequest) Send() (*AdminSetUserMFAPreferenceOutput, error)
Send marshals and sends the AdminSetUserMFAPreference API request.
type AdminSetUserSettingsInput ¶
type AdminSetUserSettingsInput struct { // Specifies the options for MFA (e.g., email or phone number). // // MFAOptions is a required field MFAOptions []MFAOptionType `type:"list" required:"true"` // The user pool ID for the user pool where you want to set the user's settings, // such as MFA options. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name of the user for whom you wish to set user settings. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to set user settings as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminSetUserSettingsRequest
func (AdminSetUserSettingsInput) GoString ¶
func (s AdminSetUserSettingsInput) GoString() string
GoString returns the string representation
func (AdminSetUserSettingsInput) String ¶
func (s AdminSetUserSettingsInput) String() string
String returns the string representation
func (*AdminSetUserSettingsInput) Validate ¶
func (s *AdminSetUserSettingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminSetUserSettingsOutput ¶
type AdminSetUserSettingsOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server to set user settings as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminSetUserSettingsResponse
func (AdminSetUserSettingsOutput) GoString ¶
func (s AdminSetUserSettingsOutput) GoString() string
GoString returns the string representation
func (AdminSetUserSettingsOutput) SDKResponseMetadata ¶
func (s AdminSetUserSettingsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminSetUserSettingsOutput) String ¶
func (s AdminSetUserSettingsOutput) String() string
String returns the string representation
type AdminSetUserSettingsRequest ¶
type AdminSetUserSettingsRequest struct { *aws.Request Input *AdminSetUserSettingsInput Copy func(*AdminSetUserSettingsInput) AdminSetUserSettingsRequest }
AdminSetUserSettingsRequest is a API request type for the AdminSetUserSettings API operation.
func (AdminSetUserSettingsRequest) Send ¶
func (r AdminSetUserSettingsRequest) Send() (*AdminSetUserSettingsOutput, error)
Send marshals and sends the AdminSetUserSettings API request.
type AdminUpdateAuthEventFeedbackInput ¶
type AdminUpdateAuthEventFeedbackInput struct { // The authentication event ID. // // EventId is a required field EventId *string `min:"1" type:"string" required:"true"` // The authentication event feedback value. // // FeedbackValue is a required field FeedbackValue FeedbackValueType `type:"string" required:"true" enum:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user pool username. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateAuthEventFeedbackRequest
func (AdminUpdateAuthEventFeedbackInput) GoString ¶
func (s AdminUpdateAuthEventFeedbackInput) GoString() string
GoString returns the string representation
func (AdminUpdateAuthEventFeedbackInput) String ¶
func (s AdminUpdateAuthEventFeedbackInput) String() string
String returns the string representation
func (*AdminUpdateAuthEventFeedbackInput) Validate ¶
func (s *AdminUpdateAuthEventFeedbackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminUpdateAuthEventFeedbackOutput ¶
type AdminUpdateAuthEventFeedbackOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateAuthEventFeedbackResponse
func (AdminUpdateAuthEventFeedbackOutput) GoString ¶
func (s AdminUpdateAuthEventFeedbackOutput) GoString() string
GoString returns the string representation
func (AdminUpdateAuthEventFeedbackOutput) SDKResponseMetadata ¶
func (s AdminUpdateAuthEventFeedbackOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminUpdateAuthEventFeedbackOutput) String ¶
func (s AdminUpdateAuthEventFeedbackOutput) String() string
String returns the string representation
type AdminUpdateAuthEventFeedbackRequest ¶
type AdminUpdateAuthEventFeedbackRequest struct { *aws.Request Input *AdminUpdateAuthEventFeedbackInput Copy func(*AdminUpdateAuthEventFeedbackInput) AdminUpdateAuthEventFeedbackRequest }
AdminUpdateAuthEventFeedbackRequest is a API request type for the AdminUpdateAuthEventFeedback API operation.
func (AdminUpdateAuthEventFeedbackRequest) Send ¶
func (r AdminUpdateAuthEventFeedbackRequest) Send() (*AdminUpdateAuthEventFeedbackOutput, error)
Send marshals and sends the AdminUpdateAuthEventFeedback API request.
type AdminUpdateDeviceStatusInput ¶
type AdminUpdateDeviceStatusInput struct { // The device key. // // DeviceKey is a required field DeviceKey *string `min:"1" type:"string" required:"true"` // The status indicating whether a device has been remembered or not. DeviceRememberedStatus DeviceRememberedStatusType `type:"string" enum:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The request to update the device status, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateDeviceStatusRequest
func (AdminUpdateDeviceStatusInput) GoString ¶
func (s AdminUpdateDeviceStatusInput) GoString() string
GoString returns the string representation
func (AdminUpdateDeviceStatusInput) String ¶
func (s AdminUpdateDeviceStatusInput) String() string
String returns the string representation
func (*AdminUpdateDeviceStatusInput) Validate ¶
func (s *AdminUpdateDeviceStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminUpdateDeviceStatusOutput ¶
type AdminUpdateDeviceStatusOutput struct {
// contains filtered or unexported fields
}
The status response from the request to update the device, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateDeviceStatusResponse
func (AdminUpdateDeviceStatusOutput) GoString ¶
func (s AdminUpdateDeviceStatusOutput) GoString() string
GoString returns the string representation
func (AdminUpdateDeviceStatusOutput) SDKResponseMetadata ¶
func (s AdminUpdateDeviceStatusOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminUpdateDeviceStatusOutput) String ¶
func (s AdminUpdateDeviceStatusOutput) String() string
String returns the string representation
type AdminUpdateDeviceStatusRequest ¶
type AdminUpdateDeviceStatusRequest struct { *aws.Request Input *AdminUpdateDeviceStatusInput Copy func(*AdminUpdateDeviceStatusInput) AdminUpdateDeviceStatusRequest }
AdminUpdateDeviceStatusRequest is a API request type for the AdminUpdateDeviceStatus API operation.
func (AdminUpdateDeviceStatusRequest) Send ¶
func (r AdminUpdateDeviceStatusRequest) Send() (*AdminUpdateDeviceStatusOutput, error)
Send marshals and sends the AdminUpdateDeviceStatus API request.
type AdminUpdateUserAttributesInput ¶
type AdminUpdateUserAttributesInput struct { // An array of name-value pairs representing user attributes. // // For custom attributes, you must prepend the custom: prefix to the attribute // name. // // UserAttributes is a required field UserAttributes []AttributeType `type:"list" required:"true"` // The user pool ID for the user pool where you want to update user attributes. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name of the user for whom you want to update user attributes. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to update the user's attributes as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateUserAttributesRequest
func (AdminUpdateUserAttributesInput) GoString ¶
func (s AdminUpdateUserAttributesInput) GoString() string
GoString returns the string representation
func (AdminUpdateUserAttributesInput) String ¶
func (s AdminUpdateUserAttributesInput) String() string
String returns the string representation
func (*AdminUpdateUserAttributesInput) Validate ¶
func (s *AdminUpdateUserAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminUpdateUserAttributesOutput ¶
type AdminUpdateUserAttributesOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server for the request to update user attributes as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateUserAttributesResponse
func (AdminUpdateUserAttributesOutput) GoString ¶
func (s AdminUpdateUserAttributesOutput) GoString() string
GoString returns the string representation
func (AdminUpdateUserAttributesOutput) SDKResponseMetadata ¶
func (s AdminUpdateUserAttributesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminUpdateUserAttributesOutput) String ¶
func (s AdminUpdateUserAttributesOutput) String() string
String returns the string representation
type AdminUpdateUserAttributesRequest ¶
type AdminUpdateUserAttributesRequest struct { *aws.Request Input *AdminUpdateUserAttributesInput Copy func(*AdminUpdateUserAttributesInput) AdminUpdateUserAttributesRequest }
AdminUpdateUserAttributesRequest is a API request type for the AdminUpdateUserAttributes API operation.
func (AdminUpdateUserAttributesRequest) Send ¶
func (r AdminUpdateUserAttributesRequest) Send() (*AdminUpdateUserAttributesOutput, error)
Send marshals and sends the AdminUpdateUserAttributes API request.
type AdminUserGlobalSignOutInput ¶
type AdminUserGlobalSignOutInput struct { // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user name. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The request to sign out of all devices, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUserGlobalSignOutRequest
func (AdminUserGlobalSignOutInput) GoString ¶
func (s AdminUserGlobalSignOutInput) GoString() string
GoString returns the string representation
func (AdminUserGlobalSignOutInput) String ¶
func (s AdminUserGlobalSignOutInput) String() string
String returns the string representation
func (*AdminUserGlobalSignOutInput) Validate ¶
func (s *AdminUserGlobalSignOutInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdminUserGlobalSignOutOutput ¶
type AdminUserGlobalSignOutOutput struct {
// contains filtered or unexported fields
}
The global sign-out response, as an administrator. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUserGlobalSignOutResponse
func (AdminUserGlobalSignOutOutput) GoString ¶
func (s AdminUserGlobalSignOutOutput) GoString() string
GoString returns the string representation
func (AdminUserGlobalSignOutOutput) SDKResponseMetadata ¶
func (s AdminUserGlobalSignOutOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AdminUserGlobalSignOutOutput) String ¶
func (s AdminUserGlobalSignOutOutput) String() string
String returns the string representation
type AdminUserGlobalSignOutRequest ¶
type AdminUserGlobalSignOutRequest struct { *aws.Request Input *AdminUserGlobalSignOutInput Copy func(*AdminUserGlobalSignOutInput) AdminUserGlobalSignOutRequest }
AdminUserGlobalSignOutRequest is a API request type for the AdminUserGlobalSignOut API operation.
func (AdminUserGlobalSignOutRequest) Send ¶
func (r AdminUserGlobalSignOutRequest) Send() (*AdminUserGlobalSignOutOutput, error)
Send marshals and sends the AdminUserGlobalSignOut API request.
type AdvancedSecurityModeType ¶
type AdvancedSecurityModeType string
const ( AdvancedSecurityModeTypeOff AdvancedSecurityModeType = "OFF" AdvancedSecurityModeTypeAudit AdvancedSecurityModeType = "AUDIT" AdvancedSecurityModeTypeEnforced AdvancedSecurityModeType = "ENFORCED" )
Enum values for AdvancedSecurityModeType
func (AdvancedSecurityModeType) MarshalValue ¶
func (enum AdvancedSecurityModeType) MarshalValue() (string, error)
func (AdvancedSecurityModeType) MarshalValueBuf ¶
func (enum AdvancedSecurityModeType) MarshalValueBuf(b []byte) ([]byte, error)
type AliasAttributeType ¶
type AliasAttributeType string
const ( AliasAttributeTypePhoneNumber AliasAttributeType = "phone_number" AliasAttributeTypeEmail AliasAttributeType = "email" AliasAttributeTypePreferredUsername AliasAttributeType = "preferred_username" )
Enum values for AliasAttributeType
func (AliasAttributeType) MarshalValue ¶
func (enum AliasAttributeType) MarshalValue() (string, error)
func (AliasAttributeType) MarshalValueBuf ¶
func (enum AliasAttributeType) MarshalValueBuf(b []byte) ([]byte, error)
type AnalyticsConfigurationType ¶
type AnalyticsConfigurationType struct { // The application ID for an Amazon Pinpoint application. // // ApplicationId is a required field ApplicationId *string `type:"string" required:"true"` // The external ID. // // ExternalId is a required field ExternalId *string `type:"string" required:"true"` // The ARN of an IAM role that authorizes Amazon Cognito to publish events to // Amazon Pinpoint analytics. // // RoleArn is a required field RoleArn *string `min:"20" type:"string" required:"true"` // it publishes to Amazon Pinpoint analytics. UserDataShared *bool `type:"boolean"` // contains filtered or unexported fields }
The Amazon Pinpoint analytics configuration for collecting metrics for a user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AnalyticsConfigurationType
func (AnalyticsConfigurationType) GoString ¶
func (s AnalyticsConfigurationType) GoString() string
GoString returns the string representation
func (AnalyticsConfigurationType) String ¶
func (s AnalyticsConfigurationType) String() string
String returns the string representation
func (*AnalyticsConfigurationType) Validate ¶
func (s *AnalyticsConfigurationType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AnalyticsMetadataType ¶
type AnalyticsMetadataType struct { // The endpoint ID. AnalyticsEndpointId *string `type:"string"` // contains filtered or unexported fields }
An Amazon Pinpoint analytics endpoint.
An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AnalyticsMetadataType
func (AnalyticsMetadataType) GoString ¶
func (s AnalyticsMetadataType) GoString() string
GoString returns the string representation
func (AnalyticsMetadataType) String ¶
func (s AnalyticsMetadataType) String() string
String returns the string representation
type AssociateSoftwareTokenInput ¶
type AssociateSoftwareTokenInput struct { // The access token. AccessToken *string `type:"string"` // The session which should be passed both ways in challenge-response calls // to the service. This allows authentication of the user as part of the MFA // setup process. Session *string `min:"20" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AssociateSoftwareTokenRequest
func (AssociateSoftwareTokenInput) GoString ¶
func (s AssociateSoftwareTokenInput) GoString() string
GoString returns the string representation
func (AssociateSoftwareTokenInput) String ¶
func (s AssociateSoftwareTokenInput) String() string
String returns the string representation
func (*AssociateSoftwareTokenInput) Validate ¶
func (s *AssociateSoftwareTokenInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociateSoftwareTokenOutput ¶
type AssociateSoftwareTokenOutput struct { // A unique generated shared secret code that is used in the TOTP algorithm // to generate a one time code. SecretCode *string `min:"16" type:"string"` // The session which should be passed both ways in challenge-response calls // to the service. This allows authentication of the user as part of the MFA // setup process. Session *string `min:"20" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AssociateSoftwareTokenResponse
func (AssociateSoftwareTokenOutput) GoString ¶
func (s AssociateSoftwareTokenOutput) GoString() string
GoString returns the string representation
func (AssociateSoftwareTokenOutput) SDKResponseMetadata ¶
func (s AssociateSoftwareTokenOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AssociateSoftwareTokenOutput) String ¶
func (s AssociateSoftwareTokenOutput) String() string
String returns the string representation
type AssociateSoftwareTokenRequest ¶
type AssociateSoftwareTokenRequest struct { *aws.Request Input *AssociateSoftwareTokenInput Copy func(*AssociateSoftwareTokenInput) AssociateSoftwareTokenRequest }
AssociateSoftwareTokenRequest is a API request type for the AssociateSoftwareToken API operation.
func (AssociateSoftwareTokenRequest) Send ¶
func (r AssociateSoftwareTokenRequest) Send() (*AssociateSoftwareTokenOutput, error)
Send marshals and sends the AssociateSoftwareToken API request.
type AttributeDataType ¶
type AttributeDataType string
const ( AttributeDataTypeString AttributeDataType = "String" AttributeDataTypeNumber AttributeDataType = "Number" AttributeDataTypeDateTime AttributeDataType = "DateTime" AttributeDataTypeBoolean AttributeDataType = "Boolean" )
Enum values for AttributeDataType
func (AttributeDataType) MarshalValue ¶
func (enum AttributeDataType) MarshalValue() (string, error)
func (AttributeDataType) MarshalValueBuf ¶
func (enum AttributeDataType) MarshalValueBuf(b []byte) ([]byte, error)
type AttributeType ¶
type AttributeType struct { // The name of the attribute. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The value of the attribute. Value *string `type:"string"` // contains filtered or unexported fields }
Specifies whether the attribute is standard or custom. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AttributeType
func (AttributeType) GoString ¶
func (s AttributeType) GoString() string
GoString returns the string representation
func (AttributeType) String ¶
func (s AttributeType) String() string
String returns the string representation
func (*AttributeType) Validate ¶
func (s *AttributeType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AuthEventType ¶
type AuthEventType struct { // The challenge responses. ChallengeResponses []ChallengeResponseType `type:"list"` // The creation date CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The user context data captured at the time of an event request. It provides // additional information about the client from which event the request is received. EventContextData *EventContextDataType `type:"structure"` // A flag specifying the user feedback captured at the time of an event request // is good or bad. EventFeedback *EventFeedbackType `type:"structure"` // The event ID. EventId *string `type:"string"` // The event response. EventResponse EventResponseType `type:"string" enum:"true"` // The event risk. EventRisk *EventRiskType `type:"structure"` // The event type. EventType EventType `type:"string" enum:"true"` // contains filtered or unexported fields }
The authentication event type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AuthEventType
func (AuthEventType) GoString ¶
func (s AuthEventType) GoString() string
GoString returns the string representation
func (AuthEventType) String ¶
func (s AuthEventType) String() string
String returns the string representation
type AuthFlowType ¶
type AuthFlowType string
const ( AuthFlowTypeUserSrpAuth AuthFlowType = "USER_SRP_AUTH" AuthFlowTypeRefreshTokenAuth AuthFlowType = "REFRESH_TOKEN_AUTH" AuthFlowTypeRefreshToken AuthFlowType = "REFRESH_TOKEN" AuthFlowTypeCustomAuth AuthFlowType = "CUSTOM_AUTH" AuthFlowTypeAdminNoSrpAuth AuthFlowType = "ADMIN_NO_SRP_AUTH" AuthFlowTypeUserPasswordAuth AuthFlowType = "USER_PASSWORD_AUTH" )
Enum values for AuthFlowType
func (AuthFlowType) MarshalValue ¶
func (enum AuthFlowType) MarshalValue() (string, error)
func (AuthFlowType) MarshalValueBuf ¶
func (enum AuthFlowType) MarshalValueBuf(b []byte) ([]byte, error)
type AuthenticationResultType ¶
type AuthenticationResultType struct { // The access token. AccessToken *string `type:"string"` // The expiration period of the authentication result in seconds. ExpiresIn *int64 `type:"integer"` // The ID token. IdToken *string `type:"string"` // The new device metadata from an authentication result. NewDeviceMetadata *NewDeviceMetadataType `type:"structure"` // The refresh token. RefreshToken *string `type:"string"` // The token type. TokenType *string `type:"string"` // contains filtered or unexported fields }
The authentication result. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AuthenticationResultType
func (AuthenticationResultType) GoString ¶
func (s AuthenticationResultType) GoString() string
GoString returns the string representation
func (AuthenticationResultType) String ¶
func (s AuthenticationResultType) String() string
String returns the string representation
type ChallengeName ¶
type ChallengeName string
const ( ChallengeNamePassword ChallengeName = "Password" ChallengeNameMfa ChallengeName = "Mfa" )
Enum values for ChallengeName
func (ChallengeName) MarshalValue ¶
func (enum ChallengeName) MarshalValue() (string, error)
func (ChallengeName) MarshalValueBuf ¶
func (enum ChallengeName) MarshalValueBuf(b []byte) ([]byte, error)
type ChallengeNameType ¶
type ChallengeNameType string
const ( ChallengeNameTypeSmsMfa ChallengeNameType = "SMS_MFA" ChallengeNameTypeSoftwareTokenMfa ChallengeNameType = "SOFTWARE_TOKEN_MFA" ChallengeNameTypeSelectMfaType ChallengeNameType = "SELECT_MFA_TYPE" ChallengeNameTypeMfaSetup ChallengeNameType = "MFA_SETUP" ChallengeNameTypePasswordVerifier ChallengeNameType = "PASSWORD_VERIFIER" ChallengeNameTypeCustomChallenge ChallengeNameType = "CUSTOM_CHALLENGE" ChallengeNameTypeDeviceSrpAuth ChallengeNameType = "DEVICE_SRP_AUTH" ChallengeNameTypeDevicePasswordVerifier ChallengeNameType = "DEVICE_PASSWORD_VERIFIER" ChallengeNameTypeAdminNoSrpAuth ChallengeNameType = "ADMIN_NO_SRP_AUTH" ChallengeNameTypeNewPasswordRequired ChallengeNameType = "NEW_PASSWORD_REQUIRED" )
Enum values for ChallengeNameType
func (ChallengeNameType) MarshalValue ¶
func (enum ChallengeNameType) MarshalValue() (string, error)
func (ChallengeNameType) MarshalValueBuf ¶
func (enum ChallengeNameType) MarshalValueBuf(b []byte) ([]byte, error)
type ChallengeResponse ¶
type ChallengeResponse string
const ( ChallengeResponseSuccess ChallengeResponse = "Success" ChallengeResponseFailure ChallengeResponse = "Failure" )
Enum values for ChallengeResponse
func (ChallengeResponse) MarshalValue ¶
func (enum ChallengeResponse) MarshalValue() (string, error)
func (ChallengeResponse) MarshalValueBuf ¶
func (enum ChallengeResponse) MarshalValueBuf(b []byte) ([]byte, error)
type ChallengeResponseType ¶
type ChallengeResponseType struct { // The challenge name ChallengeName ChallengeName `type:"string" enum:"true"` // The challenge response. ChallengeResponse ChallengeResponse `type:"string" enum:"true"` // contains filtered or unexported fields }
The challenge response type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ChallengeResponseType
func (ChallengeResponseType) GoString ¶
func (s ChallengeResponseType) GoString() string
GoString returns the string representation
func (ChallengeResponseType) String ¶
func (s ChallengeResponseType) String() string
String returns the string representation
type ChangePasswordInput ¶
type ChangePasswordInput struct { // The access token. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // The old password. // // PreviousPassword is a required field PreviousPassword *string `min:"6" type:"string" required:"true"` // The new password. // // ProposedPassword is a required field ProposedPassword *string `min:"6" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to change a user password. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ChangePasswordRequest
func (ChangePasswordInput) GoString ¶
func (s ChangePasswordInput) GoString() string
GoString returns the string representation
func (ChangePasswordInput) String ¶
func (s ChangePasswordInput) String() string
String returns the string representation
func (*ChangePasswordInput) Validate ¶
func (s *ChangePasswordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ChangePasswordOutput ¶
type ChangePasswordOutput struct {
// contains filtered or unexported fields
}
The response from the server to the change password request. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ChangePasswordResponse
func (ChangePasswordOutput) GoString ¶
func (s ChangePasswordOutput) GoString() string
GoString returns the string representation
func (ChangePasswordOutput) SDKResponseMetadata ¶
func (s ChangePasswordOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ChangePasswordOutput) String ¶
func (s ChangePasswordOutput) String() string
String returns the string representation
type ChangePasswordRequest ¶
type ChangePasswordRequest struct { *aws.Request Input *ChangePasswordInput Copy func(*ChangePasswordInput) ChangePasswordRequest }
ChangePasswordRequest is a API request type for the ChangePassword API operation.
func (ChangePasswordRequest) Send ¶
func (r ChangePasswordRequest) Send() (*ChangePasswordOutput, error)
Send marshals and sends the ChangePassword API request.
type CodeDeliveryDetailsType ¶
type CodeDeliveryDetailsType struct { // The attribute name. AttributeName *string `min:"1" type:"string"` // The delivery medium (email message or phone number). DeliveryMedium DeliveryMediumType `type:"string" enum:"true"` // The destination for the code delivery details. Destination *string `type:"string"` // contains filtered or unexported fields }
The code delivery details being returned from the server. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CodeDeliveryDetailsType
func (CodeDeliveryDetailsType) GoString ¶
func (s CodeDeliveryDetailsType) GoString() string
GoString returns the string representation
func (CodeDeliveryDetailsType) String ¶
func (s CodeDeliveryDetailsType) String() string
String returns the string representation
type CognitoIdentityProvider ¶
CognitoIdentityProvider provides the API operation methods for making requests to Amazon Cognito Identity Provider. See this package's package overview docs for details on the service.
CognitoIdentityProvider methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(config aws.Config) *CognitoIdentityProvider
New creates a new instance of the CognitoIdentityProvider client with a config.
Example:
// Create a CognitoIdentityProvider client from just a config. svc := cognitoidentityprovider.New(myConfig)
func (*CognitoIdentityProvider) AddCustomAttributesRequest ¶
func (c *CognitoIdentityProvider) AddCustomAttributesRequest(input *AddCustomAttributesInput) AddCustomAttributesRequest
AddCustomAttributesRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Adds additional user attributes to the user pool schema.
// Example sending a request using the AddCustomAttributesRequest method. req := client.AddCustomAttributesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AddCustomAttributes
func (*CognitoIdentityProvider) AdminAddUserToGroupRequest ¶
func (c *CognitoIdentityProvider) AdminAddUserToGroupRequest(input *AdminAddUserToGroupInput) AdminAddUserToGroupRequest
AdminAddUserToGroupRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Adds the specified user to the specified group.
Requires developer credentials.
// Example sending a request using the AdminAddUserToGroupRequest method. req := client.AdminAddUserToGroupRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminAddUserToGroup
func (*CognitoIdentityProvider) AdminConfirmSignUpRequest ¶
func (c *CognitoIdentityProvider) AdminConfirmSignUpRequest(input *AdminConfirmSignUpInput) AdminConfirmSignUpRequest
AdminConfirmSignUpRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Confirms user registration as an admin without using a confirmation code. Works on any user.
Requires developer credentials.
// Example sending a request using the AdminConfirmSignUpRequest method. req := client.AdminConfirmSignUpRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminConfirmSignUp
func (*CognitoIdentityProvider) AdminCreateUserRequest ¶
func (c *CognitoIdentityProvider) AdminCreateUserRequest(input *AdminCreateUserInput) AdminCreateUserRequest
AdminCreateUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Creates a new user in the specified user pool.
If MessageAction is not set, the default is to send a welcome message via email or phone (SMS).
This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password.
Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.
AdminCreateUser requires developer credentials.
// Example sending a request using the AdminCreateUserRequest method. req := client.AdminCreateUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminCreateUser
func (*CognitoIdentityProvider) AdminDeleteUserAttributesRequest ¶
func (c *CognitoIdentityProvider) AdminDeleteUserAttributesRequest(input *AdminDeleteUserAttributesInput) AdminDeleteUserAttributesRequest
AdminDeleteUserAttributesRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Deletes the user attributes in a user pool as an administrator. Works on any user.
Requires developer credentials.
// Example sending a request using the AdminDeleteUserAttributesRequest method. req := client.AdminDeleteUserAttributesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUserAttributes
func (*CognitoIdentityProvider) AdminDeleteUserRequest ¶
func (c *CognitoIdentityProvider) AdminDeleteUserRequest(input *AdminDeleteUserInput) AdminDeleteUserRequest
AdminDeleteUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Deletes a user as an administrator. Works on any user.
Requires developer credentials.
// Example sending a request using the AdminDeleteUserRequest method. req := client.AdminDeleteUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDeleteUser
func (*CognitoIdentityProvider) AdminDisableProviderForUserRequest ¶
func (c *CognitoIdentityProvider) AdminDisableProviderForUserRequest(input *AdminDisableProviderForUserInput) AdminDisableProviderForUserRequest
AdminDisableProviderForUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See .
This action is enabled only for admin access and requires developer credentials.
The ProviderName must match the value specified when creating an IdP for the pool.
To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user.
The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.
For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
// Example sending a request using the AdminDisableProviderForUserRequest method. req := client.AdminDisableProviderForUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableProviderForUser
func (*CognitoIdentityProvider) AdminDisableUserRequest ¶
func (c *CognitoIdentityProvider) AdminDisableUserRequest(input *AdminDisableUserInput) AdminDisableUserRequest
AdminDisableUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Disables the specified user as an administrator. Works on any user.
Requires developer credentials.
// Example sending a request using the AdminDisableUserRequest method. req := client.AdminDisableUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminDisableUser
func (*CognitoIdentityProvider) AdminEnableUserRequest ¶
func (c *CognitoIdentityProvider) AdminEnableUserRequest(input *AdminEnableUserInput) AdminEnableUserRequest
AdminEnableUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Enables the specified user as an administrator. Works on any user.
Requires developer credentials.
// Example sending a request using the AdminEnableUserRequest method. req := client.AdminEnableUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminEnableUser
func (*CognitoIdentityProvider) AdminForgetDeviceRequest ¶
func (c *CognitoIdentityProvider) AdminForgetDeviceRequest(input *AdminForgetDeviceInput) AdminForgetDeviceRequest
AdminForgetDeviceRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Forgets the device, as an administrator.
Requires developer credentials.
// Example sending a request using the AdminForgetDeviceRequest method. req := client.AdminForgetDeviceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminForgetDevice
func (*CognitoIdentityProvider) AdminGetDeviceRequest ¶
func (c *CognitoIdentityProvider) AdminGetDeviceRequest(input *AdminGetDeviceInput) AdminGetDeviceRequest
AdminGetDeviceRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the device, as an administrator.
Requires developer credentials.
// Example sending a request using the AdminGetDeviceRequest method. req := client.AdminGetDeviceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetDevice
func (*CognitoIdentityProvider) AdminGetUserRequest ¶
func (c *CognitoIdentityProvider) AdminGetUserRequest(input *AdminGetUserInput) AdminGetUserRequest
AdminGetUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the specified user by user name in a user pool as an administrator. Works on any user.
Requires developer credentials.
// Example sending a request using the AdminGetUserRequest method. req := client.AdminGetUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminGetUser
func (*CognitoIdentityProvider) AdminInitiateAuthRequest ¶
func (c *CognitoIdentityProvider) AdminInitiateAuthRequest(input *AdminInitiateAuthInput) AdminInitiateAuthRequest
AdminInitiateAuthRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Initiates the authentication flow, as an administrator.
Requires developer credentials.
// Example sending a request using the AdminInitiateAuthRequest method. req := client.AdminInitiateAuthRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminInitiateAuth
func (*CognitoIdentityProvider) AdminLinkProviderForUserRequest ¶
func (c *CognitoIdentityProvider) AdminLinkProviderForUserRequest(input *AdminLinkProviderForUserInput) AdminLinkProviderForUserRequest
AdminLinkProviderForUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account.
For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.
Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.
See also .
This action is enabled only for admin access and requires developer credentials.
// Example sending a request using the AdminLinkProviderForUserRequest method. req := client.AdminLinkProviderForUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminLinkProviderForUser
func (*CognitoIdentityProvider) AdminListDevicesRequest ¶
func (c *CognitoIdentityProvider) AdminListDevicesRequest(input *AdminListDevicesInput) AdminListDevicesRequest
AdminListDevicesRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists devices, as an administrator.
Requires developer credentials.
// Example sending a request using the AdminListDevicesRequest method. req := client.AdminListDevicesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListDevices
func (*CognitoIdentityProvider) AdminListGroupsForUserRequest ¶
func (c *CognitoIdentityProvider) AdminListGroupsForUserRequest(input *AdminListGroupsForUserInput) AdminListGroupsForUserRequest
AdminListGroupsForUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the groups that the user belongs to.
Requires developer credentials.
// Example sending a request using the AdminListGroupsForUserRequest method. req := client.AdminListGroupsForUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListGroupsForUser
func (*CognitoIdentityProvider) AdminListUserAuthEventsRequest ¶
func (c *CognitoIdentityProvider) AdminListUserAuthEventsRequest(input *AdminListUserAuthEventsInput) AdminListUserAuthEventsRequest
AdminListUserAuthEventsRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
// Example sending a request using the AdminListUserAuthEventsRequest method. req := client.AdminListUserAuthEventsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminListUserAuthEvents
func (*CognitoIdentityProvider) AdminRemoveUserFromGroupRequest ¶
func (c *CognitoIdentityProvider) AdminRemoveUserFromGroupRequest(input *AdminRemoveUserFromGroupInput) AdminRemoveUserFromGroupRequest
AdminRemoveUserFromGroupRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Removes the specified user from the specified group.
Requires developer credentials.
// Example sending a request using the AdminRemoveUserFromGroupRequest method. req := client.AdminRemoveUserFromGroupRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRemoveUserFromGroup
func (*CognitoIdentityProvider) AdminResetUserPasswordRequest ¶
func (c *CognitoIdentityProvider) AdminResetUserPasswordRequest(input *AdminResetUserPasswordInput) AdminResetUserPasswordRequest
AdminResetUserPasswordRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Resets the specified user's password in a user pool as an administrator. Works on any user.
When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.
Requires developer credentials.
// Example sending a request using the AdminResetUserPasswordRequest method. req := client.AdminResetUserPasswordRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminResetUserPassword
func (*CognitoIdentityProvider) AdminRespondToAuthChallengeRequest ¶
func (c *CognitoIdentityProvider) AdminRespondToAuthChallengeRequest(input *AdminRespondToAuthChallengeInput) AdminRespondToAuthChallengeRequest
AdminRespondToAuthChallengeRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Responds to an authentication challenge, as an administrator.
Requires developer credentials.
// Example sending a request using the AdminRespondToAuthChallengeRequest method. req := client.AdminRespondToAuthChallengeRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminRespondToAuthChallenge
func (*CognitoIdentityProvider) AdminSetUserMFAPreferenceRequest ¶
func (c *CognitoIdentityProvider) AdminSetUserMFAPreferenceRequest(input *AdminSetUserMFAPreferenceInput) AdminSetUserMFAPreferenceRequest
AdminSetUserMFAPreferenceRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Sets the user's multi-factor authentication (MFA) preference.
// Example sending a request using the AdminSetUserMFAPreferenceRequest method. req := client.AdminSetUserMFAPreferenceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminSetUserMFAPreference
func (*CognitoIdentityProvider) AdminSetUserSettingsRequest ¶
func (c *CognitoIdentityProvider) AdminSetUserSettingsRequest(input *AdminSetUserSettingsInput) AdminSetUserSettingsRequest
AdminSetUserSettingsRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Sets all the user settings for a specified user name. Works on any user.
Requires developer credentials.
// Example sending a request using the AdminSetUserSettingsRequest method. req := client.AdminSetUserSettingsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminSetUserSettings
func (*CognitoIdentityProvider) AdminUpdateAuthEventFeedbackRequest ¶
func (c *CognitoIdentityProvider) AdminUpdateAuthEventFeedbackRequest(input *AdminUpdateAuthEventFeedbackInput) AdminUpdateAuthEventFeedbackRequest
AdminUpdateAuthEventFeedbackRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
// Example sending a request using the AdminUpdateAuthEventFeedbackRequest method. req := client.AdminUpdateAuthEventFeedbackRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateAuthEventFeedback
func (*CognitoIdentityProvider) AdminUpdateDeviceStatusRequest ¶
func (c *CognitoIdentityProvider) AdminUpdateDeviceStatusRequest(input *AdminUpdateDeviceStatusInput) AdminUpdateDeviceStatusRequest
AdminUpdateDeviceStatusRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Updates the device status as an administrator.
Requires developer credentials.
// Example sending a request using the AdminUpdateDeviceStatusRequest method. req := client.AdminUpdateDeviceStatusRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateDeviceStatus
func (*CognitoIdentityProvider) AdminUpdateUserAttributesRequest ¶
func (c *CognitoIdentityProvider) AdminUpdateUserAttributesRequest(input *AdminUpdateUserAttributesInput) AdminUpdateUserAttributesRequest
AdminUpdateUserAttributesRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.
For custom attributes, you must prepend the custom: prefix to the attribute name.
In addition to updating user attributes, this API can also be used to mark phone and email as verified.
Requires developer credentials.
// Example sending a request using the AdminUpdateUserAttributesRequest method. req := client.AdminUpdateUserAttributesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUpdateUserAttributes
func (*CognitoIdentityProvider) AdminUserGlobalSignOutRequest ¶
func (c *CognitoIdentityProvider) AdminUserGlobalSignOutRequest(input *AdminUserGlobalSignOutInput) AdminUserGlobalSignOutRequest
AdminUserGlobalSignOutRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Signs out users from all devices, as an administrator.
Requires developer credentials.
// Example sending a request using the AdminUserGlobalSignOutRequest method. req := client.AdminUserGlobalSignOutRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AdminUserGlobalSignOut
func (*CognitoIdentityProvider) AssociateSoftwareTokenRequest ¶
func (c *CognitoIdentityProvider) AssociateSoftwareTokenRequest(input *AssociateSoftwareTokenInput) AssociateSoftwareTokenRequest
AssociateSoftwareTokenRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
// Example sending a request using the AssociateSoftwareTokenRequest method. req := client.AssociateSoftwareTokenRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/AssociateSoftwareToken
func (*CognitoIdentityProvider) ChangePasswordRequest ¶
func (c *CognitoIdentityProvider) ChangePasswordRequest(input *ChangePasswordInput) ChangePasswordRequest
ChangePasswordRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Changes the password for a specified user in a user pool.
// Example sending a request using the ChangePasswordRequest method. req := client.ChangePasswordRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ChangePassword
func (*CognitoIdentityProvider) ConfirmDeviceRequest ¶
func (c *CognitoIdentityProvider) ConfirmDeviceRequest(input *ConfirmDeviceInput) ConfirmDeviceRequest
ConfirmDeviceRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Confirms tracking of the device. This API call is the call that begins device tracking.
// Example sending a request using the ConfirmDeviceRequest method. req := client.ConfirmDeviceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmDevice
func (*CognitoIdentityProvider) ConfirmForgotPasswordRequest ¶
func (c *CognitoIdentityProvider) ConfirmForgotPasswordRequest(input *ConfirmForgotPasswordInput) ConfirmForgotPasswordRequest
ConfirmForgotPasswordRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Allows a user to enter a confirmation code to reset a forgotten password.
// Example sending a request using the ConfirmForgotPasswordRequest method. req := client.ConfirmForgotPasswordRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmForgotPassword
func (*CognitoIdentityProvider) ConfirmSignUpRequest ¶
func (c *CognitoIdentityProvider) ConfirmSignUpRequest(input *ConfirmSignUpInput) ConfirmSignUpRequest
ConfirmSignUpRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Confirms registration of a user and handles the existing alias from a previous user.
// Example sending a request using the ConfirmSignUpRequest method. req := client.ConfirmSignUpRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmSignUp
func (*CognitoIdentityProvider) CreateGroupRequest ¶
func (c *CognitoIdentityProvider) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest
CreateGroupRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Creates a new group in the specified user pool.
Requires developer credentials.
// Example sending a request using the CreateGroupRequest method. req := client.CreateGroupRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateGroup
func (*CognitoIdentityProvider) CreateIdentityProviderRequest ¶
func (c *CognitoIdentityProvider) CreateIdentityProviderRequest(input *CreateIdentityProviderInput) CreateIdentityProviderRequest
CreateIdentityProviderRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Creates an identity provider for a user pool.
// Example sending a request using the CreateIdentityProviderRequest method. req := client.CreateIdentityProviderRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateIdentityProvider
func (*CognitoIdentityProvider) CreateResourceServerRequest ¶
func (c *CognitoIdentityProvider) CreateResourceServerRequest(input *CreateResourceServerInput) CreateResourceServerRequest
CreateResourceServerRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Creates a new OAuth2.0 resource server and defines custom scopes in it.
// Example sending a request using the CreateResourceServerRequest method. req := client.CreateResourceServerRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateResourceServer
func (*CognitoIdentityProvider) CreateUserImportJobRequest ¶
func (c *CognitoIdentityProvider) CreateUserImportJobRequest(input *CreateUserImportJobInput) CreateUserImportJobRequest
CreateUserImportJobRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Creates the user import job.
// Example sending a request using the CreateUserImportJobRequest method. req := client.CreateUserImportJobRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserImportJob
func (*CognitoIdentityProvider) CreateUserPoolClientRequest ¶
func (c *CognitoIdentityProvider) CreateUserPoolClientRequest(input *CreateUserPoolClientInput) CreateUserPoolClientRequest
CreateUserPoolClientRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Creates the user pool client.
// Example sending a request using the CreateUserPoolClientRequest method. req := client.CreateUserPoolClientRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClient
func (*CognitoIdentityProvider) CreateUserPoolDomainRequest ¶
func (c *CognitoIdentityProvider) CreateUserPoolDomainRequest(input *CreateUserPoolDomainInput) CreateUserPoolDomainRequest
CreateUserPoolDomainRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Creates a new domain for a user pool.
// Example sending a request using the CreateUserPoolDomainRequest method. req := client.CreateUserPoolDomainRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolDomain
func (*CognitoIdentityProvider) CreateUserPoolRequest ¶
func (c *CognitoIdentityProvider) CreateUserPoolRequest(input *CreateUserPoolInput) CreateUserPoolRequest
CreateUserPoolRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Creates a new Amazon Cognito user pool and sets the password policy for the pool.
// Example sending a request using the CreateUserPoolRequest method. req := client.CreateUserPoolRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPool
func (*CognitoIdentityProvider) DeleteGroupRequest ¶
func (c *CognitoIdentityProvider) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest
DeleteGroupRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Deletes a group. Currently only groups with no members can be deleted.
Requires developer credentials.
// Example sending a request using the DeleteGroupRequest method. req := client.DeleteGroupRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteGroup
func (*CognitoIdentityProvider) DeleteIdentityProviderRequest ¶
func (c *CognitoIdentityProvider) DeleteIdentityProviderRequest(input *DeleteIdentityProviderInput) DeleteIdentityProviderRequest
DeleteIdentityProviderRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Deletes an identity provider for a user pool.
// Example sending a request using the DeleteIdentityProviderRequest method. req := client.DeleteIdentityProviderRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteIdentityProvider
func (*CognitoIdentityProvider) DeleteResourceServerRequest ¶
func (c *CognitoIdentityProvider) DeleteResourceServerRequest(input *DeleteResourceServerInput) DeleteResourceServerRequest
DeleteResourceServerRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Deletes a resource server.
// Example sending a request using the DeleteResourceServerRequest method. req := client.DeleteResourceServerRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteResourceServer
func (*CognitoIdentityProvider) DeleteUserAttributesRequest ¶
func (c *CognitoIdentityProvider) DeleteUserAttributesRequest(input *DeleteUserAttributesInput) DeleteUserAttributesRequest
DeleteUserAttributesRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Deletes the attributes for a user.
// Example sending a request using the DeleteUserAttributesRequest method. req := client.DeleteUserAttributesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserAttributes
func (*CognitoIdentityProvider) DeleteUserPoolClientRequest ¶
func (c *CognitoIdentityProvider) DeleteUserPoolClientRequest(input *DeleteUserPoolClientInput) DeleteUserPoolClientRequest
DeleteUserPoolClientRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Allows the developer to delete the user pool client.
// Example sending a request using the DeleteUserPoolClientRequest method. req := client.DeleteUserPoolClientRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolClient
func (*CognitoIdentityProvider) DeleteUserPoolDomainRequest ¶
func (c *CognitoIdentityProvider) DeleteUserPoolDomainRequest(input *DeleteUserPoolDomainInput) DeleteUserPoolDomainRequest
DeleteUserPoolDomainRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Deletes a domain for a user pool.
// Example sending a request using the DeleteUserPoolDomainRequest method. req := client.DeleteUserPoolDomainRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolDomain
func (*CognitoIdentityProvider) DeleteUserPoolRequest ¶
func (c *CognitoIdentityProvider) DeleteUserPoolRequest(input *DeleteUserPoolInput) DeleteUserPoolRequest
DeleteUserPoolRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Deletes the specified Amazon Cognito user pool.
// Example sending a request using the DeleteUserPoolRequest method. req := client.DeleteUserPoolRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPool
func (*CognitoIdentityProvider) DeleteUserRequest ¶
func (c *CognitoIdentityProvider) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest
DeleteUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Allows a user to delete himself or herself.
// Example sending a request using the DeleteUserRequest method. req := client.DeleteUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUser
func (*CognitoIdentityProvider) DescribeIdentityProviderRequest ¶
func (c *CognitoIdentityProvider) DescribeIdentityProviderRequest(input *DescribeIdentityProviderInput) DescribeIdentityProviderRequest
DescribeIdentityProviderRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets information about a specific identity provider.
// Example sending a request using the DescribeIdentityProviderRequest method. req := client.DescribeIdentityProviderRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeIdentityProvider
func (*CognitoIdentityProvider) DescribeResourceServerRequest ¶
func (c *CognitoIdentityProvider) DescribeResourceServerRequest(input *DescribeResourceServerInput) DescribeResourceServerRequest
DescribeResourceServerRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Describes a resource server.
// Example sending a request using the DescribeResourceServerRequest method. req := client.DescribeResourceServerRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeResourceServer
func (*CognitoIdentityProvider) DescribeRiskConfigurationRequest ¶
func (c *CognitoIdentityProvider) DescribeRiskConfigurationRequest(input *DescribeRiskConfigurationInput) DescribeRiskConfigurationRequest
DescribeRiskConfigurationRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Describes the risk configuration.
// Example sending a request using the DescribeRiskConfigurationRequest method. req := client.DescribeRiskConfigurationRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeRiskConfiguration
func (*CognitoIdentityProvider) DescribeUserImportJobRequest ¶
func (c *CognitoIdentityProvider) DescribeUserImportJobRequest(input *DescribeUserImportJobInput) DescribeUserImportJobRequest
DescribeUserImportJobRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Describes the user import job.
// Example sending a request using the DescribeUserImportJobRequest method. req := client.DescribeUserImportJobRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserImportJob
func (*CognitoIdentityProvider) DescribeUserPoolClientRequest ¶
func (c *CognitoIdentityProvider) DescribeUserPoolClientRequest(input *DescribeUserPoolClientInput) DescribeUserPoolClientRequest
DescribeUserPoolClientRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Client method for returning the configuration information and metadata of the specified user pool client.
// Example sending a request using the DescribeUserPoolClientRequest method. req := client.DescribeUserPoolClientRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClient
func (*CognitoIdentityProvider) DescribeUserPoolDomainRequest ¶
func (c *CognitoIdentityProvider) DescribeUserPoolDomainRequest(input *DescribeUserPoolDomainInput) DescribeUserPoolDomainRequest
DescribeUserPoolDomainRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets information about a domain.
// Example sending a request using the DescribeUserPoolDomainRequest method. req := client.DescribeUserPoolDomainRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolDomain
func (*CognitoIdentityProvider) DescribeUserPoolRequest ¶
func (c *CognitoIdentityProvider) DescribeUserPoolRequest(input *DescribeUserPoolInput) DescribeUserPoolRequest
DescribeUserPoolRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Returns the configuration information and metadata of the specified user pool.
// Example sending a request using the DescribeUserPoolRequest method. req := client.DescribeUserPoolRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPool
func (*CognitoIdentityProvider) ForgetDeviceRequest ¶
func (c *CognitoIdentityProvider) ForgetDeviceRequest(input *ForgetDeviceInput) ForgetDeviceRequest
ForgetDeviceRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Forgets the specified device.
// Example sending a request using the ForgetDeviceRequest method. req := client.ForgetDeviceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgetDevice
func (*CognitoIdentityProvider) ForgotPasswordRequest ¶
func (c *CognitoIdentityProvider) ForgotPasswordRequest(input *ForgotPasswordInput) ForgotPasswordRequest
ForgotPasswordRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .
// Example sending a request using the ForgotPasswordRequest method. req := client.ForgotPasswordRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgotPassword
func (*CognitoIdentityProvider) GetCSVHeaderRequest ¶
func (c *CognitoIdentityProvider) GetCSVHeaderRequest(input *GetCSVHeaderInput) GetCSVHeaderRequest
GetCSVHeaderRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the header information for the .csv file to be used as input for the user import job.
// Example sending a request using the GetCSVHeaderRequest method. req := client.GetCSVHeaderRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetCSVHeader
func (*CognitoIdentityProvider) GetDeviceRequest ¶
func (c *CognitoIdentityProvider) GetDeviceRequest(input *GetDeviceInput) GetDeviceRequest
GetDeviceRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the device.
// Example sending a request using the GetDeviceRequest method. req := client.GetDeviceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetDevice
func (*CognitoIdentityProvider) GetGroupRequest ¶
func (c *CognitoIdentityProvider) GetGroupRequest(input *GetGroupInput) GetGroupRequest
GetGroupRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets a group.
Requires developer credentials.
// Example sending a request using the GetGroupRequest method. req := client.GetGroupRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetGroup
func (*CognitoIdentityProvider) GetIdentityProviderByIdentifierRequest ¶
func (c *CognitoIdentityProvider) GetIdentityProviderByIdentifierRequest(input *GetIdentityProviderByIdentifierInput) GetIdentityProviderByIdentifierRequest
GetIdentityProviderByIdentifierRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the specified identity provider.
// Example sending a request using the GetIdentityProviderByIdentifierRequest method. req := client.GetIdentityProviderByIdentifierRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetIdentityProviderByIdentifier
func (*CognitoIdentityProvider) GetSigningCertificateRequest ¶
func (c *CognitoIdentityProvider) GetSigningCertificateRequest(input *GetSigningCertificateInput) GetSigningCertificateRequest
GetSigningCertificateRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
This method takes a user pool ID, and returns the signing certificate.
// Example sending a request using the GetSigningCertificateRequest method. req := client.GetSigningCertificateRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetSigningCertificate
func (*CognitoIdentityProvider) GetUICustomizationRequest ¶
func (c *CognitoIdentityProvider) GetUICustomizationRequest(input *GetUICustomizationInput) GetUICustomizationRequest
GetUICustomizationRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.
// Example sending a request using the GetUICustomizationRequest method. req := client.GetUICustomizationRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUICustomization
func (*CognitoIdentityProvider) GetUserAttributeVerificationCodeRequest ¶
func (c *CognitoIdentityProvider) GetUserAttributeVerificationCodeRequest(input *GetUserAttributeVerificationCodeInput) GetUserAttributeVerificationCodeRequest
GetUserAttributeVerificationCodeRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the user attribute verification code for the specified attribute name.
// Example sending a request using the GetUserAttributeVerificationCodeRequest method. req := client.GetUserAttributeVerificationCodeRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAttributeVerificationCode
func (*CognitoIdentityProvider) GetUserPoolMfaConfigRequest ¶
func (c *CognitoIdentityProvider) GetUserPoolMfaConfigRequest(input *GetUserPoolMfaConfigInput) GetUserPoolMfaConfigRequest
GetUserPoolMfaConfigRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the user pool multi-factor authentication (MFA) configuration.
// Example sending a request using the GetUserPoolMfaConfigRequest method. req := client.GetUserPoolMfaConfigRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserPoolMfaConfig
func (*CognitoIdentityProvider) GetUserRequest ¶
func (c *CognitoIdentityProvider) GetUserRequest(input *GetUserInput) GetUserRequest
GetUserRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Gets the user attributes and metadata for a user.
// Example sending a request using the GetUserRequest method. req := client.GetUserRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUser
func (*CognitoIdentityProvider) GlobalSignOutRequest ¶
func (c *CognitoIdentityProvider) GlobalSignOutRequest(input *GlobalSignOutInput) GlobalSignOutRequest
GlobalSignOutRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Signs out users from all devices.
// Example sending a request using the GlobalSignOutRequest method. req := client.GlobalSignOutRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GlobalSignOut
func (*CognitoIdentityProvider) InitiateAuthRequest ¶
func (c *CognitoIdentityProvider) InitiateAuthRequest(input *InitiateAuthInput) InitiateAuthRequest
InitiateAuthRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Initiates the authentication flow.
// Example sending a request using the InitiateAuthRequest method. req := client.InitiateAuthRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuth
func (*CognitoIdentityProvider) ListDevicesRequest ¶
func (c *CognitoIdentityProvider) ListDevicesRequest(input *ListDevicesInput) ListDevicesRequest
ListDevicesRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the devices.
// Example sending a request using the ListDevicesRequest method. req := client.ListDevicesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListDevices
func (*CognitoIdentityProvider) ListGroupsRequest ¶
func (c *CognitoIdentityProvider) ListGroupsRequest(input *ListGroupsInput) ListGroupsRequest
ListGroupsRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the groups associated with a user pool.
Requires developer credentials.
// Example sending a request using the ListGroupsRequest method. req := client.ListGroupsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListGroups
func (*CognitoIdentityProvider) ListIdentityProvidersRequest ¶
func (c *CognitoIdentityProvider) ListIdentityProvidersRequest(input *ListIdentityProvidersInput) ListIdentityProvidersRequest
ListIdentityProvidersRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists information about all identity providers for a user pool.
// Example sending a request using the ListIdentityProvidersRequest method. req := client.ListIdentityProvidersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListIdentityProviders
func (*CognitoIdentityProvider) ListResourceServersRequest ¶
func (c *CognitoIdentityProvider) ListResourceServersRequest(input *ListResourceServersInput) ListResourceServersRequest
ListResourceServersRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the resource servers for a user pool.
// Example sending a request using the ListResourceServersRequest method. req := client.ListResourceServersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListResourceServers
func (*CognitoIdentityProvider) ListUserImportJobsRequest ¶
func (c *CognitoIdentityProvider) ListUserImportJobsRequest(input *ListUserImportJobsInput) ListUserImportJobsRequest
ListUserImportJobsRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the user import jobs.
// Example sending a request using the ListUserImportJobsRequest method. req := client.ListUserImportJobsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserImportJobs
func (*CognitoIdentityProvider) ListUserPoolClientsRequest ¶
func (c *CognitoIdentityProvider) ListUserPoolClientsRequest(input *ListUserPoolClientsInput) ListUserPoolClientsRequest
ListUserPoolClientsRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the clients that have been created for the specified user pool.
// Example sending a request using the ListUserPoolClientsRequest method. req := client.ListUserPoolClientsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolClients
func (*CognitoIdentityProvider) ListUserPoolsRequest ¶
func (c *CognitoIdentityProvider) ListUserPoolsRequest(input *ListUserPoolsInput) ListUserPoolsRequest
ListUserPoolsRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the user pools associated with an AWS account.
// Example sending a request using the ListUserPoolsRequest method. req := client.ListUserPoolsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPools
func (*CognitoIdentityProvider) ListUsersInGroupRequest ¶
func (c *CognitoIdentityProvider) ListUsersInGroupRequest(input *ListUsersInGroupInput) ListUsersInGroupRequest
ListUsersInGroupRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the users in the specified group.
Requires developer credentials.
// Example sending a request using the ListUsersInGroupRequest method. req := client.ListUsersInGroupRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersInGroup
func (*CognitoIdentityProvider) ListUsersRequest ¶
func (c *CognitoIdentityProvider) ListUsersRequest(input *ListUsersInput) ListUsersRequest
ListUsersRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Lists the users in the Amazon Cognito user pool.
// Example sending a request using the ListUsersRequest method. req := client.ListUsersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsers
func (*CognitoIdentityProvider) ResendConfirmationCodeRequest ¶
func (c *CognitoIdentityProvider) ResendConfirmationCodeRequest(input *ResendConfirmationCodeInput) ResendConfirmationCodeRequest
ResendConfirmationCodeRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
// Example sending a request using the ResendConfirmationCodeRequest method. req := client.ResendConfirmationCodeRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResendConfirmationCode
func (*CognitoIdentityProvider) RespondToAuthChallengeRequest ¶
func (c *CognitoIdentityProvider) RespondToAuthChallengeRequest(input *RespondToAuthChallengeInput) RespondToAuthChallengeRequest
RespondToAuthChallengeRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Responds to the authentication challenge.
// Example sending a request using the RespondToAuthChallengeRequest method. req := client.RespondToAuthChallengeRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RespondToAuthChallenge
func (*CognitoIdentityProvider) SetRiskConfigurationRequest ¶
func (c *CognitoIdentityProvider) SetRiskConfigurationRequest(input *SetRiskConfigurationInput) SetRiskConfigurationRequest
SetRiskConfigurationRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.
To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.
See .
// Example sending a request using the SetRiskConfigurationRequest method. req := client.SetRiskConfigurationRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetRiskConfiguration
func (*CognitoIdentityProvider) SetUICustomizationRequest ¶
func (c *CognitoIdentityProvider) SetUICustomizationRequest(input *SetUICustomizationInput) SetUICustomizationRequest
SetUICustomizationRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Sets the UI customization information for a user pool's built-in app UI.
You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration.
To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
// Example sending a request using the SetUICustomizationRequest method. req := client.SetUICustomizationRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUICustomization
func (*CognitoIdentityProvider) SetUserMFAPreferenceRequest ¶
func (c *CognitoIdentityProvider) SetUserMFAPreferenceRequest(input *SetUserMFAPreferenceInput) SetUserMFAPreferenceRequest
SetUserMFAPreferenceRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Set the user's multi-factor authentication (MFA) method preference.
// Example sending a request using the SetUserMFAPreferenceRequest method. req := client.SetUserMFAPreferenceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserMFAPreference
func (*CognitoIdentityProvider) SetUserPoolMfaConfigRequest ¶
func (c *CognitoIdentityProvider) SetUserPoolMfaConfigRequest(input *SetUserPoolMfaConfigInput) SetUserPoolMfaConfigRequest
SetUserPoolMfaConfigRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Set the user pool MFA configuration.
// Example sending a request using the SetUserPoolMfaConfigRequest method. req := client.SetUserPoolMfaConfigRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserPoolMfaConfig
func (*CognitoIdentityProvider) SetUserSettingsRequest ¶
func (c *CognitoIdentityProvider) SetUserSettingsRequest(input *SetUserSettingsInput) SetUserSettingsRequest
SetUserSettingsRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.
// Example sending a request using the SetUserSettingsRequest method. req := client.SetUserSettingsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserSettings
func (*CognitoIdentityProvider) SignUpRequest ¶
func (c *CognitoIdentityProvider) SignUpRequest(input *SignUpInput) SignUpRequest
SignUpRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Registers the user in the specified user pool and creates a user name, password, and user attributes.
// Example sending a request using the SignUpRequest method. req := client.SignUpRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SignUp
func (*CognitoIdentityProvider) StartUserImportJobRequest ¶
func (c *CognitoIdentityProvider) StartUserImportJobRequest(input *StartUserImportJobInput) StartUserImportJobRequest
StartUserImportJobRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Starts the user import.
// Example sending a request using the StartUserImportJobRequest method. req := client.StartUserImportJobRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StartUserImportJob
func (*CognitoIdentityProvider) StopUserImportJobRequest ¶
func (c *CognitoIdentityProvider) StopUserImportJobRequest(input *StopUserImportJobInput) StopUserImportJobRequest
StopUserImportJobRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Stops the user import job.
// Example sending a request using the StopUserImportJobRequest method. req := client.StopUserImportJobRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StopUserImportJob
func (*CognitoIdentityProvider) UpdateAuthEventFeedbackRequest ¶
func (c *CognitoIdentityProvider) UpdateAuthEventFeedbackRequest(input *UpdateAuthEventFeedbackInput) UpdateAuthEventFeedbackRequest
UpdateAuthEventFeedbackRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
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.
// Example sending a request using the UpdateAuthEventFeedbackRequest method. req := client.UpdateAuthEventFeedbackRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateAuthEventFeedback
func (*CognitoIdentityProvider) UpdateDeviceStatusRequest ¶
func (c *CognitoIdentityProvider) UpdateDeviceStatusRequest(input *UpdateDeviceStatusInput) UpdateDeviceStatusRequest
UpdateDeviceStatusRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Updates the device status.
// Example sending a request using the UpdateDeviceStatusRequest method. req := client.UpdateDeviceStatusRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateDeviceStatus
func (*CognitoIdentityProvider) UpdateGroupRequest ¶
func (c *CognitoIdentityProvider) UpdateGroupRequest(input *UpdateGroupInput) UpdateGroupRequest
UpdateGroupRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Updates the specified group with the specified attributes.
Requires developer credentials.
// Example sending a request using the UpdateGroupRequest method. req := client.UpdateGroupRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateGroup
func (*CognitoIdentityProvider) UpdateIdentityProviderRequest ¶
func (c *CognitoIdentityProvider) UpdateIdentityProviderRequest(input *UpdateIdentityProviderInput) UpdateIdentityProviderRequest
UpdateIdentityProviderRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Updates identity provider information for a user pool.
// Example sending a request using the UpdateIdentityProviderRequest method. req := client.UpdateIdentityProviderRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateIdentityProvider
func (*CognitoIdentityProvider) UpdateResourceServerRequest ¶
func (c *CognitoIdentityProvider) UpdateResourceServerRequest(input *UpdateResourceServerInput) UpdateResourceServerRequest
UpdateResourceServerRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Updates the name and scopes of resource server. All other fields are read-only.
// Example sending a request using the UpdateResourceServerRequest method. req := client.UpdateResourceServerRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateResourceServer
func (*CognitoIdentityProvider) UpdateUserAttributesRequest ¶
func (c *CognitoIdentityProvider) UpdateUserAttributesRequest(input *UpdateUserAttributesInput) UpdateUserAttributesRequest
UpdateUserAttributesRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Allows a user to update a specific attribute (one at a time).
// Example sending a request using the UpdateUserAttributesRequest method. req := client.UpdateUserAttributesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserAttributes
func (*CognitoIdentityProvider) UpdateUserPoolClientRequest ¶
func (c *CognitoIdentityProvider) UpdateUserPoolClientRequest(input *UpdateUserPoolClientInput) UpdateUserPoolClientRequest
UpdateUserPoolClientRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Allows the developer to update the specified user pool client and password policy.
// Example sending a request using the UpdateUserPoolClientRequest method. req := client.UpdateUserPoolClientRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClient
func (*CognitoIdentityProvider) UpdateUserPoolRequest ¶
func (c *CognitoIdentityProvider) UpdateUserPoolRequest(input *UpdateUserPoolInput) UpdateUserPoolRequest
UpdateUserPoolRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Updates the specified user pool with the specified attributes.
// Example sending a request using the UpdateUserPoolRequest method. req := client.UpdateUserPoolRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPool
func (*CognitoIdentityProvider) VerifySoftwareTokenRequest ¶
func (c *CognitoIdentityProvider) VerifySoftwareTokenRequest(input *VerifySoftwareTokenInput) VerifySoftwareTokenRequest
VerifySoftwareTokenRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
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.
// Example sending a request using the VerifySoftwareTokenRequest method. req := client.VerifySoftwareTokenRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifySoftwareToken
func (*CognitoIdentityProvider) VerifyUserAttributeRequest ¶
func (c *CognitoIdentityProvider) VerifyUserAttributeRequest(input *VerifyUserAttributeInput) VerifyUserAttributeRequest
VerifyUserAttributeRequest returns a request value for making API operation for Amazon Cognito Identity Provider.
Verifies the specified user attributes in the user pool.
// Example sending a request using the VerifyUserAttributeRequest method. req := client.VerifyUserAttributeRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifyUserAttribute
type CompromisedCredentialsActionsType ¶
type CompromisedCredentialsActionsType struct { // The event action. // // EventAction is a required field EventAction CompromisedCredentialsEventActionType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The compromised credentials actions type Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CompromisedCredentialsActionsType
func (CompromisedCredentialsActionsType) GoString ¶
func (s CompromisedCredentialsActionsType) GoString() string
GoString returns the string representation
func (CompromisedCredentialsActionsType) String ¶
func (s CompromisedCredentialsActionsType) String() string
String returns the string representation
func (*CompromisedCredentialsActionsType) Validate ¶
func (s *CompromisedCredentialsActionsType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CompromisedCredentialsEventActionType ¶
type CompromisedCredentialsEventActionType string
const ( CompromisedCredentialsEventActionTypeBlock CompromisedCredentialsEventActionType = "BLOCK" CompromisedCredentialsEventActionTypeNoAction CompromisedCredentialsEventActionType = "NO_ACTION" )
Enum values for CompromisedCredentialsEventActionType
func (CompromisedCredentialsEventActionType) MarshalValue ¶
func (enum CompromisedCredentialsEventActionType) MarshalValue() (string, error)
func (CompromisedCredentialsEventActionType) MarshalValueBuf ¶
func (enum CompromisedCredentialsEventActionType) MarshalValueBuf(b []byte) ([]byte, error)
type CompromisedCredentialsRiskConfigurationType ¶
type CompromisedCredentialsRiskConfigurationType struct { // The compromised credentials risk configuration actions. // // Actions is a required field Actions *CompromisedCredentialsActionsType `type:"structure" required:"true"` // Perform the action for these events. The default is to perform all events // if no event filter is specified. EventFilter []EventFilterType `type:"list"` // contains filtered or unexported fields }
The compromised credentials risk configuration type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CompromisedCredentialsRiskConfigurationType
func (CompromisedCredentialsRiskConfigurationType) GoString ¶
func (s CompromisedCredentialsRiskConfigurationType) GoString() string
GoString returns the string representation
func (CompromisedCredentialsRiskConfigurationType) String ¶
func (s CompromisedCredentialsRiskConfigurationType) String() string
String returns the string representation
func (*CompromisedCredentialsRiskConfigurationType) Validate ¶
func (s *CompromisedCredentialsRiskConfigurationType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConfirmDeviceInput ¶
type ConfirmDeviceInput struct { // The access token. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // The device key. // // DeviceKey is a required field DeviceKey *string `min:"1" type:"string" required:"true"` // The device name. DeviceName *string `min:"1" type:"string"` // The configuration of the device secret verifier. DeviceSecretVerifierConfig *DeviceSecretVerifierConfigType `type:"structure"` // contains filtered or unexported fields }
Confirms the device request. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmDeviceRequest
func (ConfirmDeviceInput) GoString ¶
func (s ConfirmDeviceInput) GoString() string
GoString returns the string representation
func (ConfirmDeviceInput) String ¶
func (s ConfirmDeviceInput) String() string
String returns the string representation
func (*ConfirmDeviceInput) Validate ¶
func (s *ConfirmDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConfirmDeviceOutput ¶
type ConfirmDeviceOutput struct { // Indicates whether the user confirmation is necessary to confirm the device // response. UserConfirmationNecessary *bool `type:"boolean"` // contains filtered or unexported fields }
Confirms the device response. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmDeviceResponse
func (ConfirmDeviceOutput) GoString ¶
func (s ConfirmDeviceOutput) GoString() string
GoString returns the string representation
func (ConfirmDeviceOutput) SDKResponseMetadata ¶
func (s ConfirmDeviceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ConfirmDeviceOutput) String ¶
func (s ConfirmDeviceOutput) String() string
String returns the string representation
type ConfirmDeviceRequest ¶
type ConfirmDeviceRequest struct { *aws.Request Input *ConfirmDeviceInput Copy func(*ConfirmDeviceInput) ConfirmDeviceRequest }
ConfirmDeviceRequest is a API request type for the ConfirmDevice API operation.
func (ConfirmDeviceRequest) Send ¶
func (r ConfirmDeviceRequest) Send() (*ConfirmDeviceOutput, error)
Send marshals and sends the ConfirmDevice API request.
type ConfirmForgotPasswordInput ¶
type ConfirmForgotPasswordInput struct { // The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The app client ID of the app associated with the user pool. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // The confirmation code sent by a user's request to retrieve a forgotten password. // For more information, see // // ConfirmationCode is a required field ConfirmationCode *string `min:"1" type:"string" required:"true"` // The password sent by a user's request to retrieve a forgotten password. // // Password is a required field Password *string `min:"6" type:"string" required:"true"` // 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 `min:"1" type:"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 *UserContextDataType `type:"structure"` // The user name of the user for whom you want to enter a code to retrieve a // forgotten password. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The request representing the confirmation for a password reset. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmForgotPasswordRequest
func (ConfirmForgotPasswordInput) GoString ¶
func (s ConfirmForgotPasswordInput) GoString() string
GoString returns the string representation
func (ConfirmForgotPasswordInput) String ¶
func (s ConfirmForgotPasswordInput) String() string
String returns the string representation
func (*ConfirmForgotPasswordInput) Validate ¶
func (s *ConfirmForgotPasswordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConfirmForgotPasswordOutput ¶
type ConfirmForgotPasswordOutput struct {
// contains filtered or unexported fields
}
The response from the server that results from a user's request to retrieve a forgotten password. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmForgotPasswordResponse
func (ConfirmForgotPasswordOutput) GoString ¶
func (s ConfirmForgotPasswordOutput) GoString() string
GoString returns the string representation
func (ConfirmForgotPasswordOutput) SDKResponseMetadata ¶
func (s ConfirmForgotPasswordOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ConfirmForgotPasswordOutput) String ¶
func (s ConfirmForgotPasswordOutput) String() string
String returns the string representation
type ConfirmForgotPasswordRequest ¶
type ConfirmForgotPasswordRequest struct { *aws.Request Input *ConfirmForgotPasswordInput Copy func(*ConfirmForgotPasswordInput) ConfirmForgotPasswordRequest }
ConfirmForgotPasswordRequest is a API request type for the ConfirmForgotPassword API operation.
func (ConfirmForgotPasswordRequest) Send ¶
func (r ConfirmForgotPasswordRequest) Send() (*ConfirmForgotPasswordOutput, error)
Send marshals and sends the ConfirmForgotPassword API request.
type ConfirmSignUpInput ¶
type ConfirmSignUpInput struct { // The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The ID of the app client associated with the user pool. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // The confirmation code sent by a user's request to confirm registration. // // ConfirmationCode is a required field ConfirmationCode *string `min:"1" type:"string" required:"true"` // 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 `type:"boolean"` // 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 `min:"1" type:"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 *UserContextDataType `type:"structure"` // The user name of the user whose registration you wish to confirm. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to confirm registration of a user. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmSignUpRequest
func (ConfirmSignUpInput) GoString ¶
func (s ConfirmSignUpInput) GoString() string
GoString returns the string representation
func (ConfirmSignUpInput) String ¶
func (s ConfirmSignUpInput) String() string
String returns the string representation
func (*ConfirmSignUpInput) Validate ¶
func (s *ConfirmSignUpInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConfirmSignUpOutput ¶
type ConfirmSignUpOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server for the registration confirmation. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ConfirmSignUpResponse
func (ConfirmSignUpOutput) GoString ¶
func (s ConfirmSignUpOutput) GoString() string
GoString returns the string representation
func (ConfirmSignUpOutput) SDKResponseMetadata ¶
func (s ConfirmSignUpOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ConfirmSignUpOutput) String ¶
func (s ConfirmSignUpOutput) String() string
String returns the string representation
type ConfirmSignUpRequest ¶
type ConfirmSignUpRequest struct { *aws.Request Input *ConfirmSignUpInput Copy func(*ConfirmSignUpInput) ConfirmSignUpRequest }
ConfirmSignUpRequest is a API request type for the ConfirmSignUp API operation.
func (ConfirmSignUpRequest) Send ¶
func (r ConfirmSignUpRequest) Send() (*ConfirmSignUpOutput, error)
Send marshals and sends the ConfirmSignUp API request.
type ContextDataType ¶
type ContextDataType struct { // Encoded data containing device fingerprinting details, collected using the // Amazon Cognito context data collection library. EncodedData *string `type:"string"` // HttpHeaders received on your server in same order. // // HttpHeaders is a required field HttpHeaders []HttpHeader `type:"list" required:"true"` // Source IP address of your user. // // IpAddress is a required field IpAddress *string `type:"string" required:"true"` // Your server endpoint where this API is invoked. // // ServerName is a required field ServerName *string `type:"string" required:"true"` // Your server path where this API is invoked. // // ServerPath is a required field ServerPath *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ContextDataType
func (ContextDataType) GoString ¶
func (s ContextDataType) GoString() string
GoString returns the string representation
func (ContextDataType) String ¶
func (s ContextDataType) String() string
String returns the string representation
func (*ContextDataType) Validate ¶
func (s *ContextDataType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateGroupInput ¶
type CreateGroupInput struct { // A string containing the description of the group. Description *string `type:"string"` // The name of the group. Must be unique. // // GroupName is a required field GroupName *string `min:"1" type:"string" required:"true"` // 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 *int64 `type:"integer"` // The role ARN for the group. RoleArn *string `min:"20" type:"string"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateGroupRequest
func (CreateGroupInput) GoString ¶
func (s CreateGroupInput) GoString() string
GoString returns the string representation
func (CreateGroupInput) String ¶
func (s CreateGroupInput) String() string
String returns the string representation
func (*CreateGroupInput) Validate ¶
func (s *CreateGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateGroupOutput ¶
type CreateGroupOutput struct { // The group object for the group. Group *GroupType `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateGroupResponse
func (CreateGroupOutput) GoString ¶
func (s CreateGroupOutput) GoString() string
GoString returns the string representation
func (CreateGroupOutput) SDKResponseMetadata ¶
func (s CreateGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateGroupOutput) String ¶
func (s CreateGroupOutput) String() string
String returns the string representation
type CreateGroupRequest ¶
type CreateGroupRequest struct { *aws.Request Input *CreateGroupInput Copy func(*CreateGroupInput) CreateGroupRequest }
CreateGroupRequest is a API request type for the CreateGroup API operation.
func (CreateGroupRequest) Send ¶
func (r CreateGroupRequest) Send() (*CreateGroupOutput, error)
Send marshals and sends the CreateGroup API request.
type CreateIdentityProviderInput ¶
type CreateIdentityProviderInput struct { // A mapping of identity provider attributes to standard and custom user pool // attributes. AttributeMapping map[string]string `type:"map"` // A list of identity provider identifiers. IdpIdentifiers []string `type:"list"` // The identity provider details, such as MetadataURL and MetadataFile. // // ProviderDetails is a required field ProviderDetails map[string]string `type:"map" required:"true"` // The identity provider name. // // ProviderName is a required field ProviderName *string `min:"1" type:"string" required:"true"` // The identity provider type. // // ProviderType is a required field ProviderType IdentityProviderTypeType `type:"string" required:"true" enum:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateIdentityProviderRequest
func (CreateIdentityProviderInput) GoString ¶
func (s CreateIdentityProviderInput) GoString() string
GoString returns the string representation
func (CreateIdentityProviderInput) String ¶
func (s CreateIdentityProviderInput) String() string
String returns the string representation
func (*CreateIdentityProviderInput) Validate ¶
func (s *CreateIdentityProviderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateIdentityProviderOutput ¶
type CreateIdentityProviderOutput struct { // The newly created identity provider object. // // IdentityProvider is a required field IdentityProvider *IdentityProviderType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateIdentityProviderResponse
func (CreateIdentityProviderOutput) GoString ¶
func (s CreateIdentityProviderOutput) GoString() string
GoString returns the string representation
func (CreateIdentityProviderOutput) SDKResponseMetadata ¶
func (s CreateIdentityProviderOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateIdentityProviderOutput) String ¶
func (s CreateIdentityProviderOutput) String() string
String returns the string representation
type CreateIdentityProviderRequest ¶
type CreateIdentityProviderRequest struct { *aws.Request Input *CreateIdentityProviderInput Copy func(*CreateIdentityProviderInput) CreateIdentityProviderRequest }
CreateIdentityProviderRequest is a API request type for the CreateIdentityProvider API operation.
func (CreateIdentityProviderRequest) Send ¶
func (r CreateIdentityProviderRequest) Send() (*CreateIdentityProviderOutput, error)
Send marshals and sends the CreateIdentityProvider API request.
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 is a required field Identifier *string `min:"1" type:"string" required:"true"` // A friendly name for the resource server. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // A list of scopes. Each scope is map, where the keys are name and description. Scopes []ResourceServerScopeType `type:"list"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateResourceServerRequest
func (CreateResourceServerInput) GoString ¶
func (s CreateResourceServerInput) GoString() string
GoString returns the string representation
func (CreateResourceServerInput) String ¶
func (s CreateResourceServerInput) String() string
String returns the string representation
func (*CreateResourceServerInput) Validate ¶
func (s *CreateResourceServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateResourceServerOutput ¶
type CreateResourceServerOutput struct { // The newly created resource server. // // ResourceServer is a required field ResourceServer *ResourceServerType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateResourceServerResponse
func (CreateResourceServerOutput) GoString ¶
func (s CreateResourceServerOutput) GoString() string
GoString returns the string representation
func (CreateResourceServerOutput) SDKResponseMetadata ¶
func (s CreateResourceServerOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateResourceServerOutput) String ¶
func (s CreateResourceServerOutput) String() string
String returns the string representation
type CreateResourceServerRequest ¶
type CreateResourceServerRequest struct { *aws.Request Input *CreateResourceServerInput Copy func(*CreateResourceServerInput) CreateResourceServerRequest }
CreateResourceServerRequest is a API request type for the CreateResourceServer API operation.
func (CreateResourceServerRequest) Send ¶
func (r CreateResourceServerRequest) Send() (*CreateResourceServerOutput, error)
Send marshals and sends the CreateResourceServer API request.
type CreateUserImportJobInput ¶
type CreateUserImportJobInput struct { // The role ARN for the Amazon CloudWatch Logging role for the user import job. // // CloudWatchLogsRoleArn is a required field CloudWatchLogsRoleArn *string `min:"20" type:"string" required:"true"` // The job name for the user import job. // // JobName is a required field JobName *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool that the users are being imported into. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to create the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserImportJobRequest
func (CreateUserImportJobInput) GoString ¶
func (s CreateUserImportJobInput) GoString() string
GoString returns the string representation
func (CreateUserImportJobInput) String ¶
func (s CreateUserImportJobInput) String() string
String returns the string representation
func (*CreateUserImportJobInput) Validate ¶
func (s *CreateUserImportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUserImportJobOutput ¶
type CreateUserImportJobOutput struct { // The job object that represents the user import job. UserImportJob *UserImportJobType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server to the request to create the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserImportJobResponse
func (CreateUserImportJobOutput) GoString ¶
func (s CreateUserImportJobOutput) GoString() string
GoString returns the string representation
func (CreateUserImportJobOutput) SDKResponseMetadata ¶
func (s CreateUserImportJobOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateUserImportJobOutput) String ¶
func (s CreateUserImportJobOutput) String() string
String returns the string representation
type CreateUserImportJobRequest ¶
type CreateUserImportJobRequest struct { *aws.Request Input *CreateUserImportJobInput Copy func(*CreateUserImportJobInput) CreateUserImportJobRequest }
CreateUserImportJobRequest is a API request type for the CreateUserImportJob API operation.
func (CreateUserImportJobRequest) Send ¶
func (r CreateUserImportJobRequest) Send() (*CreateUserImportJobOutput, error)
Send marshals and sends the CreateUserImportJob API request.
type CreateUserPoolClientInput ¶
type CreateUserPoolClientInput struct { // 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 token to specify that the client should get the access token (and, // optionally, ID token, based on scopes) directly. AllowedOAuthFlows []OAuthFlowType `type:"list"` // Set to True if the client is allowed to follow the OAuth protocol when interacting // with Cognito user pools. AllowedOAuthFlowsUserPoolClient *bool `type:"boolean"` // A list of allowed OAuth scopes. Currently supported values are "phone", "email", // "openid", and "Cognito". AllowedOAuthScopes []string `type:"list"` // The Amazon Pinpoint analytics configuration for collecting metrics for this // user pool. AnalyticsConfiguration *AnalyticsConfigurationType `type:"structure"` // 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 use HTTP without TLS (i.e. use HTTPS instead of HTTP). // // * Not include a fragment component. // // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). CallbackURLs []string `type:"list"` // The client name for the user pool client you would like to create. // // ClientName is a required field ClientName *string `min:"1" type:"string" required:"true"` // 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 use HTTP without TLS (i.e. use HTTPS instead of HTTP). // // * Not include a fragment component. // // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). DefaultRedirectURI *string `min:"1" type:"string"` // The explicit authentication flows. ExplicitAuthFlows []ExplicitAuthFlowsType `type:"list"` // Boolean to specify whether you want to generate a secret for the user pool // client being created. GenerateSecret *bool `type:"boolean"` // A list of allowed logout URLs for the identity providers. LogoutURLs []string `type:"list"` // The read attributes. ReadAttributes []string `type:"list"` // The time limit, in days, after which the refresh token is no longer valid // and cannot be used. RefreshTokenValidity *int64 `type:"integer"` // A list of provider names for the identity providers that are supported on // this client. SupportedIdentityProviders []string `type:"list"` // The user pool ID for the user pool where you want to create a user pool client. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The write attributes. WriteAttributes []string `type:"list"` // contains filtered or unexported fields }
Represents the request to create a user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClientRequest
func (CreateUserPoolClientInput) GoString ¶
func (s CreateUserPoolClientInput) GoString() string
GoString returns the string representation
func (CreateUserPoolClientInput) String ¶
func (s CreateUserPoolClientInput) String() string
String returns the string representation
func (*CreateUserPoolClientInput) Validate ¶
func (s *CreateUserPoolClientInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUserPoolClientOutput ¶
type CreateUserPoolClientOutput struct { // The user pool client that was just created. UserPoolClient *UserPoolClientType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server to create a user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolClientResponse
func (CreateUserPoolClientOutput) GoString ¶
func (s CreateUserPoolClientOutput) GoString() string
GoString returns the string representation
func (CreateUserPoolClientOutput) SDKResponseMetadata ¶
func (s CreateUserPoolClientOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateUserPoolClientOutput) String ¶
func (s CreateUserPoolClientOutput) String() string
String returns the string representation
type CreateUserPoolClientRequest ¶
type CreateUserPoolClientRequest struct { *aws.Request Input *CreateUserPoolClientInput Copy func(*CreateUserPoolClientInput) CreateUserPoolClientRequest }
CreateUserPoolClientRequest is a API request type for the CreateUserPoolClient API operation.
func (CreateUserPoolClientRequest) Send ¶
func (r CreateUserPoolClientRequest) Send() (*CreateUserPoolClientOutput, error)
Send marshals and sends the CreateUserPoolClient API request.
type CreateUserPoolDomainInput ¶
type CreateUserPoolDomainInput struct { // The domain string. // // Domain is a required field Domain *string `min:"1" type:"string" required:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolDomainRequest
func (CreateUserPoolDomainInput) GoString ¶
func (s CreateUserPoolDomainInput) GoString() string
GoString returns the string representation
func (CreateUserPoolDomainInput) String ¶
func (s CreateUserPoolDomainInput) String() string
String returns the string representation
func (*CreateUserPoolDomainInput) Validate ¶
func (s *CreateUserPoolDomainInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUserPoolDomainOutput ¶
type CreateUserPoolDomainOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolDomainResponse
func (CreateUserPoolDomainOutput) GoString ¶
func (s CreateUserPoolDomainOutput) GoString() string
GoString returns the string representation
func (CreateUserPoolDomainOutput) SDKResponseMetadata ¶
func (s CreateUserPoolDomainOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateUserPoolDomainOutput) String ¶
func (s CreateUserPoolDomainOutput) String() string
String returns the string representation
type CreateUserPoolDomainRequest ¶
type CreateUserPoolDomainRequest struct { *aws.Request Input *CreateUserPoolDomainInput Copy func(*CreateUserPoolDomainInput) CreateUserPoolDomainRequest }
CreateUserPoolDomainRequest is a API request type for the CreateUserPoolDomain API operation.
func (CreateUserPoolDomainRequest) Send ¶
func (r CreateUserPoolDomainRequest) Send() (*CreateUserPoolDomainOutput, error)
Send marshals and sends the CreateUserPoolDomain API request.
type CreateUserPoolInput ¶
type CreateUserPoolInput struct { // The configuration for AdminCreateUser requests. AdminCreateUserConfig *AdminCreateUserConfigType `type:"structure"` // Attributes supported as an alias for this user pool. Possible values: phone_number, // email, or preferred_username. AliasAttributes []AliasAttributeType `type:"list"` // The attributes to be auto-verified. Possible values: email, phone_number. AutoVerifiedAttributes []VerifiedAttributeType `type:"list"` // The device configuration. DeviceConfiguration *DeviceConfigurationType `type:"structure"` // The email configuration. EmailConfiguration *EmailConfigurationType `type:"structure"` // A string representing the email verification message. EmailVerificationMessage *string `min:"6" type:"string"` // A string representing the email verification subject. EmailVerificationSubject *string `min:"1" type:"string"` // 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 *LambdaConfigType `type:"structure"` // Specifies MFA configuration details. MfaConfiguration UserPoolMfaType `type:"string" enum:"true"` // The policies associated with the new user pool. Policies *UserPoolPolicyType `type:"structure"` // A string used to name the user pool. // // PoolName is a required field PoolName *string `min:"1" type:"string" required:"true"` // An array of schema attributes for the new user pool. These attributes can // be standard or custom attributes. Schema []SchemaAttributeType `min:"1" type:"list"` // A string representing the SMS authentication message. SmsAuthenticationMessage *string `min:"6" type:"string"` // The SMS configuration. SmsConfiguration *SmsConfigurationType `type:"structure"` // A string representing the SMS verification message. SmsVerificationMessage *string `min:"6" type:"string"` // Used to enable advanced security risk detection. Set the key AdvancedSecurityMode // to the value "AUDIT". UserPoolAddOns *UserPoolAddOnsType `type:"structure"` // The cost allocation tags for the user pool. For more information, see Adding // Cost Allocation Tags to Your User Pool (http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-cost-allocation-tagging.html) UserPoolTags map[string]string `type:"map"` // Specifies whether email addresses or phone numbers can be specified as usernames // when a user signs up. UsernameAttributes []UsernameAttributeType `type:"list"` // The template for the verification message that the user sees when the app // requests permission to access the user's information. VerificationMessageTemplate *VerificationMessageTemplateType `type:"structure"` // contains filtered or unexported fields }
Represents the request to create a user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolRequest
func (CreateUserPoolInput) GoString ¶
func (s CreateUserPoolInput) GoString() string
GoString returns the string representation
func (CreateUserPoolInput) String ¶
func (s CreateUserPoolInput) String() string
String returns the string representation
func (*CreateUserPoolInput) Validate ¶
func (s *CreateUserPoolInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateUserPoolOutput ¶
type CreateUserPoolOutput struct { // A container for the user pool details. UserPool *UserPoolType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server for the request to create a user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/CreateUserPoolResponse
func (CreateUserPoolOutput) GoString ¶
func (s CreateUserPoolOutput) GoString() string
GoString returns the string representation
func (CreateUserPoolOutput) SDKResponseMetadata ¶
func (s CreateUserPoolOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateUserPoolOutput) String ¶
func (s CreateUserPoolOutput) String() string
String returns the string representation
type CreateUserPoolRequest ¶
type CreateUserPoolRequest struct { *aws.Request Input *CreateUserPoolInput Copy func(*CreateUserPoolInput) CreateUserPoolRequest }
CreateUserPoolRequest is a API request type for the CreateUserPool API operation.
func (CreateUserPoolRequest) Send ¶
func (r CreateUserPoolRequest) Send() (*CreateUserPoolOutput, error)
Send marshals and sends the CreateUserPool API request.
type DefaultEmailOptionType ¶
type DefaultEmailOptionType string
const ( DefaultEmailOptionTypeConfirmWithLink DefaultEmailOptionType = "CONFIRM_WITH_LINK" DefaultEmailOptionTypeConfirmWithCode DefaultEmailOptionType = "CONFIRM_WITH_CODE" )
Enum values for DefaultEmailOptionType
func (DefaultEmailOptionType) MarshalValue ¶
func (enum DefaultEmailOptionType) MarshalValue() (string, error)
func (DefaultEmailOptionType) MarshalValueBuf ¶
func (enum DefaultEmailOptionType) MarshalValueBuf(b []byte) ([]byte, error)
type DeleteGroupInput ¶
type DeleteGroupInput struct { // The name of the group. // // GroupName is a required field GroupName *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteGroupRequest
func (DeleteGroupInput) GoString ¶
func (s DeleteGroupInput) GoString() string
GoString returns the string representation
func (DeleteGroupInput) String ¶
func (s DeleteGroupInput) String() string
String returns the string representation
func (*DeleteGroupInput) Validate ¶
func (s *DeleteGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteGroupOutput ¶
type DeleteGroupOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteGroupOutput
func (DeleteGroupOutput) GoString ¶
func (s DeleteGroupOutput) GoString() string
GoString returns the string representation
func (DeleteGroupOutput) SDKResponseMetadata ¶
func (s DeleteGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteGroupOutput) String ¶
func (s DeleteGroupOutput) String() string
String returns the string representation
type DeleteGroupRequest ¶
type DeleteGroupRequest struct { *aws.Request Input *DeleteGroupInput Copy func(*DeleteGroupInput) DeleteGroupRequest }
DeleteGroupRequest is a API request type for the DeleteGroup API operation.
func (DeleteGroupRequest) Send ¶
func (r DeleteGroupRequest) Send() (*DeleteGroupOutput, error)
Send marshals and sends the DeleteGroup API request.
type DeleteIdentityProviderInput ¶
type DeleteIdentityProviderInput struct { // The identity provider name. // // ProviderName is a required field ProviderName *string `min:"1" type:"string" required:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteIdentityProviderRequest
func (DeleteIdentityProviderInput) GoString ¶
func (s DeleteIdentityProviderInput) GoString() string
GoString returns the string representation
func (DeleteIdentityProviderInput) String ¶
func (s DeleteIdentityProviderInput) String() string
String returns the string representation
func (*DeleteIdentityProviderInput) Validate ¶
func (s *DeleteIdentityProviderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteIdentityProviderOutput ¶
type DeleteIdentityProviderOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteIdentityProviderOutput
func (DeleteIdentityProviderOutput) GoString ¶
func (s DeleteIdentityProviderOutput) GoString() string
GoString returns the string representation
func (DeleteIdentityProviderOutput) SDKResponseMetadata ¶
func (s DeleteIdentityProviderOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteIdentityProviderOutput) String ¶
func (s DeleteIdentityProviderOutput) String() string
String returns the string representation
type DeleteIdentityProviderRequest ¶
type DeleteIdentityProviderRequest struct { *aws.Request Input *DeleteIdentityProviderInput Copy func(*DeleteIdentityProviderInput) DeleteIdentityProviderRequest }
DeleteIdentityProviderRequest is a API request type for the DeleteIdentityProvider API operation.
func (DeleteIdentityProviderRequest) Send ¶
func (r DeleteIdentityProviderRequest) Send() (*DeleteIdentityProviderOutput, error)
Send marshals and sends the DeleteIdentityProvider API request.
type DeleteResourceServerInput ¶
type DeleteResourceServerInput struct { // The identifier for the resource server. // // Identifier is a required field Identifier *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool that hosts the resource server. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteResourceServerRequest
func (DeleteResourceServerInput) GoString ¶
func (s DeleteResourceServerInput) GoString() string
GoString returns the string representation
func (DeleteResourceServerInput) String ¶
func (s DeleteResourceServerInput) String() string
String returns the string representation
func (*DeleteResourceServerInput) Validate ¶
func (s *DeleteResourceServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteResourceServerOutput ¶
type DeleteResourceServerOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteResourceServerOutput
func (DeleteResourceServerOutput) GoString ¶
func (s DeleteResourceServerOutput) GoString() string
GoString returns the string representation
func (DeleteResourceServerOutput) SDKResponseMetadata ¶
func (s DeleteResourceServerOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteResourceServerOutput) String ¶
func (s DeleteResourceServerOutput) String() string
String returns the string representation
type DeleteResourceServerRequest ¶
type DeleteResourceServerRequest struct { *aws.Request Input *DeleteResourceServerInput Copy func(*DeleteResourceServerInput) DeleteResourceServerRequest }
DeleteResourceServerRequest is a API request type for the DeleteResourceServer API operation.
func (DeleteResourceServerRequest) Send ¶
func (r DeleteResourceServerRequest) Send() (*DeleteResourceServerOutput, error)
Send marshals and sends the DeleteResourceServer API request.
type DeleteUserAttributesInput ¶
type DeleteUserAttributesInput struct { // The access token used in the request to delete user attributes. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // An array of strings representing the user attribute names you wish to delete. // // For custom attributes, you must prepend the custom: prefix to the attribute // name. // // UserAttributeNames is a required field UserAttributeNames []string `type:"list" required:"true"` // contains filtered or unexported fields }
Represents the request to delete user attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserAttributesRequest
func (DeleteUserAttributesInput) GoString ¶
func (s DeleteUserAttributesInput) GoString() string
GoString returns the string representation
func (DeleteUserAttributesInput) String ¶
func (s DeleteUserAttributesInput) String() string
String returns the string representation
func (*DeleteUserAttributesInput) Validate ¶
func (s *DeleteUserAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserAttributesOutput ¶
type DeleteUserAttributesOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server to delete user attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserAttributesResponse
func (DeleteUserAttributesOutput) GoString ¶
func (s DeleteUserAttributesOutput) GoString() string
GoString returns the string representation
func (DeleteUserAttributesOutput) SDKResponseMetadata ¶
func (s DeleteUserAttributesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteUserAttributesOutput) String ¶
func (s DeleteUserAttributesOutput) String() string
String returns the string representation
type DeleteUserAttributesRequest ¶
type DeleteUserAttributesRequest struct { *aws.Request Input *DeleteUserAttributesInput Copy func(*DeleteUserAttributesInput) DeleteUserAttributesRequest }
DeleteUserAttributesRequest is a API request type for the DeleteUserAttributes API operation.
func (DeleteUserAttributesRequest) Send ¶
func (r DeleteUserAttributesRequest) Send() (*DeleteUserAttributesOutput, error)
Send marshals and sends the DeleteUserAttributes API request.
type DeleteUserInput ¶
type DeleteUserInput struct { // The access token from a request to delete a user. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to delete a user. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserRequest
func (DeleteUserInput) GoString ¶
func (s DeleteUserInput) GoString() string
GoString returns the string representation
func (DeleteUserInput) String ¶
func (s DeleteUserInput) String() string
String returns the string representation
func (*DeleteUserInput) Validate ¶
func (s *DeleteUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserOutput ¶
type DeleteUserOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserOutput
func (DeleteUserOutput) GoString ¶
func (s DeleteUserOutput) GoString() string
GoString returns the string representation
func (DeleteUserOutput) SDKResponseMetadata ¶
func (s DeleteUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteUserOutput) String ¶
func (s DeleteUserOutput) String() string
String returns the string representation
type DeleteUserPoolClientInput ¶
type DeleteUserPoolClientInput struct { // The app client ID of the app associated with the user pool. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool where you want to delete the client. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to delete a user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolClientRequest
func (DeleteUserPoolClientInput) GoString ¶
func (s DeleteUserPoolClientInput) GoString() string
GoString returns the string representation
func (DeleteUserPoolClientInput) String ¶
func (s DeleteUserPoolClientInput) String() string
String returns the string representation
func (*DeleteUserPoolClientInput) Validate ¶
func (s *DeleteUserPoolClientInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserPoolClientOutput ¶
type DeleteUserPoolClientOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolClientOutput
func (DeleteUserPoolClientOutput) GoString ¶
func (s DeleteUserPoolClientOutput) GoString() string
GoString returns the string representation
func (DeleteUserPoolClientOutput) SDKResponseMetadata ¶
func (s DeleteUserPoolClientOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteUserPoolClientOutput) String ¶
func (s DeleteUserPoolClientOutput) String() string
String returns the string representation
type DeleteUserPoolClientRequest ¶
type DeleteUserPoolClientRequest struct { *aws.Request Input *DeleteUserPoolClientInput Copy func(*DeleteUserPoolClientInput) DeleteUserPoolClientRequest }
DeleteUserPoolClientRequest is a API request type for the DeleteUserPoolClient API operation.
func (DeleteUserPoolClientRequest) Send ¶
func (r DeleteUserPoolClientRequest) Send() (*DeleteUserPoolClientOutput, error)
Send marshals and sends the DeleteUserPoolClient API request.
type DeleteUserPoolDomainInput ¶
type DeleteUserPoolDomainInput struct { // The domain string. // // Domain is a required field Domain *string `min:"1" type:"string" required:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolDomainRequest
func (DeleteUserPoolDomainInput) GoString ¶
func (s DeleteUserPoolDomainInput) GoString() string
GoString returns the string representation
func (DeleteUserPoolDomainInput) String ¶
func (s DeleteUserPoolDomainInput) String() string
String returns the string representation
func (*DeleteUserPoolDomainInput) Validate ¶
func (s *DeleteUserPoolDomainInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserPoolDomainOutput ¶
type DeleteUserPoolDomainOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolDomainResponse
func (DeleteUserPoolDomainOutput) GoString ¶
func (s DeleteUserPoolDomainOutput) GoString() string
GoString returns the string representation
func (DeleteUserPoolDomainOutput) SDKResponseMetadata ¶
func (s DeleteUserPoolDomainOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteUserPoolDomainOutput) String ¶
func (s DeleteUserPoolDomainOutput) String() string
String returns the string representation
type DeleteUserPoolDomainRequest ¶
type DeleteUserPoolDomainRequest struct { *aws.Request Input *DeleteUserPoolDomainInput Copy func(*DeleteUserPoolDomainInput) DeleteUserPoolDomainRequest }
DeleteUserPoolDomainRequest is a API request type for the DeleteUserPoolDomain API operation.
func (DeleteUserPoolDomainRequest) Send ¶
func (r DeleteUserPoolDomainRequest) Send() (*DeleteUserPoolDomainOutput, error)
Send marshals and sends the DeleteUserPoolDomain API request.
type DeleteUserPoolInput ¶
type DeleteUserPoolInput struct { // The user pool ID for the user pool you want to delete. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to delete a user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolRequest
func (DeleteUserPoolInput) GoString ¶
func (s DeleteUserPoolInput) GoString() string
GoString returns the string representation
func (DeleteUserPoolInput) String ¶
func (s DeleteUserPoolInput) String() string
String returns the string representation
func (*DeleteUserPoolInput) Validate ¶
func (s *DeleteUserPoolInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserPoolOutput ¶
type DeleteUserPoolOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeleteUserPoolOutput
func (DeleteUserPoolOutput) GoString ¶
func (s DeleteUserPoolOutput) GoString() string
GoString returns the string representation
func (DeleteUserPoolOutput) SDKResponseMetadata ¶
func (s DeleteUserPoolOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteUserPoolOutput) String ¶
func (s DeleteUserPoolOutput) String() string
String returns the string representation
type DeleteUserPoolRequest ¶
type DeleteUserPoolRequest struct { *aws.Request Input *DeleteUserPoolInput Copy func(*DeleteUserPoolInput) DeleteUserPoolRequest }
DeleteUserPoolRequest is a API request type for the DeleteUserPool API operation.
func (DeleteUserPoolRequest) Send ¶
func (r DeleteUserPoolRequest) Send() (*DeleteUserPoolOutput, error)
Send marshals and sends the DeleteUserPool API request.
type DeleteUserRequest ¶
type DeleteUserRequest struct { *aws.Request Input *DeleteUserInput Copy func(*DeleteUserInput) DeleteUserRequest }
DeleteUserRequest is a API request type for the DeleteUser API operation.
func (DeleteUserRequest) Send ¶
func (r DeleteUserRequest) Send() (*DeleteUserOutput, error)
Send marshals and sends the DeleteUser API request.
type DeliveryMediumType ¶
type DeliveryMediumType string
const ( DeliveryMediumTypeSms DeliveryMediumType = "SMS" DeliveryMediumTypeEmail DeliveryMediumType = "EMAIL" )
Enum values for DeliveryMediumType
func (DeliveryMediumType) MarshalValue ¶
func (enum DeliveryMediumType) MarshalValue() (string, error)
func (DeliveryMediumType) MarshalValueBuf ¶
func (enum DeliveryMediumType) MarshalValueBuf(b []byte) ([]byte, error)
type DescribeIdentityProviderInput ¶
type DescribeIdentityProviderInput struct { // The identity provider name. // // ProviderName is a required field ProviderName *string `min:"1" type:"string" required:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeIdentityProviderRequest
func (DescribeIdentityProviderInput) GoString ¶
func (s DescribeIdentityProviderInput) GoString() string
GoString returns the string representation
func (DescribeIdentityProviderInput) String ¶
func (s DescribeIdentityProviderInput) String() string
String returns the string representation
func (*DescribeIdentityProviderInput) Validate ¶
func (s *DescribeIdentityProviderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeIdentityProviderOutput ¶
type DescribeIdentityProviderOutput struct { // The identity provider that was deleted. // // IdentityProvider is a required field IdentityProvider *IdentityProviderType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeIdentityProviderResponse
func (DescribeIdentityProviderOutput) GoString ¶
func (s DescribeIdentityProviderOutput) GoString() string
GoString returns the string representation
func (DescribeIdentityProviderOutput) SDKResponseMetadata ¶
func (s DescribeIdentityProviderOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeIdentityProviderOutput) String ¶
func (s DescribeIdentityProviderOutput) String() string
String returns the string representation
type DescribeIdentityProviderRequest ¶
type DescribeIdentityProviderRequest struct { *aws.Request Input *DescribeIdentityProviderInput Copy func(*DescribeIdentityProviderInput) DescribeIdentityProviderRequest }
DescribeIdentityProviderRequest is a API request type for the DescribeIdentityProvider API operation.
func (DescribeIdentityProviderRequest) Send ¶
func (r DescribeIdentityProviderRequest) Send() (*DescribeIdentityProviderOutput, error)
Send marshals and sends the DescribeIdentityProvider API request.
type DescribeResourceServerInput ¶
type DescribeResourceServerInput struct { // The identifier for the resource server // // Identifier is a required field Identifier *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool that hosts the resource server. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeResourceServerRequest
func (DescribeResourceServerInput) GoString ¶
func (s DescribeResourceServerInput) GoString() string
GoString returns the string representation
func (DescribeResourceServerInput) String ¶
func (s DescribeResourceServerInput) String() string
String returns the string representation
func (*DescribeResourceServerInput) Validate ¶
func (s *DescribeResourceServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeResourceServerOutput ¶
type DescribeResourceServerOutput struct { // The resource server. // // ResourceServer is a required field ResourceServer *ResourceServerType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeResourceServerResponse
func (DescribeResourceServerOutput) GoString ¶
func (s DescribeResourceServerOutput) GoString() string
GoString returns the string representation
func (DescribeResourceServerOutput) SDKResponseMetadata ¶
func (s DescribeResourceServerOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeResourceServerOutput) String ¶
func (s DescribeResourceServerOutput) String() string
String returns the string representation
type DescribeResourceServerRequest ¶
type DescribeResourceServerRequest struct { *aws.Request Input *DescribeResourceServerInput Copy func(*DescribeResourceServerInput) DescribeResourceServerRequest }
DescribeResourceServerRequest is a API request type for the DescribeResourceServer API operation.
func (DescribeResourceServerRequest) Send ¶
func (r DescribeResourceServerRequest) Send() (*DescribeResourceServerOutput, error)
Send marshals and sends the DescribeResourceServer API request.
type DescribeRiskConfigurationInput ¶
type DescribeRiskConfigurationInput struct { // The app client ID. ClientId *string `min:"1" type:"string"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeRiskConfigurationRequest
func (DescribeRiskConfigurationInput) GoString ¶
func (s DescribeRiskConfigurationInput) GoString() string
GoString returns the string representation
func (DescribeRiskConfigurationInput) String ¶
func (s DescribeRiskConfigurationInput) String() string
String returns the string representation
func (*DescribeRiskConfigurationInput) Validate ¶
func (s *DescribeRiskConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeRiskConfigurationOutput ¶
type DescribeRiskConfigurationOutput struct { // The risk configuration. // // RiskConfiguration is a required field RiskConfiguration *RiskConfigurationType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeRiskConfigurationResponse
func (DescribeRiskConfigurationOutput) GoString ¶
func (s DescribeRiskConfigurationOutput) GoString() string
GoString returns the string representation
func (DescribeRiskConfigurationOutput) SDKResponseMetadata ¶
func (s DescribeRiskConfigurationOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeRiskConfigurationOutput) String ¶
func (s DescribeRiskConfigurationOutput) String() string
String returns the string representation
type DescribeRiskConfigurationRequest ¶
type DescribeRiskConfigurationRequest struct { *aws.Request Input *DescribeRiskConfigurationInput Copy func(*DescribeRiskConfigurationInput) DescribeRiskConfigurationRequest }
DescribeRiskConfigurationRequest is a API request type for the DescribeRiskConfiguration API operation.
func (DescribeRiskConfigurationRequest) Send ¶
func (r DescribeRiskConfigurationRequest) Send() (*DescribeRiskConfigurationOutput, error)
Send marshals and sends the DescribeRiskConfiguration API request.
type DescribeUserImportJobInput ¶
type DescribeUserImportJobInput struct { // The job ID for the user import job. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool that the users are being imported into. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to describe the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserImportJobRequest
func (DescribeUserImportJobInput) GoString ¶
func (s DescribeUserImportJobInput) GoString() string
GoString returns the string representation
func (DescribeUserImportJobInput) String ¶
func (s DescribeUserImportJobInput) String() string
String returns the string representation
func (*DescribeUserImportJobInput) Validate ¶
func (s *DescribeUserImportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserImportJobOutput ¶
type DescribeUserImportJobOutput struct { // The job object that represents the user import job. UserImportJob *UserImportJobType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server to the request to describe the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserImportJobResponse
func (DescribeUserImportJobOutput) GoString ¶
func (s DescribeUserImportJobOutput) GoString() string
GoString returns the string representation
func (DescribeUserImportJobOutput) SDKResponseMetadata ¶
func (s DescribeUserImportJobOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeUserImportJobOutput) String ¶
func (s DescribeUserImportJobOutput) String() string
String returns the string representation
type DescribeUserImportJobRequest ¶
type DescribeUserImportJobRequest struct { *aws.Request Input *DescribeUserImportJobInput Copy func(*DescribeUserImportJobInput) DescribeUserImportJobRequest }
DescribeUserImportJobRequest is a API request type for the DescribeUserImportJob API operation.
func (DescribeUserImportJobRequest) Send ¶
func (r DescribeUserImportJobRequest) Send() (*DescribeUserImportJobOutput, error)
Send marshals and sends the DescribeUserImportJob API request.
type DescribeUserPoolClientInput ¶
type DescribeUserPoolClientInput struct { // The app client ID of the app associated with the user pool. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool you want to describe. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to describe a user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClientRequest
func (DescribeUserPoolClientInput) GoString ¶
func (s DescribeUserPoolClientInput) GoString() string
GoString returns the string representation
func (DescribeUserPoolClientInput) String ¶
func (s DescribeUserPoolClientInput) String() string
String returns the string representation
func (*DescribeUserPoolClientInput) Validate ¶
func (s *DescribeUserPoolClientInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserPoolClientOutput ¶
type DescribeUserPoolClientOutput struct { // The user pool client from a server response to describe the user pool client. UserPoolClient *UserPoolClientType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server from a request to describe the user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolClientResponse
func (DescribeUserPoolClientOutput) GoString ¶
func (s DescribeUserPoolClientOutput) GoString() string
GoString returns the string representation
func (DescribeUserPoolClientOutput) SDKResponseMetadata ¶
func (s DescribeUserPoolClientOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeUserPoolClientOutput) String ¶
func (s DescribeUserPoolClientOutput) String() string
String returns the string representation
type DescribeUserPoolClientRequest ¶
type DescribeUserPoolClientRequest struct { *aws.Request Input *DescribeUserPoolClientInput Copy func(*DescribeUserPoolClientInput) DescribeUserPoolClientRequest }
DescribeUserPoolClientRequest is a API request type for the DescribeUserPoolClient API operation.
func (DescribeUserPoolClientRequest) Send ¶
func (r DescribeUserPoolClientRequest) Send() (*DescribeUserPoolClientOutput, error)
Send marshals and sends the DescribeUserPoolClient API request.
type DescribeUserPoolDomainInput ¶
type DescribeUserPoolDomainInput struct { // The domain string. // // Domain is a required field Domain *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolDomainRequest
func (DescribeUserPoolDomainInput) GoString ¶
func (s DescribeUserPoolDomainInput) GoString() string
GoString returns the string representation
func (DescribeUserPoolDomainInput) String ¶
func (s DescribeUserPoolDomainInput) String() string
String returns the string representation
func (*DescribeUserPoolDomainInput) Validate ¶
func (s *DescribeUserPoolDomainInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserPoolDomainOutput ¶
type DescribeUserPoolDomainOutput struct { // A domain description object containing information about the domain. DomainDescription *DomainDescriptionType `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolDomainResponse
func (DescribeUserPoolDomainOutput) GoString ¶
func (s DescribeUserPoolDomainOutput) GoString() string
GoString returns the string representation
func (DescribeUserPoolDomainOutput) SDKResponseMetadata ¶
func (s DescribeUserPoolDomainOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeUserPoolDomainOutput) String ¶
func (s DescribeUserPoolDomainOutput) String() string
String returns the string representation
type DescribeUserPoolDomainRequest ¶
type DescribeUserPoolDomainRequest struct { *aws.Request Input *DescribeUserPoolDomainInput Copy func(*DescribeUserPoolDomainInput) DescribeUserPoolDomainRequest }
DescribeUserPoolDomainRequest is a API request type for the DescribeUserPoolDomain API operation.
func (DescribeUserPoolDomainRequest) Send ¶
func (r DescribeUserPoolDomainRequest) Send() (*DescribeUserPoolDomainOutput, error)
Send marshals and sends the DescribeUserPoolDomain API request.
type DescribeUserPoolInput ¶
type DescribeUserPoolInput struct { // The user pool ID for the user pool you want to describe. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to describe the user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolRequest
func (DescribeUserPoolInput) GoString ¶
func (s DescribeUserPoolInput) GoString() string
GoString returns the string representation
func (DescribeUserPoolInput) String ¶
func (s DescribeUserPoolInput) String() string
String returns the string representation
func (*DescribeUserPoolInput) Validate ¶
func (s *DescribeUserPoolInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeUserPoolOutput ¶
type DescribeUserPoolOutput struct { // The container of metadata returned by the server to describe the pool. UserPool *UserPoolType `type:"structure"` // contains filtered or unexported fields }
Represents the response to describe the user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DescribeUserPoolResponse
func (DescribeUserPoolOutput) GoString ¶
func (s DescribeUserPoolOutput) GoString() string
GoString returns the string representation
func (DescribeUserPoolOutput) SDKResponseMetadata ¶
func (s DescribeUserPoolOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeUserPoolOutput) String ¶
func (s DescribeUserPoolOutput) String() string
String returns the string representation
type DescribeUserPoolRequest ¶
type DescribeUserPoolRequest struct { *aws.Request Input *DescribeUserPoolInput Copy func(*DescribeUserPoolInput) DescribeUserPoolRequest }
DescribeUserPoolRequest is a API request type for the DescribeUserPool API operation.
func (DescribeUserPoolRequest) Send ¶
func (r DescribeUserPoolRequest) Send() (*DescribeUserPoolOutput, error)
Send marshals and sends the DescribeUserPool API request.
type DeviceConfigurationType ¶
type DeviceConfigurationType struct { // Indicates whether a challenge is required on a new device. Only applicable // to a new device. ChallengeRequiredOnNewDevice *bool `type:"boolean"` // If true, a device is only remembered on user prompt. DeviceOnlyRememberedOnUserPrompt *bool `type:"boolean"` // contains filtered or unexported fields }
The configuration for the user pool's device tracking. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeviceConfigurationType
func (DeviceConfigurationType) GoString ¶
func (s DeviceConfigurationType) GoString() string
GoString returns the string representation
func (DeviceConfigurationType) String ¶
func (s DeviceConfigurationType) String() string
String returns the string representation
type DeviceRememberedStatusType ¶
type DeviceRememberedStatusType string
const ( DeviceRememberedStatusTypeRemembered DeviceRememberedStatusType = "remembered" DeviceRememberedStatusTypeNotRemembered DeviceRememberedStatusType = "not_remembered" )
Enum values for DeviceRememberedStatusType
func (DeviceRememberedStatusType) MarshalValue ¶
func (enum DeviceRememberedStatusType) MarshalValue() (string, error)
func (DeviceRememberedStatusType) MarshalValueBuf ¶
func (enum DeviceRememberedStatusType) MarshalValueBuf(b []byte) ([]byte, error)
type DeviceSecretVerifierConfigType ¶
type DeviceSecretVerifierConfigType struct { // The password verifier. PasswordVerifier *string `type:"string"` // The salt. Salt *string `type:"string"` // contains filtered or unexported fields }
The device verifier against which it will be authenticated. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeviceSecretVerifierConfigType
func (DeviceSecretVerifierConfigType) GoString ¶
func (s DeviceSecretVerifierConfigType) GoString() string
GoString returns the string representation
func (DeviceSecretVerifierConfigType) String ¶
func (s DeviceSecretVerifierConfigType) String() string
String returns the string representation
type DeviceType ¶
type DeviceType struct { // The device attributes. DeviceAttributes []AttributeType `type:"list"` // The creation date of the device. DeviceCreateDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The device key. DeviceKey *string `min:"1" type:"string"` // The date in which the device was last authenticated. DeviceLastAuthenticatedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The last modified date of the device. DeviceLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
The device type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DeviceType
func (DeviceType) GoString ¶
func (s DeviceType) GoString() string
GoString returns the string representation
func (DeviceType) String ¶
func (s DeviceType) String() string
String returns the string representation
type DomainDescriptionType ¶
type DomainDescriptionType struct { // The AWS account ID for the user pool owner. AWSAccountId *string `type:"string"` // The ARN of the CloudFront distribution. CloudFrontDistribution *string `min:"20" type:"string"` // The domain string. Domain *string `min:"1" type:"string"` // The S3 bucket where the static files for this domain are stored. S3Bucket *string `min:"3" type:"string"` // The domain status. Status DomainStatusType `type:"string" enum:"true"` // The user pool ID. UserPoolId *string `min:"1" type:"string"` // The app version. Version *string `min:"1" type:"string"` // contains filtered or unexported fields }
A container for information about a domain. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/DomainDescriptionType
func (DomainDescriptionType) GoString ¶
func (s DomainDescriptionType) GoString() string
GoString returns the string representation
func (DomainDescriptionType) String ¶
func (s DomainDescriptionType) String() string
String returns the string representation
type DomainStatusType ¶
type DomainStatusType string
const ( DomainStatusTypeCreating DomainStatusType = "CREATING" DomainStatusTypeDeleting DomainStatusType = "DELETING" DomainStatusTypeUpdating DomainStatusType = "UPDATING" DomainStatusTypeActive DomainStatusType = "ACTIVE" DomainStatusTypeFailed DomainStatusType = "FAILED" )
Enum values for DomainStatusType
func (DomainStatusType) MarshalValue ¶
func (enum DomainStatusType) MarshalValue() (string, error)
func (DomainStatusType) MarshalValueBuf ¶
func (enum DomainStatusType) MarshalValueBuf(b []byte) ([]byte, error)
type EmailConfigurationType ¶
type EmailConfigurationType struct { // The destination to which the receiver of the email should reply to. ReplyToEmailAddress *string `type:"string"` // The Amazon Resource Name (ARN) of the email source. SourceArn *string `min:"20" type:"string"` // contains filtered or unexported fields }
The email configuration type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/EmailConfigurationType
func (EmailConfigurationType) GoString ¶
func (s EmailConfigurationType) GoString() string
GoString returns the string representation
func (EmailConfigurationType) String ¶
func (s EmailConfigurationType) String() string
String returns the string representation
func (*EmailConfigurationType) Validate ¶
func (s *EmailConfigurationType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EventContextDataType ¶
type EventContextDataType struct { // The user's city. City *string `type:"string"` // The user's country. Country *string `type:"string"` // The user's device name. DeviceName *string `type:"string"` // The user's IP address. IpAddress *string `type:"string"` // The user's time zone. Timezone *string `type:"string"` // contains filtered or unexported fields }
Specifies the user context data captured at the time of an event request. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/EventContextDataType
func (EventContextDataType) GoString ¶
func (s EventContextDataType) GoString() string
GoString returns the string representation
func (EventContextDataType) String ¶
func (s EventContextDataType) String() string
String returns the string representation
type EventFeedbackType ¶
type EventFeedbackType struct { // The event feedback date. FeedbackDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The event feedback value. // // FeedbackValue is a required field FeedbackValue FeedbackValueType `type:"string" required:"true" enum:"true"` // The provider. // // Provider is a required field Provider *string `type:"string" required:"true"` // contains filtered or unexported fields }
Specifies the event feedback type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/EventFeedbackType
func (EventFeedbackType) GoString ¶
func (s EventFeedbackType) GoString() string
GoString returns the string representation
func (EventFeedbackType) String ¶
func (s EventFeedbackType) String() string
String returns the string representation
type EventFilterType ¶
type EventFilterType string
const ( EventFilterTypeSignIn EventFilterType = "SIGN_IN" EventFilterTypePasswordChange EventFilterType = "PASSWORD_CHANGE" EventFilterTypeSignUp EventFilterType = "SIGN_UP" )
Enum values for EventFilterType
func (EventFilterType) MarshalValue ¶
func (enum EventFilterType) MarshalValue() (string, error)
func (EventFilterType) MarshalValueBuf ¶
func (enum EventFilterType) MarshalValueBuf(b []byte) ([]byte, error)
type EventResponseType ¶
type EventResponseType string
const ( EventResponseTypeSuccess EventResponseType = "Success" EventResponseTypeFailure EventResponseType = "Failure" )
Enum values for EventResponseType
func (EventResponseType) MarshalValue ¶
func (enum EventResponseType) MarshalValue() (string, error)
func (EventResponseType) MarshalValueBuf ¶
func (enum EventResponseType) MarshalValueBuf(b []byte) ([]byte, error)
type EventRiskType ¶
type EventRiskType struct { // The risk decision. RiskDecision RiskDecisionType `type:"string" enum:"true"` // The risk level. RiskLevel RiskLevelType `type:"string" enum:"true"` // contains filtered or unexported fields }
The event risk type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/EventRiskType
func (EventRiskType) GoString ¶
func (s EventRiskType) GoString() string
GoString returns the string representation
func (EventRiskType) String ¶
func (s EventRiskType) String() string
String returns the string representation
type EventType ¶
type EventType string
const ( EventTypeSignIn EventType = "SignIn" EventTypeSignUp EventType = "SignUp" EventTypeForgotPassword EventType = "ForgotPassword" )
Enum values for EventType
func (EventType) MarshalValue ¶
type ExplicitAuthFlowsType ¶
type ExplicitAuthFlowsType string
const ( ExplicitAuthFlowsTypeAdminNoSrpAuth ExplicitAuthFlowsType = "ADMIN_NO_SRP_AUTH" ExplicitAuthFlowsTypeCustomAuthFlowOnly ExplicitAuthFlowsType = "CUSTOM_AUTH_FLOW_ONLY" ExplicitAuthFlowsTypeUserPasswordAuth ExplicitAuthFlowsType = "USER_PASSWORD_AUTH" )
Enum values for ExplicitAuthFlowsType
func (ExplicitAuthFlowsType) MarshalValue ¶
func (enum ExplicitAuthFlowsType) MarshalValue() (string, error)
func (ExplicitAuthFlowsType) MarshalValueBuf ¶
func (enum ExplicitAuthFlowsType) MarshalValueBuf(b []byte) ([]byte, error)
type FeedbackValueType ¶
type FeedbackValueType string
const ( FeedbackValueTypeValid FeedbackValueType = "Valid" FeedbackValueTypeInvalid FeedbackValueType = "Invalid" )
Enum values for FeedbackValueType
func (FeedbackValueType) MarshalValue ¶
func (enum FeedbackValueType) MarshalValue() (string, error)
func (FeedbackValueType) MarshalValueBuf ¶
func (enum FeedbackValueType) MarshalValueBuf(b []byte) ([]byte, error)
type ForgetDeviceInput ¶
type ForgetDeviceInput struct { // The access token for the forgotten device request. AccessToken *string `type:"string"` // The device key. // // DeviceKey is a required field DeviceKey *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to forget the device. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgetDeviceRequest
func (ForgetDeviceInput) GoString ¶
func (s ForgetDeviceInput) GoString() string
GoString returns the string representation
func (ForgetDeviceInput) String ¶
func (s ForgetDeviceInput) String() string
String returns the string representation
func (*ForgetDeviceInput) Validate ¶
func (s *ForgetDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ForgetDeviceOutput ¶
type ForgetDeviceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgetDeviceOutput
func (ForgetDeviceOutput) GoString ¶
func (s ForgetDeviceOutput) GoString() string
GoString returns the string representation
func (ForgetDeviceOutput) SDKResponseMetadata ¶
func (s ForgetDeviceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ForgetDeviceOutput) String ¶
func (s ForgetDeviceOutput) String() string
String returns the string representation
type ForgetDeviceRequest ¶
type ForgetDeviceRequest struct { *aws.Request Input *ForgetDeviceInput Copy func(*ForgetDeviceInput) ForgetDeviceRequest }
ForgetDeviceRequest is a API request type for the ForgetDevice API operation.
func (ForgetDeviceRequest) Send ¶
func (r ForgetDeviceRequest) Send() (*ForgetDeviceOutput, error)
Send marshals and sends the ForgetDevice API request.
type ForgotPasswordInput ¶
type ForgotPasswordInput struct { // The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The ID of the client associated with the user pool. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // 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 `min:"1" type:"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 *UserContextDataType `type:"structure"` // The user name of the user for whom you want to enter a code to reset a forgotten // password. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to reset a user's password. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgotPasswordRequest
func (ForgotPasswordInput) GoString ¶
func (s ForgotPasswordInput) GoString() string
GoString returns the string representation
func (ForgotPasswordInput) String ¶
func (s ForgotPasswordInput) String() string
String returns the string representation
func (*ForgotPasswordInput) Validate ¶
func (s *ForgotPasswordInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ForgotPasswordOutput ¶
type ForgotPasswordOutput struct { // The code delivery details returned by the server in response to the request // to reset a password. CodeDeliveryDetails *CodeDeliveryDetailsType `type:"structure"` // contains filtered or unexported fields }
Respresents the response from the server regarding the request to reset a password. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ForgotPasswordResponse
func (ForgotPasswordOutput) GoString ¶
func (s ForgotPasswordOutput) GoString() string
GoString returns the string representation
func (ForgotPasswordOutput) SDKResponseMetadata ¶
func (s ForgotPasswordOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ForgotPasswordOutput) String ¶
func (s ForgotPasswordOutput) String() string
String returns the string representation
type ForgotPasswordRequest ¶
type ForgotPasswordRequest struct { *aws.Request Input *ForgotPasswordInput Copy func(*ForgotPasswordInput) ForgotPasswordRequest }
ForgotPasswordRequest is a API request type for the ForgotPassword API operation.
func (ForgotPasswordRequest) Send ¶
func (r ForgotPasswordRequest) Send() (*ForgotPasswordOutput, error)
Send marshals and sends the ForgotPassword API request.
type GetCSVHeaderInput ¶
type GetCSVHeaderInput struct { // The user pool ID for the user pool that the users are to be imported into. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to get the header information for the .csv file for the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetCSVHeaderRequest
func (GetCSVHeaderInput) GoString ¶
func (s GetCSVHeaderInput) GoString() string
GoString returns the string representation
func (GetCSVHeaderInput) String ¶
func (s GetCSVHeaderInput) String() string
String returns the string representation
func (*GetCSVHeaderInput) Validate ¶
func (s *GetCSVHeaderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetCSVHeaderOutput ¶
type GetCSVHeaderOutput struct { // The header information for the .csv file for the user import job. CSVHeader []string `type:"list"` // The user pool ID for the user pool that the users are to be imported into. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents the response from the server to the request to get the header information for the .csv file for the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetCSVHeaderResponse
func (GetCSVHeaderOutput) GoString ¶
func (s GetCSVHeaderOutput) GoString() string
GoString returns the string representation
func (GetCSVHeaderOutput) SDKResponseMetadata ¶
func (s GetCSVHeaderOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetCSVHeaderOutput) String ¶
func (s GetCSVHeaderOutput) String() string
String returns the string representation
type GetCSVHeaderRequest ¶
type GetCSVHeaderRequest struct { *aws.Request Input *GetCSVHeaderInput Copy func(*GetCSVHeaderInput) GetCSVHeaderRequest }
GetCSVHeaderRequest is a API request type for the GetCSVHeader API operation.
func (GetCSVHeaderRequest) Send ¶
func (r GetCSVHeaderRequest) Send() (*GetCSVHeaderOutput, error)
Send marshals and sends the GetCSVHeader API request.
type GetDeviceInput ¶
type GetDeviceInput struct { // The access token. AccessToken *string `type:"string"` // The device key. // // DeviceKey is a required field DeviceKey *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to get the device. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetDeviceRequest
func (GetDeviceInput) GoString ¶
func (s GetDeviceInput) GoString() string
GoString returns the string representation
func (GetDeviceInput) String ¶
func (s GetDeviceInput) String() string
String returns the string representation
func (*GetDeviceInput) Validate ¶
func (s *GetDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDeviceOutput ¶
type GetDeviceOutput struct { // The device. // // Device is a required field Device *DeviceType `type:"structure" required:"true"` // contains filtered or unexported fields }
Gets the device response. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetDeviceResponse
func (GetDeviceOutput) GoString ¶
func (s GetDeviceOutput) GoString() string
GoString returns the string representation
func (GetDeviceOutput) SDKResponseMetadata ¶
func (s GetDeviceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetDeviceOutput) String ¶
func (s GetDeviceOutput) String() string
String returns the string representation
type GetDeviceRequest ¶
type GetDeviceRequest struct { *aws.Request Input *GetDeviceInput Copy func(*GetDeviceInput) GetDeviceRequest }
GetDeviceRequest is a API request type for the GetDevice API operation.
func (GetDeviceRequest) Send ¶
func (r GetDeviceRequest) Send() (*GetDeviceOutput, error)
Send marshals and sends the GetDevice API request.
type GetGroupInput ¶
type GetGroupInput struct { // The name of the group. // // GroupName is a required field GroupName *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetGroupRequest
func (GetGroupInput) GoString ¶
func (s GetGroupInput) GoString() string
GoString returns the string representation
func (GetGroupInput) String ¶
func (s GetGroupInput) String() string
String returns the string representation
func (*GetGroupInput) Validate ¶
func (s *GetGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetGroupOutput ¶
type GetGroupOutput struct { // The group object for the group. Group *GroupType `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetGroupResponse
func (GetGroupOutput) GoString ¶
func (s GetGroupOutput) GoString() string
GoString returns the string representation
func (GetGroupOutput) SDKResponseMetadata ¶
func (s GetGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetGroupOutput) String ¶
func (s GetGroupOutput) String() string
String returns the string representation
type GetGroupRequest ¶
type GetGroupRequest struct { *aws.Request Input *GetGroupInput Copy func(*GetGroupInput) GetGroupRequest }
GetGroupRequest is a API request type for the GetGroup API operation.
func (GetGroupRequest) Send ¶
func (r GetGroupRequest) Send() (*GetGroupOutput, error)
Send marshals and sends the GetGroup API request.
type GetIdentityProviderByIdentifierInput ¶
type GetIdentityProviderByIdentifierInput struct { // The identity provider ID. // // IdpIdentifier is a required field IdpIdentifier *string `min:"1" type:"string" required:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetIdentityProviderByIdentifierRequest
func (GetIdentityProviderByIdentifierInput) GoString ¶
func (s GetIdentityProviderByIdentifierInput) GoString() string
GoString returns the string representation
func (GetIdentityProviderByIdentifierInput) String ¶
func (s GetIdentityProviderByIdentifierInput) String() string
String returns the string representation
func (*GetIdentityProviderByIdentifierInput) Validate ¶
func (s *GetIdentityProviderByIdentifierInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetIdentityProviderByIdentifierOutput ¶
type GetIdentityProviderByIdentifierOutput struct { // The identity provider object. // // IdentityProvider is a required field IdentityProvider *IdentityProviderType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetIdentityProviderByIdentifierResponse
func (GetIdentityProviderByIdentifierOutput) GoString ¶
func (s GetIdentityProviderByIdentifierOutput) GoString() string
GoString returns the string representation
func (GetIdentityProviderByIdentifierOutput) SDKResponseMetadata ¶
func (s GetIdentityProviderByIdentifierOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetIdentityProviderByIdentifierOutput) String ¶
func (s GetIdentityProviderByIdentifierOutput) String() string
String returns the string representation
type GetIdentityProviderByIdentifierRequest ¶
type GetIdentityProviderByIdentifierRequest struct { *aws.Request Input *GetIdentityProviderByIdentifierInput Copy func(*GetIdentityProviderByIdentifierInput) GetIdentityProviderByIdentifierRequest }
GetIdentityProviderByIdentifierRequest is a API request type for the GetIdentityProviderByIdentifier API operation.
func (GetIdentityProviderByIdentifierRequest) Send ¶
func (r GetIdentityProviderByIdentifierRequest) Send() (*GetIdentityProviderByIdentifierOutput, error)
Send marshals and sends the GetIdentityProviderByIdentifier API request.
type GetSigningCertificateInput ¶
type GetSigningCertificateInput struct { // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Request to get a signing certificate from Cognito. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetSigningCertificateRequest
func (GetSigningCertificateInput) GoString ¶
func (s GetSigningCertificateInput) GoString() string
GoString returns the string representation
func (GetSigningCertificateInput) String ¶
func (s GetSigningCertificateInput) String() string
String returns the string representation
func (*GetSigningCertificateInput) Validate ¶
func (s *GetSigningCertificateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetSigningCertificateOutput ¶
type GetSigningCertificateOutput struct { // The signing certificate. Certificate *string `type:"string"` // contains filtered or unexported fields }
Response from Cognito for a signing certificate request. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetSigningCertificateResponse
func (GetSigningCertificateOutput) GoString ¶
func (s GetSigningCertificateOutput) GoString() string
GoString returns the string representation
func (GetSigningCertificateOutput) SDKResponseMetadata ¶
func (s GetSigningCertificateOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetSigningCertificateOutput) String ¶
func (s GetSigningCertificateOutput) String() string
String returns the string representation
type GetSigningCertificateRequest ¶
type GetSigningCertificateRequest struct { *aws.Request Input *GetSigningCertificateInput Copy func(*GetSigningCertificateInput) GetSigningCertificateRequest }
GetSigningCertificateRequest is a API request type for the GetSigningCertificate API operation.
func (GetSigningCertificateRequest) Send ¶
func (r GetSigningCertificateRequest) Send() (*GetSigningCertificateOutput, error)
Send marshals and sends the GetSigningCertificate API request.
type GetUICustomizationInput ¶
type GetUICustomizationInput struct { // The client ID for the client app. ClientId *string `min:"1" type:"string"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUICustomizationRequest
func (GetUICustomizationInput) GoString ¶
func (s GetUICustomizationInput) GoString() string
GoString returns the string representation
func (GetUICustomizationInput) String ¶
func (s GetUICustomizationInput) String() string
String returns the string representation
func (*GetUICustomizationInput) Validate ¶
func (s *GetUICustomizationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUICustomizationOutput ¶
type GetUICustomizationOutput struct { // The UI customization information. // // UICustomization is a required field UICustomization *UICustomizationType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUICustomizationResponse
func (GetUICustomizationOutput) GoString ¶
func (s GetUICustomizationOutput) GoString() string
GoString returns the string representation
func (GetUICustomizationOutput) SDKResponseMetadata ¶
func (s GetUICustomizationOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetUICustomizationOutput) String ¶
func (s GetUICustomizationOutput) String() string
String returns the string representation
type GetUICustomizationRequest ¶
type GetUICustomizationRequest struct { *aws.Request Input *GetUICustomizationInput Copy func(*GetUICustomizationInput) GetUICustomizationRequest }
GetUICustomizationRequest is a API request type for the GetUICustomization API operation.
func (GetUICustomizationRequest) Send ¶
func (r GetUICustomizationRequest) Send() (*GetUICustomizationOutput, error)
Send marshals and sends the GetUICustomization API request.
type GetUserAttributeVerificationCodeInput ¶
type GetUserAttributeVerificationCodeInput struct { // The access token returned by the server response to get the user attribute // verification code. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // The attribute name returned by the server response to get the user attribute // verification code. // // AttributeName is a required field AttributeName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to get user attribute verification. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAttributeVerificationCodeRequest
func (GetUserAttributeVerificationCodeInput) GoString ¶
func (s GetUserAttributeVerificationCodeInput) GoString() string
GoString returns the string representation
func (GetUserAttributeVerificationCodeInput) String ¶
func (s GetUserAttributeVerificationCodeInput) String() string
String returns the string representation
func (*GetUserAttributeVerificationCodeInput) Validate ¶
func (s *GetUserAttributeVerificationCodeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 *CodeDeliveryDetailsType `type:"structure"` // contains filtered or unexported fields }
The verification code response returned by the server response to get the user attribute verification code. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserAttributeVerificationCodeResponse
func (GetUserAttributeVerificationCodeOutput) GoString ¶
func (s GetUserAttributeVerificationCodeOutput) GoString() string
GoString returns the string representation
func (GetUserAttributeVerificationCodeOutput) SDKResponseMetadata ¶
func (s GetUserAttributeVerificationCodeOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetUserAttributeVerificationCodeOutput) String ¶
func (s GetUserAttributeVerificationCodeOutput) String() string
String returns the string representation
type GetUserAttributeVerificationCodeRequest ¶
type GetUserAttributeVerificationCodeRequest struct { *aws.Request Input *GetUserAttributeVerificationCodeInput Copy func(*GetUserAttributeVerificationCodeInput) GetUserAttributeVerificationCodeRequest }
GetUserAttributeVerificationCodeRequest is a API request type for the GetUserAttributeVerificationCode API operation.
func (GetUserAttributeVerificationCodeRequest) Send ¶
func (r GetUserAttributeVerificationCodeRequest) Send() (*GetUserAttributeVerificationCodeOutput, error)
Send marshals and sends the GetUserAttributeVerificationCode API request.
type GetUserInput ¶
type GetUserInput struct { // The access token returned by the server response to get information about // the user. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to get information about the user. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserRequest
func (GetUserInput) GoString ¶
func (s GetUserInput) GoString() string
GoString returns the string representation
func (GetUserInput) String ¶
func (s GetUserInput) String() string
String returns the string representation
func (*GetUserInput) Validate ¶
func (s *GetUserInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUserOutput ¶
type GetUserOutput struct { // Specifies the options for MFA (e.g., email or phone number). MFAOptions []MFAOptionType `type:"list"` // The user's preferred MFA setting. PreferredMfaSetting *string `type:"string"` // An array of name-value pairs representing user attributes. // // For custom attributes, you must prepend the custom: prefix to the attribute // name. // // UserAttributes is a required field UserAttributes []AttributeType `type:"list" required:"true"` // The list of the user's MFA settings. UserMFASettingList []string `type:"list"` // The user name of the user you wish to retrieve from the get user request. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the response from the server from the request to get information about the user. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserResponse
func (GetUserOutput) GoString ¶
func (s GetUserOutput) GoString() string
GoString returns the string representation
func (GetUserOutput) SDKResponseMetadata ¶
func (s GetUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetUserOutput) String ¶
func (s GetUserOutput) String() string
String returns the string representation
type GetUserPoolMfaConfigInput ¶
type GetUserPoolMfaConfigInput struct { // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserPoolMfaConfigRequest
func (GetUserPoolMfaConfigInput) GoString ¶
func (s GetUserPoolMfaConfigInput) GoString() string
GoString returns the string representation
func (GetUserPoolMfaConfigInput) String ¶
func (s GetUserPoolMfaConfigInput) String() string
String returns the string representation
func (*GetUserPoolMfaConfigInput) Validate ¶
func (s *GetUserPoolMfaConfigInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetUserPoolMfaConfigOutput ¶
type GetUserPoolMfaConfigOutput struct { // The multi-factor (MFA) configuration. MfaConfiguration UserPoolMfaType `type:"string" enum:"true"` // The SMS text message multi-factor (MFA) configuration. SmsMfaConfiguration *SmsMfaConfigType `type:"structure"` // The software token multi-factor (MFA) configuration. SoftwareTokenMfaConfiguration *SoftwareTokenMfaConfigType `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GetUserPoolMfaConfigResponse
func (GetUserPoolMfaConfigOutput) GoString ¶
func (s GetUserPoolMfaConfigOutput) GoString() string
GoString returns the string representation
func (GetUserPoolMfaConfigOutput) SDKResponseMetadata ¶
func (s GetUserPoolMfaConfigOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetUserPoolMfaConfigOutput) String ¶
func (s GetUserPoolMfaConfigOutput) String() string
String returns the string representation
type GetUserPoolMfaConfigRequest ¶
type GetUserPoolMfaConfigRequest struct { *aws.Request Input *GetUserPoolMfaConfigInput Copy func(*GetUserPoolMfaConfigInput) GetUserPoolMfaConfigRequest }
GetUserPoolMfaConfigRequest is a API request type for the GetUserPoolMfaConfig API operation.
func (GetUserPoolMfaConfigRequest) Send ¶
func (r GetUserPoolMfaConfigRequest) Send() (*GetUserPoolMfaConfigOutput, error)
Send marshals and sends the GetUserPoolMfaConfig API request.
type GetUserRequest ¶
type GetUserRequest struct { *aws.Request Input *GetUserInput Copy func(*GetUserInput) GetUserRequest }
GetUserRequest is a API request type for the GetUser API operation.
func (GetUserRequest) Send ¶
func (r GetUserRequest) Send() (*GetUserOutput, error)
Send marshals and sends the GetUser API request.
type GlobalSignOutInput ¶
type GlobalSignOutInput struct { // The access token. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to sign out all devices. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GlobalSignOutRequest
func (GlobalSignOutInput) GoString ¶
func (s GlobalSignOutInput) GoString() string
GoString returns the string representation
func (GlobalSignOutInput) String ¶
func (s GlobalSignOutInput) String() string
String returns the string representation
func (*GlobalSignOutInput) Validate ¶
func (s *GlobalSignOutInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GlobalSignOutOutput ¶
type GlobalSignOutOutput struct {
// contains filtered or unexported fields
}
The response to the request to sign out all devices. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GlobalSignOutResponse
func (GlobalSignOutOutput) GoString ¶
func (s GlobalSignOutOutput) GoString() string
GoString returns the string representation
func (GlobalSignOutOutput) SDKResponseMetadata ¶
func (s GlobalSignOutOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GlobalSignOutOutput) String ¶
func (s GlobalSignOutOutput) String() string
String returns the string representation
type GlobalSignOutRequest ¶
type GlobalSignOutRequest struct { *aws.Request Input *GlobalSignOutInput Copy func(*GlobalSignOutInput) GlobalSignOutRequest }
GlobalSignOutRequest is a API request type for the GlobalSignOut API operation.
func (GlobalSignOutRequest) Send ¶
func (r GlobalSignOutRequest) Send() (*GlobalSignOutOutput, error)
Send marshals and sends the GlobalSignOut API request.
type GroupType ¶
type GroupType struct { // The date the group was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // A string containing the description of the group. Description *string `type:"string"` // The name of the group. GroupName *string `min:"1" type:"string"` // The date the group was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // 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. If a user // belongs to two or more groups, it is the group with the highest precedence // whose role ARN will be used in the cognito:roles and cognito:preferred_role // claims in the user's tokens. Groups with higher Precedence values take precedence // over groups with lower Precedence values or with null Precedence values. // // 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 *int64 `type:"integer"` // The role ARN for the group. RoleArn *string `min:"20" type:"string"` // The user pool ID for the user pool. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
The group type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/GroupType
type HttpHeader ¶
type HttpHeader struct { // The header name HeaderName *string `locationName:"headerName" type:"string"` // The header value. HeaderValue *string `locationName:"headerValue" type:"string"` // contains filtered or unexported fields }
The HTTP header. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/HttpHeader
func (HttpHeader) GoString ¶
func (s HttpHeader) GoString() string
GoString returns the string representation
func (HttpHeader) String ¶
func (s HttpHeader) String() string
String returns the string representation
type IdentityProviderType ¶
type IdentityProviderType struct { // A mapping of identity provider attributes to standard and custom user pool // attributes. AttributeMapping map[string]string `type:"map"` // The date the identity provider was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // A list of identity provider identifiers. IdpIdentifiers []string `type:"list"` // The date the identity provider was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The identity provider details, such as MetadataURL and MetadataFile. ProviderDetails map[string]string `type:"map"` // The identity provider name. ProviderName *string `min:"1" type:"string"` // The identity provider type. ProviderType IdentityProviderTypeType `type:"string" enum:"true"` // The user pool ID. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
A container for information about an identity provider. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/IdentityProviderType
func (IdentityProviderType) GoString ¶
func (s IdentityProviderType) GoString() string
GoString returns the string representation
func (IdentityProviderType) String ¶
func (s IdentityProviderType) String() string
String returns the string representation
type IdentityProviderTypeType ¶
type IdentityProviderTypeType string
const ( IdentityProviderTypeTypeSaml IdentityProviderTypeType = "SAML" IdentityProviderTypeTypeFacebook IdentityProviderTypeType = "Facebook" IdentityProviderTypeTypeGoogle IdentityProviderTypeType = "Google" IdentityProviderTypeTypeLoginWithAmazon IdentityProviderTypeType = "LoginWithAmazon" IdentityProviderTypeTypeOidc IdentityProviderTypeType = "OIDC" )
Enum values for IdentityProviderTypeType
func (IdentityProviderTypeType) MarshalValue ¶
func (enum IdentityProviderTypeType) MarshalValue() (string, error)
func (IdentityProviderTypeType) MarshalValueBuf ¶
func (enum IdentityProviderTypeType) MarshalValueBuf(b []byte) ([]byte, error)
type InitiateAuthInput ¶
type InitiateAuthInput struct { // The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The authentication flow for this call to execute. The API action will depend // on this value. For example: // // * REFRESH_TOKEN_AUTH will take in a valid refresh token and return new // tokens. // // * USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables // to be used for next challenge execution. // // * USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the // next challenge or tokens. // // Valid values include: // // * USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) // protocol. // // * REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing // the access token and ID token by supplying a valid refresh token. // // * CUSTOM_AUTH: Custom authentication flow. // // * 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_NO_SRP_AUTH is not a valid value. // // AuthFlow is a required field AuthFlow AuthFlowType `type:"string" required:"true" enum:"true"` // 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 `type:"map"` // The app client ID. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // This is a random key-value pair map which can contain any key and will be // passed to your PreAuthentication Lambda trigger as-is. It can be used to // implement additional validations around authentication. ClientMetadata map[string]string `type:"map"` // Contextual data such as the user's device fingerprint, IP address, or location // used for evaluating the risk of an unexpected event by Amazon Cognito advanced // security. UserContextData *UserContextDataType `type:"structure"` // contains filtered or unexported fields }
Initiates the authentication request. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuthRequest
func (InitiateAuthInput) GoString ¶
func (s InitiateAuthInput) GoString() string
GoString returns the string representation
func (InitiateAuthInput) String ¶
func (s InitiateAuthInput) String() string
String returns the string representation
func (*InitiateAuthInput) Validate ¶
func (s *InitiateAuthInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InitiateAuthOutput ¶
type InitiateAuthOutput struct { // The result of the authentication response. This is only returned if the caller // does not need to pass another challenge. If the caller does need to pass // another challenge before it gets tokens, ChallengeName, ChallengeParameters, // and Session are returned. AuthenticationResult *AuthenticationResultType `type:"structure"` // The name of the challenge which you are responding to with this call. This // is returned to you in the AdminInitiateAuth response if you need to pass // another challenge. // // 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 ChallengeNameType `type:"string" enum:"true"` // 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 `type:"map"` // The session which should be passed both ways in challenge-response calls // to the service. If the or API call determines that the caller needs to go // through another challenge, they return a session with other challenge parameters. // This session should be passed as it is to the next RespondToAuthChallenge // API call. Session *string `min:"20" type:"string"` // contains filtered or unexported fields }
Initiates the authentication response. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/InitiateAuthResponse
func (InitiateAuthOutput) GoString ¶
func (s InitiateAuthOutput) GoString() string
GoString returns the string representation
func (InitiateAuthOutput) SDKResponseMetadata ¶
func (s InitiateAuthOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (InitiateAuthOutput) String ¶
func (s InitiateAuthOutput) String() string
String returns the string representation
type InitiateAuthRequest ¶
type InitiateAuthRequest struct { *aws.Request Input *InitiateAuthInput Copy func(*InitiateAuthInput) InitiateAuthRequest }
InitiateAuthRequest is a API request type for the InitiateAuth API operation.
func (InitiateAuthRequest) Send ¶
func (r InitiateAuthRequest) Send() (*InitiateAuthOutput, error)
Send marshals and sends the InitiateAuth API request.
type LambdaConfigType ¶
type LambdaConfigType struct { // Creates an authentication challenge. CreateAuthChallenge *string `min:"20" type:"string"` // A custom Message AWS Lambda trigger. CustomMessage *string `min:"20" type:"string"` // Defines the authentication challenge. DefineAuthChallenge *string `min:"20" type:"string"` // A post-authentication AWS Lambda trigger. PostAuthentication *string `min:"20" type:"string"` // A post-confirmation AWS Lambda trigger. PostConfirmation *string `min:"20" type:"string"` // A pre-authentication AWS Lambda trigger. PreAuthentication *string `min:"20" type:"string"` // A pre-registration AWS Lambda trigger. PreSignUp *string `min:"20" type:"string"` // A Lambda trigger that is invoked before token generation. PreTokenGeneration *string `min:"20" type:"string"` // The user migration Lambda config type. UserMigration *string `min:"20" type:"string"` // Verifies the authentication challenge response. VerifyAuthChallengeResponse *string `min:"20" type:"string"` // contains filtered or unexported fields }
Specifies the configuration for AWS Lambda triggers. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/LambdaConfigType
func (LambdaConfigType) GoString ¶
func (s LambdaConfigType) GoString() string
GoString returns the string representation
func (LambdaConfigType) String ¶
func (s LambdaConfigType) String() string
String returns the string representation
func (*LambdaConfigType) Validate ¶
func (s *LambdaConfigType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDevicesInput ¶
type ListDevicesInput struct { // The access tokens for the request to list devices. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // The limit of the device request. Limit *int64 `type:"integer"` // The pagination token for the list request. PaginationToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents the request to list the devices. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListDevicesRequest
func (ListDevicesInput) GoString ¶
func (s ListDevicesInput) GoString() string
GoString returns the string representation
func (ListDevicesInput) String ¶
func (s ListDevicesInput) String() string
String returns the string representation
func (*ListDevicesInput) Validate ¶
func (s *ListDevicesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListDevicesOutput ¶
type ListDevicesOutput struct { // The devices returned in the list devices response. Devices []DeviceType `type:"list"` // The pagination token for the list device response. PaginationToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents the response to list devices. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListDevicesResponse
func (ListDevicesOutput) GoString ¶
func (s ListDevicesOutput) GoString() string
GoString returns the string representation
func (ListDevicesOutput) SDKResponseMetadata ¶
func (s ListDevicesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListDevicesOutput) String ¶
func (s ListDevicesOutput) String() string
String returns the string representation
type ListDevicesRequest ¶
type ListDevicesRequest struct { *aws.Request Input *ListDevicesInput Copy func(*ListDevicesInput) ListDevicesRequest }
ListDevicesRequest is a API request type for the ListDevices API operation.
func (ListDevicesRequest) Send ¶
func (r ListDevicesRequest) Send() (*ListDevicesOutput, error)
Send marshals and sends the ListDevices API request.
type ListGroupsInput ¶
type ListGroupsInput struct { // The limit of the request to list groups. Limit *int64 `type:"integer"` // An identifier that was returned from the previous call to this operation, // which can be used to return the next set of items in the list. NextToken *string `min:"1" type:"string"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListGroupsRequest
func (ListGroupsInput) GoString ¶
func (s ListGroupsInput) GoString() string
GoString returns the string representation
func (ListGroupsInput) String ¶
func (s ListGroupsInput) String() string
String returns the string representation
func (*ListGroupsInput) Validate ¶
func (s *ListGroupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGroupsOutput ¶
type ListGroupsOutput struct { // The group objects for the groups. Groups []GroupType `type:"list"` // An identifier that was returned from the previous call to this operation, // which can be used to return the next set of items in the list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListGroupsResponse
func (ListGroupsOutput) GoString ¶
func (s ListGroupsOutput) GoString() string
GoString returns the string representation
func (ListGroupsOutput) SDKResponseMetadata ¶
func (s ListGroupsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListGroupsOutput) String ¶
func (s ListGroupsOutput) String() string
String returns the string representation
type ListGroupsRequest ¶
type ListGroupsRequest struct { *aws.Request Input *ListGroupsInput Copy func(*ListGroupsInput) ListGroupsRequest }
ListGroupsRequest is a API request type for the ListGroups API operation.
func (ListGroupsRequest) Send ¶
func (r ListGroupsRequest) Send() (*ListGroupsOutput, error)
Send marshals and sends the ListGroups API request.
type ListIdentityProvidersInput ¶
type ListIdentityProvidersInput struct { // The maximum number of identity providers to return. MaxResults *int64 `min:"1" type:"integer"` // A pagination token. NextToken *string `min:"1" type:"string"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListIdentityProvidersRequest
func (ListIdentityProvidersInput) GoString ¶
func (s ListIdentityProvidersInput) GoString() string
GoString returns the string representation
func (ListIdentityProvidersInput) String ¶
func (s ListIdentityProvidersInput) String() string
String returns the string representation
func (*ListIdentityProvidersInput) Validate ¶
func (s *ListIdentityProvidersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListIdentityProvidersOutput ¶
type ListIdentityProvidersOutput struct { // A pagination token. NextToken *string `min:"1" type:"string"` // A list of identity provider objects. // // Providers is a required field Providers []ProviderDescription `type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListIdentityProvidersResponse
func (ListIdentityProvidersOutput) GoString ¶
func (s ListIdentityProvidersOutput) GoString() string
GoString returns the string representation
func (ListIdentityProvidersOutput) SDKResponseMetadata ¶
func (s ListIdentityProvidersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListIdentityProvidersOutput) String ¶
func (s ListIdentityProvidersOutput) String() string
String returns the string representation
type ListIdentityProvidersRequest ¶
type ListIdentityProvidersRequest struct { *aws.Request Input *ListIdentityProvidersInput Copy func(*ListIdentityProvidersInput) ListIdentityProvidersRequest }
ListIdentityProvidersRequest is a API request type for the ListIdentityProviders API operation.
func (ListIdentityProvidersRequest) Send ¶
func (r ListIdentityProvidersRequest) Send() (*ListIdentityProvidersOutput, error)
Send marshals and sends the ListIdentityProviders API request.
type ListResourceServersInput ¶
type ListResourceServersInput struct { // The maximum number of resource servers to return. MaxResults *int64 `min:"1" type:"integer"` // A pagination token. NextToken *string `min:"1" type:"string"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListResourceServersRequest
func (ListResourceServersInput) GoString ¶
func (s ListResourceServersInput) GoString() string
GoString returns the string representation
func (ListResourceServersInput) String ¶
func (s ListResourceServersInput) String() string
String returns the string representation
func (*ListResourceServersInput) Validate ¶
func (s *ListResourceServersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListResourceServersOutput ¶
type ListResourceServersOutput struct { // A pagination token. NextToken *string `min:"1" type:"string"` // The resource servers. // // ResourceServers is a required field ResourceServers []ResourceServerType `type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListResourceServersResponse
func (ListResourceServersOutput) GoString ¶
func (s ListResourceServersOutput) GoString() string
GoString returns the string representation
func (ListResourceServersOutput) SDKResponseMetadata ¶
func (s ListResourceServersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListResourceServersOutput) String ¶
func (s ListResourceServersOutput) String() string
String returns the string representation
type ListResourceServersRequest ¶
type ListResourceServersRequest struct { *aws.Request Input *ListResourceServersInput Copy func(*ListResourceServersInput) ListResourceServersRequest }
ListResourceServersRequest is a API request type for the ListResourceServers API operation.
func (ListResourceServersRequest) Send ¶
func (r ListResourceServersRequest) Send() (*ListResourceServersOutput, error)
Send marshals and sends the ListResourceServers API request.
type ListUserImportJobsInput ¶
type ListUserImportJobsInput struct { // The maximum number of import jobs you want the request to return. // // MaxResults is a required field MaxResults *int64 `min:"1" type:"integer" required:"true"` // 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 `min:"1" type:"string"` // The user pool ID for the user pool that the users are being imported into. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to list the user import jobs. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserImportJobsRequest
func (ListUserImportJobsInput) GoString ¶
func (s ListUserImportJobsInput) GoString() string
GoString returns the string representation
func (ListUserImportJobsInput) String ¶
func (s ListUserImportJobsInput) String() string
String returns the string representation
func (*ListUserImportJobsInput) Validate ¶
func (s *ListUserImportJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListUserImportJobsOutput ¶
type ListUserImportJobsOutput struct { // An identifier that can be used to return the next set of user import jobs // in the list. PaginationToken *string `min:"1" type:"string"` // The user import jobs. UserImportJobs []UserImportJobType `min:"1" type:"list"` // contains filtered or unexported fields }
Represents the response from the server to the request to list the user import jobs. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserImportJobsResponse
func (ListUserImportJobsOutput) GoString ¶
func (s ListUserImportJobsOutput) GoString() string
GoString returns the string representation
func (ListUserImportJobsOutput) SDKResponseMetadata ¶
func (s ListUserImportJobsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUserImportJobsOutput) String ¶
func (s ListUserImportJobsOutput) String() string
String returns the string representation
type ListUserImportJobsRequest ¶
type ListUserImportJobsRequest struct { *aws.Request Input *ListUserImportJobsInput Copy func(*ListUserImportJobsInput) ListUserImportJobsRequest }
ListUserImportJobsRequest is a API request type for the ListUserImportJobs API operation.
func (ListUserImportJobsRequest) Send ¶
func (r ListUserImportJobsRequest) Send() (*ListUserImportJobsOutput, error)
Send marshals and sends the ListUserImportJobs API request.
type ListUserPoolClientsInput ¶
type ListUserPoolClientsInput struct { // The maximum number of results you want the request to return when listing // the user pool clients. MaxResults *int64 `min:"1" type:"integer"` // An identifier that was returned from the previous call to this operation, // which can be used to return the next set of items in the list. NextToken *string `min:"1" type:"string"` // The user pool ID for the user pool where you want to list user pool clients. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to list the user pool clients. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolClientsRequest
func (ListUserPoolClientsInput) GoString ¶
func (s ListUserPoolClientsInput) GoString() string
GoString returns the string representation
func (ListUserPoolClientsInput) String ¶
func (s ListUserPoolClientsInput) String() string
String returns the string representation
func (*ListUserPoolClientsInput) Validate ¶
func (s *ListUserPoolClientsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 `min:"1" type:"string"` // The user pool clients in the response that lists user pool clients. UserPoolClients []UserPoolClientDescription `type:"list"` // contains filtered or unexported fields }
Represents the response from the server that lists user pool clients. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolClientsResponse
func (ListUserPoolClientsOutput) GoString ¶
func (s ListUserPoolClientsOutput) GoString() string
GoString returns the string representation
func (ListUserPoolClientsOutput) SDKResponseMetadata ¶
func (s ListUserPoolClientsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUserPoolClientsOutput) String ¶
func (s ListUserPoolClientsOutput) String() string
String returns the string representation
type ListUserPoolClientsRequest ¶
type ListUserPoolClientsRequest struct { *aws.Request Input *ListUserPoolClientsInput Copy func(*ListUserPoolClientsInput) ListUserPoolClientsRequest }
ListUserPoolClientsRequest is a API request type for the ListUserPoolClients API operation.
func (ListUserPoolClientsRequest) Send ¶
func (r ListUserPoolClientsRequest) Send() (*ListUserPoolClientsOutput, error)
Send marshals and sends the ListUserPoolClients API request.
type ListUserPoolsInput ¶
type ListUserPoolsInput struct { // The maximum number of results you want the request to return when listing // the user pools. // // MaxResults is a required field MaxResults *int64 `min:"1" type:"integer" required:"true"` // An identifier that was returned from the previous call to this operation, // which can be used to return the next set of items in the list. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents the request to list user pools. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolsRequest
func (ListUserPoolsInput) GoString ¶
func (s ListUserPoolsInput) GoString() string
GoString returns the string representation
func (ListUserPoolsInput) String ¶
func (s ListUserPoolsInput) String() string
String returns the string representation
func (*ListUserPoolsInput) Validate ¶
func (s *ListUserPoolsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListUserPoolsOutput ¶
type ListUserPoolsOutput 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 `min:"1" type:"string"` // The user pools from the response to list users. UserPools []UserPoolDescriptionType `type:"list"` // contains filtered or unexported fields }
Represents the response to list user pools. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolsResponse
func (ListUserPoolsOutput) GoString ¶
func (s ListUserPoolsOutput) GoString() string
GoString returns the string representation
func (ListUserPoolsOutput) SDKResponseMetadata ¶
func (s ListUserPoolsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUserPoolsOutput) String ¶
func (s ListUserPoolsOutput) String() string
String returns the string representation
type ListUserPoolsRequest ¶
type ListUserPoolsRequest struct { *aws.Request Input *ListUserPoolsInput Copy func(*ListUserPoolsInput) ListUserPoolsRequest }
ListUserPoolsRequest is a API request type for the ListUserPools API operation.
func (ListUserPoolsRequest) Send ¶
func (r ListUserPoolsRequest) Send() (*ListUserPoolsOutput, error)
Send marshals and sends the ListUserPools API request.
type ListUsersInGroupInput ¶
type ListUsersInGroupInput struct { // The name of the group. // // GroupName is a required field GroupName *string `min:"1" type:"string" required:"true"` // The limit of the request to list users. Limit *int64 `type:"integer"` // An identifier that was returned from the previous call to this operation, // which can be used to return the next set of items in the list. NextToken *string `min:"1" type:"string"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersInGroupRequest
func (ListUsersInGroupInput) GoString ¶
func (s ListUsersInGroupInput) GoString() string
GoString returns the string representation
func (ListUsersInGroupInput) String ¶
func (s ListUsersInGroupInput) String() string
String returns the string representation
func (*ListUsersInGroupInput) Validate ¶
func (s *ListUsersInGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 `min:"1" type:"string"` // The users returned in the request to list users. Users []UserType `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersInGroupResponse
func (ListUsersInGroupOutput) GoString ¶
func (s ListUsersInGroupOutput) GoString() string
GoString returns the string representation
func (ListUsersInGroupOutput) SDKResponseMetadata ¶
func (s ListUsersInGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUsersInGroupOutput) String ¶
func (s ListUsersInGroupOutput) String() string
String returns the string representation
type ListUsersInGroupRequest ¶
type ListUsersInGroupRequest struct { *aws.Request Input *ListUsersInGroupInput Copy func(*ListUsersInGroupInput) ListUsersInGroupRequest }
ListUsersInGroupRequest is a API request type for the ListUsersInGroup API operation.
func (ListUsersInGroupRequest) Send ¶
func (r ListUsersInGroupRequest) Send() (*ListUsersInGroupOutput, error)
Send marshals and sends the ListUsersInGroup API request.
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 `type:"list"` // A filter string of the form "AttributeNameFilter-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 Enabled in the Console) (case-sensitive) // // * status (case-insensitive) // // * sub // // Custom attributes are not searchable. // // For more information, see Searching for Users Using the ListUsers API (http://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 (http://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 `type:"string"` // Maximum number of users to be returned. Limit *int64 `type:"integer"` // An identifier that was returned from the previous call to this operation, // which can be used to return the next set of items in the list. PaginationToken *string `min:"1" type:"string"` // The user pool ID for the user pool on which the search should be performed. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to list users. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersRequest
func (ListUsersInput) GoString ¶
func (s ListUsersInput) GoString() string
GoString returns the string representation
func (ListUsersInput) String ¶
func (s ListUsersInput) String() string
String returns the string representation
func (*ListUsersInput) Validate ¶
func (s *ListUsersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListUsersOutput ¶
type ListUsersOutput 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. PaginationToken *string `min:"1" type:"string"` // The users returned in the request to list users. Users []UserType `type:"list"` // contains filtered or unexported fields }
The response from the request to list users. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUsersResponse
func (ListUsersOutput) GoString ¶
func (s ListUsersOutput) GoString() string
GoString returns the string representation
func (ListUsersOutput) SDKResponseMetadata ¶
func (s ListUsersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUsersOutput) String ¶
func (s ListUsersOutput) String() string
String returns the string representation
type ListUsersRequest ¶
type ListUsersRequest struct { *aws.Request Input *ListUsersInput Copy func(*ListUsersInput) ListUsersRequest }
ListUsersRequest is a API request type for the ListUsers API operation.
func (ListUsersRequest) Send ¶
func (r ListUsersRequest) Send() (*ListUsersOutput, error)
Send marshals and sends the ListUsers API request.
type MFAOptionType ¶
type MFAOptionType struct { // The attribute name of the MFA option type. AttributeName *string `min:"1" type:"string"` // The delivery medium (email message or SMS message) to send the MFA code. DeliveryMedium DeliveryMediumType `type:"string" enum:"true"` // contains filtered or unexported fields }
Specifies the different settings for multi-factor authentication (MFA). Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/MFAOptionType
func (MFAOptionType) GoString ¶
func (s MFAOptionType) GoString() string
GoString returns the string representation
func (MFAOptionType) String ¶
func (s MFAOptionType) String() string
String returns the string representation
func (*MFAOptionType) Validate ¶
func (s *MFAOptionType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MessageActionType ¶
type MessageActionType string
const ( MessageActionTypeResend MessageActionType = "RESEND" MessageActionTypeSuppress MessageActionType = "SUPPRESS" )
Enum values for MessageActionType
func (MessageActionType) MarshalValue ¶
func (enum MessageActionType) MarshalValue() (string, error)
func (MessageActionType) MarshalValueBuf ¶
func (enum MessageActionType) MarshalValueBuf(b []byte) ([]byte, error)
type MessageTemplateType ¶
type MessageTemplateType struct { // The message template for email messages. EmailMessage *string `min:"6" type:"string"` // The subject line for email messages. EmailSubject *string `min:"1" type:"string"` // The message template for SMS messages. SMSMessage *string `min:"6" type:"string"` // contains filtered or unexported fields }
The message template structure. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/MessageTemplateType
func (MessageTemplateType) GoString ¶
func (s MessageTemplateType) GoString() string
GoString returns the string representation
func (MessageTemplateType) String ¶
func (s MessageTemplateType) String() string
String returns the string representation
func (*MessageTemplateType) Validate ¶
func (s *MessageTemplateType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type NewDeviceMetadataType ¶
type NewDeviceMetadataType struct { // The device group key. DeviceGroupKey *string `type:"string"` // The device key. DeviceKey *string `min:"1" type:"string"` // contains filtered or unexported fields }
The new device metadata type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/NewDeviceMetadataType
func (NewDeviceMetadataType) GoString ¶
func (s NewDeviceMetadataType) GoString() string
GoString returns the string representation
func (NewDeviceMetadataType) String ¶
func (s NewDeviceMetadataType) String() string
String returns the string representation
type NotifyConfigurationType ¶
type NotifyConfigurationType struct { // Email template used when a detected risk event is blocked. BlockEmail *NotifyEmailType `type:"structure"` // The email address that is sending the email. It must be either individually // verified with Amazon SES, or from a domain that has been verified with Amazon // SES. From *string `type:"string"` // The MFA email template used when MFA is challenged as part of a detected // risk. MfaEmail *NotifyEmailType `type:"structure"` // The email template used when a detected risk event is allowed. NoActionEmail *NotifyEmailType `type:"structure"` // The destination to which the receiver of an email should reply to. ReplyTo *string `type:"string"` // The Amazon Resource Name (ARN) of the identity that is associated with the // sending authorization policy. It permits Amazon Cognito to send for the email // address specified in the From parameter. // // SourceArn is a required field SourceArn *string `min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
The notify configuration type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/NotifyConfigurationType
func (NotifyConfigurationType) GoString ¶
func (s NotifyConfigurationType) GoString() string
GoString returns the string representation
func (NotifyConfigurationType) String ¶
func (s NotifyConfigurationType) String() string
String returns the string representation
func (*NotifyConfigurationType) Validate ¶
func (s *NotifyConfigurationType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type NotifyEmailType ¶
type NotifyEmailType struct { // The HTML body. HtmlBody *string `min:"6" type:"string"` // The subject. // // Subject is a required field Subject *string `min:"1" type:"string" required:"true"` // The text body. TextBody *string `min:"6" type:"string"` // contains filtered or unexported fields }
The notify email type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/NotifyEmailType
func (NotifyEmailType) GoString ¶
func (s NotifyEmailType) GoString() string
GoString returns the string representation
func (NotifyEmailType) String ¶
func (s NotifyEmailType) String() string
String returns the string representation
func (*NotifyEmailType) Validate ¶
func (s *NotifyEmailType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type NumberAttributeConstraintsType ¶
type NumberAttributeConstraintsType struct { // The maximum value of an attribute that is of the number data type. MaxValue *string `type:"string"` // The minimum value of an attribute that is of the number data type. MinValue *string `type:"string"` // contains filtered or unexported fields }
The minimum and maximum value of an attribute that is of the number data type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/NumberAttributeConstraintsType
func (NumberAttributeConstraintsType) GoString ¶
func (s NumberAttributeConstraintsType) GoString() string
GoString returns the string representation
func (NumberAttributeConstraintsType) String ¶
func (s NumberAttributeConstraintsType) String() string
String returns the string representation
type OAuthFlowType ¶
type OAuthFlowType string
const ( OAuthFlowTypeCode OAuthFlowType = "code" OAuthFlowTypeImplicit OAuthFlowType = "implicit" OAuthFlowTypeClientCredentials OAuthFlowType = "client_credentials" )
Enum values for OAuthFlowType
func (OAuthFlowType) MarshalValue ¶
func (enum OAuthFlowType) MarshalValue() (string, error)
func (OAuthFlowType) MarshalValueBuf ¶
func (enum OAuthFlowType) MarshalValueBuf(b []byte) ([]byte, error)
type PasswordPolicyType ¶
type PasswordPolicyType struct { // The minimum length of the password policy that you have set. Cannot be less // than 6. MinimumLength *int64 `min:"6" type:"integer"` // In the password policy that you have set, refers to whether you have required // users to use at least one lowercase letter in their password. RequireLowercase *bool `type:"boolean"` // In the password policy that you have set, refers to whether you have required // users to use at least one number in their password. RequireNumbers *bool `type:"boolean"` // In the password policy that you have set, refers to whether you have required // users to use at least one symbol in their password. RequireSymbols *bool `type:"boolean"` // In the password policy that you have set, refers to whether you have required // users to use at least one uppercase letter in their password. RequireUppercase *bool `type:"boolean"` // contains filtered or unexported fields }
The password policy type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/PasswordPolicyType
func (PasswordPolicyType) GoString ¶
func (s PasswordPolicyType) GoString() string
GoString returns the string representation
func (PasswordPolicyType) String ¶
func (s PasswordPolicyType) String() string
String returns the string representation
func (*PasswordPolicyType) Validate ¶
func (s *PasswordPolicyType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ProviderDescription ¶
type ProviderDescription struct { // The date the provider was added to the user pool. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The date the provider was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The identity provider name. ProviderName *string `min:"1" type:"string"` // The identity provider type. ProviderType IdentityProviderTypeType `type:"string" enum:"true"` // contains filtered or unexported fields }
A container for identity provider details. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ProviderDescription
func (ProviderDescription) GoString ¶
func (s ProviderDescription) GoString() string
GoString returns the string representation
func (ProviderDescription) String ¶
func (s ProviderDescription) String() string
String returns the string representation
type ProviderUserIdentifierType ¶
type ProviderUserIdentifierType struct { // The name of the provider attribute to link to, for example, NameID. ProviderAttributeName *string `type:"string"` // The value of the provider attribute to link to, for example, xxxxx_account. ProviderAttributeValue *string `type:"string"` // The name of the provider, for example, Facebook, Google, or Login with Amazon. ProviderName *string `min:"1" type:"string"` // contains filtered or unexported fields }
A container for information about an identity provider for a user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ProviderUserIdentifierType
func (ProviderUserIdentifierType) GoString ¶
func (s ProviderUserIdentifierType) GoString() string
GoString returns the string representation
func (ProviderUserIdentifierType) String ¶
func (s ProviderUserIdentifierType) String() string
String returns the string representation
func (*ProviderUserIdentifierType) Validate ¶
func (s *ProviderUserIdentifierType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResendConfirmationCodeInput ¶
type ResendConfirmationCodeInput struct { // The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The ID of the client associated with the user pool. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // 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 `min:"1" type:"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 *UserContextDataType `type:"structure"` // The user name of the user to whom you wish to resend a confirmation code. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to resend the confirmation code. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResendConfirmationCodeRequest
func (ResendConfirmationCodeInput) GoString ¶
func (s ResendConfirmationCodeInput) GoString() string
GoString returns the string representation
func (ResendConfirmationCodeInput) String ¶
func (s ResendConfirmationCodeInput) String() string
String returns the string representation
func (*ResendConfirmationCodeInput) Validate ¶
func (s *ResendConfirmationCodeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResendConfirmationCodeOutput ¶
type ResendConfirmationCodeOutput struct { // The code delivery details returned by the server in response to the request // to resend the confirmation code. CodeDeliveryDetails *CodeDeliveryDetailsType `type:"structure"` // contains filtered or unexported fields }
The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResendConfirmationCodeResponse
func (ResendConfirmationCodeOutput) GoString ¶
func (s ResendConfirmationCodeOutput) GoString() string
GoString returns the string representation
func (ResendConfirmationCodeOutput) SDKResponseMetadata ¶
func (s ResendConfirmationCodeOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ResendConfirmationCodeOutput) String ¶
func (s ResendConfirmationCodeOutput) String() string
String returns the string representation
type ResendConfirmationCodeRequest ¶
type ResendConfirmationCodeRequest struct { *aws.Request Input *ResendConfirmationCodeInput Copy func(*ResendConfirmationCodeInput) ResendConfirmationCodeRequest }
ResendConfirmationCodeRequest is a API request type for the ResendConfirmationCode API operation.
func (ResendConfirmationCodeRequest) Send ¶
func (r ResendConfirmationCodeRequest) Send() (*ResendConfirmationCodeOutput, error)
Send marshals and sends the ResendConfirmationCode API request.
type ResourceServerScopeType ¶
type ResourceServerScopeType struct { // A description of the scope. // // ScopeDescription is a required field ScopeDescription *string `min:"1" type:"string" required:"true"` // The name of the scope. // // ScopeName is a required field ScopeName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
A resource server scope. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResourceServerScopeType
func (ResourceServerScopeType) GoString ¶
func (s ResourceServerScopeType) GoString() string
GoString returns the string representation
func (ResourceServerScopeType) String ¶
func (s ResourceServerScopeType) String() string
String returns the string representation
func (*ResourceServerScopeType) Validate ¶
func (s *ResourceServerScopeType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResourceServerType ¶
type ResourceServerType struct { // The identifier for the resource server. Identifier *string `min:"1" type:"string"` // The name of the resource server. Name *string `min:"1" type:"string"` // A list of scopes that are defined for the resource server. Scopes []ResourceServerScopeType `type:"list"` // The user pool ID for the user pool that hosts the resource server. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
A container for information about a resource server for a user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ResourceServerType
func (ResourceServerType) GoString ¶
func (s ResourceServerType) GoString() string
GoString returns the string representation
func (ResourceServerType) String ¶
func (s ResourceServerType) String() string
String returns the string representation
type RespondToAuthChallengeInput ¶
type RespondToAuthChallengeInput struct { // The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The challenge name. For more information, see . // // ADMIN_NO_SRP_AUTH is not a valid value. // // ChallengeName is a required field ChallengeName ChallengeNameType `type:"string" required:"true" enum:"true"` // 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). // // * NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, // USERNAME, SECRET_HASH (if app client is configured with client secret). ChallengeResponses map[string]string `type:"map"` // The app client ID. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // The session which should be passed both ways in challenge-response calls // to the service. If InitiateAuth or RespondToAuthChallenge API call determines // that the caller needs to go through another challenge, they return a session // with other challenge parameters. This session should be passed as it is to // the next RespondToAuthChallenge API call. Session *string `min:"20" type:"string"` // 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 *UserContextDataType `type:"structure"` // contains filtered or unexported fields }
The request to respond to an authentication challenge. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RespondToAuthChallengeRequest
func (RespondToAuthChallengeInput) GoString ¶
func (s RespondToAuthChallengeInput) GoString() string
GoString returns the string representation
func (RespondToAuthChallengeInput) String ¶
func (s RespondToAuthChallengeInput) String() string
String returns the string representation
func (*RespondToAuthChallengeInput) Validate ¶
func (s *RespondToAuthChallengeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RespondToAuthChallengeOutput ¶
type RespondToAuthChallengeOutput struct { // The result returned by the server in response to the request to respond to // the authentication challenge. AuthenticationResult *AuthenticationResultType `type:"structure"` // The challenge name. For more information, see . ChallengeName ChallengeNameType `type:"string" enum:"true"` // The challenge parameters. For more information, see . ChallengeParameters map[string]string `type:"map"` // The session which should be passed both ways in challenge-response calls // to the service. If the or API call determines that the caller needs to go // through another challenge, they return a session with other challenge parameters. // This session should be passed as it is to the next RespondToAuthChallenge // API call. Session *string `min:"20" type:"string"` // contains filtered or unexported fields }
The response to respond to the authentication challenge. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RespondToAuthChallengeResponse
func (RespondToAuthChallengeOutput) GoString ¶
func (s RespondToAuthChallengeOutput) GoString() string
GoString returns the string representation
func (RespondToAuthChallengeOutput) SDKResponseMetadata ¶
func (s RespondToAuthChallengeOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RespondToAuthChallengeOutput) String ¶
func (s RespondToAuthChallengeOutput) String() string
String returns the string representation
type RespondToAuthChallengeRequest ¶
type RespondToAuthChallengeRequest struct { *aws.Request Input *RespondToAuthChallengeInput Copy func(*RespondToAuthChallengeInput) RespondToAuthChallengeRequest }
RespondToAuthChallengeRequest is a API request type for the RespondToAuthChallenge API operation.
func (RespondToAuthChallengeRequest) Send ¶
func (r RespondToAuthChallengeRequest) Send() (*RespondToAuthChallengeOutput, error)
Send marshals and sends the RespondToAuthChallenge API request.
type RiskConfigurationType ¶
type RiskConfigurationType struct { // The account takeover risk configuration object including the NotifyConfiguration // object and Actions to take in the case of an account takeover. AccountTakeoverRiskConfiguration *AccountTakeoverRiskConfigurationType `type:"structure"` // The app client ID. ClientId *string `min:"1" type:"string"` // The compromised credentials risk configuration object including the EventFilter // and the EventAction CompromisedCredentialsRiskConfiguration *CompromisedCredentialsRiskConfigurationType `type:"structure"` // The last modified date. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The configuration to override the risk decision. RiskExceptionConfiguration *RiskExceptionConfigurationType `type:"structure"` // The user pool ID. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
The risk configuration type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RiskConfigurationType
func (RiskConfigurationType) GoString ¶
func (s RiskConfigurationType) GoString() string
GoString returns the string representation
func (RiskConfigurationType) String ¶
func (s RiskConfigurationType) String() string
String returns the string representation
type RiskDecisionType ¶
type RiskDecisionType string
const ( RiskDecisionTypeNoRisk RiskDecisionType = "NoRisk" RiskDecisionTypeAccountTakeover RiskDecisionType = "AccountTakeover" RiskDecisionTypeBlock RiskDecisionType = "Block" )
Enum values for RiskDecisionType
func (RiskDecisionType) MarshalValue ¶
func (enum RiskDecisionType) MarshalValue() (string, error)
func (RiskDecisionType) MarshalValueBuf ¶
func (enum RiskDecisionType) MarshalValueBuf(b []byte) ([]byte, error)
type RiskExceptionConfigurationType ¶
type RiskExceptionConfigurationType struct { // Overrides the risk decision to always block the pre-authentication requests. // The IP range is in CIDR notation: a compact representation of an IP address // and its associated routing prefix. BlockedIPRangeList []string `type:"list"` // Risk detection is not performed on the IP addresses in the range list. The // IP range is in CIDR notation. SkippedIPRangeList []string `type:"list"` // contains filtered or unexported fields }
The type of the configuration to override the risk decision. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/RiskExceptionConfigurationType
func (RiskExceptionConfigurationType) GoString ¶
func (s RiskExceptionConfigurationType) GoString() string
GoString returns the string representation
func (RiskExceptionConfigurationType) String ¶
func (s RiskExceptionConfigurationType) String() string
String returns the string representation
type RiskLevelType ¶
type RiskLevelType string
const ( RiskLevelTypeLow RiskLevelType = "Low" RiskLevelTypeMedium RiskLevelType = "Medium" RiskLevelTypeHigh RiskLevelType = "High" )
Enum values for RiskLevelType
func (RiskLevelType) MarshalValue ¶
func (enum RiskLevelType) MarshalValue() (string, error)
func (RiskLevelType) MarshalValueBuf ¶
func (enum RiskLevelType) MarshalValueBuf(b []byte) ([]byte, error)
type SMSMfaSettingsType ¶
type SMSMfaSettingsType struct { // Specifies whether SMS text message MFA is enabled. Enabled *bool `type:"boolean"` // The preferred MFA method. PreferredMfa *bool `type:"boolean"` // contains filtered or unexported fields }
The SMS multi-factor authentication (MFA) settings type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SMSMfaSettingsType
func (SMSMfaSettingsType) GoString ¶
func (s SMSMfaSettingsType) GoString() string
GoString returns the string representation
func (SMSMfaSettingsType) String ¶
func (s SMSMfaSettingsType) String() string
String returns the string representation
type SchemaAttributeType ¶
type SchemaAttributeType struct { // The attribute data type. AttributeDataType AttributeDataType `type:"string" enum:"true"` // Specifies whether the attribute type is developer only. DeveloperOnlyAttribute *bool `type:"boolean"` // Specifies whether the value of the attribute can be changed. Mutable *bool `type:"boolean"` // A schema attribute of the name type. Name *string `min:"1" type:"string"` // Specifies the constraints for an attribute of the number type. NumberAttributeConstraints *NumberAttributeConstraintsType `type:"structure"` // Specifies whether a user pool attribute is required. If the attribute is // required and the user does not provide a value, registration or sign-in will // fail. Required *bool `type:"boolean"` // Specifies the constraints for an attribute of the string type. StringAttributeConstraints *StringAttributeConstraintsType `type:"structure"` // contains filtered or unexported fields }
Contains information about the schema attribute. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SchemaAttributeType
func (SchemaAttributeType) GoString ¶
func (s SchemaAttributeType) GoString() string
GoString returns the string representation
func (SchemaAttributeType) String ¶
func (s SchemaAttributeType) String() string
String returns the string representation
func (*SchemaAttributeType) Validate ¶
func (s *SchemaAttributeType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetRiskConfigurationInput ¶
type SetRiskConfigurationInput struct { // The account takeover risk configuration. AccountTakeoverRiskConfiguration *AccountTakeoverRiskConfigurationType `type:"structure"` // 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 `min:"1" type:"string"` // The compromised credentials risk configuration. CompromisedCredentialsRiskConfiguration *CompromisedCredentialsRiskConfigurationType `type:"structure"` // The configuration to override the risk decision. RiskExceptionConfiguration *RiskExceptionConfigurationType `type:"structure"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetRiskConfigurationRequest
func (SetRiskConfigurationInput) GoString ¶
func (s SetRiskConfigurationInput) GoString() string
GoString returns the string representation
func (SetRiskConfigurationInput) String ¶
func (s SetRiskConfigurationInput) String() string
String returns the string representation
func (*SetRiskConfigurationInput) Validate ¶
func (s *SetRiskConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetRiskConfigurationOutput ¶
type SetRiskConfigurationOutput struct { // The risk configuration. // // RiskConfiguration is a required field RiskConfiguration *RiskConfigurationType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetRiskConfigurationResponse
func (SetRiskConfigurationOutput) GoString ¶
func (s SetRiskConfigurationOutput) GoString() string
GoString returns the string representation
func (SetRiskConfigurationOutput) SDKResponseMetadata ¶
func (s SetRiskConfigurationOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SetRiskConfigurationOutput) String ¶
func (s SetRiskConfigurationOutput) String() string
String returns the string representation
type SetRiskConfigurationRequest ¶
type SetRiskConfigurationRequest struct { *aws.Request Input *SetRiskConfigurationInput Copy func(*SetRiskConfigurationInput) SetRiskConfigurationRequest }
SetRiskConfigurationRequest is a API request type for the SetRiskConfiguration API operation.
func (SetRiskConfigurationRequest) Send ¶
func (r SetRiskConfigurationRequest) Send() (*SetRiskConfigurationOutput, error)
Send marshals and sends the SetRiskConfiguration API request.
type SetUICustomizationInput ¶
type SetUICustomizationInput struct { // The CSS values in the UI customization. CSS *string `type:"string"` // The client ID for the client app. ClientId *string `min:"1" type:"string"` // The uploaded logo image for the UI customization. // // ImageFile is automatically base64 encoded/decoded by the SDK. ImageFile []byte `type:"blob"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUICustomizationRequest
func (SetUICustomizationInput) GoString ¶
func (s SetUICustomizationInput) GoString() string
GoString returns the string representation
func (SetUICustomizationInput) String ¶
func (s SetUICustomizationInput) String() string
String returns the string representation
func (*SetUICustomizationInput) Validate ¶
func (s *SetUICustomizationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetUICustomizationOutput ¶
type SetUICustomizationOutput struct { // The UI customization information. // // UICustomization is a required field UICustomization *UICustomizationType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUICustomizationResponse
func (SetUICustomizationOutput) GoString ¶
func (s SetUICustomizationOutput) GoString() string
GoString returns the string representation
func (SetUICustomizationOutput) SDKResponseMetadata ¶
func (s SetUICustomizationOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SetUICustomizationOutput) String ¶
func (s SetUICustomizationOutput) String() string
String returns the string representation
type SetUICustomizationRequest ¶
type SetUICustomizationRequest struct { *aws.Request Input *SetUICustomizationInput Copy func(*SetUICustomizationInput) SetUICustomizationRequest }
SetUICustomizationRequest is a API request type for the SetUICustomization API operation.
func (SetUICustomizationRequest) Send ¶
func (r SetUICustomizationRequest) Send() (*SetUICustomizationOutput, error)
Send marshals and sends the SetUICustomization API request.
type SetUserMFAPreferenceInput ¶
type SetUserMFAPreferenceInput struct { // The access token. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // The SMS text message multi-factor authentication (MFA) settings. SMSMfaSettings *SMSMfaSettingsType `type:"structure"` // The time-based one-time password software token MFA settings. SoftwareTokenMfaSettings *SoftwareTokenMfaSettingsType `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserMFAPreferenceRequest
func (SetUserMFAPreferenceInput) GoString ¶
func (s SetUserMFAPreferenceInput) GoString() string
GoString returns the string representation
func (SetUserMFAPreferenceInput) String ¶
func (s SetUserMFAPreferenceInput) String() string
String returns the string representation
func (*SetUserMFAPreferenceInput) Validate ¶
func (s *SetUserMFAPreferenceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetUserMFAPreferenceOutput ¶
type SetUserMFAPreferenceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserMFAPreferenceResponse
func (SetUserMFAPreferenceOutput) GoString ¶
func (s SetUserMFAPreferenceOutput) GoString() string
GoString returns the string representation
func (SetUserMFAPreferenceOutput) SDKResponseMetadata ¶
func (s SetUserMFAPreferenceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SetUserMFAPreferenceOutput) String ¶
func (s SetUserMFAPreferenceOutput) String() string
String returns the string representation
type SetUserMFAPreferenceRequest ¶
type SetUserMFAPreferenceRequest struct { *aws.Request Input *SetUserMFAPreferenceInput Copy func(*SetUserMFAPreferenceInput) SetUserMFAPreferenceRequest }
SetUserMFAPreferenceRequest is a API request type for the SetUserMFAPreference API operation.
func (SetUserMFAPreferenceRequest) Send ¶
func (r SetUserMFAPreferenceRequest) Send() (*SetUserMFAPreferenceOutput, error)
Send marshals and sends the SetUserMFAPreference API request.
type SetUserPoolMfaConfigInput ¶
type SetUserPoolMfaConfigInput struct { // The MFA configuration. MfaConfiguration UserPoolMfaType `type:"string" enum:"true"` // The SMS text message MFA configuration. SmsMfaConfiguration *SmsMfaConfigType `type:"structure"` // The software token MFA configuration. SoftwareTokenMfaConfiguration *SoftwareTokenMfaConfigType `type:"structure"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserPoolMfaConfigRequest
func (SetUserPoolMfaConfigInput) GoString ¶
func (s SetUserPoolMfaConfigInput) GoString() string
GoString returns the string representation
func (SetUserPoolMfaConfigInput) String ¶
func (s SetUserPoolMfaConfigInput) String() string
String returns the string representation
func (*SetUserPoolMfaConfigInput) Validate ¶
func (s *SetUserPoolMfaConfigInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetUserPoolMfaConfigOutput ¶
type SetUserPoolMfaConfigOutput struct { // The MFA configuration. MfaConfiguration UserPoolMfaType `type:"string" enum:"true"` // The SMS text message MFA configuration. SmsMfaConfiguration *SmsMfaConfigType `type:"structure"` // The software token MFA configuration. SoftwareTokenMfaConfiguration *SoftwareTokenMfaConfigType `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserPoolMfaConfigResponse
func (SetUserPoolMfaConfigOutput) GoString ¶
func (s SetUserPoolMfaConfigOutput) GoString() string
GoString returns the string representation
func (SetUserPoolMfaConfigOutput) SDKResponseMetadata ¶
func (s SetUserPoolMfaConfigOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SetUserPoolMfaConfigOutput) String ¶
func (s SetUserPoolMfaConfigOutput) String() string
String returns the string representation
type SetUserPoolMfaConfigRequest ¶
type SetUserPoolMfaConfigRequest struct { *aws.Request Input *SetUserPoolMfaConfigInput Copy func(*SetUserPoolMfaConfigInput) SetUserPoolMfaConfigRequest }
SetUserPoolMfaConfigRequest is a API request type for the SetUserPoolMfaConfig API operation.
func (SetUserPoolMfaConfigRequest) Send ¶
func (r SetUserPoolMfaConfigRequest) Send() (*SetUserPoolMfaConfigOutput, error)
Send marshals and sends the SetUserPoolMfaConfig API request.
type SetUserSettingsInput ¶
type SetUserSettingsInput struct { // The access token for the set user settings request. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // Specifies the options for MFA (e.g., email or phone number). // // MFAOptions is a required field MFAOptions []MFAOptionType `type:"list" required:"true"` // contains filtered or unexported fields }
Represents the request to set user settings. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserSettingsRequest
func (SetUserSettingsInput) GoString ¶
func (s SetUserSettingsInput) GoString() string
GoString returns the string representation
func (SetUserSettingsInput) String ¶
func (s SetUserSettingsInput) String() string
String returns the string representation
func (*SetUserSettingsInput) Validate ¶
func (s *SetUserSettingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetUserSettingsOutput ¶
type SetUserSettingsOutput struct {
// contains filtered or unexported fields
}
The response from the server for a set user settings request. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SetUserSettingsResponse
func (SetUserSettingsOutput) GoString ¶
func (s SetUserSettingsOutput) GoString() string
GoString returns the string representation
func (SetUserSettingsOutput) SDKResponseMetadata ¶
func (s SetUserSettingsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SetUserSettingsOutput) String ¶
func (s SetUserSettingsOutput) String() string
String returns the string representation
type SetUserSettingsRequest ¶
type SetUserSettingsRequest struct { *aws.Request Input *SetUserSettingsInput Copy func(*SetUserSettingsInput) SetUserSettingsRequest }
SetUserSettingsRequest is a API request type for the SetUserSettings API operation.
func (SetUserSettingsRequest) Send ¶
func (r SetUserSettingsRequest) Send() (*SetUserSettingsOutput, error)
Send marshals and sends the SetUserSettings API request.
type SignUpInput ¶
type SignUpInput struct { // The Amazon Pinpoint analytics metadata for collecting metrics for SignUp // calls. AnalyticsMetadata *AnalyticsMetadataType `type:"structure"` // The ID of the client associated with the user pool. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // The password of the user you wish to register. // // Password is a required field Password *string `min:"6" type:"string" required:"true"` // 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 `min:"1" type:"string"` // An array of name-value pairs representing user attributes. // // For custom attributes, you must prepend the custom: prefix to the attribute // name. UserAttributes []AttributeType `type:"list"` // 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 *UserContextDataType `type:"structure"` // The user name of the user you wish to register. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // The validation data in the request to register a user. ValidationData []AttributeType `type:"list"` // contains filtered or unexported fields }
Represents the request to register a user. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SignUpRequest
func (SignUpInput) GoString ¶
func (s SignUpInput) GoString() string
GoString returns the string representation
func (SignUpInput) String ¶
func (s SignUpInput) String() string
String returns the string representation
func (*SignUpInput) Validate ¶
func (s *SignUpInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SignUpOutput ¶
type SignUpOutput struct { // The code delivery details returned by the server response to the user registration // request. CodeDeliveryDetails *CodeDeliveryDetailsType `type:"structure"` // A response from the server indicating that a user registration has been confirmed. // // UserConfirmed is a required field UserConfirmed *bool `type:"boolean" required:"true"` // The UUID of the authenticated user. This is not the same as username. // // UserSub is a required field UserSub *string `type:"string" required:"true"` // contains filtered or unexported fields }
The response from the server for a registration request. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SignUpResponse
func (SignUpOutput) GoString ¶
func (s SignUpOutput) GoString() string
GoString returns the string representation
func (SignUpOutput) SDKResponseMetadata ¶
func (s SignUpOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SignUpOutput) String ¶
func (s SignUpOutput) String() string
String returns the string representation
type SignUpRequest ¶
type SignUpRequest struct { *aws.Request Input *SignUpInput Copy func(*SignUpInput) SignUpRequest }
SignUpRequest is a API request type for the SignUp API operation.
func (SignUpRequest) Send ¶
func (r SignUpRequest) Send() (*SignUpOutput, error)
Send marshals and sends the SignUp API request.
type SmsConfigurationType ¶
type SmsConfigurationType struct { // The external ID. ExternalId *string `type:"string"` // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service // (SNS) caller. // // SnsCallerArn is a required field SnsCallerArn *string `min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
The SMS configuration type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SmsConfigurationType
func (SmsConfigurationType) GoString ¶
func (s SmsConfigurationType) GoString() string
GoString returns the string representation
func (SmsConfigurationType) String ¶
func (s SmsConfigurationType) String() string
String returns the string representation
func (*SmsConfigurationType) Validate ¶
func (s *SmsConfigurationType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SmsMfaConfigType ¶
type SmsMfaConfigType struct { // The SMS authentication message. SmsAuthenticationMessage *string `min:"6" type:"string"` // The SMS configuration. SmsConfiguration *SmsConfigurationType `type:"structure"` // contains filtered or unexported fields }
The SMS text message multi-factor authentication (MFA) configuration type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SmsMfaConfigType
func (SmsMfaConfigType) GoString ¶
func (s SmsMfaConfigType) GoString() string
GoString returns the string representation
func (SmsMfaConfigType) String ¶
func (s SmsMfaConfigType) String() string
String returns the string representation
func (*SmsMfaConfigType) Validate ¶
func (s *SmsMfaConfigType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SoftwareTokenMfaConfigType ¶
type SoftwareTokenMfaConfigType struct { // Specifies whether software token MFA is enabled. Enabled *bool `type:"boolean"` // contains filtered or unexported fields }
The type used for enabling software token MFA at the user pool level. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SoftwareTokenMfaConfigType
func (SoftwareTokenMfaConfigType) GoString ¶
func (s SoftwareTokenMfaConfigType) GoString() string
GoString returns the string representation
func (SoftwareTokenMfaConfigType) String ¶
func (s SoftwareTokenMfaConfigType) String() string
String returns the string representation
type SoftwareTokenMfaSettingsType ¶
type SoftwareTokenMfaSettingsType struct { // Specifies whether software token MFA is enabled. Enabled *bool `type:"boolean"` // The preferred MFA method. PreferredMfa *bool `type:"boolean"` // contains filtered or unexported fields }
The type used for enabling software token MFA at the user level. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SoftwareTokenMfaSettingsType
func (SoftwareTokenMfaSettingsType) GoString ¶
func (s SoftwareTokenMfaSettingsType) GoString() string
GoString returns the string representation
func (SoftwareTokenMfaSettingsType) String ¶
func (s SoftwareTokenMfaSettingsType) String() string
String returns the string representation
type StartUserImportJobInput ¶
type StartUserImportJobInput struct { // The job ID for the user import job. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool that the users are being imported into. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to start the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StartUserImportJobRequest
func (StartUserImportJobInput) GoString ¶
func (s StartUserImportJobInput) GoString() string
GoString returns the string representation
func (StartUserImportJobInput) String ¶
func (s StartUserImportJobInput) String() string
String returns the string representation
func (*StartUserImportJobInput) Validate ¶
func (s *StartUserImportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartUserImportJobOutput ¶
type StartUserImportJobOutput struct { // The job object that represents the user import job. UserImportJob *UserImportJobType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server to the request to start the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StartUserImportJobResponse
func (StartUserImportJobOutput) GoString ¶
func (s StartUserImportJobOutput) GoString() string
GoString returns the string representation
func (StartUserImportJobOutput) SDKResponseMetadata ¶
func (s StartUserImportJobOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (StartUserImportJobOutput) String ¶
func (s StartUserImportJobOutput) String() string
String returns the string representation
type StartUserImportJobRequest ¶
type StartUserImportJobRequest struct { *aws.Request Input *StartUserImportJobInput Copy func(*StartUserImportJobInput) StartUserImportJobRequest }
StartUserImportJobRequest is a API request type for the StartUserImportJob API operation.
func (StartUserImportJobRequest) Send ¶
func (r StartUserImportJobRequest) Send() (*StartUserImportJobOutput, error)
Send marshals and sends the StartUserImportJob API request.
type StatusType ¶
type StatusType string
const ( StatusTypeEnabled StatusType = "Enabled" StatusTypeDisabled StatusType = "Disabled" )
Enum values for StatusType
func (StatusType) MarshalValue ¶
func (enum StatusType) MarshalValue() (string, error)
func (StatusType) MarshalValueBuf ¶
func (enum StatusType) MarshalValueBuf(b []byte) ([]byte, error)
type StopUserImportJobInput ¶
type StopUserImportJobInput struct { // The job ID for the user import job. // // JobId is a required field JobId *string `min:"1" type:"string" required:"true"` // The user pool ID for the user pool that the users are being imported into. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to stop the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StopUserImportJobRequest
func (StopUserImportJobInput) GoString ¶
func (s StopUserImportJobInput) GoString() string
GoString returns the string representation
func (StopUserImportJobInput) String ¶
func (s StopUserImportJobInput) String() string
String returns the string representation
func (*StopUserImportJobInput) Validate ¶
func (s *StopUserImportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopUserImportJobOutput ¶
type StopUserImportJobOutput struct { // The job object that represents the user import job. UserImportJob *UserImportJobType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server to the request to stop the user import job. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StopUserImportJobResponse
func (StopUserImportJobOutput) GoString ¶
func (s StopUserImportJobOutput) GoString() string
GoString returns the string representation
func (StopUserImportJobOutput) SDKResponseMetadata ¶
func (s StopUserImportJobOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (StopUserImportJobOutput) String ¶
func (s StopUserImportJobOutput) String() string
String returns the string representation
type StopUserImportJobRequest ¶
type StopUserImportJobRequest struct { *aws.Request Input *StopUserImportJobInput Copy func(*StopUserImportJobInput) StopUserImportJobRequest }
StopUserImportJobRequest is a API request type for the StopUserImportJob API operation.
func (StopUserImportJobRequest) Send ¶
func (r StopUserImportJobRequest) Send() (*StopUserImportJobOutput, error)
Send marshals and sends the StopUserImportJob API request.
type StringAttributeConstraintsType ¶
type StringAttributeConstraintsType struct { // The maximum length. MaxLength *string `type:"string"` // The minimum length. MinLength *string `type:"string"` // contains filtered or unexported fields }
The constraints associated with a string attribute. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/StringAttributeConstraintsType
func (StringAttributeConstraintsType) GoString ¶
func (s StringAttributeConstraintsType) GoString() string
GoString returns the string representation
func (StringAttributeConstraintsType) String ¶
func (s StringAttributeConstraintsType) String() string
String returns the string representation
type UICustomizationType ¶
type UICustomizationType struct { // The CSS values in the UI customization. CSS *string `type:"string"` // The CSS version number. CSSVersion *string `type:"string"` // The client ID for the client app. ClientId *string `min:"1" type:"string"` // The creation date for the UI customization. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The logo image for the UI customization. ImageUrl *string `type:"string"` // The last-modified date for the UI customization. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The user pool ID for the user pool. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
A container for the UI customization information for a user pool's built-in app UI. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UICustomizationType
func (UICustomizationType) GoString ¶
func (s UICustomizationType) GoString() string
GoString returns the string representation
func (UICustomizationType) String ¶
func (s UICustomizationType) String() string
String returns the string representation
type UpdateAuthEventFeedbackInput ¶
type UpdateAuthEventFeedbackInput struct { // The event ID. // // EventId is a required field EventId *string `min:"1" type:"string" required:"true"` // The feedback token. // // FeedbackToken is a required field FeedbackToken *string `type:"string" required:"true"` // The authentication event feedback value. // // FeedbackValue is a required field FeedbackValue FeedbackValueType `type:"string" required:"true" enum:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The user pool username. // // Username is a required field Username *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateAuthEventFeedbackRequest
func (UpdateAuthEventFeedbackInput) GoString ¶
func (s UpdateAuthEventFeedbackInput) GoString() string
GoString returns the string representation
func (UpdateAuthEventFeedbackInput) String ¶
func (s UpdateAuthEventFeedbackInput) String() string
String returns the string representation
func (*UpdateAuthEventFeedbackInput) Validate ¶
func (s *UpdateAuthEventFeedbackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateAuthEventFeedbackOutput ¶
type UpdateAuthEventFeedbackOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateAuthEventFeedbackResponse
func (UpdateAuthEventFeedbackOutput) GoString ¶
func (s UpdateAuthEventFeedbackOutput) GoString() string
GoString returns the string representation
func (UpdateAuthEventFeedbackOutput) SDKResponseMetadata ¶
func (s UpdateAuthEventFeedbackOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateAuthEventFeedbackOutput) String ¶
func (s UpdateAuthEventFeedbackOutput) String() string
String returns the string representation
type UpdateAuthEventFeedbackRequest ¶
type UpdateAuthEventFeedbackRequest struct { *aws.Request Input *UpdateAuthEventFeedbackInput Copy func(*UpdateAuthEventFeedbackInput) UpdateAuthEventFeedbackRequest }
UpdateAuthEventFeedbackRequest is a API request type for the UpdateAuthEventFeedback API operation.
func (UpdateAuthEventFeedbackRequest) Send ¶
func (r UpdateAuthEventFeedbackRequest) Send() (*UpdateAuthEventFeedbackOutput, error)
Send marshals and sends the UpdateAuthEventFeedback API request.
type UpdateDeviceStatusInput ¶
type UpdateDeviceStatusInput struct { // The access token. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // The device key. // // DeviceKey is a required field DeviceKey *string `min:"1" type:"string" required:"true"` // The status of whether a device is remembered. DeviceRememberedStatus DeviceRememberedStatusType `type:"string" enum:"true"` // contains filtered or unexported fields }
Represents the request to update the device status. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateDeviceStatusRequest
func (UpdateDeviceStatusInput) GoString ¶
func (s UpdateDeviceStatusInput) GoString() string
GoString returns the string representation
func (UpdateDeviceStatusInput) String ¶
func (s UpdateDeviceStatusInput) String() string
String returns the string representation
func (*UpdateDeviceStatusInput) Validate ¶
func (s *UpdateDeviceStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateDeviceStatusOutput ¶
type UpdateDeviceStatusOutput struct {
// contains filtered or unexported fields
}
The response to the request to update the device status. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateDeviceStatusResponse
func (UpdateDeviceStatusOutput) GoString ¶
func (s UpdateDeviceStatusOutput) GoString() string
GoString returns the string representation
func (UpdateDeviceStatusOutput) SDKResponseMetadata ¶
func (s UpdateDeviceStatusOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateDeviceStatusOutput) String ¶
func (s UpdateDeviceStatusOutput) String() string
String returns the string representation
type UpdateDeviceStatusRequest ¶
type UpdateDeviceStatusRequest struct { *aws.Request Input *UpdateDeviceStatusInput Copy func(*UpdateDeviceStatusInput) UpdateDeviceStatusRequest }
UpdateDeviceStatusRequest is a API request type for the UpdateDeviceStatus API operation.
func (UpdateDeviceStatusRequest) Send ¶
func (r UpdateDeviceStatusRequest) Send() (*UpdateDeviceStatusOutput, error)
Send marshals and sends the UpdateDeviceStatus API request.
type UpdateGroupInput ¶
type UpdateGroupInput struct { // A string containing the new description of the group. Description *string `type:"string"` // The name of the group. // // GroupName is a required field GroupName *string `min:"1" type:"string" required:"true"` // The new precedence value for the group. For more information about this parameter, // see . Precedence *int64 `type:"integer"` // 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 `min:"20" type:"string"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateGroupRequest
func (UpdateGroupInput) GoString ¶
func (s UpdateGroupInput) GoString() string
GoString returns the string representation
func (UpdateGroupInput) String ¶
func (s UpdateGroupInput) String() string
String returns the string representation
func (*UpdateGroupInput) Validate ¶
func (s *UpdateGroupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateGroupOutput ¶
type UpdateGroupOutput struct { // The group object for the group. Group *GroupType `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateGroupResponse
func (UpdateGroupOutput) GoString ¶
func (s UpdateGroupOutput) GoString() string
GoString returns the string representation
func (UpdateGroupOutput) SDKResponseMetadata ¶
func (s UpdateGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateGroupOutput) String ¶
func (s UpdateGroupOutput) String() string
String returns the string representation
type UpdateGroupRequest ¶
type UpdateGroupRequest struct { *aws.Request Input *UpdateGroupInput Copy func(*UpdateGroupInput) UpdateGroupRequest }
UpdateGroupRequest is a API request type for the UpdateGroup API operation.
func (UpdateGroupRequest) Send ¶
func (r UpdateGroupRequest) Send() (*UpdateGroupOutput, error)
Send marshals and sends the UpdateGroup API request.
type UpdateIdentityProviderInput ¶
type UpdateIdentityProviderInput struct { // The identity provider attribute mapping to be changed. AttributeMapping map[string]string `type:"map"` // A list of identity provider identifiers. IdpIdentifiers []string `type:"list"` // The identity provider details to be updated, such as MetadataURL and MetadataFile. ProviderDetails map[string]string `type:"map"` // The identity provider name. // // ProviderName is a required field ProviderName *string `min:"1" type:"string" required:"true"` // The user pool ID. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateIdentityProviderRequest
func (UpdateIdentityProviderInput) GoString ¶
func (s UpdateIdentityProviderInput) GoString() string
GoString returns the string representation
func (UpdateIdentityProviderInput) String ¶
func (s UpdateIdentityProviderInput) String() string
String returns the string representation
func (*UpdateIdentityProviderInput) Validate ¶
func (s *UpdateIdentityProviderInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateIdentityProviderOutput ¶
type UpdateIdentityProviderOutput struct { // The identity provider object. // // IdentityProvider is a required field IdentityProvider *IdentityProviderType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateIdentityProviderResponse
func (UpdateIdentityProviderOutput) GoString ¶
func (s UpdateIdentityProviderOutput) GoString() string
GoString returns the string representation
func (UpdateIdentityProviderOutput) SDKResponseMetadata ¶
func (s UpdateIdentityProviderOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateIdentityProviderOutput) String ¶
func (s UpdateIdentityProviderOutput) String() string
String returns the string representation
type UpdateIdentityProviderRequest ¶
type UpdateIdentityProviderRequest struct { *aws.Request Input *UpdateIdentityProviderInput Copy func(*UpdateIdentityProviderInput) UpdateIdentityProviderRequest }
UpdateIdentityProviderRequest is a API request type for the UpdateIdentityProvider API operation.
func (UpdateIdentityProviderRequest) Send ¶
func (r UpdateIdentityProviderRequest) Send() (*UpdateIdentityProviderOutput, error)
Send marshals and sends the UpdateIdentityProvider API request.
type UpdateResourceServerInput ¶
type UpdateResourceServerInput struct { // The identifier for the resource server. // // Identifier is a required field Identifier *string `min:"1" type:"string" required:"true"` // The name of the resource server. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` // The scope values to be set for the resource server. Scopes []ResourceServerScopeType `type:"list"` // The user pool ID for the user pool. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateResourceServerRequest
func (UpdateResourceServerInput) GoString ¶
func (s UpdateResourceServerInput) GoString() string
GoString returns the string representation
func (UpdateResourceServerInput) String ¶
func (s UpdateResourceServerInput) String() string
String returns the string representation
func (*UpdateResourceServerInput) Validate ¶
func (s *UpdateResourceServerInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateResourceServerOutput ¶
type UpdateResourceServerOutput struct { // The resource server. // // ResourceServer is a required field ResourceServer *ResourceServerType `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateResourceServerResponse
func (UpdateResourceServerOutput) GoString ¶
func (s UpdateResourceServerOutput) GoString() string
GoString returns the string representation
func (UpdateResourceServerOutput) SDKResponseMetadata ¶
func (s UpdateResourceServerOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateResourceServerOutput) String ¶
func (s UpdateResourceServerOutput) String() string
String returns the string representation
type UpdateResourceServerRequest ¶
type UpdateResourceServerRequest struct { *aws.Request Input *UpdateResourceServerInput Copy func(*UpdateResourceServerInput) UpdateResourceServerRequest }
UpdateResourceServerRequest is a API request type for the UpdateResourceServer API operation.
func (UpdateResourceServerRequest) Send ¶
func (r UpdateResourceServerRequest) Send() (*UpdateResourceServerOutput, error)
Send marshals and sends the UpdateResourceServer API request.
type UpdateUserAttributesInput ¶
type UpdateUserAttributesInput struct { // The access token for the request to update user attributes. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // An array of name-value pairs representing user attributes. // // For custom attributes, you must prepend the custom: prefix to the attribute // name. // // UserAttributes is a required field UserAttributes []AttributeType `type:"list" required:"true"` // contains filtered or unexported fields }
Represents the request to update user attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserAttributesRequest
func (UpdateUserAttributesInput) GoString ¶
func (s UpdateUserAttributesInput) GoString() string
GoString returns the string representation
func (UpdateUserAttributesInput) String ¶
func (s UpdateUserAttributesInput) String() string
String returns the string representation
func (*UpdateUserAttributesInput) Validate ¶
func (s *UpdateUserAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUserAttributesOutput ¶
type UpdateUserAttributesOutput struct { // The code delivery details list from the server for the request to update // user attributes. CodeDeliveryDetailsList []CodeDeliveryDetailsType `type:"list"` // contains filtered or unexported fields }
Represents the response from the server for the request to update user attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserAttributesResponse
func (UpdateUserAttributesOutput) GoString ¶
func (s UpdateUserAttributesOutput) GoString() string
GoString returns the string representation
func (UpdateUserAttributesOutput) SDKResponseMetadata ¶
func (s UpdateUserAttributesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateUserAttributesOutput) String ¶
func (s UpdateUserAttributesOutput) String() string
String returns the string representation
type UpdateUserAttributesRequest ¶
type UpdateUserAttributesRequest struct { *aws.Request Input *UpdateUserAttributesInput Copy func(*UpdateUserAttributesInput) UpdateUserAttributesRequest }
UpdateUserAttributesRequest is a API request type for the UpdateUserAttributes API operation.
func (UpdateUserAttributesRequest) Send ¶
func (r UpdateUserAttributesRequest) Send() (*UpdateUserAttributesOutput, error)
Send marshals and sends the UpdateUserAttributes API request.
type UpdateUserPoolClientInput ¶
type UpdateUserPoolClientInput struct { // 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 token to specify that the client should get the access token (and, // optionally, ID token, based on scopes) directly. AllowedOAuthFlows []OAuthFlowType `type:"list"` // Set to TRUE if the client is allowed to follow the OAuth protocol when interacting // with Cognito user pools. AllowedOAuthFlowsUserPoolClient *bool `type:"boolean"` // A list of allowed OAuth scopes. Currently supported values are "phone", "email", // "openid", and "Cognito". AllowedOAuthScopes []string `type:"list"` // The Amazon Pinpoint analytics configuration for collecting metrics for this // user pool. AnalyticsConfiguration *AnalyticsConfigurationType `type:"structure"` // 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 use HTTP without TLS (i.e. use HTTPS instead of HTTP). // // * Not include a fragment component. // // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). CallbackURLs []string `type:"list"` // The ID of the client associated with the user pool. // // ClientId is a required field ClientId *string `min:"1" type:"string" required:"true"` // The client name from the update user pool client request. ClientName *string `min:"1" type:"string"` // 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 use HTTP without TLS (i.e. use HTTPS instead of HTTP). // // * Not include a fragment component. // // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). DefaultRedirectURI *string `min:"1" type:"string"` // Explicit authentication flows. ExplicitAuthFlows []ExplicitAuthFlowsType `type:"list"` // A list of allowed logout URLs for the identity providers. LogoutURLs []string `type:"list"` // The read-only attributes of the user pool. ReadAttributes []string `type:"list"` // The time limit, in days, after which the refresh token is no longer valid // and cannot be used. RefreshTokenValidity *int64 `type:"integer"` // A list of provider names for the identity providers that are supported on // this client. SupportedIdentityProviders []string `type:"list"` // The user pool ID for the user pool where you want to update the user pool // client. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The writeable attributes of the user pool. WriteAttributes []string `type:"list"` // contains filtered or unexported fields }
Represents the request to update the user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClientRequest
func (UpdateUserPoolClientInput) GoString ¶
func (s UpdateUserPoolClientInput) GoString() string
GoString returns the string representation
func (UpdateUserPoolClientInput) String ¶
func (s UpdateUserPoolClientInput) String() string
String returns the string representation
func (*UpdateUserPoolClientInput) Validate ¶
func (s *UpdateUserPoolClientInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 *UserPoolClientType `type:"structure"` // contains filtered or unexported fields }
Represents the response from the server to the request to update the user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolClientResponse
func (UpdateUserPoolClientOutput) GoString ¶
func (s UpdateUserPoolClientOutput) GoString() string
GoString returns the string representation
func (UpdateUserPoolClientOutput) SDKResponseMetadata ¶
func (s UpdateUserPoolClientOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateUserPoolClientOutput) String ¶
func (s UpdateUserPoolClientOutput) String() string
String returns the string representation
type UpdateUserPoolClientRequest ¶
type UpdateUserPoolClientRequest struct { *aws.Request Input *UpdateUserPoolClientInput Copy func(*UpdateUserPoolClientInput) UpdateUserPoolClientRequest }
UpdateUserPoolClientRequest is a API request type for the UpdateUserPoolClient API operation.
func (UpdateUserPoolClientRequest) Send ¶
func (r UpdateUserPoolClientRequest) Send() (*UpdateUserPoolClientOutput, error)
Send marshals and sends the UpdateUserPoolClient API request.
type UpdateUserPoolInput ¶
type UpdateUserPoolInput struct { // The configuration for AdminCreateUser requests. AdminCreateUserConfig *AdminCreateUserConfigType `type:"structure"` // The attributes that are automatically verified when the Amazon Cognito service // makes a request to update user pools. AutoVerifiedAttributes []VerifiedAttributeType `type:"list"` // Device configuration. DeviceConfiguration *DeviceConfigurationType `type:"structure"` // Email configuration. EmailConfiguration *EmailConfigurationType `type:"structure"` // The contents of the email verification message. EmailVerificationMessage *string `min:"6" type:"string"` // The subject of the email verification message. EmailVerificationSubject *string `min:"1" type:"string"` // The AWS Lambda configuration information from the request to update the user // pool. LambdaConfig *LambdaConfigType `type:"structure"` // 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 UserPoolMfaType `type:"string" enum:"true"` // A container with the policies you wish to update in a user pool. Policies *UserPoolPolicyType `type:"structure"` // The contents of the SMS authentication message. SmsAuthenticationMessage *string `min:"6" type:"string"` // SMS configuration. SmsConfiguration *SmsConfigurationType `type:"structure"` // A container with information about the SMS verification message. SmsVerificationMessage *string `min:"6" type:"string"` // Used to enable advanced security risk detection. Set the key AdvancedSecurityMode // to the value "AUDIT". UserPoolAddOns *UserPoolAddOnsType `type:"structure"` // The user pool ID for the user pool you want to update. // // UserPoolId is a required field UserPoolId *string `min:"1" type:"string" required:"true"` // The cost allocation tags for the user pool. For more information, see Adding // Cost Allocation Tags to Your User Pool (http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-cost-allocation-tagging.html) UserPoolTags map[string]string `type:"map"` // The template for verification messages. VerificationMessageTemplate *VerificationMessageTemplateType `type:"structure"` // contains filtered or unexported fields }
Represents the request to update the user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolRequest
func (UpdateUserPoolInput) GoString ¶
func (s UpdateUserPoolInput) GoString() string
GoString returns the string representation
func (UpdateUserPoolInput) String ¶
func (s UpdateUserPoolInput) String() string
String returns the string representation
func (*UpdateUserPoolInput) Validate ¶
func (s *UpdateUserPoolInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateUserPoolOutput ¶
type UpdateUserPoolOutput struct {
// contains filtered or unexported fields
}
Represents the response from the server when you make a request to update the user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UpdateUserPoolResponse
func (UpdateUserPoolOutput) GoString ¶
func (s UpdateUserPoolOutput) GoString() string
GoString returns the string representation
func (UpdateUserPoolOutput) SDKResponseMetadata ¶
func (s UpdateUserPoolOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateUserPoolOutput) String ¶
func (s UpdateUserPoolOutput) String() string
String returns the string representation
type UpdateUserPoolRequest ¶
type UpdateUserPoolRequest struct { *aws.Request Input *UpdateUserPoolInput Copy func(*UpdateUserPoolInput) UpdateUserPoolRequest }
UpdateUserPoolRequest is a API request type for the UpdateUserPool API operation.
func (UpdateUserPoolRequest) Send ¶
func (r UpdateUserPoolRequest) Send() (*UpdateUserPoolOutput, error)
Send marshals and sends the UpdateUserPool API request.
type UserContextDataType ¶
type UserContextDataType 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. EncodedData *string `type:"string"` // contains filtered or unexported fields }
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserContextDataType
func (UserContextDataType) GoString ¶
func (s UserContextDataType) GoString() string
GoString returns the string representation
func (UserContextDataType) String ¶
func (s UserContextDataType) String() string
String returns the string representation
type UserImportJobStatusType ¶
type UserImportJobStatusType string
const ( UserImportJobStatusTypeCreated UserImportJobStatusType = "Created" UserImportJobStatusTypePending UserImportJobStatusType = "Pending" UserImportJobStatusTypeInProgress UserImportJobStatusType = "InProgress" UserImportJobStatusTypeStopping UserImportJobStatusType = "Stopping" UserImportJobStatusTypeExpired UserImportJobStatusType = "Expired" UserImportJobStatusTypeStopped UserImportJobStatusType = "Stopped" UserImportJobStatusTypeFailed UserImportJobStatusType = "Failed" UserImportJobStatusTypeSucceeded UserImportJobStatusType = "Succeeded" )
Enum values for UserImportJobStatusType
func (UserImportJobStatusType) MarshalValue ¶
func (enum UserImportJobStatusType) MarshalValue() (string, error)
func (UserImportJobStatusType) MarshalValueBuf ¶
func (enum UserImportJobStatusType) MarshalValueBuf(b []byte) ([]byte, error)
type UserImportJobType ¶
type UserImportJobType struct { // The role ARN for the Amazon CloudWatch Logging role for the user import job. // For more information, see "Creating the CloudWatch Logs IAM Role" in the // Amazon Cognito Developer Guide. CloudWatchLogsRoleArn *string `min:"20" type:"string"` // The date when the user import job was completed. CompletionDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The message returned when the user import job is completed. CompletionMessage *string `min:"1" type:"string"` // The date the user import job was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The number of users that could not be imported. FailedUsers *int64 `type:"long"` // The number of users that were successfully imported. ImportedUsers *int64 `type:"long"` // The job ID for the user import job. JobId *string `min:"1" type:"string"` // The job name for the user import job. JobName *string `min:"1" type:"string"` // The pre-signed URL to be used to upload the .csv file. PreSignedUrl *string `type:"string"` // The number of users that were skipped. SkippedUsers *int64 `type:"long"` // The date when the user import job was started. StartDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The status of the user import job. One of the following: // // * Created - The job was created but not started. // // * Pending - A transition state. You have started the job, but it has not // begun importing users yet. // // * InProgress - The job has started, and users are being imported. // // * Stopping - You have stopped the job, but the job has not stopped importing // users yet. // // * Stopped - You have stopped the job, and the job has stopped importing // users. // // * Succeeded - The job has completed successfully. // // * Failed - The job has stopped due to an error. // // * Expired - You created a job, but did not start the job within 24-48 // hours. All data associated with the job was deleted, and the job cannot // be started. Status UserImportJobStatusType `type:"string" enum:"true"` // The user pool ID for the user pool that the users are being imported into. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
The user import job type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserImportJobType
func (UserImportJobType) GoString ¶
func (s UserImportJobType) GoString() string
GoString returns the string representation
func (UserImportJobType) String ¶
func (s UserImportJobType) String() string
String returns the string representation
type UserPoolAddOnsType ¶
type UserPoolAddOnsType struct { // The advanced security mode. // // AdvancedSecurityMode is a required field AdvancedSecurityMode AdvancedSecurityModeType `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
The user pool add-ons type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolAddOnsType
func (UserPoolAddOnsType) GoString ¶
func (s UserPoolAddOnsType) GoString() string
GoString returns the string representation
func (UserPoolAddOnsType) String ¶
func (s UserPoolAddOnsType) String() string
String returns the string representation
func (*UserPoolAddOnsType) Validate ¶
func (s *UserPoolAddOnsType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UserPoolClientDescription ¶
type UserPoolClientDescription struct { // The ID of the client associated with the user pool. ClientId *string `min:"1" type:"string"` // The client name from the user pool client description. ClientName *string `min:"1" type:"string"` // The user pool ID for the user pool where you want to describe the user pool // client. UserPoolId *string `min:"1" type:"string"` // contains filtered or unexported fields }
The description of the user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolClientDescription
func (UserPoolClientDescription) GoString ¶
func (s UserPoolClientDescription) GoString() string
GoString returns the string representation
func (UserPoolClientDescription) String ¶
func (s UserPoolClientDescription) String() string
String returns the string representation
type UserPoolClientType ¶
type UserPoolClientType struct { // 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 token to specify that the client should get the access token (and, // optionally, ID token, based on scopes) directly. AllowedOAuthFlows []OAuthFlowType `type:"list"` // Set to TRUE if the client is allowed to follow the OAuth protocol when interacting // with Cognito user pools. AllowedOAuthFlowsUserPoolClient *bool `type:"boolean"` // A list of allowed OAuth scopes. Currently supported values are "phone", "email", // "openid", and "Cognito". AllowedOAuthScopes []string `type:"list"` // The Amazon Pinpoint analytics configuration for the user pool client. AnalyticsConfiguration *AnalyticsConfigurationType `type:"structure"` // 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 use HTTP without TLS (i.e. use HTTPS instead of HTTP). // // * Not include a fragment component. // // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). CallbackURLs []string `type:"list"` // The ID of the client associated with the user pool. ClientId *string `min:"1" type:"string"` // The client name from the user pool request of the client type. ClientName *string `min:"1" type:"string"` // The client secret from the user pool request of the client type. ClientSecret *string `min:"1" type:"string"` // The date the user pool client was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // 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 use HTTP without TLS (i.e. use HTTPS instead of HTTP). // // * Not include a fragment component. // // See OAuth 2.0 - Redirection Endpoint (https://tools.ietf.org/html/rfc6749#section-3.1.2). DefaultRedirectURI *string `min:"1" type:"string"` // The explicit authentication flows. ExplicitAuthFlows []ExplicitAuthFlowsType `type:"list"` // The date the user pool client was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // A list of allowed logout URLs for the identity providers. LogoutURLs []string `type:"list"` // The Read-only attributes. ReadAttributes []string `type:"list"` // The time limit, in days, after which the refresh token is no longer valid // and cannot be used. RefreshTokenValidity *int64 `type:"integer"` // A list of provider names for the identity providers that are supported on // this client. SupportedIdentityProviders []string `type:"list"` // The user pool ID for the user pool client. UserPoolId *string `min:"1" type:"string"` // The writeable attributes. WriteAttributes []string `type:"list"` // contains filtered or unexported fields }
Contains information about a user pool client. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolClientType
func (UserPoolClientType) GoString ¶
func (s UserPoolClientType) GoString() string
GoString returns the string representation
func (UserPoolClientType) String ¶
func (s UserPoolClientType) String() string
String returns the string representation
type UserPoolDescriptionType ¶
type UserPoolDescriptionType struct { // The date the user pool description was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The ID in a user pool description. Id *string `min:"1" type:"string"` // The AWS Lambda configuration information in a user pool description. LambdaConfig *LambdaConfigType `type:"structure"` // The date the user pool description was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The name in a user pool description. Name *string `min:"1" type:"string"` // The user pool status in a user pool description. Status StatusType `type:"string" enum:"true"` // contains filtered or unexported fields }
A user pool description. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolDescriptionType
func (UserPoolDescriptionType) GoString ¶
func (s UserPoolDescriptionType) GoString() string
GoString returns the string representation
func (UserPoolDescriptionType) String ¶
func (s UserPoolDescriptionType) String() string
String returns the string representation
type UserPoolMfaType ¶
type UserPoolMfaType string
const ( UserPoolMfaTypeOff UserPoolMfaType = "OFF" UserPoolMfaTypeOn UserPoolMfaType = "ON" UserPoolMfaTypeOptional UserPoolMfaType = "OPTIONAL" )
Enum values for UserPoolMfaType
func (UserPoolMfaType) MarshalValue ¶
func (enum UserPoolMfaType) MarshalValue() (string, error)
func (UserPoolMfaType) MarshalValueBuf ¶
func (enum UserPoolMfaType) MarshalValueBuf(b []byte) ([]byte, error)
type UserPoolPolicyType ¶
type UserPoolPolicyType struct { // The password policy. PasswordPolicy *PasswordPolicyType `type:"structure"` // contains filtered or unexported fields }
The policy associated with a user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolPolicyType
func (UserPoolPolicyType) GoString ¶
func (s UserPoolPolicyType) GoString() string
GoString returns the string representation
func (UserPoolPolicyType) String ¶
func (s UserPoolPolicyType) String() string
String returns the string representation
func (*UserPoolPolicyType) Validate ¶
func (s *UserPoolPolicyType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UserPoolType ¶
type UserPoolType struct { // The configuration for AdminCreateUser requests. AdminCreateUserConfig *AdminCreateUserConfigType `type:"structure"` // Specifies the attributes that are aliased in a user pool. AliasAttributes []AliasAttributeType `type:"list"` // The Amazon Resource Name (ARN) for the user pool. Arn *string `min:"20" type:"string"` // Specifies the attributes that are auto-verified in a user pool. AutoVerifiedAttributes []VerifiedAttributeType `type:"list"` // The date the user pool was created. CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The device configuration. DeviceConfiguration *DeviceConfigurationType `type:"structure"` // Holds the domain prefix if the user pool has a domain associated with it. Domain *string `min:"1" type:"string"` // The email configuration. EmailConfiguration *EmailConfigurationType `type:"structure"` // The reason why the email configuration cannot send the messages to your users. EmailConfigurationFailure *string `type:"string"` // The contents of the email verification message. EmailVerificationMessage *string `min:"6" type:"string"` // The subject of the email verification message. EmailVerificationSubject *string `min:"1" type:"string"` // A number estimating the size of the user pool. EstimatedNumberOfUsers *int64 `type:"integer"` // The ID of the user pool. Id *string `min:"1" type:"string"` // The AWS Lambda triggers associated with the user pool. LambdaConfig *LambdaConfigType `type:"structure"` // The date the user pool was last modified. LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // 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 UserPoolMfaType `type:"string" enum:"true"` // The name of the user pool. Name *string `min:"1" type:"string"` // The policies associated with the user pool. Policies *UserPoolPolicyType `type:"structure"` // A container with the schema attributes of a user pool. SchemaAttributes []SchemaAttributeType `min:"1" type:"list"` // The contents of the SMS authentication message. SmsAuthenticationMessage *string `min:"6" type:"string"` // The SMS configuration. SmsConfiguration *SmsConfigurationType `type:"structure"` // The reason why the SMS configuration cannot send the messages to your users. SmsConfigurationFailure *string `type:"string"` // The contents of the SMS verification message. SmsVerificationMessage *string `min:"6" type:"string"` // The status of a user pool. Status StatusType `type:"string" enum:"true"` // The user pool add-ons. UserPoolAddOns *UserPoolAddOnsType `type:"structure"` // The cost allocation tags for the user pool. For more information, see Adding // Cost Allocation Tags to Your User Pool (http://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-cost-allocation-tagging.html) UserPoolTags map[string]string `type:"map"` // Specifies whether email addresses or phone numbers can be specified as usernames // when a user signs up. UsernameAttributes []UsernameAttributeType `type:"list"` // The template for verification messages. VerificationMessageTemplate *VerificationMessageTemplateType `type:"structure"` // contains filtered or unexported fields }
A container for information about the user pool. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserPoolType
func (UserPoolType) GoString ¶
func (s UserPoolType) GoString() string
GoString returns the string representation
func (UserPoolType) String ¶
func (s UserPoolType) String() string
String returns the string representation
type UserStatusType ¶
type UserStatusType string
const ( UserStatusTypeUnconfirmed UserStatusType = "UNCONFIRMED" UserStatusTypeConfirmed UserStatusType = "CONFIRMED" UserStatusTypeArchived UserStatusType = "ARCHIVED" UserStatusTypeCompromised UserStatusType = "COMPROMISED" UserStatusTypeUnknown UserStatusType = "UNKNOWN" UserStatusTypeResetRequired UserStatusType = "RESET_REQUIRED" UserStatusTypeForceChangePassword UserStatusType = "FORCE_CHANGE_PASSWORD" )
Enum values for UserStatusType
func (UserStatusType) MarshalValue ¶
func (enum UserStatusType) MarshalValue() (string, error)
func (UserStatusType) MarshalValueBuf ¶
func (enum UserStatusType) MarshalValueBuf(b []byte) ([]byte, error)
type UserType ¶
type UserType struct { // A container with information about the user type attributes. Attributes []AttributeType `type:"list"` // Specifies whether the user is enabled. Enabled *bool `type:"boolean"` // The MFA options for the user. MFAOptions []MFAOptionType `type:"list"` // The creation date of the user. UserCreateDate *time.Time `type:"timestamp" timestampFormat:"unix"` // The last modified date of the user. UserLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"` // 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. UserStatus UserStatusType `type:"string" enum:"true"` // The user name of the user you wish to describe. Username *string `min:"1" type:"string"` // contains filtered or unexported fields }
The user type. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserType
type UsernameAttributeType ¶
type UsernameAttributeType string
const ( UsernameAttributeTypePhoneNumber UsernameAttributeType = "phone_number" UsernameAttributeTypeEmail UsernameAttributeType = "email" )
Enum values for UsernameAttributeType
func (UsernameAttributeType) MarshalValue ¶
func (enum UsernameAttributeType) MarshalValue() (string, error)
func (UsernameAttributeType) MarshalValueBuf ¶
func (enum UsernameAttributeType) MarshalValueBuf(b []byte) ([]byte, error)
type VerificationMessageTemplateType ¶
type VerificationMessageTemplateType struct { // The default email option. DefaultEmailOption DefaultEmailOptionType `type:"string" enum:"true"` // The email message template. EmailMessage *string `min:"6" type:"string"` // The email message template for sending a confirmation link to the user. EmailMessageByLink *string `min:"6" type:"string"` // The subject line for the email message template. EmailSubject *string `min:"1" type:"string"` // The subject line for the email message template for sending a confirmation // link to the user. EmailSubjectByLink *string `min:"1" type:"string"` // The SMS message template. SmsMessage *string `min:"6" type:"string"` // contains filtered or unexported fields }
The template for verification messages. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerificationMessageTemplateType
func (VerificationMessageTemplateType) GoString ¶
func (s VerificationMessageTemplateType) GoString() string
GoString returns the string representation
func (VerificationMessageTemplateType) String ¶
func (s VerificationMessageTemplateType) String() string
String returns the string representation
func (*VerificationMessageTemplateType) Validate ¶
func (s *VerificationMessageTemplateType) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type VerifiedAttributeType ¶
type VerifiedAttributeType string
const ( VerifiedAttributeTypePhoneNumber VerifiedAttributeType = "phone_number" VerifiedAttributeTypeEmail VerifiedAttributeType = "email" )
Enum values for VerifiedAttributeType
func (VerifiedAttributeType) MarshalValue ¶
func (enum VerifiedAttributeType) MarshalValue() (string, error)
func (VerifiedAttributeType) MarshalValueBuf ¶
func (enum VerifiedAttributeType) MarshalValueBuf(b []byte) ([]byte, error)
type VerifySoftwareTokenInput ¶
type VerifySoftwareTokenInput struct { // The access token. AccessToken *string `type:"string"` // The friendly device name. FriendlyDeviceName *string `type:"string"` // The session which should be passed both ways in challenge-response calls // to the service. Session *string `min:"20" type:"string"` // The one time password computed using the secret code returned by // // UserCode is a required field UserCode *string `min:"6" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifySoftwareTokenRequest
func (VerifySoftwareTokenInput) GoString ¶
func (s VerifySoftwareTokenInput) GoString() string
GoString returns the string representation
func (VerifySoftwareTokenInput) String ¶
func (s VerifySoftwareTokenInput) String() string
String returns the string representation
func (*VerifySoftwareTokenInput) Validate ¶
func (s *VerifySoftwareTokenInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type VerifySoftwareTokenOutput ¶
type VerifySoftwareTokenOutput struct { // The session which should be passed both ways in challenge-response calls // to the service. Session *string `min:"20" type:"string"` // The status of the verify software token. Status VerifySoftwareTokenResponseType `type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifySoftwareTokenResponse
func (VerifySoftwareTokenOutput) GoString ¶
func (s VerifySoftwareTokenOutput) GoString() string
GoString returns the string representation
func (VerifySoftwareTokenOutput) SDKResponseMetadata ¶
func (s VerifySoftwareTokenOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (VerifySoftwareTokenOutput) String ¶
func (s VerifySoftwareTokenOutput) String() string
String returns the string representation
type VerifySoftwareTokenRequest ¶
type VerifySoftwareTokenRequest struct { *aws.Request Input *VerifySoftwareTokenInput Copy func(*VerifySoftwareTokenInput) VerifySoftwareTokenRequest }
VerifySoftwareTokenRequest is a API request type for the VerifySoftwareToken API operation.
func (VerifySoftwareTokenRequest) Send ¶
func (r VerifySoftwareTokenRequest) Send() (*VerifySoftwareTokenOutput, error)
Send marshals and sends the VerifySoftwareToken API request.
type VerifySoftwareTokenResponseType ¶
type VerifySoftwareTokenResponseType string
const ( VerifySoftwareTokenResponseTypeSuccess VerifySoftwareTokenResponseType = "SUCCESS" VerifySoftwareTokenResponseTypeError VerifySoftwareTokenResponseType = "ERROR" )
Enum values for VerifySoftwareTokenResponseType
func (VerifySoftwareTokenResponseType) MarshalValue ¶
func (enum VerifySoftwareTokenResponseType) MarshalValue() (string, error)
func (VerifySoftwareTokenResponseType) MarshalValueBuf ¶
func (enum VerifySoftwareTokenResponseType) MarshalValueBuf(b []byte) ([]byte, error)
type VerifyUserAttributeInput ¶
type VerifyUserAttributeInput struct { // Represents the access token of the request to verify user attributes. // // AccessToken is a required field AccessToken *string `type:"string" required:"true"` // The attribute name in the request to verify user attributes. // // AttributeName is a required field AttributeName *string `min:"1" type:"string" required:"true"` // The verification code in the request to verify user attributes. // // Code is a required field Code *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the request to verify user attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifyUserAttributeRequest
func (VerifyUserAttributeInput) GoString ¶
func (s VerifyUserAttributeInput) GoString() string
GoString returns the string representation
func (VerifyUserAttributeInput) String ¶
func (s VerifyUserAttributeInput) String() string
String returns the string representation
func (*VerifyUserAttributeInput) Validate ¶
func (s *VerifyUserAttributeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type VerifyUserAttributeOutput ¶
type VerifyUserAttributeOutput struct {
// contains filtered or unexported fields
}
A container representing the response from the server from the request to verify user attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerifyUserAttributeResponse
func (VerifyUserAttributeOutput) GoString ¶
func (s VerifyUserAttributeOutput) GoString() string
GoString returns the string representation
func (VerifyUserAttributeOutput) SDKResponseMetadata ¶
func (s VerifyUserAttributeOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (VerifyUserAttributeOutput) String ¶
func (s VerifyUserAttributeOutput) String() string
String returns the string representation
type VerifyUserAttributeRequest ¶
type VerifyUserAttributeRequest struct { *aws.Request Input *VerifyUserAttributeInput Copy func(*VerifyUserAttributeInput) VerifyUserAttributeRequest }
VerifyUserAttributeRequest is a API request type for the VerifyUserAttribute API operation.
func (VerifyUserAttributeRequest) Send ¶
func (r VerifyUserAttributeRequest) Send() (*VerifyUserAttributeOutput, error)
Send marshals and sends the VerifyUserAttribute API request.
Directories ¶
Path | Synopsis |
---|---|
Package cognitoidentityprovideriface provides an interface to enable mocking the Amazon Cognito Identity Provider service client for testing your code.
|
Package cognitoidentityprovideriface provides an interface to enable mocking the Amazon Cognito Identity Provider service client for testing your code. |