types

package
v1.23.9 Latest Latest
Warning

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

 Go to latest Published: May 23, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdditionalConstraintsElement 

type AdditionalConstraintsElement string
const (
	AdditionalConstraintsElementRequireDigit     AdditionalConstraintsElement = "REQUIRE_DIGIT"
	AdditionalConstraintsElementRequireLowercase AdditionalConstraintsElement = "REQUIRE_LOWERCASE"
	AdditionalConstraintsElementRequireSymbol    AdditionalConstraintsElement = "REQUIRE_SYMBOL"
	AdditionalConstraintsElementRequireUppercase AdditionalConstraintsElement = "REQUIRE_UPPERCASE"
)

Enum values for AdditionalConstraintsElement

func (AdditionalConstraintsElement) Values 

func (AdditionalConstraintsElement) Values() []AdditionalConstraintsElement

Values returns all known values for AdditionalConstraintsElement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuthResources 

type AuthResources string
const (
	AuthResourcesUserPoolOnly            AuthResources = "USER_POOL_ONLY"
	AuthResourcesIdentityPoolAndUserPool AuthResources = "IDENTITY_POOL_AND_USER_POOL"
)

Enum values for AuthResources

func (AuthResources) Values 

func (AuthResources) Values() []AuthResources

Values returns all known values for AuthResources. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AuthenticatedElement added in v1.8.0 

type AuthenticatedElement string
const (
	AuthenticatedElementRead            AuthenticatedElement = "READ"
	AuthenticatedElementCreateAndUpdate AuthenticatedElement = "CREATE_AND_UPDATE"
	AuthenticatedElementDelete          AuthenticatedElement = "DELETE"
)

Enum values for AuthenticatedElement

func (AuthenticatedElement) Values added in v1.8.0 

func (AuthenticatedElement) Values() []AuthenticatedElement

Values returns all known values for AuthenticatedElement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type BackendAPIAppSyncAuthSettings 

type BackendAPIAppSyncAuthSettings struct {

	// The Amazon Cognito user pool ID, if Amazon Cognito was used as an
	// authentication setting to access your data models.
	CognitoUserPoolId *string

	// The API key description for API_KEY, if it was used as an authentication
	// mechanism to access your data models.
	Description *string

	// The API key expiration time for API_KEY, if it was used as an authentication
	// mechanism to access your data models.
	ExpirationTime *float64

	// The expiry time for the OpenID authentication mechanism.
	OpenIDAuthTTL *string

	// The clientID for openID, if openID was used as an authentication setting to
	// access your data models.
	OpenIDClientId *string

	// The expiry time for the OpenID authentication mechanism.
	OpenIDIatTTL *string

	// The openID issuer URL, if openID was used as an authentication setting to
	// access your data models.
	OpenIDIssueURL *string

	// The OpenID provider name, if OpenID was used as an authentication mechanism to
	// access your data models.
	OpenIDProviderName *string
	// contains filtered or unexported fields
}

The authentication settings for accessing provisioned data models in your Amplify project.

type BackendAPIAuthType 

type BackendAPIAuthType struct {

	// Describes the authentication mode.
	Mode Mode

	// Describes settings for the authentication mode.
	Settings *BackendAPIAppSyncAuthSettings
	// contains filtered or unexported fields
}

Describes the auth types for your configured data models.

type BackendAPIConflictResolution 

type BackendAPIConflictResolution struct {

	// The strategy for conflict resolution.
	ResolutionStrategy ResolutionStrategy
	// contains filtered or unexported fields
}

Describes the conflict resolution configuration for your data model configured in your Amplify project.

type BackendAPIResourceConfig 

type BackendAPIResourceConfig struct {

	// Additional authentication methods used to interact with your data models.
	AdditionalAuthTypes []BackendAPIAuthType

	// The API name used to interact with the data model, configured as a part of your
	// Amplify project.
	ApiName *string

	// The conflict resolution strategy for your data stored in the data models.
	ConflictResolution *BackendAPIConflictResolution

	// The default authentication type for interacting with the configured data models
	// in your Amplify project.
	DefaultAuthType *BackendAPIAuthType

	// The service used to provision and interact with the data model.
	Service *string

	// The definition of the data model in the annotated transform of the GraphQL
	// schema.
	TransformSchema *string
	// contains filtered or unexported fields
}

The resource config for the data model, configured as a part of the Amplify project.

type BackendAuthAppleProviderConfig added in v1.3.0 

type BackendAuthAppleProviderConfig struct {

	// Describes the client_id (also called Services ID) that comes from Apple.
	ClientId *string

	// Describes the key_id that comes from Apple.
	KeyId *string

	// Describes the private_key that comes from Apple.
	PrivateKey *string

	// Describes the team_id that comes from Apple.
	TeamId *string
	// contains filtered or unexported fields
}

Describes Apple social federation configurations for allowing your app users to sign in using OAuth.

type BackendAuthSocialProviderConfig 

type BackendAuthSocialProviderConfig struct {

	// Describes the client_id, which can be obtained from the third-party social
	// federation provider.
	ClientId *string

	// Describes the client_secret, which can be obtained from third-party social
	// federation providers.
	ClientSecret *string
	// contains filtered or unexported fields
}

Describes third-party social federation configurations for allowing your app users to sign in using OAuth.

type BackendJobRespObj 

type BackendJobRespObj struct {

	// The app ID.
	//
	// This member is required.
	AppId *string

	// The name of the backend environment.
	//
	// This member is required.
	BackendEnvironmentName *string

	// The time when the job was created.
	CreateTime *string

	// If the request fails, this error is returned.
	Error *string

	// The ID for the job.
	JobId *string

	// The name of the operation.
	Operation *string

	// The current status of the request.
	Status *string

	// The time when the job was last updated.
	UpdateTime *string
	// contains filtered or unexported fields
}

The response object for this operation.

type BackendStoragePermissions added in v1.8.0 

type BackendStoragePermissions struct {

	// Lists all authenticated user read, write, and delete permissions for your S3
	// bucket.
	//
	// This member is required.
	Authenticated []AuthenticatedElement

	// Lists all unauthenticated user read, write, and delete permissions for your S3
	// bucket.
	UnAuthenticated []UnAuthenticatedElement
	// contains filtered or unexported fields
}

Describes the read, write, and delete permissions users have against your storage S3 bucket.

type BadRequestException 

type BadRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error returned if a request is not formed properly.

func (*BadRequestException) Error 

func (e *BadRequestException) Error() string

func (*BadRequestException) ErrorCode 

func (e *BadRequestException) ErrorCode() string

func (*BadRequestException) ErrorFault 

func (e *BadRequestException) ErrorFault() smithy.ErrorFault

func (*BadRequestException) ErrorMessage 

func (e *BadRequestException) ErrorMessage() string

type CreateBackendAuthForgotPasswordConfig 

type CreateBackendAuthForgotPasswordConfig struct {

	// (DEPRECATED) Describes which mode to use (either SMS or email) to deliver
	// messages to app users who want to recover their password.
	//
	// This member is required.
	DeliveryMethod DeliveryMethod

	// (DEPRECATED) The configuration for the email sent when an app user forgets
	// their password.
	EmailSettings *EmailSettings

	// (DEPRECATED) The configuration for the SMS message sent when an app user
	// forgets their password.
	SmsSettings *SmsSettings
	// contains filtered or unexported fields
}

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

type CreateBackendAuthIdentityPoolConfig 

type CreateBackendAuthIdentityPoolConfig struct {

	// Name of the Amazon Cognito identity pool used for authorization.
	//
	// This member is required.
	IdentityPoolName *string

	// Set to true or false based on whether you want to enable guest authorization to
	// your Amplify app.
	//
	// This member is required.
	UnauthenticatedLogin *bool
	// contains filtered or unexported fields
}

Describes authorization configurations for the auth resources, configured as a part of your Amplify project.

type CreateBackendAuthMFAConfig 

type CreateBackendAuthMFAConfig struct {

	// Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in
	// your Amplify project.
	//
	// This member is required.
	MFAMode MFAMode

	// Describes the configuration settings and methods for your Amplify app users to
	// use MFA.
	Settings *Settings
	// contains filtered or unexported fields
}

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

type CreateBackendAuthOAuthConfig 

type CreateBackendAuthOAuthConfig struct {

	// The OAuth grant type that you use to allow app users to authenticate from your
	// Amplify app.
	//
	// This member is required.
	OAuthGrantType OAuthGrantType

	// List of OAuth-related flows used to allow your app users to authenticate from
	// your Amplify app.
	//
	// This member is required.
	OAuthScopes []OAuthScopesElement

	// The redirected URI for signing in to your Amplify app.
	//
	// This member is required.
	RedirectSignInURIs []string

	// Redirect URLs that OAuth uses when a user signs out of an Amplify app.
	//
	// This member is required.
	RedirectSignOutURIs []string

	// The domain prefix for your Amplify app.
	DomainPrefix *string

	// The settings for using social providers to access your Amplify app.
	SocialProviderSettings *SocialProviderSettings
	// contains filtered or unexported fields
}

Creates the OAuth configuration for your Amplify project.

type CreateBackendAuthPasswordPolicyConfig 

type CreateBackendAuthPasswordPolicyConfig struct {

	// The minimum length of the password used to access the backend of your Amplify
	// project.
	//
	// This member is required.
	MinimumLength *float64

	// Additional constraints for the password used to access the backend of your
	// Amplify project.
	AdditionalConstraints []AdditionalConstraintsElement
	// contains filtered or unexported fields
}

The password policy configuration for the backend to your Amplify project.

type CreateBackendAuthResourceConfig 

type CreateBackendAuthResourceConfig struct {

	// Defines whether you want to configure only authentication or both
	// authentication and authorization settings.
	//
	// This member is required.
	AuthResources AuthResources

	// Defines the service name to use when configuring an authentication resource in
	// your Amplify project.
	//
	// This member is required.
	Service Service

	// Describes authentication configuration for the Amazon Cognito user pool,
	// provisioned as a part of your auth resource in the Amplify project.
	//
	// This member is required.
	UserPoolConfigs *CreateBackendAuthUserPoolConfig

	// Describes the authorization configuration for the Amazon Cognito identity pool,
	// provisioned as a part of your auth resource in the Amplify project.
	IdentityPoolConfigs *CreateBackendAuthIdentityPoolConfig
	// contains filtered or unexported fields
}

Defines the resource configuration when creating an auth resource in your Amplify project.

type CreateBackendAuthUserPoolConfig 

type CreateBackendAuthUserPoolConfig struct {

	// The required attributes to sign up new users in the user pool.
	//
	// This member is required.
	RequiredSignUpAttributes []RequiredSignUpAttributesElement

	// Describes the sign-in methods that your Amplify app users use to log in using
	// the Amazon Cognito user pool, configured as a part of your Amplify project.
	//
	// This member is required.
	SignInMethod SignInMethod

	// The Amazon Cognito user pool name.
	//
	// This member is required.
	UserPoolName *string

	// (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito
	// user pool, configured as a part of your Amplify project.
	ForgotPassword *CreateBackendAuthForgotPasswordConfig

	// Describes whether to apply multi-factor authentication policies for your Amazon
	// Cognito user pool configured as a part of your Amplify project.
	Mfa *CreateBackendAuthMFAConfig

	// Describes the OAuth policy and rules for your Amazon Cognito user pool,
	// configured as a part of your Amplify project.
	OAuth *CreateBackendAuthOAuthConfig

	// Describes the password policy for your Amazon Cognito user pool, configured as
	// a part of your Amplify project.
	PasswordPolicy *CreateBackendAuthPasswordPolicyConfig

	// Describes the email or SMS verification message for your Amazon Cognito user
	// pool, configured as a part of your Amplify project.
	VerificationMessage *CreateBackendAuthVerificationMessageConfig
	// contains filtered or unexported fields
}

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

type CreateBackendAuthVerificationMessageConfig added in v1.13.0 

type CreateBackendAuthVerificationMessageConfig struct {

	// The type of verification message to send.
	//
	// This member is required.
	DeliveryMethod DeliveryMethod

	// The settings for the email message.
	EmailSettings *EmailSettings

	// The settings for the SMS message.
	SmsSettings *SmsSettings
	// contains filtered or unexported fields
}

Creates an email or SMS verification message for the auth resource configured for your Amplify project.

type CreateBackendStorageResourceConfig added in v1.8.0 

type CreateBackendStorageResourceConfig struct {

	// The authorization configuration for the storage S3 bucket.
	//
	// This member is required.
	Permissions *BackendStoragePermissions

	// The name of the storage service.
	//
	// This member is required.
	ServiceName ServiceName

	// The name of the S3 bucket.
	BucketName *string
	// contains filtered or unexported fields
}

The resource configuration for creating backend storage.

type DeliveryMethod 

type DeliveryMethod string
const (
	DeliveryMethodEmail DeliveryMethod = "EMAIL"
	DeliveryMethodSms   DeliveryMethod = "SMS"
)

Enum values for DeliveryMethod

func (DeliveryMethod) Values 

func (DeliveryMethod) Values() []DeliveryMethod

Values returns all known values for DeliveryMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EmailSettings 

type EmailSettings struct {

	// The contents of the email message.
	EmailMessage *string

	// The contents of the subject line of the email message.
	EmailSubject *string
	// contains filtered or unexported fields
}

The configuration for the email sent when an app user forgets their password.

type GatewayTimeoutException 

type GatewayTimeoutException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An error returned if there's a temporary issue with the service.

func (*GatewayTimeoutException) Error 

func (e *GatewayTimeoutException) Error() string

func (*GatewayTimeoutException) ErrorCode 

func (e *GatewayTimeoutException) ErrorCode() string

func (*GatewayTimeoutException) ErrorFault 

func (e *GatewayTimeoutException) ErrorFault() smithy.ErrorFault

func (*GatewayTimeoutException) ErrorMessage 

func (e *GatewayTimeoutException) ErrorMessage() string

type GetBackendStorageResourceConfig added in v1.8.0 

type GetBackendStorageResourceConfig struct {

	// Returns True if the storage resource has been imported.
	//
	// This member is required.
	Imported *bool

	// The name of the storage service.
	//
	// This member is required.
	ServiceName ServiceName

	// The name of the S3 bucket.
	BucketName *string

	// The authorization configuration for the storage S3 bucket.
	Permissions *BackendStoragePermissions
	// contains filtered or unexported fields
}

The details for a backend storage resource.

type LoginAuthConfigReqObj 

type LoginAuthConfigReqObj struct {

	// The Amazon Cognito identity pool ID used for the Amplify Admin UI login
	// authorization.
	AwsCognitoIdentityPoolId *string

	// The AWS Region for the Amplify Admin UI login.
	AwsCognitoRegion *string

	// The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
	AwsUserPoolsId *string

	// The web client ID for the Amazon Cognito user pools.
	AwsUserPoolsWebClientId *string
	// contains filtered or unexported fields
}

The request object for this operation.

type MFAMode 

type MFAMode string
const (
	MFAModeOn       MFAMode = "ON"
	MFAModeOff      MFAMode = "OFF"
	MFAModeOptional MFAMode = "OPTIONAL"
)

Enum values for MFAMode

func (MFAMode) Values 

func (MFAMode) Values() []MFAMode

Values returns all known values for MFAMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MfaTypesElement 

type MfaTypesElement string
const (
	MfaTypesElementSms  MfaTypesElement = "SMS"
	MfaTypesElementTotp MfaTypesElement = "TOTP"
)

Enum values for MfaTypesElement

func (MfaTypesElement) Values 

func (MfaTypesElement) Values() []MfaTypesElement

Values returns all known values for MfaTypesElement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Mode 

type Mode string
const (
	ModeApiKey                 Mode = "API_KEY"
	ModeAwsIam                 Mode = "AWS_IAM"
	ModeAmazonCognitoUserPools Mode = "AMAZON_COGNITO_USER_POOLS"
	ModeOpenidConnect          Mode = "OPENID_CONNECT"
)

Enum values for Mode

func (Mode) Values 

func (Mode) Values() []Mode

Values returns all known values for Mode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NotFoundException 

type NotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceType *string
	// contains filtered or unexported fields
}

An error returned when a specific resource type is not found.

func (*NotFoundException) Error 

func (e *NotFoundException) Error() string

func (*NotFoundException) ErrorCode 

func (e *NotFoundException) ErrorCode() string

func (*NotFoundException) ErrorFault 

func (e *NotFoundException) ErrorFault() smithy.ErrorFault

func (*NotFoundException) ErrorMessage 

func (e *NotFoundException) ErrorMessage() string

type OAuthGrantType 

type OAuthGrantType string
const (
	OAuthGrantTypeCode     OAuthGrantType = "CODE"
	OAuthGrantTypeImplicit OAuthGrantType = "IMPLICIT"
)

Enum values for OAuthGrantType

func (OAuthGrantType) Values 

func (OAuthGrantType) Values() []OAuthGrantType

Values returns all known values for OAuthGrantType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OAuthScopesElement 

type OAuthScopesElement string
const (
	OAuthScopesElementPhone                     OAuthScopesElement = "PHONE"
	OAuthScopesElementEmail                     OAuthScopesElement = "EMAIL"
	OAuthScopesElementOpenid                    OAuthScopesElement = "OPENID"
	OAuthScopesElementProfile                   OAuthScopesElement = "PROFILE"
	OAuthScopesElementAwsCognitoSigninUserAdmin OAuthScopesElement = "AWS_COGNITO_SIGNIN_USER_ADMIN"
)

Enum values for OAuthScopesElement

func (OAuthScopesElement) Values 

func (OAuthScopesElement) Values() []OAuthScopesElement

Values returns all known values for OAuthScopesElement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RequiredSignUpAttributesElement 

type RequiredSignUpAttributesElement string
const (
	RequiredSignUpAttributesElementAddress           RequiredSignUpAttributesElement = "ADDRESS"
	RequiredSignUpAttributesElementBirthdate         RequiredSignUpAttributesElement = "BIRTHDATE"
	RequiredSignUpAttributesElementEmail             RequiredSignUpAttributesElement = "EMAIL"
	RequiredSignUpAttributesElementFamilyName        RequiredSignUpAttributesElement = "FAMILY_NAME"
	RequiredSignUpAttributesElementGender            RequiredSignUpAttributesElement = "GENDER"
	RequiredSignUpAttributesElementGivenName         RequiredSignUpAttributesElement = "GIVEN_NAME"
	RequiredSignUpAttributesElementLocale            RequiredSignUpAttributesElement = "LOCALE"
	RequiredSignUpAttributesElementMiddleName        RequiredSignUpAttributesElement = "MIDDLE_NAME"
	RequiredSignUpAttributesElementName              RequiredSignUpAttributesElement = "NAME"
	RequiredSignUpAttributesElementNickname          RequiredSignUpAttributesElement = "NICKNAME"
	RequiredSignUpAttributesElementPhoneNumber       RequiredSignUpAttributesElement = "PHONE_NUMBER"
	RequiredSignUpAttributesElementPicture           RequiredSignUpAttributesElement = "PICTURE"
	RequiredSignUpAttributesElementPreferredUsername RequiredSignUpAttributesElement = "PREFERRED_USERNAME"
	RequiredSignUpAttributesElementProfile           RequiredSignUpAttributesElement = "PROFILE"
	RequiredSignUpAttributesElementUpdatedAt         RequiredSignUpAttributesElement = "UPDATED_AT"
	RequiredSignUpAttributesElementWebsite           RequiredSignUpAttributesElement = "WEBSITE"
	RequiredSignUpAttributesElementZoneInfo          RequiredSignUpAttributesElement = "ZONE_INFO"
)

Enum values for RequiredSignUpAttributesElement

func (RequiredSignUpAttributesElement) Values 

func (RequiredSignUpAttributesElement) Values() []RequiredSignUpAttributesElement

Values returns all known values for RequiredSignUpAttributesElement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResolutionStrategy 

type ResolutionStrategy string
const (
	ResolutionStrategyOptimisticConcurrency ResolutionStrategy = "OPTIMISTIC_CONCURRENCY"
	ResolutionStrategyLambda                ResolutionStrategy = "LAMBDA"
	ResolutionStrategyAutomerge             ResolutionStrategy = "AUTOMERGE"
	ResolutionStrategyNone                  ResolutionStrategy = "NONE"
)

Enum values for ResolutionStrategy

func (ResolutionStrategy) Values 

func (ResolutionStrategy) Values() []ResolutionStrategy

Values returns all known values for ResolutionStrategy. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceConfig 

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

Defines the resource configuration for the data model in your Amplify project.

type S3BucketInfo added in v1.8.0 

type S3BucketInfo struct {

	// The creation date of the S3 bucket.
	CreationDate *string

	// The name of the S3 bucket.
	Name *string
	// contains filtered or unexported fields
}

Describes the metadata of the S3 bucket.

type Service 

type Service string
const (
	ServiceCognito Service = "COGNITO"
)

Enum values for Service

func (Service) Values 

func (Service) Values() []Service

Values returns all known values for Service. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceName added in v1.8.0 

type ServiceName string
const (
	ServiceNameS3 ServiceName = "S3"
)

Enum values for ServiceName

func (ServiceName) Values added in v1.8.0 

func (ServiceName) Values() []ServiceName

Values returns all known values for ServiceName. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Settings 

type Settings struct {

	// The supported MFA types.
	MfaTypes []MfaTypesElement

	// The body of the SMS message.
	SmsMessage *string
	// contains filtered or unexported fields
}

The settings of your MFA configuration for the backend of your Amplify project.

type SignInMethod 

type SignInMethod string
const (
	SignInMethodEmail               SignInMethod = "EMAIL"
	SignInMethodEmailAndPhoneNumber SignInMethod = "EMAIL_AND_PHONE_NUMBER"
	SignInMethodPhoneNumber         SignInMethod = "PHONE_NUMBER"
	SignInMethodUsername            SignInMethod = "USERNAME"
)

Enum values for SignInMethod

func (SignInMethod) Values 

func (SignInMethod) Values() []SignInMethod

Values returns all known values for SignInMethod. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SmsSettings 

type SmsSettings struct {

	// The contents of the SMS message.
	SmsMessage *string
	// contains filtered or unexported fields
}

SMS settings for authentication.

type SocialProviderSettings 

type SocialProviderSettings struct {

	// Describes third-party social federation configurations for allowing your app
	// users to sign in using OAuth.
	Facebook *BackendAuthSocialProviderConfig

	// Describes third-party social federation configurations for allowing your app
	// users to sign in using OAuth.
	Google *BackendAuthSocialProviderConfig

	// Describes third-party social federation configurations for allowing your app
	// users to sign in using OAuth.
	LoginWithAmazon *BackendAuthSocialProviderConfig

	// Describes Apple social federation configurations for allowing your app users to
	// sign in using OAuth.
	SignInWithApple *BackendAuthAppleProviderConfig
	// contains filtered or unexported fields
}

The settings for using the social identity providers for access to your Amplify app.

type Status 

type Status string
const (
	StatusLatest Status = "LATEST"
	StatusStale  Status = "STALE"
)

Enum values for Status

func (Status) Values 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TooManyRequestsException 

type TooManyRequestsException struct {
	Message *string

	ErrorCodeOverride *string

	LimitType *string
	// contains filtered or unexported fields
}

An error that is returned when a limit of a specific type has been exceeded.

func (*TooManyRequestsException) Error 

func (e *TooManyRequestsException) Error() string

func (*TooManyRequestsException) ErrorCode 

func (e *TooManyRequestsException) ErrorCode() string

func (*TooManyRequestsException) ErrorFault 

func (e *TooManyRequestsException) ErrorFault() smithy.ErrorFault

func (*TooManyRequestsException) ErrorMessage 

func (e *TooManyRequestsException) ErrorMessage() string

type UnAuthenticatedElement added in v1.8.0 

type UnAuthenticatedElement string
const (
	UnAuthenticatedElementRead            UnAuthenticatedElement = "READ"
	UnAuthenticatedElementCreateAndUpdate UnAuthenticatedElement = "CREATE_AND_UPDATE"
	UnAuthenticatedElementDelete          UnAuthenticatedElement = "DELETE"
)

Enum values for UnAuthenticatedElement

func (UnAuthenticatedElement) Values added in v1.8.0 

func (UnAuthenticatedElement) Values() []UnAuthenticatedElement

Values returns all known values for UnAuthenticatedElement. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UpdateBackendAuthForgotPasswordConfig 

type UpdateBackendAuthForgotPasswordConfig struct {

	// (DEPRECATED) Describes which mode to use (either SMS or email) to deliver
	// messages to app users that want to recover their password.
	DeliveryMethod DeliveryMethod

	// (DEPRECATED) The configuration for the email sent when an app user forgets
	// their password.
	EmailSettings *EmailSettings

	// (DEPRECATED) The configuration for the SMS message sent when an Amplify app
	// user forgets their password.
	SmsSettings *SmsSettings
	// contains filtered or unexported fields
}

(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.

type UpdateBackendAuthIdentityPoolConfig 

type UpdateBackendAuthIdentityPoolConfig struct {

	// A boolean value that can be set to allow or disallow guest-level authorization
	// into your Amplify app.
	UnauthenticatedLogin *bool
	// contains filtered or unexported fields
}

Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.

type UpdateBackendAuthMFAConfig 

type UpdateBackendAuthMFAConfig struct {

	// The MFA mode for the backend of your Amplify project.
	MFAMode MFAMode

	// The settings of your MFA configuration for the backend of your Amplify project.
	Settings *Settings
	// contains filtered or unexported fields
}

Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.

type UpdateBackendAuthOAuthConfig 

type UpdateBackendAuthOAuthConfig struct {

	// The Amazon Cognito domain prefix used to create a hosted UI for authentication.
	DomainPrefix *string

	// The OAuth grant type to allow app users to authenticate from your Amplify app.
	OAuthGrantType OAuthGrantType

	// The list of OAuth-related flows that can allow users to authenticate from your
	// Amplify app.
	OAuthScopes []OAuthScopesElement

	// Redirect URLs that OAuth uses when a user signs in to an Amplify app.
	RedirectSignInURIs []string

	// Redirect URLs that OAuth uses when a user signs out of an Amplify app.
	RedirectSignOutURIs []string

	// Describes third-party social federation configurations for allowing your users
	// to sign in with OAuth.
	SocialProviderSettings *SocialProviderSettings
	// contains filtered or unexported fields
}

The OAuth configurations for authenticating users into your Amplify app.

type UpdateBackendAuthPasswordPolicyConfig 

type UpdateBackendAuthPasswordPolicyConfig struct {

	// Describes additional constraints on password requirements to sign in to the
	// auth resource, configured as a part of your Amplify project.
	AdditionalConstraints []AdditionalConstraintsElement

	// Describes the minimum length of the password required to sign in to the auth
	// resource, configured as a part of your Amplify project.
	MinimumLength *float64
	// contains filtered or unexported fields
}

Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.

type UpdateBackendAuthResourceConfig 

type UpdateBackendAuthResourceConfig struct {

	// Defines the service name to use when configuring an authentication resource in
	// your Amplify project.
	//
	// This member is required.
	AuthResources AuthResources

	// Defines the service name to use when configuring an authentication resource in
	// your Amplify project.
	//
	// This member is required.
	Service Service

	// Describes the authentication configuration for the Amazon Cognito user pool,
	// provisioned as a part of your auth resource in the Amplify project.
	//
	// This member is required.
	UserPoolConfigs *UpdateBackendAuthUserPoolConfig

	// Describes the authorization configuration for the Amazon Cognito identity pool,
	// provisioned as a part of your auth resource in the Amplify project.
	IdentityPoolConfigs *UpdateBackendAuthIdentityPoolConfig
	// contains filtered or unexported fields
}

Defines the resource configuration when updating an authentication resource in your Amplify project.

type UpdateBackendAuthUserPoolConfig 

type UpdateBackendAuthUserPoolConfig struct {

	// (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user
	// pool, configured as a part of your Amplify project.
	ForgotPassword *UpdateBackendAuthForgotPasswordConfig

	// Describes whether to apply multi-factor authentication policies for your Amazon
	// Cognito user pool configured as a part of your Amplify project.
	Mfa *UpdateBackendAuthMFAConfig

	// Describes the OAuth policy and rules for your Amazon Cognito user pool,
	// configured as a part of your Amplify project.
	OAuth *UpdateBackendAuthOAuthConfig

	// Describes the password policy for your Amazon Cognito user pool, configured as
	// a part of your Amplify project.
	PasswordPolicy *UpdateBackendAuthPasswordPolicyConfig

	// Describes the email or SMS verification message for your Amazon Cognito user
	// pool, configured as a part of your Amplify project.
	VerificationMessage *UpdateBackendAuthVerificationMessageConfig
	// contains filtered or unexported fields
}

Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.

type UpdateBackendAuthVerificationMessageConfig added in v1.13.0 

type UpdateBackendAuthVerificationMessageConfig struct {

	// The type of verification message to send.
	//
	// This member is required.
	DeliveryMethod DeliveryMethod

	// The settings for the email message.
	EmailSettings *EmailSettings

	// The settings for the SMS message.
	SmsSettings *SmsSettings
	// contains filtered or unexported fields
}

Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.

type UpdateBackendStorageResourceConfig added in v1.8.0 

type UpdateBackendStorageResourceConfig struct {

	// The authorization configuration for the storage S3 bucket.
	//
	// This member is required.
	Permissions *BackendStoragePermissions

	// The name of the storage service.
	//
	// This member is required.
	ServiceName ServiceName
	// contains filtered or unexported fields
}

The resource configuration for updating backend storage.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.