From 2d98f9cf1fd6f5c70dcb194b173748ec0a7ba574 Mon Sep 17 00:00:00 2001 From: ShadowCat567 Date: Thu, 19 Dec 2024 23:57:03 +0000 Subject: [PATCH] deploy: b574bce26ec2d55a4391aeceecc1d4957e79fba3 --- ...versation.ConversationHandlerFunction.html | 8 ++-- ...ws_amplify_auth_construct.AmplifyAuth.html | 44 +++++++++---------- ...ckend_deployer.BackendDeployerFactory.html | 6 +-- ...ut_storage.AttributionMetadataStorage.html | 6 +-- ...kMetadataBackendOutputStorageStrategy.html | 10 ++--- ..._platform_test_stubs.AmplifyStackStub.html | 4 +- ...orm_test_stubs.ConstructContainerStub.html | 10 ++--- ...orm_test_stubs.ImportPathVerifierStub.html | 4 +- ..._test_stubs.ResourceNameValidatorStub.html | 4 +- ...bs.SsmEnvironmentEntriesGeneratorStub.html | 8 ++-- ...platform_test_stubs.StackResolverStub.html | 6 +-- ...ws_amplify_backend_secret.SecretError.html | 8 ++-- ..._aws_amplify_cli_core.AmplifyPrompter.html | 8 ++-- classes/_aws_amplify_cli_core.Format.html | 4 +- ..._core.PackageManagerControllerFactory.html | 8 ++-- classes/_aws_amplify_cli_core.Printer.html | 22 +++++----- ...ckend_client.BackendOutputClientError.html | 6 +-- ...end_client.BackendOutputClientFactory.html | 4 +- ...d_client.DeployedBackendClientFactory.html | 4 +- ...ws_amplify_platform_core.AmplifyError.html | 16 +++---- ...ws_amplify_platform_core.AmplifyFault.html | 14 +++--- ...mplify_platform_core.AmplifyUserError.html | 14 +++--- ...orm_core.BackendIdentifierConversions.html | 6 +-- ..._amplify_platform_core.BackendLocator.html | 4 +- ...latform_core.CallerDirectoryExtractor.html | 4 +- ...m_core.ConfigurationControllerFactory.html | 6 +-- ...plify_platform_core.FilePathExtractor.html | 4 +- ...amplify_platform_core.NamingConverter.html | 4 +- ...plify_platform_core.ObjectAccumulator.html | 6 +-- ...AccumulatorPropertyAlreadyExistsError.html | 4 +- ...ObjectAccumulatorVersionMismatchError.html | 4 +- ...plify_platform_core.PackageJsonReader.html | 6 +-- ...latform_core.ParameterPathConversions.html | 8 ++-- ...platform_core.UsageDataEmitterFactory.html | 4 +- ...plify_sandbox.SandboxSingletonFactory.html | 6 +-- ...lify_schema_generator.SchemaGenerator.html | 4 +- enums/_aws_amplify_cli_core.LogLevel.html | 4 +- ...lient_config.ClientConfigFileBaseName.html | 4 +- ...lify_client_config.ClientConfigFormat.html | 4 +- ...ient_config.ClientConfigVersionOption.html | 4 +- ...y_deployed_backend_client.ApiAuthType.html | 4 +- ...ackend_client.BackendDeploymentStatus.html | 4 +- ...d_client.BackendOutputClientErrorType.html | 4 +- ...deployed_backend_client.BackendStatus.html | 4 +- ...backend_client.ConflictResolutionMode.html | 4 +- ...model_generator.GenerateApiCodeFormat.html | 4 +- ..._generator.GenerateApiCodeModelTarget.html | 4 +- ...erator.GenerateApiCodeStatementTarget.html | 4 +- ...l_generator.GenerateApiCodeTypeTarget.html | 4 +- ...s_amplify_platform_core.CDKContextKey.html | 4 +- enums/_aws_amplify_platform_core.TagName.html | 4 +- .../_aws_amplify_backend.defineBackend.html | 2 +- functions/_aws_amplify_backend.secret.html | 2 +- .../_aws_amplify_backend_auth.defineAuth.html | 2 +- ...ws_amplify_backend_auth.referenceAuth.html | 2 +- .../_aws_amplify_backend_data.defineData.html | 2 +- ...plify_backend_function.defineFunction.html | 2 +- ...mplify_backend_secret.getSecretClient.html | 2 +- ...tSecretClientWithAmplifyErrorHandling.html | 2 +- ...amplify_backend_storage.defineStorage.html | 2 +- ...fy_client_config.generateClientConfig.html | 2 +- ...ent_config.generateClientConfigToFile.html | 2 +- ...onfig.generateEmptyClientConfigToFile.html | 2 +- ...client_config.getClientConfigFileName.html | 2 +- ...ify_client_config.getClientConfigPath.html | 2 +- ...rator.createLocalGraphqlFormGenerator.html | 2 +- ...erator.createGraphqlDocumentGenerator.html | 2 +- ...enerator.createGraphqlModelsGenerator.html | 2 +- ...plify_model_generator.generateApiCode.html | 2 +- ...onfigTypesV1.AWSAmplifyBackendOutputs.html | 18 ++++---- ...igTypesV1.AmazonLocationServiceConfig.html | 6 +-- ...figTypesV1_1.AWSAmplifyBackendOutputs.html | 18 ++++---- ...TypesV1_1.AmazonLocationServiceConfig.html | 6 +-- ...tConfigTypesV1_1.AmplifyStorageBucket.html | 4 +- ...figTypesV1_2.AWSAmplifyBackendOutputs.html | 18 ++++---- ...TypesV1_2.AmazonLocationServiceConfig.html | 6 +-- ...figTypesV1_2.AmplifyStorageAccessRule.html | 4 +- ...tConfigTypesV1_2.AmplifyStorageBucket.html | 4 +- ...figTypesV1_3.AWSAmplifyBackendOutputs.html | 18 ++++---- ...TypesV1_3.AmazonLocationServiceConfig.html | 6 +-- ...figTypesV1_3.AmplifyStorageAccessRule.html | 4 +- ...tConfigTypesV1_3.AmplifyStorageBucket.html | 4 +- ...onfigTypesV1_3.AmplifyUserGroupConfig.html | 4 +- ...ws_amplify_ai_constructs.conversation.html | 2 +- ...ify_client_config.clientConfigTypesV1.html | 2 +- ...y_client_config.clientConfigTypesV1_1.html | 2 +- ...y_client_config.clientConfigTypesV1_2.html | 2 +- ...y_client_config.clientConfigTypesV1_3.html | 2 +- ...tion.ConversationHandlerFunctionProps.html | 2 +- ...ersation.ConversationTurnEventVersion.html | 2 +- ...fy_auth_construct.AmazonProviderProps.html | 2 +- ...ify_auth_construct.AppleProviderProps.html | 2 +- ...plify_auth_construct.AttributeMapping.html | 2 +- ..._aws_amplify_auth_construct.AuthProps.html | 2 +- ...mplify_auth_construct.CustomAttribute.html | 2 +- ...fy_auth_construct.CustomAttributeBase.html | 2 +- ...auth_construct.CustomAttributeBoolean.html | 2 +- ...uth_construct.CustomAttributeDateTime.html | 2 +- ..._auth_construct.CustomAttributeNumber.html | 2 +- ..._auth_construct.CustomAttributeString.html | 2 +- ...lify_auth_construct.CustomEmailSender.html | 2 +- ...aws_amplify_auth_construct.EmailLogin.html | 2 +- ...ify_auth_construct.EmailLoginSettings.html | 2 +- ...uth_construct.ExternalProviderOptions.html | 2 +- ..._auth_construct.FacebookProviderProps.html | 2 +- ...fy_auth_construct.GoogleProviderProps.html | 2 +- ..._auth_construct.IdentityProviderProps.html | 2 +- types/_aws_amplify_auth_construct.MFA.html | 2 +- ...ws_amplify_auth_construct.MFASettings.html | 2 +- ...amplify_auth_construct.MFASmsSettings.html | 2 +- ...mplify_auth_construct.MFATotpSettings.html | 2 +- ...lify_auth_construct.OidcProviderProps.html | 2 +- ...plify_auth_construct.PhoneNumberLogin.html | 2 +- ...lify_auth_construct.SamlProviderProps.html | 2 +- ...s_amplify_auth_construct.TriggerEvent.html | 2 +- ...amplify_auth_construct.UserAttributes.html | 2 +- ...h_construct.VerificationEmailWithCode.html | 2 +- ...h_construct.VerificationEmailWithLink.html | 2 +- types/_aws_amplify_backend.Backend.html | 2 +- types/_aws_amplify_backend.BackendBase.html | 2 +- ...ws_amplify_backend.DefineBackendProps.html | 2 +- .../_aws_amplify_backend_auth.ActionIam.html | 2 +- .../_aws_amplify_backend_auth.ActionMeta.html | 2 +- ...ckend_auth.AmazonProviderFactoryProps.html | 2 +- ...amplify_backend_auth.AmplifyAuthProps.html | 2 +- ...ackend_auth.AmplifyReferenceAuthProps.html | 2 +- ...ackend_auth.AppleProviderFactoryProps.html | 2 +- ...mplify_backend_auth.AuthAccessBuilder.html | 2 +- ...ify_backend_auth.AuthAccessDefinition.html | 2 +- ...lify_backend_auth.AuthAccessGenerator.html | 2 +- .../_aws_amplify_backend_auth.AuthAction.html | 2 +- ...mplify_backend_auth.AuthActionBuilder.html | 2 +- ...ackend_auth.AuthLoginWithFactoryProps.html | 2 +- ..._aws_amplify_backend_auth.BackendAuth.html | 2 +- ...ify_backend_auth.BackendReferenceAuth.html | 2 +- ...mplify_backend_auth.CustomEmailSender.html | 2 +- types/_aws_amplify_backend_auth.Expand.html | 2 +- ...h.ExternalProviderGeneralFactoryProps.html | 2 +- ....ExternalProviderSpecificFactoryProps.html | 2 +- ...end_auth.FacebookProviderFactoryProps.html | 2 +- ...ckend_auth.GoogleProviderFactoryProps.html | 2 +- ...backend_auth.OidcProviderFactoryProps.html | 2 +- ...plify_backend_auth.ReferenceAuthProps.html | 2 +- ...end_data.ApiKeyAuthorizationModeProps.html | 2 +- ...plify_backend_data.AuthorizationModes.html | 2 +- .../_aws_amplify_backend_data.DataProps.html | 2 +- ..._amplify_backend_data.DataSchemaInput.html | 2 +- ...backend_data.DefaultAuthorizationMode.html | 2 +- ...end_data.LambdaAuthorizationModeProps.html | 2 +- ...ckend_data.OIDCAuthorizationModeProps.html | 2 +- ...lify_backend_deployer.BackendDeployer.html | 2 +- ...ployer.BackendDeployerOutputFormatter.html | 2 +- ..._amplify_backend_deployer.DeployProps.html | 2 +- ...amplify_backend_deployer.DeployResult.html | 2 +- ...lify_backend_deployer.DeploymentTimes.html | 2 +- ...amplify_backend_deployer.DestroyProps.html | 2 +- ...mplify_backend_deployer.DestroyResult.html | 2 +- ...ackend_function.AddEnvironmentFactory.html | 2 +- ...amplify_backend_function.CronSchedule.html | 2 +- ...kend_function.FunctionBundlingOptions.html | 2 +- ...ify_backend_function.FunctionLogLevel.html | 2 +- ...backend_function.FunctionLogRetention.html | 2 +- ...ckend_function.FunctionLoggingOptions.html | 2 +- ...mplify_backend_function.FunctionProps.html | 2 +- ...ify_backend_function.FunctionSchedule.html | 2 +- ..._amplify_backend_function.NodeVersion.html | 2 +- ...amplify_backend_function.TimeInterval.html | 2 +- ...d_output_schemas.AIConversationOutput.html | 2 +- ...ify_backend_output_schemas.AuthOutput.html | 2 +- ..._schemas.AwsAppsyncAuthenticationType.html | 2 +- ...hemas.BackendOutputEntryStackMetadata.html | 2 +- ...ut_schemas.BackendOutputStackMetadata.html | 2 +- ...y_backend_output_schemas.CustomOutput.html | 2 +- ...backend_output_schemas.FunctionOutput.html | 2 +- ..._backend_output_schemas.GraphqlOutput.html | 2 +- ..._backend_output_schemas.StorageOutput.html | 2 +- ...d_output_schemas.UnifiedBackendOutput.html | 2 +- ...nd_output_storage.AttributionMetadata.html | 2 +- ...d_output_storage.DeploymentEngineType.html | 2 +- ...plify_backend_output_storage.Platform.html | 2 +- ...end_platform_test_stubs.StackResolver.html | 2 +- types/_aws_amplify_backend_secret.Secret.html | 2 +- ...s_amplify_backend_secret.SecretClient.html | 2 +- ...fy_backend_secret.SecretClientOptions.html | 2 +- ...plify_backend_secret.SecretIdentifier.html | 2 +- ...amplify_backend_secret.SecretListItem.html | 2 +- ...nd_storage.AmplifyStorageFactoryProps.html | 2 +- ...y_backend_storage.AmplifyStorageProps.html | 2 +- ...nd_storage.AmplifyStorageTriggerEvent.html | 2 +- ..._aws_amplify_backend_storage.EntityId.html | 2 +- ..._backend_storage.StorageAccessBuilder.html | 2 +- ...ckend_storage.StorageAccessDefinition.html | 2 +- ...ackend_storage.StorageAccessGenerator.html | 2 +- ...y_backend_storage.StorageAccessRecord.html | 2 +- ...amplify_backend_storage.StorageAction.html | 2 +- ..._backend_storage.StorageActionBuilder.html | 2 +- ...s_amplify_backend_storage.StoragePath.html | 2 +- ...lify_backend_storage.StorageResources.html | 2 +- types/_aws_amplify_cli_core.ColorName.html | 2 +- types/_aws_amplify_cli_core.RecordValue.html | 2 +- ...y_client_config.AnalyticsClientConfig.html | 2 +- ...mplify_client_config.AuthClientConfig.html | 2 +- ...ws_amplify_client_config.ClientConfig.html | 2 +- ...lify_client_config.ClientConfigLegacy.html | 2 +- ...ify_client_config.ClientConfigVersion.html | 2 +- ...onfig.ClientConfigVersionTemplateType.html | 2 +- ...lify_client_config.CustomClientConfig.html | 2 +- ...nfig.GenerateClientConfigToFileResult.html | 2 +- ...amplify_client_config.GeoClientConfig.html | 2 +- ...ify_client_config.GraphqlClientConfig.html | 2 +- ...ient_config.NotificationsClientConfig.html | 2 +- ...fy_client_config.PlatformClientConfig.html | 2 +- ...ify_client_config.StorageClientConfig.html | 2 +- ...pesV1.AmazonCognitoStandardAttributes.html | 2 +- ...tConfigTypesV1.AmazonPinpointChannels.html | 2 +- ...igTypesV1.AwsAppsyncAuthorizationType.html | 2 +- ..._config.clientConfigTypesV1.AwsRegion.html | 2 +- ...sV1_1.AmazonCognitoStandardAttributes.html | 2 +- ...onfigTypesV1_1.AmazonPinpointChannels.html | 2 +- ...TypesV1_1.AwsAppsyncAuthorizationType.html | 2 +- ...onfig.clientConfigTypesV1_1.AwsRegion.html | 2 +- ...sV1_2.AmazonCognitoStandardAttributes.html | 2 +- ...onfigTypesV1_2.AmazonPinpointChannels.html | 2 +- ...TypesV1_2.AmplifyStorageAccessActions.html | 2 +- ...TypesV1_2.AwsAppsyncAuthorizationType.html | 2 +- ...onfig.clientConfigTypesV1_2.AwsRegion.html | 2 +- ...sV1_3.AmazonCognitoStandardAttributes.html | 2 +- ...onfigTypesV1_3.AmazonPinpointChannels.html | 2 +- ...TypesV1_3.AmplifyStorageAccessActions.html | 2 +- ...TypesV1_3.AwsAppsyncAuthorizationType.html | 2 +- ...onfig.clientConfigTypesV1_3.AwsRegion.html | 2 +- ...ent.AppNameAndBranchBackendIdentifier.html | 2 +- ...ployed_backend_client.BackendMetadata.html | 2 +- ...ed_backend_client.BackendOutputClient.html | 2 +- ...ent.BackendOutputClientFactoryOptions.html | 2 +- ...end_client.BackendOutputClientOptions.html | 2 +- ...lient.BackendOutputCredentialsOptions.html | 2 +- ...backend_client.BackendSummaryMetadata.html | 2 +- ..._backend_client.DeployedBackendClient.html | 2 +- ...kend_client.DeployedBackendIdentifier.html | 2 +- ...ackend_client.DeployedBackendResource.html | 2 +- ..._backend_client.FunctionConfiguration.html | 2 +- ...ed_backend_client.ListBackendsRequest.html | 2 +- ...d_backend_client.ListBackendsResponse.html | 2 +- ...ployed_backend_client.StackIdentifier.html | 2 +- ..._form_generator.FormGenerationOptions.html | 2 +- ...generator.GenerateGraphqlToFileResult.html | 2 +- ...y_form_generator.GraphqlFormGenerator.html | 2 +- ...orm_generator.GraphqlGenerationResult.html | 2 +- ...rator.LocalGraphqlFormGeneratorParams.html | 2 +- ...enerator.DocumentGenerationParameters.html | 2 +- ..._model_generator.GenerateApiCodeProps.html | 2 +- ...nerator.GenerateGraphqlCodegenOptions.html | 2 +- ...or.GenerateGraphqlCodegenToFileResult.html | 2 +- ...enerator.GenerateIntrospectionOptions.html | 2 +- ...model_generator.GenerateModelsOptions.html | 2 +- ...plify_model_generator.GenerateOptions.html | 2 +- ...lify_model_generator.GenerationResult.html | 2 +- ...el_generator.GraphqlDocumentGenerator.html | 2 +- ...GraphqlDocumentGeneratorFactoryParams.html | 2 +- ...odel_generator.GraphqlModelsGenerator.html | 2 +- ...r.GraphqlModelsGeneratorFactoryParams.html | 2 +- ...model_generator.GraphqlTypesGenerator.html | 2 +- ..._generator.ModelsGenerationParameters.html | 2 +- ...l_generator.TypesGenerationParameters.html | 2 +- ...tform_core.AmplifyErrorClassification.html | 2 +- ...ify_platform_core.AmplifyErrorOptions.html | 2 +- ...platform_core.AmplifyUserErrorOptions.html | 2 +- ...platform_core.ConfigurationController.html | 2 +- ...tform_core.LocalConfigurationFileName.html | 2 +- ...aws_amplify_platform_core.PackageJson.html | 2 +- ...mplify_platform_core.UsageDataEmitter.html | 2 +- ...mplify_plugin_types.AWSClientProvider.html | 2 +- ..._amplify_plugin_types.AmplifyFunction.html | 2 +- ...plugin_types.AmplifyResourceGroupName.html | 2 +- types/_aws_amplify_plugin_types.AppId.html | 2 +- ...amplify_plugin_types.AuthCfnResources.html | 2 +- ...ws_amplify_plugin_types.AuthResources.html | 2 +- ...aws_amplify_plugin_types.AuthRoleName.html | 2 +- ...mplify_plugin_types.BackendIdentifier.html | 2 +- ...ws_amplify_plugin_types.BackendOutput.html | 2 +- ...plify_plugin_types.BackendOutputEntry.html | 2 +- ..._types.BackendOutputRetrievalStrategy.html | 2 +- ...in_types.BackendOutputStorageStrategy.html | 2 +- ...ws_amplify_plugin_types.BackendSecret.html | 2 +- ...fy_plugin_types.BackendSecretResolver.html | 2 +- .../_aws_amplify_plugin_types.BranchName.html | 2 +- ...plify_plugin_types.ConstructContainer.html | 2 +- ...ypes.ConstructContainerEntryGenerator.html | 2 +- ...amplify_plugin_types.ConstructFactory.html | 2 +- ...ypes.ConstructFactoryGetInstanceProps.html | 2 +- ..._aws_amplify_plugin_types.DeepPartial.html | 2 +- ...es.DeepPartialAmplifyGeneratedConfigs.html | 2 +- ...s_amplify_plugin_types.DeploymentType.html | 2 +- ...mplify_plugin_types.ExecaChildProcess.html | 2 +- ..._plugin_types.ExecaChildProcessResult.html | 2 +- ...aws_amplify_plugin_types.ExecaOptions.html | 2 +- ...mplify_plugin_types.FunctionResources.html | 2 +- ...gin_types.GenerateContainerEntryProps.html | 2 +- ...plify_plugin_types.ImportPathVerifier.html | 2 +- types/_aws_amplify_plugin_types.LogLevel.html | 2 +- ...aws_amplify_plugin_types.LogRetention.html | 2 +- ...amplify_plugin_types.MainStackCreator.html | 2 +- ...fy_plugin_types.MainStackNameResolver.html | 2 +- ...plugin_types.PackageManagerController.html | 2 +- ..._aws_amplify_plugin_types.ProjectName.html | 2 +- ...y_plugin_types.ReferenceAuthResources.html | 2 +- ...mplify_plugin_types.ResolvePathResult.html | 2 +- ...y_plugin_types.ResourceAccessAcceptor.html | 2 +- ...n_types.ResourceAccessAcceptorFactory.html | 2 +- ...fy_plugin_types.ResourceNameValidator.html | 2 +- ...amplify_plugin_types.ResourceProvider.html | 2 +- ..._aws_amplify_plugin_types.SandboxName.html | 2 +- ..._types.SsmEnvironmentEntriesGenerator.html | 2 +- ...lify_plugin_types.SsmEnvironmentEntry.html | 2 +- ...plugin_types.StableBackendIdentifiers.html | 2 +- ...ws_amplify_plugin_types.StackProvider.html | 2 +- ...lify_sandbox.BackendIdSandboxResolver.html | 2 +- types/_aws_amplify_sandbox.Sandbox.html | 2 +- ..._amplify_sandbox.SandboxDeleteOptions.html | 2 +- types/_aws_amplify_sandbox.SandboxEvents.html | 2 +- ...ndbox.SandboxFunctionStreamingOptions.html | 2 +- .../_aws_amplify_sandbox.SandboxOptions.html | 2 +- ..._schema_generator.SQLDataSourceConfig.html | 2 +- ...ws_amplify_schema_generator.SQLEngine.html | 2 +- ...chema_generator.SchemaGeneratorConfig.html | 2 +- ..._amplify_auth_construct.triggerEvents.html | 2 +- ...hemas.AwsAppsyncAuthenticationZodEnum.html | 2 +- ...utput_schemas.aiConversationOutputKey.html | 2 +- ..._backend_output_schemas.authOutputKey.html | 2 +- ...backendOutputEntryStackMetadataSchema.html | 2 +- ...emas.backendOutputStackMetadataSchema.html | 2 +- ...ackend_output_schemas.customOutputKey.html | 2 +- ...kend_output_schemas.functionOutputKey.html | 2 +- ...ckend_output_schemas.graphqlOutputKey.html | 2 +- ...kend_output_schemas.platformOutputKey.html | 2 +- ...ckend_output_schemas.storageOutputKey.html | 2 +- ...ut_schemas.unifiedBackendOutputSchema.html | 2 +- ...s.versionedAIConversationOutputSchema.html | 2 +- ...put_schemas.versionedAuthOutputSchema.html | 2 +- ...t_schemas.versionedCustomOutputSchema.html | 2 +- ...schemas.versionedFunctionOutputSchema.html | 2 +- ..._schemas.versionedGraphqlOutputSchema.html | 2 +- ..._schemas.versionedStorageOutputSchema.html | 2 +- .../_aws_amplify_cli_core.colorNames.html | 2 +- variables/_aws_amplify_cli_core.format-1.html | 2 +- .../_aws_amplify_cli_core.printer-1.html | 2 +- ..._config.DEFAULT_CLIENT_CONFIG_VERSION.html | 2 +- ...form_core.USAGE_DATA_TRACKING_ENABLED.html | 2 +- ...platform_core.configControllerFactory.html | 2 +- ...plify_platform_core.packageJsonSchema.html | 2 +- 351 files changed, 520 insertions(+), 520 deletions(-) diff --git a/classes/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunction.html b/classes/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunction.html index d5c60c5d12..ebd0d9e08d 100644 --- a/classes/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunction.html +++ b/classes/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunction.html @@ -8,7 +8,7 @@
  • AWS CloudWatch log group policy with appropriate data protection policies.
  • AWS IAM policy that grants access to selected AWS Bedrock models.
  • -

    Hierarchy

    Implements

    Constructors

    Hierarchy

    • Construct
      • ConversationHandlerFunction

    Implements

    Constructors

    Properties

    Constructors

    Properties

    node: Node

    The tree node.

    -
    eventVersion: `1.${number}` = '1.0'

    Methods

    Properties

    node: Node

    The tree node.

    +
    eventVersion: `1.${number}` = '1.0'

    Methods

    • Returns a string representation of this construct.

      Returns string

    Properties

    computedUserPoolProps: UserPoolProps
    customEmailSenderKMSkey: undefined | IKey

    The KMS key used for encrypting custom email sender data. This is only set when using a custom email sender.

    -
    domainPrefix: undefined | string
    groups: {
        [key: string]: {
            cfnUserGroup: CfnUserPoolGroup;
            role: Role;
        };
    } = {}

    Type declaration

    • [key: string]: {
          cfnUserGroup: CfnUserPoolGroup;
          role: Role;
      }
      • cfnUserGroup: CfnUserPoolGroup
      • role: Role
    name: string
    node: Node

    The tree node.

    +
    domainPrefix: undefined | string
    groups: {
        [key: string]: {
            cfnUserGroup: CfnUserPoolGroup;
            role: Role;
        };
    } = {}

    Type declaration

    • [key: string]: {
          cfnUserGroup: CfnUserPoolGroup;
          role: Role;
      }
      • cfnUserGroup: CfnUserPoolGroup
      • role: Role
    name: string
    node: Node

    The tree node.

    providerSetupResult: IdentityProviderSetupResult

    External provider settings

    -
    resources: AuthResources

    The resources generated by the construct.

    -
    userPool: UserPool

    Methods

    • Define bindCustomAttribute to meet requirements of the Cognito API to call the bind method

      -

      Parameters

      Returns CustomAttributeConfig & ICustomAttribute

    resources: AuthResources

    The resources generated by the construct.

    +
    userPool: UserPool

    Methods

    • Define bindCustomAttribute to meet requirements of the Cognito API to call the bind method

      +

      Parameters

      Returns CustomAttributeConfig & ICustomAttribute

    • Convert user friendly account recovery method to cognito AccountRecover enum. This eliminates the need for users to import cognito.AccountRecovery.

      Parameters

      • method: undefined | "EMAIL_AND_PHONE_WITHOUT_MFA" | "PHONE_WITHOUT_MFA_AND_EMAIL" | "EMAIL_ONLY" | "PHONE_ONLY_WITHOUT_MFA" | "PHONE_AND_EMAIL" | "NONE"

        account recovery method as a string value

      Returns undefined | AccountRecovery

      cognito.AccountRecovery enum value

      -
    • Converts the simplified mapping type to cognito.AttributeMapping.

      Parameters

      • Optional mapping: AttributeMapping

        the AttributeMapping to convert to a cognito.AttributeMapping

      Returns undefined | AttributeMapping

      cognito.AttributeMapping

      -
    • Determine the account recovery option based on enabled login methods.

      +
    • Determine the account recovery option based on enabled login methods.

      Parameters

      • emailEnabled: boolean

        is email enabled

      • phoneEnabled: boolean

        is phone enabled

      • accountRecoveryMethodAsString: undefined | "EMAIL_AND_PHONE_WITHOUT_MFA" | "PHONE_WITHOUT_MFA_AND_EMAIL" | "EMAIL_ONLY" | "PHONE_ONLY_WITHOUT_MFA" | "PHONE_AND_EMAIL" | "NONE"

        the user provided account recovery setting

      Returns undefined | AccountRecovery

      account recovery setting enum value

      -
    • Get email verification style from user props

      Parameters

      • verificationEmailStyle: undefined | "LINK" | "CODE"

        string value

      Returns undefined | VerificationEmailStyle

      verificationEmailStyle - enum value

      -
    • Convert user friendly Mfa mode to cognito Mfa Mode. This eliminates the need for users to import cognito.Mfa.

      Parameters

      • mfa: undefined | MFA

        MFA settings

      Returns undefined | Mfa

      cognito MFA enforcement mode

      -
    • Convert user friendly Mfa type to cognito Mfa type. This eliminates the need for users to import cognito.Mfa.

      Parameters

      • mfa: undefined | MFA

        MFA settings

      Returns undefined | MfaSecondFactor

      cognito MFA type (sms or totp)

      -
    • Convert scopes from string list to OAuthScopes.

      Parameters

      • scopes: undefined | ("PHONE" | "EMAIL" | "OPENID" | "PROFILE" | "COGNITO_ADMIN")[]

        scope list

      Returns OAuthScope[]

      cognito OAuthScopes

      -
    • Parses the user invitation settings and inserts codes/usernames where necessary.

      Parameters

      • settings: undefined | {
            emailBody?: ((username, code) => string);
            emailSubject?: string;
            smsMessage?: ((username, code) => string);
        }

        the invitation settings

      Returns undefined | UserInvitationConfig

      cognito.UserInvitationConfig | undefined

      -
    • Setup External Providers (OAuth/OIDC/SAML) and related settings such as OAuth settings and User Pool Domains

      Parameters

      • userPool: UserPool
      • loginOptions: {
            email?: EmailLogin;
            externalProviders?: ExternalProviderOptions;
            phone?: PhoneNumberLogin;
        }
        • Optional email?: EmailLogin

          Email login options.

          If true, email login will be enabled with default settings. @@ -80,15 +80,15 @@

        • Optional phone?: PhoneNumberLogin

          Phone number login options.

          If true, phone number login will be enabled with default settings. If settings are provided, phone number login will be enabled with the specified settings.

          -

      Returns IdentityProviderSetupResult

    • Setup Identity Pool with default roles/role mappings, and register providers

      -

      Parameters

      • userPool: UserPool
      • userPoolClient: UserPoolClient
      • providerSetupResult: IdentityProviderSetupResult

      Returns {
          identityPool: CfnIdentityPool;
          identityPoolRoleAttachment: CfnIdentityPoolRoleAttachment;
          roles: DefaultRoles;
      }

      • identityPool: CfnIdentityPool
      • identityPoolRoleAttachment: CfnIdentityPoolRoleAttachment
      • roles: DefaultRoles
    • Auto generate the user pool groups and group roles

      -

      Parameters

      • groups: undefined | string[]
      • identityPool: CfnIdentityPool

      Returns void

    • Stores auth output using the provided strategy

      -

      Parameters

      • outputStorageStrategy: BackendOutputStorageStrategy<{
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                groups?: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        }> = ...

      Returns void

    • Returns a string representation of this construct.

      +

    Returns IdentityProviderSetupResult

    • Setup Identity Pool with default roles/role mappings, and register providers

      +

      Parameters

      • userPool: UserPool
      • userPoolClient: UserPoolClient
      • providerSetupResult: IdentityProviderSetupResult

      Returns {
          identityPool: CfnIdentityPool;
          identityPoolRoleAttachment: CfnIdentityPoolRoleAttachment;
          roles: DefaultRoles;
      }

      • identityPool: CfnIdentityPool
      • identityPoolRoleAttachment: CfnIdentityPoolRoleAttachment
      • roles: DefaultRoles
    • Auto generate the user pool groups and group roles

      +

      Parameters

      • groups: undefined | string[]
      • identityPool: CfnIdentityPool

      Returns void

    • Stores auth output using the provided strategy

      +

      Parameters

      • outputStorageStrategy: BackendOutputStorageStrategy<{
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                groups?: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        }> = ...

      Returns void

    • Returns a string representation of this construct.

      Returns string

    • Verify the email body depending on if 'CODE' or 'LINK' style is used. This ensures that the template contains the necessary placeholders for Cognito to insert verification codes or links.

      Parameters

      Returns undefined | string

      emailBody

      -

    Properties

    packageManagerController: PackageManagerController
    instance: undefined | BackendDeployer

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_output_storage.AttributionMetadataStorage.html b/classes/_aws_amplify_backend_output_storage.AttributionMetadataStorage.html index 88a5780774..cfd431a4e9 100644 --- a/classes/_aws_amplify_backend_output_storage.AttributionMetadataStorage.html +++ b/classes/_aws_amplify_backend_output_storage.AttributionMetadataStorage.html @@ -1,5 +1,5 @@ AttributionMetadataStorage | Amplify Toolbox

    Stores BI metrics information in stack descriptions

    -

    Constructors

    Constructors

    Properties

    os: __module = _os
    packageJsonReader: PackageJsonReader = ...

    Methods

    Properties

    os: __module = _os
    packageJsonReader: PackageJsonReader = ...

    Methods

    • Stores an attribution metadata string in the stack description of the provided stack Does nothing if the stack already has a non-empty description

      -

      Parameters

      • stack: Stack
      • stackType: string
      • libraryPackageJsonAbsolutePath: string
      • additionalMetadata: Record<string, string> = {}

      Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_output_storage.StackMetadataBackendOutputStorageStrategy.html b/classes/_aws_amplify_backend_output_storage.StackMetadataBackendOutputStorageStrategy.html index e7e4b959ca..945672f021 100644 --- a/classes/_aws_amplify_backend_output_storage.StackMetadataBackendOutputStorageStrategy.html +++ b/classes/_aws_amplify_backend_output_storage.StackMetadataBackendOutputStorageStrategy.html @@ -1,5 +1,5 @@ StackMetadataBackendOutputStorageStrategy | Amplify Toolbox

    Implementation of BackendOutputStorageStrategy that stores config data in stack metadata and outputs

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    lazyListValueMap: Map<string, Map<string, string[]>> = ...
    stack: Stack

    Methods

    • Store construct output as stack output and add metadata to the metadata object.

      -

      Parameters

      Returns void

    Properties

    lazyListValueMap: Map<string, Map<string, string[]>> = ...
    stack: Stack

    Methods

    • Store construct output as stack output and add metadata to the metadata object.

      +

      Parameters

      Returns void

    • Add or update metadata entry.

      Parameters

      • existingMetadataEntry: undefined | {
            stackOutputs: string[];
            version: string;
        }

        The existing metadata entry.

      • keyName: string

        The key name.

      • backendOutputEntry: BackendOutputEntry

        The backend output entry.

        -

      Returns void

    • Lazily construct and append to output list as stack output and add metadata to the metadata object.

      -

      Parameters

      Returns void

    \ No newline at end of file +

    Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html b/classes/_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html index b257e3b789..c0f814a435 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.AmplifyStackStub.html @@ -1,5 +1,5 @@ AmplifyStackStub | Amplify Toolbox

    Test implementation of AmplifyStack. Currently copied from the real implementation of AmplifyStack but the implementations do not need to match going forward

    -

    Hierarchy

    • Stack
      • AmplifyStackStub

    Constructors

    Hierarchy

    • Stack
      • AmplifyStackStub

    Constructors

    Properties

    _crossRegionReferences _notificationArns? _versionReportingEnabled @@ -189,7 +189,7 @@

    Example

    declare const stack: Stack;

    stack.addTransform('AWS::Serverless-2016-10-31')
    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.ImportPathVerifierStub.html b/classes/_aws_amplify_backend_platform_test_stubs.ImportPathVerifierStub.html index 783fcb9945..27715317b6 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.ImportPathVerifierStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.ImportPathVerifierStub.html @@ -1,4 +1,4 @@ ImportPathVerifierStub | Amplify Toolbox

    Stub implementation of ImportPathVerifier

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.ResourceNameValidatorStub.html b/classes/_aws_amplify_backend_platform_test_stubs.ResourceNameValidatorStub.html index 2b60779fb1..ef9df0b25b 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.ResourceNameValidatorStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.ResourceNameValidatorStub.html @@ -1,4 +1,4 @@ ResourceNameValidatorStub | Amplify Toolbox

    Stub implementation of ResourceNameValidator

    -

    Implements

    Constructors

    Implements

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.SsmEnvironmentEntriesGeneratorStub.html b/classes/_aws_amplify_backend_platform_test_stubs.SsmEnvironmentEntriesGeneratorStub.html index 172e240400..f217838447 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.SsmEnvironmentEntriesGeneratorStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.SsmEnvironmentEntriesGeneratorStub.html @@ -1,9 +1,9 @@ SsmEnvironmentEntriesGeneratorStub | Amplify Toolbox

    Stub implementation of SsmEnvironmentEntriesGenerator used for backend unit testing

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    scope: Construct

    The scope of the construct.

    -

    Methods

    • Stub implementation for testing. Synthesizes SSM parameters using a test path.

      -

      Parameters

      • scopeContext: Record<string, string>

      Returns {
          name: string;
          path: string;
      }[]

    \ No newline at end of file +

    Returns SsmEnvironmentEntriesGeneratorStub

    Properties

    scope: Construct

    The scope of the construct.

    +

    Methods

    • Stub implementation for testing. Synthesizes SSM parameters using a test path.

      +

      Parameters

      • scopeContext: Record<string, string>

      Returns {
          name: string;
          path: string;
      }[]

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_platform_test_stubs.StackResolverStub.html b/classes/_aws_amplify_backend_platform_test_stubs.StackResolverStub.html index 3437cbdb6e..35ee39790c 100644 --- a/classes/_aws_amplify_backend_platform_test_stubs.StackResolverStub.html +++ b/classes/_aws_amplify_backend_platform_test_stubs.StackResolverStub.html @@ -1,9 +1,9 @@ StackResolverStub | Amplify Toolbox

    Stub implementation of StackResolver. Currently copied from @aws-amplify/backend, but they can evolve independently

    -

    Implements

    Constructors

    Implements

    Constructors

    Properties

    Methods

    Constructors

    Properties

    rootStack: Stack
    stacks: Record<string, Stack> = {}

    Methods

    Properties

    rootStack: Stack
    stacks: Record<string, Stack> = {}

    Methods

    • Returns a cached NestedStack if resourceGroupName has been seen before Otherwise, creates a new NestedStack, caches it and returns it

      -

      Parameters

      • resourceGroupName: string

      Returns Stack

    \ No newline at end of file +

    Parameters

    Returns Stack

    \ No newline at end of file diff --git a/classes/_aws_amplify_backend_secret.SecretError.html b/classes/_aws_amplify_backend_secret.SecretError.html index 27c14265d3..3e48962957 100644 --- a/classes/_aws_amplify_backend_secret.SecretError.html +++ b/classes/_aws_amplify_backend_secret.SecretError.html @@ -1,5 +1,5 @@ SecretError | Amplify Toolbox

    Secret Error.

    -

    Hierarchy

    • Error
      • SecretError

    Constructors

    Hierarchy

    • Error
      • SecretError

    Constructors

    Properties

    Constructors

    • Creates a secret error instance.

      -

      Parameters

      • message: string
      • Optional options: {
            cause?: Error;
            httpStatusCode?: number;
        }
        • Optional cause?: Error
        • Optional httpStatusCode?: number

      Returns SecretError

    Properties

    cause?: Error
    httpStatusCode?: number
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Parameters

    • message: string
    • Optional options: {
          cause?: Error;
          httpStatusCode?: number;
      }
      • Optional cause?: Error
      • Optional httpStatusCode?: number

    Returns SecretError

    Properties

    cause?: Error
    httpStatusCode?: number
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns SecretError

    \ No newline at end of file diff --git a/classes/_aws_amplify_cli_core.AmplifyPrompter.html b/classes/_aws_amplify_cli_core.AmplifyPrompter.html index 76a29f3582..e3cc61f5c3 100644 --- a/classes/_aws_amplify_cli_core.AmplifyPrompter.html +++ b/classes/_aws_amplify_cli_core.AmplifyPrompter.html @@ -1,17 +1,17 @@ AmplifyPrompter | Amplify Toolbox

    Wrapper for prompter library Because @inquirer/prompts library set the methods as non-configurable, we cannot mock the methods directly. see details: https://github.com/orgs/nodejs/discussions/47959

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    • An input style prompt.

      Parameters

      • options: {
            defaultValue?: string;
            message: string;
            required?: undefined;
        } | {
            defaultValue?: undefined;
            message: string;
            required: true;
        }

        for displaying the prompt

      Returns Promise<string>

      Promise the user input

      -
    • A secret prompt.

      -

      Parameters

      • promptMessage: string = 'Enter secret value'

      Returns Promise<string>

    • A secret prompt.

      +

      Parameters

      • promptMessage: string = 'Enter secret value'

      Returns Promise<string>

    • A confirm style prompt. Styles question as y/N

      Parameters

      • options: {
            defaultValue?: boolean;
            message: string;
        }

        for displaying the prompt

        • Optional defaultValue?: boolean

          if user submits without typing anything. Defaults false

        • message: string

          display for the prompt

      Returns Promise<boolean>

      the boolean answer

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/_aws_amplify_cli_core.Format.html b/classes/_aws_amplify_cli_core.Format.html index c4f7ca907d..8d60ad07ca 100644 --- a/classes/_aws_amplify_cli_core.Format.html +++ b/classes/_aws_amplify_cli_core.Format.html @@ -1,5 +1,5 @@ Format | Amplify Toolbox

    Formats various inputs into single string.

    -

    Constructors

    Constructors

    Properties

    Methods

    bold color @@ -16,4 +16,4 @@ sectionHeader success

    Constructors

    • Initialize with a package manager runner name. Defaults to attempting to load a value derived from environment variables.

      -

      Parameters

      • packageManagerRunnerName: string = ...

      Returns Format

    Properties

    packageManagerRunnerName: string = ...

    Methods

    • Parameters

      • message: string
      • colorName: "Green" | "Yellow" | "Blue" | "Magenta" | "Cyan"

      Returns string

    • Parameters

      • command: string

      Returns string

    • Parameters

      • command: string

      Returns string

    • Parameters

      • record: Record<string, string | number | Date>

      Returns string

    • Parameters

      • header: string

      Returns string

    \ No newline at end of file +

    Parameters

    Returns Format

    Properties

    packageManagerRunnerName: string = ...

    Methods

    • Parameters

      • message: string
      • colorName: "Green" | "Yellow" | "Blue" | "Magenta" | "Cyan"

      Returns string

    • Parameters

      • command: string

      Returns string

    • Parameters

      • command: string

      Returns string

    • Parameters

      • record: Record<string, string | number | Date>

      Returns string

    • Parameters

      • header: string

      Returns string

    \ No newline at end of file diff --git a/classes/_aws_amplify_cli_core.PackageManagerControllerFactory.html b/classes/_aws_amplify_cli_core.PackageManagerControllerFactory.html index 23866472d8..0805ceed0d 100644 --- a/classes/_aws_amplify_cli_core.PackageManagerControllerFactory.html +++ b/classes/_aws_amplify_cli_core.PackageManagerControllerFactory.html @@ -1,11 +1,11 @@ PackageManagerControllerFactory | Amplify Toolbox

    PackageManagerControllerFactory is a factory for an abstraction around package manager commands that are needed to initialize a project and install dependencies

    -

    Constructors

    Constructors

    Properties

    cwd: string = ...

    the root directory of the project

    -
    platform: Platform = process.platform
    printer: Printer = _printer

    Methods

    \ No newline at end of file +
  • printer: Printer = _printer
  • platform: Platform = process.platform
  • Returns PackageManagerControllerFactory

    Properties

    cwd: string = ...

    the root directory of the project

    +
    platform: Platform = process.platform
    printer: Printer = _printer

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_cli_core.Printer.html b/classes/_aws_amplify_cli_core.Printer.html index 8d72ed4ae0..cd8e9efd5e 100644 --- a/classes/_aws_amplify_cli_core.Printer.html +++ b/classes/_aws_amplify_cli_core.Printer.html @@ -1,5 +1,5 @@ Printer | Amplify Toolbox

    The class that pretty prints to the output stream.

    -

    Constructors

    Constructors

    • Sets default configs

      -

      Parameters

      • minimumLogLevel: LogLevel
      • stdout: WriteStream | WritableStream = process.stdout
      • stderr: WriteStream | WritableStream = process.stderr
      • refreshRate: number = 500

      Returns Printer

    Properties

    minimumLogLevel: LogLevel
    refreshRate: number = 500
    spinnerFrames: string[] = ...

    Spinner frames

    -
    stderr: WriteStream | WritableStream = process.stderr
    stdout: WriteStream | WritableStream = process.stdout
    timer: Timeout
    timerSet: boolean

    Methods

    • Logs a message with animated spinner +

      Parameters

      • minimumLogLevel: LogLevel
      • stdout: WriteStream | WritableStream = process.stdout
      • stderr: WriteStream | WritableStream = process.stderr
      • refreshRate: number = 500

      Returns Printer

    Properties

    minimumLogLevel: LogLevel
    refreshRate: number = 500
    spinnerFrames: string[] = ...

    Spinner frames

    +
    stderr: WriteStream | WritableStream = process.stderr
    stdout: WriteStream | WritableStream = process.stdout
    timer: Timeout
    timerSet: boolean

    Methods

    • Logs a message with animated spinner If stdout is not a TTY, the message is logged at the info level without a spinner

      -

      Parameters

      • message: string
      • callback: (() => Promise<void>)
          • (): Promise<void>
          • Returns Promise<void>

      Returns Promise<void>

    • Logs a message to the output stream at the given log level followed by a newline

      -

      Parameters

      • message: string
      • level: LogLevel = LogLevel.INFO

      Returns void

    • Prints a given message to output stream followed by a newline.

      -

      Parameters

      • message: string

      Returns void

    • Starts animating spinner with a message.

      -

      Parameters

      • message: string

      Returns void

    • Writes escape sequence to stdout

      -

      Parameters

      • action: EscapeSequence

      Returns void

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    \ No newline at end of file diff --git a/classes/_aws_amplify_deployed_backend_client.BackendOutputClientError.html b/classes/_aws_amplify_deployed_backend_client.BackendOutputClientError.html index 7ba1bc9820..31f836bdb5 100644 --- a/classes/_aws_amplify_deployed_backend_client.BackendOutputClientError.html +++ b/classes/_aws_amplify_deployed_backend_client.BackendOutputClientError.html @@ -1,5 +1,5 @@ BackendOutputClientError | Amplify Toolbox

    Error type for BackendOutputClientError

    -

    Hierarchy

    • Error
      • BackendOutputClientError

    Constructors

    Hierarchy

    • Error
      • BackendOutputClientError

    Constructors

    Properties

    cause? code message @@ -10,7 +10,7 @@

    Methods

    Constructors

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Parameters

    Returns BackendOutputClientError

    Properties

    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns error is BackendOutputClientError

    \ No newline at end of file diff --git a/classes/_aws_amplify_deployed_backend_client.BackendOutputClientFactory.html b/classes/_aws_amplify_deployed_backend_client.BackendOutputClientFactory.html index 883a547f65..511cddbcee 100644 --- a/classes/_aws_amplify_deployed_backend_client.BackendOutputClientFactory.html +++ b/classes/_aws_amplify_deployed_backend_client.BackendOutputClientFactory.html @@ -1,5 +1,5 @@ BackendOutputClientFactory | Amplify Toolbox

    Factory to create a backend metadata reader

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Parameters

    Returns BackendOutputClient

    \ No newline at end of file diff --git a/classes/_aws_amplify_deployed_backend_client.DeployedBackendClientFactory.html b/classes/_aws_amplify_deployed_backend_client.DeployedBackendClientFactory.html index 6254f0d42a..a3cf50cde1 100644 --- a/classes/_aws_amplify_deployed_backend_client.DeployedBackendClientFactory.html +++ b/classes/_aws_amplify_deployed_backend_client.DeployedBackendClientFactory.html @@ -1,5 +1,5 @@ DeployedBackendClientFactory | Amplify Toolbox

    Factory to create a DeploymentClient

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Parameters

    Returns DeployedBackendClient

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.AmplifyError.html b/classes/_aws_amplify_platform_core.AmplifyError.html index 065cff6ac8..313ba28426 100644 --- a/classes/_aws_amplify_platform_core.AmplifyError.html +++ b/classes/_aws_amplify_platform_core.AmplifyError.html @@ -1,5 +1,5 @@ AmplifyError | Amplify Toolbox

    Base class for all Amplify errors or faults

    -

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Properties

    cause? classification code? @@ -25,19 +25,19 @@ you must provide the exception that was caught.

    Returns AmplifyError<T>

    Example

    try {
    ...
    } catch (error){
    throw new AmplifyError(...,...,error);
    }
    -

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, +

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, you must provide the exception that was caught.

    -

    LibraryFault or UserError

    -
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    -

    error stack, resolution steps, details, or help links

    -
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    LibraryFault or UserError

    +
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    +

    error stack, resolution steps, details, or help links

    +
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • This function is a type predicate for AmplifyError. +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns error is AmplifyError<string>

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.AmplifyFault.html b/classes/_aws_amplify_platform_core.AmplifyFault.html index 615e1fcc4d..4427a68478 100644 --- a/classes/_aws_amplify_platform_core.AmplifyFault.html +++ b/classes/_aws_amplify_platform_core.AmplifyFault.html @@ -1,5 +1,5 @@ AmplifyFault | Amplify Toolbox

    Base class for all Amplify library faults

    -

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Properties

    cause? classification code? @@ -23,18 +23,18 @@ you must provide the exception that was caught.

    Returns AmplifyFault<T>

    Example

    try {
    ...
    } catch (error){
    throw new AmplifyLibraryFault(error,...,...);
    }
    -

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, +

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, you must provide the exception that was caught.

    -

    LibraryFault or UserError

    -
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    -
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    LibraryFault or UserError

    +
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    +
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • This function is a type predicate for AmplifyError. +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns error is AmplifyError<string>

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.AmplifyUserError.html b/classes/_aws_amplify_platform_core.AmplifyUserError.html index 9414e5d2c0..b9c817119e 100644 --- a/classes/_aws_amplify_platform_core.AmplifyUserError.html +++ b/classes/_aws_amplify_platform_core.AmplifyUserError.html @@ -1,5 +1,5 @@ AmplifyUserError | Amplify Toolbox

    Base class for all Amplify user errors

    -

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Type Parameters

    • T extends string = string

    Hierarchy (view full)

    Constructors

    Properties

    cause? classification code? @@ -23,18 +23,18 @@ you must provide the error that was caught.

    Returns AmplifyUserError<T>

    Example

    try {
    ...
    } catch (error){
    throw new AmplifyError(...,...,error);
    }
    -

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, +

    Properties

    cause?: Error

    If you are throwing this exception from within a catch block, you must provide the exception that was caught.

    -

    LibraryFault or UserError

    -
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    -
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    LibraryFault or UserError

    +
    code?: string
    details?: string
    link?: string
    message: string
    name: T

    a user friendly name for the exception

    +
    resolution?: string
    serializedError?: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      -

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    • This function is a type predicate for AmplifyError. +

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file +

    Parameters

    Returns error is AmplifyError<string>

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.BackendIdentifierConversions.html b/classes/_aws_amplify_platform_core.BackendIdentifierConversions.html index 732a3615c4..f681bde2ed 100644 --- a/classes/_aws_amplify_platform_core.BackendIdentifierConversions.html +++ b/classes/_aws_amplify_platform_core.BackendIdentifierConversions.html @@ -1,11 +1,11 @@ BackendIdentifierConversions | Amplify Toolbox

    Provides static methods for converting BackendIdentifier to/from a stack name string

    -

    Constructors

    Constructors

    Methods

    • Convert a BackendIdentifier to a stack name.

      !!!DANGER!!! !!!DO NOT CHANGE THIS UNLESS YOU ARE 100% SURE YOU UNDERSTAND THE CONSEQUENCES!!!

      Changing this method will change how stack names are generated which could be a massive breaking change for existing Amplify stacks.

      -

      Parameters

      Returns string

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.BackendLocator.html b/classes/_aws_amplify_platform_core.BackendLocator.html index b48e6d4094..83e0983758 100644 --- a/classes/_aws_amplify_platform_core.BackendLocator.html +++ b/classes/_aws_amplify_platform_core.BackendLocator.html @@ -1,8 +1,8 @@ BackendLocator | Amplify Toolbox

    Find the backend definition file in the customer app that represents a CDK app.

    -

    Constructors

    Constructors

    Properties

    relativePath: string = ...
    rootDir: string = ...
    supportedFileExtensions: string[] = ...

    Methods

    \ No newline at end of file +

    Parameters

    Returns BackendLocator

    Properties

    relativePath: string = ...
    rootDir: string = ...
    supportedFileExtensions: string[] = ...

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.CallerDirectoryExtractor.html b/classes/_aws_amplify_platform_core.CallerDirectoryExtractor.html index 0a55c5373d..65fc03cd31 100644 --- a/classes/_aws_amplify_platform_core.CallerDirectoryExtractor.html +++ b/classes/_aws_amplify_platform_core.CallerDirectoryExtractor.html @@ -1,8 +1,8 @@ CallerDirectoryExtractor | Amplify Toolbox

    Extracts the path of the caller of the code that generated the input stack trace. In other words, extracts the path from the second entry in the stack trace (the first entry being the location where the stack trace was created and the second entry being the location that called the code that generated the stack trace)

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    stackTrace: undefined | string

    Methods

    \ No newline at end of file +

    Parameters

    Returns CallerDirectoryExtractor

    Properties

    stackTrace: undefined | string

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ConfigurationControllerFactory.html b/classes/_aws_amplify_platform_core.ConfigurationControllerFactory.html index 489ae71657..782a2c9e84 100644 --- a/classes/_aws_amplify_platform_core.ConfigurationControllerFactory.html +++ b/classes/_aws_amplify_platform_core.ConfigurationControllerFactory.html @@ -1,7 +1,7 @@ ConfigurationControllerFactory | Amplify Toolbox

    Instantiates LocalConfigurationController

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    controllers: Record<string, ConfigurationController>

    Methods

    \ No newline at end of file +

    Returns ConfigurationControllerFactory

    Properties

    controllers: Record<string, ConfigurationController>

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.FilePathExtractor.html b/classes/_aws_amplify_platform_core.FilePathExtractor.html index 197d3d2740..7b57382e5b 100644 --- a/classes/_aws_amplify_platform_core.FilePathExtractor.html +++ b/classes/_aws_amplify_platform_core.FilePathExtractor.html @@ -1,7 +1,7 @@ FilePathExtractor | Amplify Toolbox

    Extracts a file path from a given stack trace line

    -

    Constructors

    Constructors

    Properties

    Methods

    Constructors

    Properties

    stackTraceLine: string

    Methods

    \ No newline at end of file +

    Parameters

    Returns FilePathExtractor

    Properties

    stackTraceLine: string

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.NamingConverter.html b/classes/_aws_amplify_platform_core.NamingConverter.html index 7371323166..ab8c0574d5 100644 --- a/classes/_aws_amplify_platform_core.NamingConverter.html +++ b/classes/_aws_amplify_platform_core.NamingConverter.html @@ -1,8 +1,8 @@ NamingConverter | Amplify Toolbox

    Naming Converter

    Example

    new NamingConverter().toScreamingSnakeCase('myInputString')
     
    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Returns string

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ObjectAccumulator.html b/classes/_aws_amplify_platform_core.ObjectAccumulator.html index 671bd958d9..515a99443f 100644 --- a/classes/_aws_amplify_platform_core.ObjectAccumulator.html +++ b/classes/_aws_amplify_platform_core.ObjectAccumulator.html @@ -1,13 +1,13 @@ ObjectAccumulator | Amplify Toolbox

    A class that can accumulate (squash merge) objects into single instance.

    -

    Type Parameters

    • T

    Constructors

    Type Parameters

    • T

    Constructors

    Properties

    versionKey: string = 'version'

    Methods

    Properties

    versionKey: string = 'version'

    Methods

    \ No newline at end of file +
    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ObjectAccumulatorPropertyAlreadyExistsError.html b/classes/_aws_amplify_platform_core.ObjectAccumulatorPropertyAlreadyExistsError.html index ca40b08d29..517741c369 100644 --- a/classes/_aws_amplify_platform_core.ObjectAccumulatorPropertyAlreadyExistsError.html +++ b/classes/_aws_amplify_platform_core.ObjectAccumulatorPropertyAlreadyExistsError.html @@ -1,5 +1,5 @@ ObjectAccumulatorPropertyAlreadyExistsError | Amplify Toolbox

    This error is thrown when there's a collision in the object keys

    -

    Hierarchy

    • Error
      • ObjectAccumulatorPropertyAlreadyExistsError

    Constructors

    Hierarchy

    • Error
      • ObjectAccumulatorPropertyAlreadyExistsError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    cause?: unknown
    existingValue: unknown
    incomingValue: unknown
    key: string
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Parameters

    • key: string
    • existingValue: unknown
    • incomingValue: unknown

    Returns ObjectAccumulatorPropertyAlreadyExistsError

    Properties

    cause?: unknown
    existingValue: unknown
    incomingValue: unknown
    key: string
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ObjectAccumulatorVersionMismatchError.html b/classes/_aws_amplify_platform_core.ObjectAccumulatorVersionMismatchError.html index 4f882c0283..fcda1f39b4 100644 --- a/classes/_aws_amplify_platform_core.ObjectAccumulatorVersionMismatchError.html +++ b/classes/_aws_amplify_platform_core.ObjectAccumulatorVersionMismatchError.html @@ -1,5 +1,5 @@ ObjectAccumulatorVersionMismatchError | Amplify Toolbox

    This error is thrown when partial objects with different versions are being accumulated

    -

    Hierarchy

    • Error
      • ObjectAccumulatorVersionMismatchError

    Constructors

    Hierarchy

    • Error
      • ObjectAccumulatorVersionMismatchError

    Constructors

    Properties

    Methods

    Constructors

    Properties

    cause?: unknown
    existingVersion: string
    message: string
    name: string
    newVersion: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Parameters

    • existingVersion: string
    • newVersion: string

    Returns ObjectAccumulatorVersionMismatchError

    Properties

    cause?: unknown
    existingVersion: string
    message: string
    name: string
    newVersion: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

      • (err, stackTraces): any
      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    stackTraceLimit: number

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.PackageJsonReader.html b/classes/_aws_amplify_platform_core.PackageJsonReader.html index 1ebb55ad10..20d39e93f7 100644 --- a/classes/_aws_amplify_platform_core.PackageJsonReader.html +++ b/classes/_aws_amplify_platform_core.PackageJsonReader.html @@ -1,7 +1,7 @@ PackageJsonReader | Amplify Toolbox

    return the package json

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    • Parameters

      • absolutePackageJsonPath: string

      Returns {
          name?: string;
          type?: "module" | "commonjs";
          version?: string;
      }

      • Optional name?: string
      • Optional type?: "module" | "commonjs"
      • Optional version?: string
    • Returns the contents of the package.json file in process.cwd()

      +

    Constructors

    Methods

    • Parameters

      • absolutePackageJsonPath: string

      Returns {
          name?: string;
          type?: "module" | "commonjs";
          version?: string;
      }

      • Optional name?: string
      • Optional type?: "module" | "commonjs"
      • Optional version?: string
    • Returns the contents of the package.json file in process.cwd()

      If no package.json file exists, or the content does not pass validation, an error is thrown

      -

      Returns {
          name?: string;
          type?: "module" | "commonjs";
          version?: string;
      }

      • Optional name?: string
      • Optional type?: "module" | "commonjs"
      • Optional version?: string
    \ No newline at end of file +

    Returns {
        name?: string;
        type?: "module" | "commonjs";
        version?: string;
    }

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.ParameterPathConversions.html b/classes/_aws_amplify_platform_core.ParameterPathConversions.html index fcfafc50ad..385a69932b 100644 --- a/classes/_aws_amplify_platform_core.ParameterPathConversions.html +++ b/classes/_aws_amplify_platform_core.ParameterPathConversions.html @@ -1,9 +1,9 @@ ParameterPathConversions | Amplify Toolbox

    Provides static methods for converting BackendIdentifier to parameter path strings

    -

    Constructors

    Constructors

    Methods

    \ No newline at end of file +

    Parameters

    Returns string

    \ No newline at end of file diff --git a/classes/_aws_amplify_platform_core.UsageDataEmitterFactory.html b/classes/_aws_amplify_platform_core.UsageDataEmitterFactory.html index 6976a4d069..b13bb35456 100644 --- a/classes/_aws_amplify_platform_core.UsageDataEmitterFactory.html +++ b/classes/_aws_amplify_platform_core.UsageDataEmitterFactory.html @@ -1,5 +1,5 @@ UsageDataEmitterFactory | Amplify Toolbox

    Creates UsageDataEmitter for a given library version

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Parameters

    Returns Promise<UsageDataEmitter>

    \ No newline at end of file diff --git a/classes/_aws_amplify_sandbox.SandboxSingletonFactory.html b/classes/_aws_amplify_sandbox.SandboxSingletonFactory.html index a89f7017ef..a40cd85329 100644 --- a/classes/_aws_amplify_sandbox.SandboxSingletonFactory.html +++ b/classes/_aws_amplify_sandbox.SandboxSingletonFactory.html @@ -1,10 +1,10 @@ SandboxSingletonFactory | Amplify Toolbox

    Factory to create a new sandbox

    -

    Constructors

    Constructors

    Properties

    format: Format
    instance: undefined | Sandbox
    printer: Printer
    sandboxIdResolver: BackendIdSandboxResolver

    Methods

    \ No newline at end of file +

    Parameters

    Returns SandboxSingletonFactory

    Properties

    format: Format
    instance: undefined | Sandbox
    printer: Printer
    sandboxIdResolver: BackendIdSandboxResolver

    Methods

    \ No newline at end of file diff --git a/classes/_aws_amplify_schema_generator.SchemaGenerator.html b/classes/_aws_amplify_schema_generator.SchemaGenerator.html index c76a63814b..380de7e471 100644 --- a/classes/_aws_amplify_schema_generator.SchemaGenerator.html +++ b/classes/_aws_amplify_schema_generator.SchemaGenerator.html @@ -1,4 +1,4 @@ SchemaGenerator | Amplify Toolbox

    Schema generator class.

    -

    Constructors

    Constructors

    Methods

    Constructors

    Methods

    \ No newline at end of file +

    Constructors

    Methods

    \ No newline at end of file diff --git a/enums/_aws_amplify_cli_core.LogLevel.html b/enums/_aws_amplify_cli_core.LogLevel.html index ee481bd965..e618523806 100644 --- a/enums/_aws_amplify_cli_core.LogLevel.html +++ b/enums/_aws_amplify_cli_core.LogLevel.html @@ -1,4 +1,4 @@ -LogLevel | Amplify Toolbox

    Enumeration Members

    DEBUG +LogLevel | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    DEBUG: 2
    ERROR: 0
    INFO: 1
    \ No newline at end of file +

    Enumeration Members

    DEBUG: 2
    ERROR: 0
    INFO: 1
    \ No newline at end of file diff --git a/enums/_aws_amplify_client_config.ClientConfigFileBaseName.html b/enums/_aws_amplify_client_config.ClientConfigFileBaseName.html index 8a5156b2a1..73aa9a510d 100644 --- a/enums/_aws_amplify_client_config.ClientConfigFileBaseName.html +++ b/enums/_aws_amplify_client_config.ClientConfigFileBaseName.html @@ -1,3 +1,3 @@ -ClientConfigFileBaseName | Amplify Toolbox

    Enumeration Members

    DEFAULT +ClientConfigFileBaseName | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    DEFAULT: "amplify_outputs"
    LEGACY: "amplifyconfiguration"
    \ No newline at end of file +

    Enumeration Members

    DEFAULT: "amplify_outputs"
    LEGACY: "amplifyconfiguration"
    \ No newline at end of file diff --git a/enums/_aws_amplify_client_config.ClientConfigFormat.html b/enums/_aws_amplify_client_config.ClientConfigFormat.html index eac023f5e2..439a69a98a 100644 --- a/enums/_aws_amplify_client_config.ClientConfigFormat.html +++ b/enums/_aws_amplify_client_config.ClientConfigFormat.html @@ -1,6 +1,6 @@ -ClientConfigFormat | Amplify Toolbox

    Enumeration Members

    DART +ClientConfigFormat | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    DART: "dart"
    JSON: "json"
    JSON_MOBILE: "json-mobile"
    MJS: "mjs"
    TS: "ts"
    \ No newline at end of file +

    Enumeration Members

    DART: "dart"
    JSON: "json"
    JSON_MOBILE: "json-mobile"
    MJS: "mjs"
    TS: "ts"
    \ No newline at end of file diff --git a/enums/_aws_amplify_client_config.ClientConfigVersionOption.html b/enums/_aws_amplify_client_config.ClientConfigVersionOption.html index c1e36b3646..d9b535f94d 100644 --- a/enums/_aws_amplify_client_config.ClientConfigVersionOption.html +++ b/enums/_aws_amplify_client_config.ClientConfigVersionOption.html @@ -1,6 +1,6 @@ -ClientConfigVersionOption | Amplify Toolbox

    Enumeration Members

    V0 +ClientConfigVersionOption | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    V0: "0"
    V1: "1"
    V1_1: "1.1"
    V1_2: "1.2"
    V1_3: "1.3"
    \ No newline at end of file +

    Enumeration Members

    V0: "0"
    V1: "1"
    V1_1: "1.1"
    V1_2: "1.2"
    V1_3: "1.3"
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.ApiAuthType.html b/enums/_aws_amplify_deployed_backend_client.ApiAuthType.html index 165c53d3a9..3ffb60b3f8 100644 --- a/enums/_aws_amplify_deployed_backend_client.ApiAuthType.html +++ b/enums/_aws_amplify_deployed_backend_client.ApiAuthType.html @@ -1,6 +1,6 @@ -ApiAuthType | Amplify Toolbox

    Enumeration Members

    AMAZON_COGNITO_USER_POOLS +ApiAuthType | Amplify Toolbox
    \ No newline at end of file +

    Enumeration Members

    AMAZON_COGNITO_USER_POOLS: "AMAZON_COGNITO_USER_POOLS"
    API_KEY: "API_KEY"
    AWS_IAM: "AWS_IAM"
    AWS_LAMBDA: "AWS_LAMBDA"
    OPENID_CONNECT: "OPENID_CONNECT"
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.BackendDeploymentStatus.html b/enums/_aws_amplify_deployed_backend_client.BackendDeploymentStatus.html index 6dea93a40b..967e15d478 100644 --- a/enums/_aws_amplify_deployed_backend_client.BackendDeploymentStatus.html +++ b/enums/_aws_amplify_deployed_backend_client.BackendDeploymentStatus.html @@ -1,7 +1,7 @@ -BackendDeploymentStatus | Amplify Toolbox

    Enumeration Members

    DELETED +BackendDeploymentStatus | Amplify Toolbox
    \ No newline at end of file +

    Enumeration Members

    DELETED: "DELETED"
    DELETING: "DELETING"
    DEPLOYED: "DEPLOYED"
    DEPLOYING: "DEPLOYING"
    FAILED: "FAILED"
    UNKNOWN: "UNKNOWN"
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.BackendOutputClientErrorType.html b/enums/_aws_amplify_deployed_backend_client.BackendOutputClientErrorType.html index f5a2da6275..ac7cf3f689 100644 --- a/enums/_aws_amplify_deployed_backend_client.BackendOutputClientErrorType.html +++ b/enums/_aws_amplify_deployed_backend_client.BackendOutputClientErrorType.html @@ -1,7 +1,7 @@ -BackendOutputClientErrorType | Amplify Toolbox

    Enumeration Members

    ACCESS_DENIED +BackendOutputClientErrorType | Amplify Toolbox

    Enumeration Members

    ACCESS_DENIED: "AccessDenied"
    CREDENTIALS_ERROR: "CredentialsError"
    DEPLOYMENT_IN_PROGRESS: "DeploymentInProgress"
    METADATA_RETRIEVAL_ERROR: "MetadataRetrievalError"
    NO_OUTPUTS_FOUND: "NoOutputsFound"
    NO_STACK_FOUND: "NoStackFound"
    \ No newline at end of file +

    Enumeration Members

    ACCESS_DENIED: "AccessDenied"
    CREDENTIALS_ERROR: "CredentialsError"
    DEPLOYMENT_IN_PROGRESS: "DeploymentInProgress"
    METADATA_RETRIEVAL_ERROR: "MetadataRetrievalError"
    NO_OUTPUTS_FOUND: "NoOutputsFound"
    NO_STACK_FOUND: "NoStackFound"
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.BackendStatus.html b/enums/_aws_amplify_deployed_backend_client.BackendStatus.html index 8ecdc2f4b2..a61a4472e3 100644 --- a/enums/_aws_amplify_deployed_backend_client.BackendStatus.html +++ b/enums/_aws_amplify_deployed_backend_client.BackendStatus.html @@ -1,2 +1,2 @@ -BackendStatus | Amplify Toolbox
    \ No newline at end of file +BackendStatus | Amplify Toolbox
    \ No newline at end of file diff --git a/enums/_aws_amplify_deployed_backend_client.ConflictResolutionMode.html b/enums/_aws_amplify_deployed_backend_client.ConflictResolutionMode.html index fb132beb39..aed8d470cd 100644 --- a/enums/_aws_amplify_deployed_backend_client.ConflictResolutionMode.html +++ b/enums/_aws_amplify_deployed_backend_client.ConflictResolutionMode.html @@ -1,4 +1,4 @@ -ConflictResolutionMode | Amplify Toolbox

    Enumeration Members

    AUTOMERGE +ConflictResolutionMode | Amplify Toolbox
    \ No newline at end of file +

    Enumeration Members

    AUTOMERGE: "AUTOMERGE"
    LAMBDA: "LAMBDA"
    OPTIMISTIC_CONCURRENCY: "OPTIMISTIC_CONCURRENCY"
    \ No newline at end of file diff --git a/enums/_aws_amplify_model_generator.GenerateApiCodeFormat.html b/enums/_aws_amplify_model_generator.GenerateApiCodeFormat.html index fa354307b7..41453622c7 100644 --- a/enums/_aws_amplify_model_generator.GenerateApiCodeFormat.html +++ b/enums/_aws_amplify_model_generator.GenerateApiCodeFormat.html @@ -1,4 +1,4 @@ -GenerateApiCodeFormat | Amplify Toolbox

    Enumeration Members

    GRAPHQL_CODEGEN +GenerateApiCodeFormat | Amplify Toolbox

    Enumeration Members

    GRAPHQL_CODEGEN: "graphql-codegen"
    INTROSPECTION: "introspection"
    MODELGEN: "modelgen"
    \ No newline at end of file +

    Enumeration Members

    GRAPHQL_CODEGEN: "graphql-codegen"
    INTROSPECTION: "introspection"
    MODELGEN: "modelgen"
    \ No newline at end of file diff --git a/enums/_aws_amplify_model_generator.GenerateApiCodeModelTarget.html b/enums/_aws_amplify_model_generator.GenerateApiCodeModelTarget.html index 0aab1b19e7..994f591e66 100644 --- a/enums/_aws_amplify_model_generator.GenerateApiCodeModelTarget.html +++ b/enums/_aws_amplify_model_generator.GenerateApiCodeModelTarget.html @@ -1,6 +1,6 @@ -GenerateApiCodeModelTarget | Amplify Toolbox

    Enumeration Members

    DART +GenerateApiCodeModelTarget | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    DART: "dart"
    JAVA: "java"
    JAVASCRIPT: "javascript"
    SWIFT: "swift"
    TYPESCRIPT: "typescript"
    \ No newline at end of file +

    Enumeration Members

    DART: "dart"
    JAVA: "java"
    JAVASCRIPT: "javascript"
    SWIFT: "swift"
    TYPESCRIPT: "typescript"
    \ No newline at end of file diff --git a/enums/_aws_amplify_model_generator.GenerateApiCodeStatementTarget.html b/enums/_aws_amplify_model_generator.GenerateApiCodeStatementTarget.html index 8603bad840..a46c0d2ba0 100644 --- a/enums/_aws_amplify_model_generator.GenerateApiCodeStatementTarget.html +++ b/enums/_aws_amplify_model_generator.GenerateApiCodeStatementTarget.html @@ -1,6 +1,6 @@ -GenerateApiCodeStatementTarget | Amplify Toolbox

    Enumeration Members

    ANGULAR +GenerateApiCodeStatementTarget | Amplify Toolbox

    Enumeration Members

    ANGULAR: "angular"
    FLOW: "flow"
    GRAPHQL: "graphql"
    JAVASCRIPT: "javascript"
    TYPESCRIPT: "typescript"
    \ No newline at end of file +

    Enumeration Members

    ANGULAR: "angular"
    FLOW: "flow"
    GRAPHQL: "graphql"
    JAVASCRIPT: "javascript"
    TYPESCRIPT: "typescript"
    \ No newline at end of file diff --git a/enums/_aws_amplify_model_generator.GenerateApiCodeTypeTarget.html b/enums/_aws_amplify_model_generator.GenerateApiCodeTypeTarget.html index da795bce6e..5eb4da6984 100644 --- a/enums/_aws_amplify_model_generator.GenerateApiCodeTypeTarget.html +++ b/enums/_aws_amplify_model_generator.GenerateApiCodeTypeTarget.html @@ -1,8 +1,8 @@ -GenerateApiCodeTypeTarget | Amplify Toolbox

    Enumeration Members

    ANGULAR +GenerateApiCodeTypeTarget | Amplify Toolbox

    Enumeration Members

    ANGULAR: "angular"
    FLOW: "flow"
    FLOW_MODERN: "flow-modern"
    JSON: "json"
    SCALA: "scala"
    SWIFT: "swift"
    TYPESCRIPT: "typescript"
    \ No newline at end of file +

    Enumeration Members

    ANGULAR: "angular"
    FLOW: "flow"
    FLOW_MODERN: "flow-modern"
    JSON: "json"
    SCALA: "scala"
    SWIFT: "swift"
    TYPESCRIPT: "typescript"
    \ No newline at end of file diff --git a/enums/_aws_amplify_platform_core.CDKContextKey.html b/enums/_aws_amplify_platform_core.CDKContextKey.html index 708bb7b706..e9a206e174 100644 --- a/enums/_aws_amplify_platform_core.CDKContextKey.html +++ b/enums/_aws_amplify_platform_core.CDKContextKey.html @@ -1,7 +1,7 @@ CDKContextKey | Amplify Toolbox

    Keys for values that are passed between the Amplify deployment engine and the CDK synth process via CDK Context

    !!!WARNING!!! Changing the values of these keys could be a breaking change

    -

    Enumeration Members

    Enumeration Members

    BACKEND_NAME: "amplify-backend-name"
    BACKEND_NAMESPACE: "amplify-backend-namespace"
    DEPLOYMENT_TYPE: "amplify-backend-type"
    \ No newline at end of file +

    Enumeration Members

    BACKEND_NAME: "amplify-backend-name"
    BACKEND_NAMESPACE: "amplify-backend-namespace"
    DEPLOYMENT_TYPE: "amplify-backend-type"
    \ No newline at end of file diff --git a/enums/_aws_amplify_platform_core.TagName.html b/enums/_aws_amplify_platform_core.TagName.html index bb91886d65..9ae22a9204 100644 --- a/enums/_aws_amplify_platform_core.TagName.html +++ b/enums/_aws_amplify_platform_core.TagName.html @@ -1,2 +1,2 @@ -TagName | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    FRIENDLY_NAME: "amplify:friendly-name"
    \ No newline at end of file +TagName | Amplify Toolbox

    Enumeration Members

    Enumeration Members

    FRIENDLY_NAME: "amplify:friendly-name"
    \ No newline at end of file diff --git a/functions/_aws_amplify_backend.defineBackend.html b/functions/_aws_amplify_backend.defineBackend.html index 5fd834cd2d..d320b9bc14 100644 --- a/functions/_aws_amplify_backend.defineBackend.html +++ b/functions/_aws_amplify_backend.defineBackend.html @@ -1,3 +1,3 @@ defineBackend | Amplify Toolbox
    \ No newline at end of file +

    Returns Backend<T>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend.secret.html b/functions/_aws_amplify_backend.secret.html index 6aa8bf5a70..3784745ee7 100644 --- a/functions/_aws_amplify_backend.secret.html +++ b/functions/_aws_amplify_backend.secret.html @@ -9,4 +9,4 @@

    Example: Using a secret

             defineAuth({
    loginWith: {
    email: {},
    externalProviders: {
    loginWithAmazon: {
    clientId: secret('LOGIN_WITH_AMAZON_CLIENT_ID'),
    clientSecret: secret('LOGIN_WITH_AMAZON_CLIENT_SECRET'),
    },
    },
    },
    })
    ```
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_auth.defineAuth.html b/functions/_aws_amplify_backend_auth.defineAuth.html index 74d73302ba..6229fde6f2 100644 --- a/functions/_aws_amplify_backend_auth.defineAuth.html +++ b/functions/_aws_amplify_backend_auth.defineAuth.html @@ -31,4 +31,4 @@

    Example

    access<
     
  • Optional userAttributes?: UserAttributes

    The set of attributes that are required for every user in the user pool. Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

    Default

    - email/phone will be added as required user attributes if they are included as login methods
     
    -
  • Returns ConstructFactory<BackendAuth>

    \ No newline at end of file +

    Returns ConstructFactory<BackendAuth>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_auth.referenceAuth.html b/functions/_aws_amplify_backend_auth.referenceAuth.html index e85d794b53..26cc87bb4e 100644 --- a/functions/_aws_amplify_backend_auth.referenceAuth.html +++ b/functions/_aws_amplify_backend_auth.referenceAuth.html @@ -12,4 +12,4 @@

    Example

    access<
     
  • unauthRoleArn: string

    Existing UnauthRole ARN

  • userPoolClientId: string

    Existing UserPoolClient Id

  • userPoolId: string

    Existing UserPool Id

    -
  • Returns ConstructFactory<BackendReferenceAuth>

    \ No newline at end of file +

    Returns ConstructFactory<BackendReferenceAuth>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_data.defineData.html b/functions/_aws_amplify_backend_data.defineData.html index 455d427965..3294ef1a2c 100644 --- a/functions/_aws_amplify_backend_data.defineData.html +++ b/functions/_aws_amplify_backend_data.defineData.html @@ -1,2 +1,2 @@ defineData | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns ConstructFactory<AmplifyGraphqlApi>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_function.defineFunction.html b/functions/_aws_amplify_backend_function.defineFunction.html index fdec167400..ed4f3e99f5 100644 --- a/functions/_aws_amplify_backend_function.defineFunction.html +++ b/functions/_aws_amplify_backend_function.defineFunction.html @@ -1,2 +1,2 @@ defineFunction | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns ConstructFactory<ResourceProvider<FunctionResources> & ResourceAccessAcceptorFactory & AddEnvironmentFactory & StackProvider>

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_secret.getSecretClient.html b/functions/_aws_amplify_backend_secret.getSecretClient.html index 635099f727..c19a41b526 100644 --- a/functions/_aws_amplify_backend_secret.getSecretClient.html +++ b/functions/_aws_amplify_backend_secret.getSecretClient.html @@ -1,2 +1,2 @@ getSecretClient | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns SecretClient

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_secret.getSecretClientWithAmplifyErrorHandling.html b/functions/_aws_amplify_backend_secret.getSecretClientWithAmplifyErrorHandling.html index 88d1cbff3a..380f22e58e 100644 --- a/functions/_aws_amplify_backend_secret.getSecretClientWithAmplifyErrorHandling.html +++ b/functions/_aws_amplify_backend_secret.getSecretClientWithAmplifyErrorHandling.html @@ -1,3 +1,3 @@ getSecretClientWithAmplifyErrorHandling | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns SecretClient

    \ No newline at end of file diff --git a/functions/_aws_amplify_backend_storage.defineStorage.html b/functions/_aws_amplify_backend_storage.defineStorage.html index 9ae6011d11..8fff306861 100644 --- a/functions/_aws_amplify_backend_storage.defineStorage.html +++ b/functions/_aws_amplify_backend_storage.defineStorage.html @@ -1,3 +1,3 @@ defineStorage | Amplify Toolbox
    \ No newline at end of file +
    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.generateClientConfig.html b/functions/_aws_amplify_client_config.generateClientConfig.html index 97c26f5ca5..564f4bb816 100644 --- a/functions/_aws_amplify_client_config.generateClientConfig.html +++ b/functions/_aws_amplify_client_config.generateClientConfig.html @@ -1,2 +1,2 @@ generateClientConfig | Amplify Toolbox
    \ No newline at end of file +

    Type Parameters

    • T extends "1" | "1.1" | "1.2" | "1.3" | "0"

    Parameters

    • backendIdentifier: DeployedBackendIdentifier
    • version: T
    • Optional awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>

    Returns Promise<ClientConfigVersionTemplateType<T>>

    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.generateClientConfigToFile.html b/functions/_aws_amplify_client_config.generateClientConfigToFile.html index ee0c071c49..dfe10140a2 100644 --- a/functions/_aws_amplify_client_config.generateClientConfigToFile.html +++ b/functions/_aws_amplify_client_config.generateClientConfigToFile.html @@ -1,2 +1,2 @@ generateClientConfigToFile | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    • backendIdentifier: DeployedBackendIdentifier
    • version: "1" | "1.1" | "1.2" | "1.3" | "0"
    • Optional outDir: string
    • Optional format: ClientConfigFormat
    • Optional awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>

    Returns Promise<GenerateClientConfigToFileResult>

    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.generateEmptyClientConfigToFile.html b/functions/_aws_amplify_client_config.generateEmptyClientConfigToFile.html index 03c2a187a6..7b86a01fcd 100644 --- a/functions/_aws_amplify_client_config.generateEmptyClientConfigToFile.html +++ b/functions/_aws_amplify_client_config.generateEmptyClientConfigToFile.html @@ -1,2 +1,2 @@ generateEmptyClientConfigToFile | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    • version: "1" | "1.1" | "1.2" | "1.3" | "0"
    • Optional outDir: string
    • Optional format: ClientConfigFormat

    Returns Promise<GenerateClientConfigToFileResult>

    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.getClientConfigFileName.html b/functions/_aws_amplify_client_config.getClientConfigFileName.html index e0cc06bc7b..a735a95df6 100644 --- a/functions/_aws_amplify_client_config.getClientConfigFileName.html +++ b/functions/_aws_amplify_client_config.getClientConfigFileName.html @@ -1,2 +1,2 @@ getClientConfigFileName | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    • version: "1" | "1.1" | "1.2" | "1.3" | "0"

    Returns ClientConfigFileBaseName

    \ No newline at end of file diff --git a/functions/_aws_amplify_client_config.getClientConfigPath.html b/functions/_aws_amplify_client_config.getClientConfigPath.html index 4d9a80b604..374c493de6 100644 --- a/functions/_aws_amplify_client_config.getClientConfigPath.html +++ b/functions/_aws_amplify_client_config.getClientConfigPath.html @@ -3,4 +3,4 @@
  • Optional outDir: string

    path to directory where config is written. If not provided defaults to current process working directory.

  • Optional format: ClientConfigFormat

    The format which the configuration should be exported into. Defaults to JSON. returns path to config file

    -
  • Returns Promise<string>

    \ No newline at end of file +

    Returns Promise<string>

    \ No newline at end of file diff --git a/functions/_aws_amplify_form_generator.createLocalGraphqlFormGenerator.html b/functions/_aws_amplify_form_generator.createLocalGraphqlFormGenerator.html index d24854f3cb..18d4691d6e 100644 --- a/functions/_aws_amplify_form_generator.createLocalGraphqlFormGenerator.html +++ b/functions/_aws_amplify_form_generator.createLocalGraphqlFormGenerator.html @@ -1,2 +1,2 @@ createLocalGraphqlFormGenerator | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns GraphqlFormGenerator

    \ No newline at end of file diff --git a/functions/_aws_amplify_model_generator.createGraphqlDocumentGenerator.html b/functions/_aws_amplify_model_generator.createGraphqlDocumentGenerator.html index 83e4e81082..23208ef285 100644 --- a/functions/_aws_amplify_model_generator.createGraphqlDocumentGenerator.html +++ b/functions/_aws_amplify_model_generator.createGraphqlDocumentGenerator.html @@ -1,2 +1,2 @@ createGraphqlDocumentGenerator | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns GraphqlDocumentGenerator

    \ No newline at end of file diff --git a/functions/_aws_amplify_model_generator.createGraphqlModelsGenerator.html b/functions/_aws_amplify_model_generator.createGraphqlModelsGenerator.html index 820c0e5348..7c64d78823 100644 --- a/functions/_aws_amplify_model_generator.createGraphqlModelsGenerator.html +++ b/functions/_aws_amplify_model_generator.createGraphqlModelsGenerator.html @@ -1,2 +1,2 @@ createGraphqlModelsGenerator | Amplify Toolbox
    \ No newline at end of file +

    Returns GraphqlModelsGenerator

    \ No newline at end of file diff --git a/functions/_aws_amplify_model_generator.generateApiCode.html b/functions/_aws_amplify_model_generator.generateApiCode.html index 811ad8c33b..959569c197 100644 --- a/functions/_aws_amplify_model_generator.generateApiCode.html +++ b/functions/_aws_amplify_model_generator.generateApiCode.html @@ -1,2 +1,2 @@ generateApiCode | Amplify Toolbox
    \ No newline at end of file +

    Parameters

    Returns Promise<GenerationResult>

    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AWSAmplifyBackendOutputs.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AWSAmplifyBackendOutputs.html index 9a360056c6..5a4a815aef 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AWSAmplifyBackendOutputs.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AWSAmplifyBackendOutputs.html @@ -1,5 +1,5 @@ AWSAmplifyBackendOutputs | Amplify Toolbox

    Config format for Amplify Gen 2 client libraries to communicate with backend services.

    -
    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
        };
        version: "1";
    }

    Properties

    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
        };
        version: "1";
    }

    Properties

    Properties

    analytics?: {
        amazon_pinpoint?: {
            app_id: string;
            aws_region: string;
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • Optional amazon_pinpoint?: {
          app_id: string;
          aws_region: string;
      }
      • app_id: string
      • aws_region: string

        AWS Region of Amazon Pinpoint resources

        -
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    +
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    Type declaration

    • aws_region: string

      AWS Region of Amazon Cognito resources

    • Optional identity_pool_id?: string

      Cognito Identity Pool ID

    • Optional mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"
    • Optional mfa_methods?: ("SMS" | "TOTP")[]
    • Optional oauth?: {
          domain: string;
          identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
          redirect_sign_in_uri: string[];
          redirect_sign_out_uri: string[];
          response_type: "code" | "token";
          scopes: string[];
      }
      • domain: string

        Domain used for identity providers

        @@ -27,17 +27,17 @@
      • user_pool_id: string

        Cognito User Pool ID

      • Optional user_verification_types?: ("email" | "phone_number")[]
      • Optional username_attributes?: ("email" | "phone_number" | "username")[]

        Cognito User Pool username attributes

        Min Items

        1

        -
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    -

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    +
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    +

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    Type declaration

    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    +
    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • aws_region: string

      AWS Region of Amazon Location Service resources

    • Optional geofence_collections?: {
          default: string;
          items: string[];
      }

      Geofencing (visualize virtual perimeters)

      • default: string
      • items: string[]
    • Optional maps?: {
          default: string;
          items: {
              [k: string]: clientConfigTypesV1.AmazonLocationServiceConfig;
          };
      }

      Maps from Amazon Location Service

    • Optional search_indices?: {
          default: string;
          items: string[];
      }

      Location search (search by places, addresses, coordinates)

      -
      • default: string
      • items: string[]
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    +
    • default: string
    • items: string[]
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    storage?: {
        aws_region: string;
        bucket_name: string;
    }

    Outputs generated from defineStorage

    -

    Type declaration

    • aws_region: string
    • bucket_name: string
    version: "1"

    Version of this schema

    -
    \ No newline at end of file +
    storage?: {
        aws_region: string;
        bucket_name: string;
    }

    Outputs generated from defineStorage

    +

    Type declaration

    • aws_region: string
    • bucket_name: string
    version: "1"

    Version of this schema

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AmazonLocationServiceConfig.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AmazonLocationServiceConfig.html index ad4a474c43..6a5b70c314 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AmazonLocationServiceConfig.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1.AmazonLocationServiceConfig.html @@ -1,7 +1,7 @@ AmazonLocationServiceConfig | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    Properties

    name?: string

    Map resource name

    -
    style?: string

    Map style

    -
    \ No newline at end of file +
    style?: string

    Map style

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AWSAmplifyBackendOutputs.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AWSAmplifyBackendOutputs.html index b9bffedf50..fa4d053a5e 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AWSAmplifyBackendOutputs.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AWSAmplifyBackendOutputs.html @@ -1,5 +1,5 @@ AWSAmplifyBackendOutputs | Amplify Toolbox

    Config format for Amplify Gen 2 client libraries to communicate with backend services.

    -
    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1_1.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1_1.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1_1.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1_1.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
            buckets?: clientConfigTypesV1_1.AmplifyStorageBucket[];
        };
        version: "1.1";
    }

    Properties

    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1_1.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1_1.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1_1.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1_1.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
            buckets?: clientConfigTypesV1_1.AmplifyStorageBucket[];
        };
        version: "1.1";
    }

    Properties

    Properties

    analytics?: {
        amazon_pinpoint?: {
            app_id: string;
            aws_region: string;
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • Optional amazon_pinpoint?: {
          app_id: string;
          aws_region: string;
      }
      • app_id: string
      • aws_region: string

        AWS Region of Amazon Pinpoint resources

        -
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_1.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    +
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_1.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    Type declaration

    • aws_region: string

      AWS Region of Amazon Cognito resources

    • Optional identity_pool_id?: string

      Cognito Identity Pool ID

    • Optional mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"
    • Optional mfa_methods?: ("SMS" | "TOTP")[]
    • Optional oauth?: {
          domain: string;
          identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
          redirect_sign_in_uri: string[];
          redirect_sign_out_uri: string[];
          response_type: "code" | "token";
          scopes: string[];
      }
      • domain: string

        Domain used for identity providers

        @@ -27,17 +27,17 @@
      • user_pool_id: string

        Cognito User Pool ID

      • Optional user_verification_types?: ("email" | "phone_number")[]
      • Optional username_attributes?: ("email" | "phone_number" | "username")[]

        Cognito User Pool username attributes

        Min Items

        1

        -
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    -

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_1.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_1.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    +
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    +

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_1.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_1.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    Type declaration

    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    +
    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • aws_region: string

      AWS Region of Amazon Location Service resources

    • Optional geofence_collections?: {
          default: string;
          items: string[];
      }

      Geofencing (visualize virtual perimeters)

      • default: string
      • items: string[]
    • Optional maps?: {
          default: string;
          items: {
              [k: string]: clientConfigTypesV1_1.AmazonLocationServiceConfig;
          };
      }

      Maps from Amazon Location Service

    • Optional search_indices?: {
          default: string;
          items: string[];
      }

      Location search (search by places, addresses, coordinates)

      -
      • default: string
      • items: string[]
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_1.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    +
    • default: string
    • items: string[]
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_1.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: clientConfigTypesV1_1.AmplifyStorageBucket[];
    }

    Outputs generated from defineStorage

    -

    Type declaration

    version: "1.1"

    Version of this schema

    -
    \ No newline at end of file +
    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: clientConfigTypesV1_1.AmplifyStorageBucket[];
    }

    Outputs generated from defineStorage

    +

    Type declaration

    version: "1.1"

    Version of this schema

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonLocationServiceConfig.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonLocationServiceConfig.html index 9cfe777ea6..be5738ad38 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonLocationServiceConfig.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonLocationServiceConfig.html @@ -1,7 +1,7 @@ AmazonLocationServiceConfig | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    Properties

    name?: string

    Map resource name

    -
    style?: string

    Map style

    -
    \ No newline at end of file +
    style?: string

    Map style

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmplifyStorageBucket.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmplifyStorageBucket.html index ebad089a07..b97a766a00 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmplifyStorageBucket.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_1.AmplifyStorageBucket.html @@ -1,4 +1,4 @@ -AmplifyStorageBucket | Amplify Toolbox
    interface AmplifyStorageBucket {
        aws_region: string;
        bucket_name: string;
        name: string;
    }

    Properties

    aws_region +AmplifyStorageBucket | Amplify Toolbox
    interface AmplifyStorageBucket {
        aws_region: string;
        bucket_name: string;
        name: string;
    }

    Properties

    aws_region: string
    bucket_name: string
    name: string
    \ No newline at end of file +

    Properties

    aws_region: string
    bucket_name: string
    name: string
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AWSAmplifyBackendOutputs.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AWSAmplifyBackendOutputs.html index e3090edc02..fa2d49e3f3 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AWSAmplifyBackendOutputs.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AWSAmplifyBackendOutputs.html @@ -1,5 +1,5 @@ AWSAmplifyBackendOutputs | Amplify Toolbox

    Config format for Amplify Gen 2 client libraries to communicate with backend services.

    -
    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1_2.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1_2.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1_2.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1_2.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1_2.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
            buckets?: clientConfigTypesV1_2.AmplifyStorageBucket[];
        };
        version: "1.2";
    }

    Properties

    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1_2.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1_2.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1_2.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1_2.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1_2.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
            buckets?: clientConfigTypesV1_2.AmplifyStorageBucket[];
        };
        version: "1.2";
    }

    Properties

    Properties

    analytics?: {
        amazon_pinpoint?: {
            app_id: string;
            aws_region: string;
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • Optional amazon_pinpoint?: {
          app_id: string;
          aws_region: string;
      }
      • app_id: string
      • aws_region: string

        AWS Region of Amazon Pinpoint resources

        -
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_2.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    +
    auth?: {
        aws_region: string;
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_2.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    Type declaration

    • aws_region: string

      AWS Region of Amazon Cognito resources

    • Optional identity_pool_id?: string

      Cognito Identity Pool ID

    • Optional mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"
    • Optional mfa_methods?: ("SMS" | "TOTP")[]
    • Optional oauth?: {
          domain: string;
          identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
          redirect_sign_in_uri: string[];
          redirect_sign_out_uri: string[];
          response_type: "code" | "token";
          scopes: string[];
      }
      • domain: string

        Domain used for identity providers

        @@ -27,19 +27,19 @@
      • user_pool_id: string

        Cognito User Pool ID

      • Optional user_verification_types?: ("email" | "phone_number")[]
      • Optional username_attributes?: ("email" | "phone_number" | "username")[]

        Cognito User Pool username attributes

        Min Items

        1

        -
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    -

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_2.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_2.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    +
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    +

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_2.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_2.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    Type declaration

    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1_2.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    +
    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1_2.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • aws_region: string

      AWS Region of Amazon Location Service resources

    • Optional geofence_collections?: {
          default: string;
          items: string[];
      }

      Geofencing (visualize virtual perimeters)

      • default: string
      • items: string[]

        Min Items

        1

    • Optional maps?: {
          default: string;
          items: {
              [k: string]: clientConfigTypesV1_2.AmazonLocationServiceConfig;
          };
      }

      Maps from Amazon Location Service

    • Optional search_indices?: {
          default: string;
          items: string[];
      }

      Location search (search by places, addresses, coordinates)

      • default: string
      • items: string[]

        Min Items

        1

        -
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_2.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    +
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_2.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: clientConfigTypesV1_2.AmplifyStorageBucket[];
    }

    Outputs generated from defineStorage

    -

    Type declaration

    version: "1.2"

    Version of this schema

    -
    \ No newline at end of file +
    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: clientConfigTypesV1_2.AmplifyStorageBucket[];
    }

    Outputs generated from defineStorage

    +

    Type declaration

    version: "1.2"

    Version of this schema

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonLocationServiceConfig.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonLocationServiceConfig.html index 7a43f15b8c..2f3fbf6a78 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonLocationServiceConfig.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonLocationServiceConfig.html @@ -1,7 +1,7 @@ AmazonLocationServiceConfig | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    Properties

    name?: string

    Map resource name

    -
    style?: string

    Map style

    -
    \ No newline at end of file +
    style?: string

    Map style

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageAccessRule.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageAccessRule.html index b189bd8245..e7d0f81c25 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageAccessRule.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageAccessRule.html @@ -1,8 +1,8 @@ AmplifyStorageAccessRule | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    \ No newline at end of file +

    Properties

    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageBucket.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageBucket.html index d1784a9782..5aa0f82585 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageBucket.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageBucket.html @@ -1,5 +1,5 @@ -AmplifyStorageBucket | Amplify Toolbox
    interface AmplifyStorageBucket {
        aws_region: string;
        bucket_name: string;
        name: string;
        paths?: {
            [k: string]: clientConfigTypesV1_2.AmplifyStorageAccessRule;
        };
    }

    Properties

    aws_region +AmplifyStorageBucket | Amplify Toolbox
    interface AmplifyStorageBucket {
        aws_region: string;
        bucket_name: string;
        name: string;
        paths?: {
            [k: string]: clientConfigTypesV1_2.AmplifyStorageAccessRule;
        };
    }

    Properties

    aws_region: string
    bucket_name: string
    name: string
    paths?: {
        [k: string]: clientConfigTypesV1_2.AmplifyStorageAccessRule;
    }

    Type declaration

    \ No newline at end of file +

    Properties

    aws_region: string
    bucket_name: string
    name: string
    paths?: {
        [k: string]: clientConfigTypesV1_2.AmplifyStorageAccessRule;
    }

    Type declaration

    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AWSAmplifyBackendOutputs.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AWSAmplifyBackendOutputs.html index e04ac38a99..1a824d15ce 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AWSAmplifyBackendOutputs.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AWSAmplifyBackendOutputs.html @@ -1,5 +1,5 @@ AWSAmplifyBackendOutputs | Amplify Toolbox

    Config format for Amplify Gen 2 client libraries to communicate with backend services.

    -
    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            groups?: {
                [k: string]: AmplifyUserGroupConfig;
            }[];
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1_3.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1_3.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1_3.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1_3.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1_3.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
            buckets?: clientConfigTypesV1_3.AmplifyStorageBucket[];
        };
        version: "1.3";
    }

    Properties

    interface AWSAmplifyBackendOutputs {
        analytics?: {
            amazon_pinpoint?: {
                app_id: string;
                aws_region: string;
            };
        };
        auth?: {
            aws_region: string;
            groups?: {
                [k: string]: AmplifyUserGroupConfig;
            }[];
            identity_pool_id?: string;
            mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
            mfa_methods?: ("SMS" | "TOTP")[];
            oauth?: {
                domain: string;
                identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
                redirect_sign_in_uri: string[];
                redirect_sign_out_uri: string[];
                response_type: "code" | "token";
                scopes: string[];
            };
            password_policy?: {
                min_length: number;
                require_lowercase: boolean;
                require_numbers: boolean;
                require_symbols: boolean;
                require_uppercase: boolean;
            };
            standard_required_attributes?: clientConfigTypesV1_3.AmazonCognitoStandardAttributes[];
            unauthenticated_identities_enabled?: boolean;
            user_pool_client_id: string;
            user_pool_id: string;
            user_verification_types?: ("email" | "phone_number")[];
            username_attributes?: ("email" | "phone_number" | "username")[];
        };
        custom?: {
            [k: string]: unknown;
        };
        data?: {
            api_key?: string;
            authorization_types: clientConfigTypesV1_3.AwsAppsyncAuthorizationType[];
            aws_region: string;
            default_authorization_type: clientConfigTypesV1_3.AwsAppsyncAuthorizationType;
            model_introspection?: {
                [k: string]: unknown;
            };
            url: string;
        };
        geo?: {
            aws_region: string;
            geofence_collections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: {
                    [k: string]: clientConfigTypesV1_3.AmazonLocationServiceConfig;
                };
            };
            search_indices?: {
                default: string;
                items: string[];
            };
        };
        notifications?: {
            amazon_pinpoint_app_id: string;
            aws_region: string;
            channels: clientConfigTypesV1_3.AmazonPinpointChannels[];
        };
        storage?: {
            aws_region: string;
            bucket_name: string;
            buckets?: clientConfigTypesV1_3.AmplifyStorageBucket[];
        };
        version: "1.3";
    }

    Properties

    Properties

    analytics?: {
        amazon_pinpoint?: {
            app_id: string;
            aws_region: string;
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • Optional amazon_pinpoint?: {
          app_id: string;
          aws_region: string;
      }
      • app_id: string
      • aws_region: string

        AWS Region of Amazon Pinpoint resources

        -
    auth?: {
        aws_region: string;
        groups?: {
            [k: string]: AmplifyUserGroupConfig;
        }[];
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_3.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    +
    auth?: {
        aws_region: string;
        groups?: {
            [k: string]: AmplifyUserGroupConfig;
        }[];
        identity_pool_id?: string;
        mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED";
        mfa_methods?: ("SMS" | "TOTP")[];
        oauth?: {
            domain: string;
            identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
            redirect_sign_in_uri: string[];
            redirect_sign_out_uri: string[];
            response_type: "code" | "token";
            scopes: string[];
        };
        password_policy?: {
            min_length: number;
            require_lowercase: boolean;
            require_numbers: boolean;
            require_symbols: boolean;
            require_uppercase: boolean;
        };
        standard_required_attributes?: clientConfigTypesV1_3.AmazonCognitoStandardAttributes[];
        unauthenticated_identities_enabled?: boolean;
        user_pool_client_id: string;
        user_pool_id: string;
        user_verification_types?: ("email" | "phone_number")[];
        username_attributes?: ("email" | "phone_number" | "username")[];
    }

    Outputs generated from defineAuth

    Type declaration

    • aws_region: string

      AWS Region of Amazon Cognito resources

    • Optional groups?: {
          [k: string]: AmplifyUserGroupConfig;
      }[]
    • Optional identity_pool_id?: string

      Cognito Identity Pool ID

    • Optional mfa_configuration?: "NONE" | "OPTIONAL" | "REQUIRED"
    • Optional mfa_methods?: ("SMS" | "TOTP")[]
    • Optional oauth?: {
          domain: string;
          identity_providers: ("GOOGLE" | "FACEBOOK" | "LOGIN_WITH_AMAZON" | "SIGN_IN_WITH_APPLE")[];
          redirect_sign_in_uri: string[];
          redirect_sign_out_uri: string[];
          response_type: "code" | "token";
          scopes: string[];
      }
      • domain: string

        Domain used for identity providers

        @@ -27,19 +27,19 @@
      • user_pool_id: string

        Cognito User Pool ID

      • Optional user_verification_types?: ("email" | "phone_number")[]
      • Optional username_attributes?: ("email" | "phone_number" | "username")[]

        Cognito User Pool username attributes

        Min Items

        1

        -
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    -

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_3.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_3.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    +
    custom?: {
        [k: string]: unknown;
    }

    Outputs generated from backend.addOutput({ custom: })

    +

    Type declaration

    • [k: string]: unknown
    data?: {
        api_key?: string;
        authorization_types: clientConfigTypesV1_3.AwsAppsyncAuthorizationType[];
        aws_region: string;
        default_authorization_type: clientConfigTypesV1_3.AwsAppsyncAuthorizationType;
        model_introspection?: {
            [k: string]: unknown;
        };
        url: string;
    }

    Outputs generated from defineData

    Type declaration

    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1_3.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    +
    geo?: {
        aws_region: string;
        geofence_collections?: {
            default: string;
            items: string[];
        };
        maps?: {
            default: string;
            items: {
                [k: string]: clientConfigTypesV1_3.AmazonLocationServiceConfig;
            };
        };
        search_indices?: {
            default: string;
            items: string[];
        };
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    • aws_region: string

      AWS Region of Amazon Location Service resources

    • Optional geofence_collections?: {
          default: string;
          items: string[];
      }

      Geofencing (visualize virtual perimeters)

      • default: string
      • items: string[]

        Min Items

        1

    • Optional maps?: {
          default: string;
          items: {
              [k: string]: clientConfigTypesV1_3.AmazonLocationServiceConfig;
          };
      }

      Maps from Amazon Location Service

    • Optional search_indices?: {
          default: string;
          items: string[];
      }

      Location search (search by places, addresses, coordinates)

      • default: string
      • items: string[]

        Min Items

        1

        -
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_3.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    +
    notifications?: {
        amazon_pinpoint_app_id: string;
        aws_region: string;
        channels: clientConfigTypesV1_3.AmazonPinpointChannels[];
    }

    Outputs manually specified by developers for use with frontend library

    Type declaration

    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: clientConfigTypesV1_3.AmplifyStorageBucket[];
    }

    Outputs generated from defineStorage

    -

    Type declaration

    version: "1.3"

    Version of this schema

    -
    \ No newline at end of file +
    storage?: {
        aws_region: string;
        bucket_name: string;
        buckets?: clientConfigTypesV1_3.AmplifyStorageBucket[];
    }

    Outputs generated from defineStorage

    +

    Type declaration

    version: "1.3"

    Version of this schema

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonLocationServiceConfig.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonLocationServiceConfig.html index b3defef79e..57f6fe2288 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonLocationServiceConfig.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonLocationServiceConfig.html @@ -1,7 +1,7 @@ AmazonLocationServiceConfig | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    interface AmazonLocationServiceConfig {
        name?: string;
        style?: string;
    }

    Properties

    Properties

    name?: string

    Map resource name

    -
    style?: string

    Map style

    -
    \ No newline at end of file +
    style?: string

    Map style

    +
    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageAccessRule.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageAccessRule.html index 7f757ecbe9..840189af84 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageAccessRule.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageAccessRule.html @@ -1,8 +1,8 @@ AmplifyStorageAccessRule | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    \ No newline at end of file +

    Properties

    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageBucket.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageBucket.html index dbcc3d65cf..38525a938d 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageBucket.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageBucket.html @@ -1,5 +1,5 @@ -AmplifyStorageBucket | Amplify Toolbox
    interface AmplifyStorageBucket {
        aws_region: string;
        bucket_name: string;
        name: string;
        paths?: {
            [k: string]: clientConfigTypesV1_3.AmplifyStorageAccessRule;
        };
    }

    Properties

    aws_region +AmplifyStorageBucket | Amplify Toolbox
    interface AmplifyStorageBucket {
        aws_region: string;
        bucket_name: string;
        name: string;
        paths?: {
            [k: string]: clientConfigTypesV1_3.AmplifyStorageAccessRule;
        };
    }

    Properties

    aws_region: string
    bucket_name: string
    name: string
    paths?: {
        [k: string]: clientConfigTypesV1_3.AmplifyStorageAccessRule;
    }

    Type declaration

    \ No newline at end of file +

    Properties

    aws_region: string
    bucket_name: string
    name: string
    paths?: {
        [k: string]: clientConfigTypesV1_3.AmplifyStorageAccessRule;
    }

    Type declaration

    \ No newline at end of file diff --git a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyUserGroupConfig.html b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyUserGroupConfig.html index 622164c866..8aab857533 100644 --- a/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyUserGroupConfig.html +++ b/interfaces/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyUserGroupConfig.html @@ -1,4 +1,4 @@ AmplifyUserGroupConfig | Amplify Toolbox

    This interface was referenced by undefined's JSON-Schema definition via the patternProperty ".*".

    -
    interface AmplifyUserGroupConfig {
        precedence?: number;
    }

    Properties

    Properties

    precedence?: number
    \ No newline at end of file +
    interface AmplifyUserGroupConfig {
        precedence?: number;
    }

    Properties

    Properties

    precedence?: number
    \ No newline at end of file diff --git a/modules/_aws_amplify_ai_constructs.conversation.html b/modules/_aws_amplify_ai_constructs.conversation.html index 8f4508d6ac..209794e3e0 100644 --- a/modules/_aws_amplify_ai_constructs.conversation.html +++ b/modules/_aws_amplify_ai_constructs.conversation.html @@ -1,4 +1,4 @@ -conversation | Amplify Toolbox

    Index

    Classes

    ConversationHandlerFunction +conversation | Amplify Toolbox
    \ No newline at end of file diff --git a/modules/_aws_amplify_client_config.clientConfigTypesV1.html b/modules/_aws_amplify_client_config.clientConfigTypesV1.html index 9ff9a6f6fe..d97df569c9 100644 --- a/modules/_aws_amplify_client_config.clientConfigTypesV1.html +++ b/modules/_aws_amplify_client_config.clientConfigTypesV1.html @@ -1,4 +1,4 @@ -clientConfigTypesV1 | Amplify Toolbox

    Index

    Interfaces

    AWSAmplifyBackendOutputs +clientConfigTypesV1 | Amplify Toolbox

    Index

    Interfaces

    Type Aliases

    AmazonCognitoStandardAttributes AmazonPinpointChannels diff --git a/modules/_aws_amplify_client_config.clientConfigTypesV1_1.html b/modules/_aws_amplify_client_config.clientConfigTypesV1_1.html index 0796b70f2d..905e37d3cc 100644 --- a/modules/_aws_amplify_client_config.clientConfigTypesV1_1.html +++ b/modules/_aws_amplify_client_config.clientConfigTypesV1_1.html @@ -1,4 +1,4 @@ -clientConfigTypesV1_1 | Amplify Toolbox

    Index

    Interfaces

    AWSAmplifyBackendOutputs +clientConfigTypesV1_1 | Amplify Toolbox

    Index

    Interfaces

    Type Aliases

    AmazonCognitoStandardAttributes diff --git a/modules/_aws_amplify_client_config.clientConfigTypesV1_2.html b/modules/_aws_amplify_client_config.clientConfigTypesV1_2.html index 0c29f47a99..fe5449de60 100644 --- a/modules/_aws_amplify_client_config.clientConfigTypesV1_2.html +++ b/modules/_aws_amplify_client_config.clientConfigTypesV1_2.html @@ -1,4 +1,4 @@ -clientConfigTypesV1_2 | Amplify Toolbox

    Index

    Interfaces

    AWSAmplifyBackendOutputs +clientConfigTypesV1_2 | Amplify Toolbox

    Index

    Interfaces

    AWSAmplifyBackendOutputs AmazonLocationServiceConfig AmplifyStorageAccessRule AmplifyStorageBucket diff --git a/modules/_aws_amplify_client_config.clientConfigTypesV1_3.html b/modules/_aws_amplify_client_config.clientConfigTypesV1_3.html index 17ce3ac36e..1c687214bb 100644 --- a/modules/_aws_amplify_client_config.clientConfigTypesV1_3.html +++ b/modules/_aws_amplify_client_config.clientConfigTypesV1_3.html @@ -1,4 +1,4 @@ -clientConfigTypesV1_3 | Amplify Toolbox

    Index

    Interfaces

    AWSAmplifyBackendOutputs +clientConfigTypesV1_3 | Amplify Toolbox

    Index

    Interfaces

    AWSAmplifyBackendOutputs AmazonLocationServiceConfig AmplifyStorageAccessRule AmplifyStorageBucket diff --git a/types/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunctionProps.html b/types/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunctionProps.html index 1ccdc0caec..10083aaecf 100644 --- a/types/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunctionProps.html +++ b/types/_aws_amplify_ai_constructs.conversation.ConversationHandlerFunctionProps.html @@ -4,4 +4,4 @@
  • models: {
        modelId: string;
        region?: string;
    }[]
  • Optional Internal outputStorageStrategy?: BackendOutputStorageStrategy<AIConversationOutput>
  • Optional timeoutSeconds?: number

    An amount of time in seconds between 1 second and 15 minutes. Must be a whole number. Default is 60 seconds.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_ai_constructs.conversation.ConversationTurnEventVersion.html b/types/_aws_amplify_ai_constructs.conversation.ConversationTurnEventVersion.html index dae4187fd6..0d837d7810 100644 --- a/types/_aws_amplify_ai_constructs.conversation.ConversationTurnEventVersion.html +++ b/types/_aws_amplify_ai_constructs.conversation.ConversationTurnEventVersion.html @@ -1 +1 @@ -ConversationTurnEventVersion | Amplify Toolbox
    \ No newline at end of file +ConversationTurnEventVersion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.AmazonProviderProps.html b/types/_aws_amplify_auth_construct.AmazonProviderProps.html index 70e17c3ea0..795e046bea 100644 --- a/types/_aws_amplify_auth_construct.AmazonProviderProps.html +++ b/types/_aws_amplify_auth_construct.AmazonProviderProps.html @@ -1,2 +1,2 @@ AmazonProviderProps | Amplify Toolbox
    AmazonProviderProps: Omit<cognito.UserPoolIdentityProviderAmazonProps, "userPool" | "attributeMapping"> & IdentityProviderProps

    Amazon provider.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.AppleProviderProps.html b/types/_aws_amplify_auth_construct.AppleProviderProps.html index 743cac90a5..dfb475634b 100644 --- a/types/_aws_amplify_auth_construct.AppleProviderProps.html +++ b/types/_aws_amplify_auth_construct.AppleProviderProps.html @@ -1,2 +1,2 @@ AppleProviderProps | Amplify Toolbox
    AppleProviderProps: Omit<cognito.UserPoolIdentityProviderAppleProps, "userPool" | "attributeMapping"> & IdentityProviderProps

    Apple provider.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.AttributeMapping.html b/types/_aws_amplify_auth_construct.AttributeMapping.html index 260a7e6d73..a7aef9701b 100644 --- a/types/_aws_amplify_auth_construct.AttributeMapping.html +++ b/types/_aws_amplify_auth_construct.AttributeMapping.html @@ -3,4 +3,4 @@

    Type declaration

    • Optional custom?: {
          [key: string]: string;
      }

      Specify custom attribute mapping here and mapping for any standard attributes not supported yet.

      Default

      - no custom attribute mapping
       
      -
      • [key: string]: string
    \ No newline at end of file +
    • [key: string]: string
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.AuthProps.html b/types/_aws_amplify_auth_construct.AuthProps.html index 82e9345b5c..bdd5b2b8d1 100644 --- a/types/_aws_amplify_auth_construct.AuthProps.html +++ b/types/_aws_amplify_auth_construct.AuthProps.html @@ -31,4 +31,4 @@
  • Optional userAttributes?: UserAttributes

    The set of attributes that are required for every user in the user pool. Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

    Default

    - email/phone will be added as required user attributes if they are included as login methods
     
    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttribute.html b/types/_aws_amplify_auth_construct.CustomAttribute.html index 93d0cc946e..38aadafeba 100644 --- a/types/_aws_amplify_auth_construct.CustomAttribute.html +++ b/types/_aws_amplify_auth_construct.CustomAttribute.html @@ -1,2 +1,2 @@ CustomAttribute | Amplify Toolbox

    CustomAttributes is a union type that represents all the different types of custom attributes.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeBase.html b/types/_aws_amplify_auth_construct.CustomAttributeBase.html index d22a1bd9a1..aceba0052a 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeBase.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeBase.html @@ -1,4 +1,4 @@ CustomAttributeBase | Amplify Toolbox
    CustomAttributeBase: {
        mutable?: boolean;
    }

    CustomAttributeBase is a type that represents the base properties for a custom attribute

    Type declaration

    • Optional mutable?: boolean

      Default

      {true}
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeBoolean.html b/types/_aws_amplify_auth_construct.CustomAttributeBoolean.html index ada542fe28..93a4873b5b 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeBoolean.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeBoolean.html @@ -1,2 +1,2 @@ CustomAttributeBoolean | Amplify Toolbox
    CustomAttributeBoolean: CustomAttributeBase & {
        dataType: "Boolean";
    }

    CustomAttributeBoolean represents a custom attribute of type boolean.

    -

    Type declaration

    • dataType: "Boolean"
    \ No newline at end of file +

    Type declaration

    • dataType: "Boolean"
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeDateTime.html b/types/_aws_amplify_auth_construct.CustomAttributeDateTime.html index 5aa8916203..20af500bb8 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeDateTime.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeDateTime.html @@ -1,2 +1,2 @@ CustomAttributeDateTime | Amplify Toolbox
    CustomAttributeDateTime: CustomAttributeBase & {
        dataType: "DateTime";
    }

    CustomAttributeDateTime represents a custom attribute of type dataTime.

    -

    Type declaration

    • dataType: "DateTime"
    \ No newline at end of file +

    Type declaration

    • dataType: "DateTime"
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeNumber.html b/types/_aws_amplify_auth_construct.CustomAttributeNumber.html index 85db25d215..2667e2f3cc 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeNumber.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeNumber.html @@ -1,2 +1,2 @@ CustomAttributeNumber | Amplify Toolbox
    CustomAttributeNumber: CustomAttributeBase & NumberAttributeConstraints & {
        dataType: "Number";
    }

    CustomAttributeNumber represents a custom attribute of type number.

    -

    Type declaration

    • dataType: "Number"
    \ No newline at end of file +

    Type declaration

    • dataType: "Number"
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomAttributeString.html b/types/_aws_amplify_auth_construct.CustomAttributeString.html index 0d914567b8..02c3524452 100644 --- a/types/_aws_amplify_auth_construct.CustomAttributeString.html +++ b/types/_aws_amplify_auth_construct.CustomAttributeString.html @@ -1,2 +1,2 @@ CustomAttributeString | Amplify Toolbox
    CustomAttributeString: CustomAttributeBase & StringAttributeConstraints & {
        dataType: "String";
    }

    CustomAttributeString represents a custom attribute of type string.

    -

    Type declaration

    • dataType: "String"
    \ No newline at end of file +

    Type declaration

    • dataType: "String"
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.CustomEmailSender.html b/types/_aws_amplify_auth_construct.CustomEmailSender.html index 8b5c807480..77ea78d0c0 100644 --- a/types/_aws_amplify_auth_construct.CustomEmailSender.html +++ b/types/_aws_amplify_auth_construct.CustomEmailSender.html @@ -1,2 +1,2 @@ CustomEmailSender | Amplify Toolbox
    CustomEmailSender: {
        handler: IFunction;
        kmsKeyArn?: string;
    }

    CustomEmailSender type for configuring a custom Lambda function for email sending

    -

    Type declaration

    • handler: IFunction
    • Optional kmsKeyArn?: string
    \ No newline at end of file +

    Type declaration

    • handler: IFunction
    • Optional kmsKeyArn?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.EmailLogin.html b/types/_aws_amplify_auth_construct.EmailLogin.html index f86834158a..407ba9a6f1 100644 --- a/types/_aws_amplify_auth_construct.EmailLogin.html +++ b/types/_aws_amplify_auth_construct.EmailLogin.html @@ -1,4 +1,4 @@ EmailLogin | Amplify Toolbox
    EmailLogin: true | EmailLoginSettings

    Email login options.

    If true, email login will be enabled with default settings. If settings are provided, email login will be enabled with the specified settings.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.EmailLoginSettings.html b/types/_aws_amplify_auth_construct.EmailLoginSettings.html index c8135381a2..8495542c7b 100644 --- a/types/_aws_amplify_auth_construct.EmailLoginSettings.html +++ b/types/_aws_amplify_auth_construct.EmailLoginSettings.html @@ -9,4 +9,4 @@
  • Optional smsMessage?: ((username, code) => string)

    The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

    Default

    (username, code) => 'Your username is {username()} and temporary password is {code()}.'
     
    -
      • (username, code): string
      • Parameters

        • username: (() => string)
            • (): string
            • Returns string

        • code: (() => string)
            • (): string
            • Returns string

        Returns string

  • \ No newline at end of file +
      • (username, code): string
      • Parameters

        • username: (() => string)
            • (): string
            • Returns string

        • code: (() => string)
            • (): string
            • Returns string

        Returns string

    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.ExternalProviderOptions.html b/types/_aws_amplify_auth_construct.ExternalProviderOptions.html index f7cf2d5f07..7a45d33bbd 100644 --- a/types/_aws_amplify_auth_construct.ExternalProviderOptions.html +++ b/types/_aws_amplify_auth_construct.ExternalProviderOptions.html @@ -14,4 +14,4 @@

    Example

    ['PROFILE']

    For details about each scope, see below.

    'PHONE' - Grants access to the 'phone_number' and 'phone_number_verified' claims.
    Automatically includes access to `OAuthScope.OPENID`.

    'EMAIL' - Grants access to the 'email' and 'email_verified' claims.
    Automatically includes access to `OAuthScope.OPENID`.

    'OPENID' - Returns all user attributes in the ID token that are readable by the client

    'PROFILE' - Grants access to all user attributes that are readable by the client
    Automatically includes access to `OAuthScope.OPENID`.

    'COGNITO_ADMIN' - Grants access to Amazon Cognito User Pool API operations that require access tokens,
    such as UpdateUserAttributes and VerifyUserAttribute.
  • Optional signInWithApple?: AppleProviderProps

    SignInWithApple Settings

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.FacebookProviderProps.html b/types/_aws_amplify_auth_construct.FacebookProviderProps.html index 8b060c19f0..37b57376c9 100644 --- a/types/_aws_amplify_auth_construct.FacebookProviderProps.html +++ b/types/_aws_amplify_auth_construct.FacebookProviderProps.html @@ -1,2 +1,2 @@ FacebookProviderProps | Amplify Toolbox
    FacebookProviderProps: Omit<cognito.UserPoolIdentityProviderFacebookProps, "userPool" | "attributeMapping"> & IdentityProviderProps

    Facebook provider.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.GoogleProviderProps.html b/types/_aws_amplify_auth_construct.GoogleProviderProps.html index 604c50e393..5a89946a0e 100644 --- a/types/_aws_amplify_auth_construct.GoogleProviderProps.html +++ b/types/_aws_amplify_auth_construct.GoogleProviderProps.html @@ -3,4 +3,4 @@
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.IdentityProviderProps.html b/types/_aws_amplify_auth_construct.IdentityProviderProps.html index d899b20e97..c53259ef6f 100644 --- a/types/_aws_amplify_auth_construct.IdentityProviderProps.html +++ b/types/_aws_amplify_auth_construct.IdentityProviderProps.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional attributeMapping?: AttributeMapping

      Mapping attributes from the identity provider to standard and custom attributes of the user pool.

      Default

      - no attribute mapping
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.MFA.html b/types/_aws_amplify_auth_construct.MFA.html index 69182b0668..28ca7bdf99 100644 --- a/types/_aws_amplify_auth_construct.MFA.html +++ b/types/_aws_amplify_auth_construct.MFA.html @@ -2,4 +2,4 @@

    Type declaration

    • mode: "OFF"

      Configure whether users can or are required to use multifactor (MFA) to sign in.

      Default

      - 'OFF'
       
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.MFASettings.html b/types/_aws_amplify_auth_construct.MFASettings.html index 39383831b9..b9dfeab8ad 100644 --- a/types/_aws_amplify_auth_construct.MFASettings.html +++ b/types/_aws_amplify_auth_construct.MFASettings.html @@ -1,2 +1,2 @@ MFASettings | Amplify Toolbox
    MFASettings: {
        sms: MFASmsSettings;
        totp?: MFATotpSettings;
    } | {
        sms?: MFASmsSettings;
        totp: MFATotpSettings;
    }

    Configure the MFA types that users can use. At least one of totp or sms is required.

    -

    Type declaration

    Type declaration

    \ No newline at end of file +

    Type declaration

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.MFASmsSettings.html b/types/_aws_amplify_auth_construct.MFASmsSettings.html index d2a5993395..9b61d0a8ee 100644 --- a/types/_aws_amplify_auth_construct.MFASmsSettings.html +++ b/types/_aws_amplify_auth_construct.MFASmsSettings.html @@ -5,4 +5,4 @@
      • (createCode): string
      • Parameters

        • createCode: (() => string)
            • (): string
            • Returns string

        Returns string

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.MFATotpSettings.html b/types/_aws_amplify_auth_construct.MFATotpSettings.html index 504a8ce9cb..e4b6b640c7 100644 --- a/types/_aws_amplify_auth_construct.MFATotpSettings.html +++ b/types/_aws_amplify_auth_construct.MFATotpSettings.html @@ -2,4 +2,4 @@
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.OidcProviderProps.html b/types/_aws_amplify_auth_construct.OidcProviderProps.html index 189f8bf9e4..55faf0e43d 100644 --- a/types/_aws_amplify_auth_construct.OidcProviderProps.html +++ b/types/_aws_amplify_auth_construct.OidcProviderProps.html @@ -2,4 +2,4 @@

    Type declaration

    • Optional Readonly attributeRequestMethod?: "GET" | "POST"

      The method to use to request attributes

      Default

      'GET'

      For details about each option, see below.

      'GET' - use GET
      'POST' - use POST
      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.PhoneNumberLogin.html b/types/_aws_amplify_auth_construct.PhoneNumberLogin.html index 1260924565..da16d1c1b8 100644 --- a/types/_aws_amplify_auth_construct.PhoneNumberLogin.html +++ b/types/_aws_amplify_auth_construct.PhoneNumberLogin.html @@ -5,4 +5,4 @@

    Default

    // If VerificationEmailStyle.LINK is chosen, verificationMessage will not be configured by default.

    // If VerificationEmailStyle.CODE is chosen, the default function will be as follows: (code) => The verification code to your new account is ${createCode()}

    -
      • (createCode): string
      • Parameters

        • createCode: (() => string)
            • (): string
            • Returns string

        Returns string

    \ No newline at end of file +
      • (createCode): string
      • Parameters

        • createCode: (() => string)
            • (): string
            • Returns string

        Returns string

    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.SamlProviderProps.html b/types/_aws_amplify_auth_construct.SamlProviderProps.html index 3b485867e5..4c9d3ec6aa 100644 --- a/types/_aws_amplify_auth_construct.SamlProviderProps.html +++ b/types/_aws_amplify_auth_construct.SamlProviderProps.html @@ -1,3 +1,3 @@ SamlProviderProps | Amplify Toolbox
    SamlProviderProps: Omit<cognito.UserPoolIdentityProviderSamlProps, "userPool" | "metadata" | "attributeMapping"> & {
        metadata: Omit<UserPoolIdentityProviderSamlMetadata, "metadataType"> & {
            metadataType: "URL" | "FILE";
        };
    } & IdentityProviderProps

    SAML provider.

    Type declaration

    • metadata: Omit<UserPoolIdentityProviderSamlMetadata, "metadataType"> & {
          metadataType: "URL" | "FILE";
      }

      The SAML metadata.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.TriggerEvent.html b/types/_aws_amplify_auth_construct.TriggerEvent.html index ae4981250a..59d36730f9 100644 --- a/types/_aws_amplify_auth_construct.TriggerEvent.html +++ b/types/_aws_amplify_auth_construct.TriggerEvent.html @@ -1,2 +1,2 @@ TriggerEvent | Amplify Toolbox
    TriggerEvent: typeof triggerEvents[number]

    Union type of all supported auth trigger events

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.UserAttributes.html b/types/_aws_amplify_auth_construct.UserAttributes.html index b31beea551..69a985ec26 100644 --- a/types/_aws_amplify_auth_construct.UserAttributes.html +++ b/types/_aws_amplify_auth_construct.UserAttributes.html @@ -1,3 +1,3 @@ UserAttributes | Amplify Toolbox
    UserAttributes: StandardAttributes & Record<`custom:${string}`, CustomAttribute>

    UserAttributes represents the combined attributes of a user, including standard attributes and any number of custom attributes defined with a 'custom:' prefix.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.VerificationEmailWithCode.html b/types/_aws_amplify_auth_construct.VerificationEmailWithCode.html index 06521a9b23..78f88bcea6 100644 --- a/types/_aws_amplify_auth_construct.VerificationEmailWithCode.html +++ b/types/_aws_amplify_auth_construct.VerificationEmailWithCode.html @@ -4,4 +4,4 @@
      • (createCode): string
      • Parameters

        • createCode: (() => string)
            • (): string
            • Returns string

        Returns string

  • Optional verificationEmailStyle?: "CODE"

    The type of verification. Must be one of "CODE" or "LINK".

  • Optional verificationEmailSubject?: string

    The verification email subject.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_auth_construct.VerificationEmailWithLink.html b/types/_aws_amplify_auth_construct.VerificationEmailWithLink.html index 01a5842e7c..98e43d7cc1 100644 --- a/types/_aws_amplify_auth_construct.VerificationEmailWithLink.html +++ b/types/_aws_amplify_auth_construct.VerificationEmailWithLink.html @@ -7,4 +7,4 @@

    Example

    To
      • (createLink): string
      • Parameters

        • createLink: ((text?) => string)
            • (text?): string
            • Parameters

              • Optional text: string

              Returns string

        Returns string

  • Optional verificationEmailStyle?: "LINK"

    The type of verification. Must be one of "CODE" or "LINK".

  • Optional verificationEmailSubject?: string

    The verification email subject.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend.Backend.html b/types/_aws_amplify_backend.Backend.html index f2687c7441..facec95983 100644 --- a/types/_aws_amplify_backend.Backend.html +++ b/types/_aws_amplify_backend.Backend.html @@ -1,4 +1,4 @@ Backend | Amplify Toolbox
    Backend<T>: BackendBase & {
        [K in keyof T]: Omit<ReturnType<T[K]["getInstance"]>, keyof ResourceAccessAcceptorFactory>
    }

    Use defineBackend to create an instance of this type. This object has the Amplify BackendBase methods on it for interacting with the backend. It also has dynamic properties based on the resources passed into defineBackend

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/types/_aws_amplify_backend.BackendBase.html b/types/_aws_amplify_backend.BackendBase.html index 500a0da61b..06903c900b 100644 --- a/types/_aws_amplify_backend.BackendBase.html +++ b/types/_aws_amplify_backend.BackendBase.html @@ -1 +1 @@ -BackendBase | Amplify Toolbox
    BackendBase: {
        addOutput: ((clientConfigPart) => void);
        createStack: ((name) => Stack);
        stack: Stack;
    }

    Type declaration

    • addOutput: ((clientConfigPart) => void)
    • createStack: ((name) => Stack)
        • (name): Stack
        • Parameters

          • name: string

          Returns Stack

    • stack: Stack
    \ No newline at end of file +BackendBase | Amplify Toolbox
    BackendBase: {
        addOutput: ((clientConfigPart) => void);
        createStack: ((name) => Stack);
        stack: Stack;
    }

    Type declaration

    • addOutput: ((clientConfigPart) => void)
    • createStack: ((name) => Stack)
        • (name): Stack
        • Parameters

          • name: string

          Returns Stack

    • stack: Stack
    \ No newline at end of file diff --git a/types/_aws_amplify_backend.DefineBackendProps.html b/types/_aws_amplify_backend.DefineBackendProps.html index c7ee235787..618638ffce 100644 --- a/types/_aws_amplify_backend.DefineBackendProps.html +++ b/types/_aws_amplify_backend.DefineBackendProps.html @@ -1 +1 @@ -DefineBackendProps | Amplify Toolbox
    DefineBackendProps: Record<string, ConstructFactory<ResourceProvider & Partial<ResourceAccessAcceptorFactory<never>>>> & {
        [K in keyof BackendBase]?: never
    }
    \ No newline at end of file +DefineBackendProps | Amplify Toolbox
    DefineBackendProps: Record<string, ConstructFactory<ResourceProvider & Partial<ResourceAccessAcceptorFactory<never>>>> & {
        [K in keyof BackendBase]?: never
    }
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ActionIam.html b/types/_aws_amplify_backend_auth.ActionIam.html index 72d4ee780c..dccb9ed86c 100644 --- a/types/_aws_amplify_backend_auth.ActionIam.html +++ b/types/_aws_amplify_backend_auth.ActionIam.html @@ -1,4 +1,4 @@ ActionIam | Amplify Toolbox
    ActionIam: "addUserToGroup" | "createGroup" | "createUser" | "deleteGroup" | "deleteUser" | "deleteUserAttributes" | "disableUser" | "enableUser" | "forgetDevice" | "getDevice" | "getGroup" | "getUser" | "listUsers" | "listUsersInGroup" | "listGroups" | "listDevices" | "listGroupsForUser" | "removeUserFromGroup" | "resetUserPassword" | "setUserMfaPreference" | "setUserPassword" | "setUserSettings" | "updateDeviceStatus" | "updateGroup" | "updateUserAttributes"

    This maps to Cognito IAM actions.

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ActionMeta.html b/types/_aws_amplify_backend_auth.ActionMeta.html index 4bc73e2e9d..7638e0c0e4 100644 --- a/types/_aws_amplify_backend_auth.ActionMeta.html +++ b/types/_aws_amplify_backend_auth.ActionMeta.html @@ -1,2 +1,2 @@ ActionMeta | Amplify Toolbox
    ActionMeta: "manageUsers" | "manageGroups" | "manageGroupMembership" | "manageUserDevices" | "managePasswordRecovery"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AmazonProviderFactoryProps.html b/types/_aws_amplify_backend_auth.AmazonProviderFactoryProps.html index d843def756..d7fbeb4b77 100644 --- a/types/_aws_amplify_backend_auth.AmazonProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.AmazonProviderFactoryProps.html @@ -3,4 +3,4 @@
  • clientSecret: BackendSecret

    The client secret to be accompanied with clientId for 'Login with Amazon' APIs to authenticate the client.

  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AmplifyAuthProps.html b/types/_aws_amplify_backend_auth.AmplifyAuthProps.html index 893355b148..2683b7406c 100644 --- a/types/_aws_amplify_backend_auth.AmplifyAuthProps.html +++ b/types/_aws_amplify_backend_auth.AmplifyAuthProps.html @@ -1 +1 @@ -AmplifyAuthProps | Amplify Toolbox
    AmplifyAuthProps: Expand<Omit<AuthProps, "outputStorageStrategy" | "loginWith" | "senders"> & {
        access?: AuthAccessGenerator;
        loginWith: Expand<AuthLoginWithFactoryProps>;
        senders?: {
            email: Pick<UserPoolSESOptions, "fromEmail" | "fromName" | "replyTo"> | CustomEmailSender;
        };
        triggers?: Partial<Record<TriggerEvent, ConstructFactory<ResourceProvider<FunctionResources>>>>;
    }>
    \ No newline at end of file +AmplifyAuthProps | Amplify Toolbox
    AmplifyAuthProps: Expand<Omit<AuthProps, "outputStorageStrategy" | "loginWith" | "senders"> & {
        access?: AuthAccessGenerator;
        loginWith: Expand<AuthLoginWithFactoryProps>;
        senders?: {
            email: Pick<UserPoolSESOptions, "fromEmail" | "fromName" | "replyTo"> | CustomEmailSender;
        };
        triggers?: Partial<Record<TriggerEvent, ConstructFactory<ResourceProvider<FunctionResources>>>>;
    }>
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AmplifyReferenceAuthProps.html b/types/_aws_amplify_backend_auth.AmplifyReferenceAuthProps.html index dee754a738..3e3a789868 100644 --- a/types/_aws_amplify_backend_auth.AmplifyReferenceAuthProps.html +++ b/types/_aws_amplify_backend_auth.AmplifyReferenceAuthProps.html @@ -1 +1 @@ -AmplifyReferenceAuthProps | Amplify Toolbox
    AmplifyReferenceAuthProps: Expand<Omit<ReferenceAuthProps, "outputStorageStrategy"> & {
        access?: AuthAccessGenerator;
    }>
    \ No newline at end of file +AmplifyReferenceAuthProps | Amplify Toolbox
    AmplifyReferenceAuthProps: Expand<Omit<ReferenceAuthProps, "outputStorageStrategy"> & {
        access?: AuthAccessGenerator;
    }>
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AppleProviderFactoryProps.html b/types/_aws_amplify_backend_auth.AppleProviderFactoryProps.html index 19e7cc476c..5ef76a7d02 100644 --- a/types/_aws_amplify_backend_auth.AppleProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.AppleProviderFactoryProps.html @@ -4,4 +4,4 @@
  • keyId: BackendSecret

    The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.

  • privateKey: BackendSecret

    The privateKey content for Apple APIs to authenticate the client.

  • teamId: BackendSecret

    The teamId for Apple APIs to authenticate the client.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthAccessBuilder.html b/types/_aws_amplify_backend_auth.AuthAccessBuilder.html index 3e90aec87e..7adb20bae1 100644 --- a/types/_aws_amplify_backend_auth.AuthAccessBuilder.html +++ b/types/_aws_amplify_backend_auth.AuthAccessBuilder.html @@ -1 +1 @@ -AuthAccessBuilder | Amplify Toolbox
    AuthAccessBuilder: {
        resource: ((other) => AuthActionBuilder);
    }

    Type declaration

    \ No newline at end of file +AuthAccessBuilder | Amplify Toolbox
    AuthAccessBuilder: {
        resource: ((other) => AuthActionBuilder);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthAccessDefinition.html b/types/_aws_amplify_backend_auth.AuthAccessDefinition.html index f1b68f8503..b5da6d06a5 100644 --- a/types/_aws_amplify_backend_auth.AuthAccessDefinition.html +++ b/types/_aws_amplify_backend_auth.AuthAccessDefinition.html @@ -1 +1 @@ -AuthAccessDefinition | Amplify Toolbox
    AuthAccessDefinition: {
        actions: AuthAction[];
        getResourceAccessAcceptor: ((getInstanceProps) => ResourceAccessAcceptor);
    }

    Type declaration

    \ No newline at end of file +AuthAccessDefinition | Amplify Toolbox
    AuthAccessDefinition: {
        actions: AuthAction[];
        getResourceAccessAcceptor: ((getInstanceProps) => ResourceAccessAcceptor);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthAccessGenerator.html b/types/_aws_amplify_backend_auth.AuthAccessGenerator.html index f8a9261a6a..69d981ee60 100644 --- a/types/_aws_amplify_backend_auth.AuthAccessGenerator.html +++ b/types/_aws_amplify_backend_auth.AuthAccessGenerator.html @@ -1 +1 @@ -AuthAccessGenerator | Amplify Toolbox
    AuthAccessGenerator: ((allow) => AuthAccessDefinition[])

    Type declaration

    \ No newline at end of file +AuthAccessGenerator | Amplify Toolbox
    AuthAccessGenerator: ((allow) => AuthAccessDefinition[])

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthAction.html b/types/_aws_amplify_backend_auth.AuthAction.html index 40c61e0fee..e740e546d2 100644 --- a/types/_aws_amplify_backend_auth.AuthAction.html +++ b/types/_aws_amplify_backend_auth.AuthAction.html @@ -1 +1 @@ -AuthAction | Amplify Toolbox
    \ No newline at end of file +AuthAction | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthActionBuilder.html b/types/_aws_amplify_backend_auth.AuthActionBuilder.html index 930b2790c4..39ac3303aa 100644 --- a/types/_aws_amplify_backend_auth.AuthActionBuilder.html +++ b/types/_aws_amplify_backend_auth.AuthActionBuilder.html @@ -1 +1 @@ -AuthActionBuilder | Amplify Toolbox
    AuthActionBuilder: {
        to: ((actions) => AuthAccessDefinition);
    }

    Type declaration

    \ No newline at end of file +AuthActionBuilder | Amplify Toolbox
    AuthActionBuilder: {
        to: ((actions) => AuthAccessDefinition);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.AuthLoginWithFactoryProps.html b/types/_aws_amplify_backend_auth.AuthLoginWithFactoryProps.html index cce7bbd73b..f4beb37106 100644 --- a/types/_aws_amplify_backend_auth.AuthLoginWithFactoryProps.html +++ b/types/_aws_amplify_backend_auth.AuthLoginWithFactoryProps.html @@ -1,3 +1,3 @@ AuthLoginWithFactoryProps | Amplify Toolbox
    AuthLoginWithFactoryProps: Omit<AuthProps["loginWith"], "externalProviders"> & {
        externalProviders?: ExternalProviderSpecificFactoryProps;
    }

    Auth factory loginWith attribute.

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.BackendAuth.html b/types/_aws_amplify_backend_auth.BackendAuth.html index 5cd94d8895..45c73130fb 100644 --- a/types/_aws_amplify_backend_auth.BackendAuth.html +++ b/types/_aws_amplify_backend_auth.BackendAuth.html @@ -1 +1 @@ -BackendAuth | Amplify Toolbox
    \ No newline at end of file +BackendAuth | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.BackendReferenceAuth.html b/types/_aws_amplify_backend_auth.BackendReferenceAuth.html index a19ead9ea4..35f9942854 100644 --- a/types/_aws_amplify_backend_auth.BackendReferenceAuth.html +++ b/types/_aws_amplify_backend_auth.BackendReferenceAuth.html @@ -1 +1 @@ -BackendReferenceAuth | Amplify Toolbox
    \ No newline at end of file +BackendReferenceAuth | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.CustomEmailSender.html b/types/_aws_amplify_backend_auth.CustomEmailSender.html index 0f84f89c5d..bc7aff1521 100644 --- a/types/_aws_amplify_backend_auth.CustomEmailSender.html +++ b/types/_aws_amplify_backend_auth.CustomEmailSender.html @@ -1,2 +1,2 @@ CustomEmailSender | Amplify Toolbox
    CustomEmailSender: {
        handler: ConstructFactory<AmplifyFunction> | IFunction;
        kmsKeyArn?: string;
    }

    CustomEmailSender type for configuring a custom Lambda function for email sending

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.Expand.html b/types/_aws_amplify_backend_auth.Expand.html index 53eebfcb91..2e3205a49e 100644 --- a/types/_aws_amplify_backend_auth.Expand.html +++ b/types/_aws_amplify_backend_auth.Expand.html @@ -1,4 +1,4 @@ Expand | Amplify Toolbox
    Expand<T>: T extends infer O
        ? {
            [K in keyof O]: O[K]
        }
        : never

    This utility allows us to expand nested types in auto complete prompts.

    Type Parameters

    • T

    Example

    type OtherType = {
    property1: string;
    property2: number;
    }
    type SomeType = {
    property2: Expand<OtherType>;
    }
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ExternalProviderGeneralFactoryProps.html b/types/_aws_amplify_backend_auth.ExternalProviderGeneralFactoryProps.html index 239e05f669..820f79aee4 100644 --- a/types/_aws_amplify_backend_auth.ExternalProviderGeneralFactoryProps.html +++ b/types/_aws_amplify_backend_auth.ExternalProviderGeneralFactoryProps.html @@ -1,2 +1,2 @@ ExternalProviderGeneralFactoryProps | Amplify Toolbox
    ExternalProviderGeneralFactoryProps: Omit<ExternalProviderOptions, "signInWithApple" | "loginWithAmazon" | "facebook" | "oidc" | "google" | "domainPrefix">

    External provider general properties.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ExternalProviderSpecificFactoryProps.html b/types/_aws_amplify_backend_auth.ExternalProviderSpecificFactoryProps.html index 842bacf5db..e7d7c141f9 100644 --- a/types/_aws_amplify_backend_auth.ExternalProviderSpecificFactoryProps.html +++ b/types/_aws_amplify_backend_auth.ExternalProviderSpecificFactoryProps.html @@ -4,4 +4,4 @@
  • Optional loginWithAmazon?: AmazonProviderFactoryProps

    LoginWithAmazon Settings

  • Optional oidc?: OidcProviderFactoryProps[]

    OIDC Settings

  • Optional signInWithApple?: AppleProviderFactoryProps

    SignInWithApple Settings

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.FacebookProviderFactoryProps.html b/types/_aws_amplify_backend_auth.FacebookProviderFactoryProps.html index 6593845258..19254e3459 100644 --- a/types/_aws_amplify_backend_auth.FacebookProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.FacebookProviderFactoryProps.html @@ -2,4 +2,4 @@

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.GoogleProviderFactoryProps.html b/types/_aws_amplify_backend_auth.GoogleProviderFactoryProps.html index faf35307cc..587e73c6cb 100644 --- a/types/_aws_amplify_backend_auth.GoogleProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.GoogleProviderFactoryProps.html @@ -5,4 +5,4 @@
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.OidcProviderFactoryProps.html b/types/_aws_amplify_backend_auth.OidcProviderFactoryProps.html index 6971a877bf..aa2f97415b 100644 --- a/types/_aws_amplify_backend_auth.OidcProviderFactoryProps.html +++ b/types/_aws_amplify_backend_auth.OidcProviderFactoryProps.html @@ -1,4 +1,4 @@ OidcProviderFactoryProps | Amplify Toolbox
    OidcProviderFactoryProps: Omit<OidcProviderProps, "clientId" | "clientSecret"> & {
        clientId: BackendSecret;
        clientSecret: BackendSecret;
    }

    Oidc provider properties.

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_auth.ReferenceAuthProps.html b/types/_aws_amplify_backend_auth.ReferenceAuthProps.html index 203bb7000e..357f139f4a 100644 --- a/types/_aws_amplify_backend_auth.ReferenceAuthProps.html +++ b/types/_aws_amplify_backend_auth.ReferenceAuthProps.html @@ -5,4 +5,4 @@
  • Optional Internal outputStorageStrategy?: BackendOutputStorageStrategy<AuthOutput>
  • unauthRoleArn: string

    Existing UnauthRole ARN

  • userPoolClientId: string

    Existing UserPoolClient Id

  • userPoolId: string

    Existing UserPool Id

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.ApiKeyAuthorizationModeProps.html b/types/_aws_amplify_backend_data.ApiKeyAuthorizationModeProps.html index 74a7fe28b9..96e304853f 100644 --- a/types/_aws_amplify_backend_data.ApiKeyAuthorizationModeProps.html +++ b/types/_aws_amplify_backend_data.ApiKeyAuthorizationModeProps.html @@ -3,4 +3,4 @@
  • Optional expiresInDays?: number

    A duration representing the time from Cloudformation deploy until expiry.

    Default

    7
     
    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.AuthorizationModes.html b/types/_aws_amplify_backend_data.AuthorizationModes.html index 7dd9fb1856..1c65cc4227 100644 --- a/types/_aws_amplify_backend_data.AuthorizationModes.html +++ b/types/_aws_amplify_backend_data.AuthorizationModes.html @@ -3,4 +3,4 @@
  • Optional defaultAuthorizationMode?: DefaultAuthorizationMode

    Default auth mode to use in the API, only required if more than one auth mode is specified.

  • Optional lambdaAuthorizationMode?: LambdaAuthorizationModeProps

    Lambda authorization config if function provider is specified in the api definition.

  • Optional oidcAuthorizationMode?: OIDCAuthorizationModeProps

    OIDC authorization config if oidc provider is specified in the api definition.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.DataProps.html b/types/_aws_amplify_backend_data.DataProps.html index 4afa9cd6c7..901934b13f 100644 --- a/types/_aws_amplify_backend_data.DataProps.html +++ b/types/_aws_amplify_backend_data.DataProps.html @@ -3,4 +3,4 @@
  • Optional functions?: Record<string, ConstructFactory<AmplifyFunction>>

    Functions invokable by the API. The specific input type of the function is subject to change or removal.

  • Optional name?: string

    Optional name for the generated Api.

  • schema: DataSchemaInput

    Graphql Schema as a string to be passed into the CDK construct.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.DataSchemaInput.html b/types/_aws_amplify_backend_data.DataSchemaInput.html index 74a901cab9..5a456f3efb 100644 --- a/types/_aws_amplify_backend_data.DataSchemaInput.html +++ b/types/_aws_amplify_backend_data.DataSchemaInput.html @@ -1,2 +1,2 @@ DataSchemaInput | Amplify Toolbox
    DataSchemaInput: string | DerivedModelSchema | DerivedCombinedSchema

    Schemas type definition, can be either a raw Graphql string, or a typed model schema, or a collection of combined Schemas.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.DefaultAuthorizationMode.html b/types/_aws_amplify_backend_data.DefaultAuthorizationMode.html index 6b266f9d4b..caa35b6661 100644 --- a/types/_aws_amplify_backend_data.DefaultAuthorizationMode.html +++ b/types/_aws_amplify_backend_data.DefaultAuthorizationMode.html @@ -1,2 +1,2 @@ DefaultAuthorizationMode | Amplify Toolbox
    DefaultAuthorizationMode: "iam" | "identityPool" | "userPool" | "oidc" | "apiKey" | "lambda"

    Authorization modes used in by client side Amplify represented in camelCase.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.LambdaAuthorizationModeProps.html b/types/_aws_amplify_backend_data.LambdaAuthorizationModeProps.html index 7973ac1832..ead8b79dc4 100644 --- a/types/_aws_amplify_backend_data.LambdaAuthorizationModeProps.html +++ b/types/_aws_amplify_backend_data.LambdaAuthorizationModeProps.html @@ -3,4 +3,4 @@
  • Optional timeToLiveInSeconds?: number

    How long the results are cached.

    Default

    60
     
    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_data.OIDCAuthorizationModeProps.html b/types/_aws_amplify_backend_data.OIDCAuthorizationModeProps.html index 51679be568..4eaa4c05b7 100644 --- a/types/_aws_amplify_backend_data.OIDCAuthorizationModeProps.html +++ b/types/_aws_amplify_backend_data.OIDCAuthorizationModeProps.html @@ -7,4 +7,4 @@ This validation uses iat claim of OIDC token.

  • tokenExpiryFromAuthInSeconds: number

    The duration an OIDC token is valid after being authenticated by OIDC provider in seconds. auth_time claim in OIDC token is required for this validation to work.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.BackendDeployer.html b/types/_aws_amplify_backend_deployer.BackendDeployer.html index 2c17818f46..cd15957efe 100644 --- a/types/_aws_amplify_backend_deployer.BackendDeployer.html +++ b/types/_aws_amplify_backend_deployer.BackendDeployer.html @@ -1,2 +1,2 @@ BackendDeployer | Amplify Toolbox
    BackendDeployer: {
        deploy: ((backendId, deployProps?) => Promise<DeployResult>);
        destroy: ((backendId, destroyProps?) => Promise<DestroyResult>);
    }

    Invokes an invokable command

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.BackendDeployerOutputFormatter.html b/types/_aws_amplify_backend_deployer.BackendDeployerOutputFormatter.html index 8b9016841b..c4ecc9c436 100644 --- a/types/_aws_amplify_backend_deployer.BackendDeployerOutputFormatter.html +++ b/types/_aws_amplify_backend_deployer.BackendDeployerOutputFormatter.html @@ -1 +1 @@ -BackendDeployerOutputFormatter | Amplify Toolbox
    BackendDeployerOutputFormatter: {
        normalizeAmpxCommand: ((command) => string);
    }

    Type declaration

    • normalizeAmpxCommand: ((command) => string)
        • (command): string
        • Parameters

          • command: string

          Returns string

    \ No newline at end of file +BackendDeployerOutputFormatter | Amplify Toolbox
    BackendDeployerOutputFormatter: {
        normalizeAmpxCommand: ((command) => string);
    }

    Type declaration

    • normalizeAmpxCommand: ((command) => string)
        • (command): string
        • Parameters

          • command: string

          Returns string

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DeployProps.html b/types/_aws_amplify_backend_deployer.DeployProps.html index 4a380eabb8..b30d68b692 100644 --- a/types/_aws_amplify_backend_deployer.DeployProps.html +++ b/types/_aws_amplify_backend_deployer.DeployProps.html @@ -1 +1 @@ -DeployProps | Amplify Toolbox
    DeployProps: {
        profile?: string;
        secretLastUpdated?: Date;
        validateAppSources?: boolean;
    }

    Type declaration

    • Optional profile?: string
    • Optional secretLastUpdated?: Date
    • Optional validateAppSources?: boolean
    \ No newline at end of file +DeployProps | Amplify Toolbox
    DeployProps: {
        profile?: string;
        secretLastUpdated?: Date;
        validateAppSources?: boolean;
    }

    Type declaration

    • Optional profile?: string
    • Optional secretLastUpdated?: Date
    • Optional validateAppSources?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DeployResult.html b/types/_aws_amplify_backend_deployer.DeployResult.html index cac9c9b588..b46ab9f472 100644 --- a/types/_aws_amplify_backend_deployer.DeployResult.html +++ b/types/_aws_amplify_backend_deployer.DeployResult.html @@ -1 +1 @@ -DeployResult | Amplify Toolbox
    DeployResult: {
        deploymentTimes: DeploymentTimes;
    }

    Type declaration

    \ No newline at end of file +DeployResult | Amplify Toolbox
    DeployResult: {
        deploymentTimes: DeploymentTimes;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DeploymentTimes.html b/types/_aws_amplify_backend_deployer.DeploymentTimes.html index 11d5e3cc86..7d9d55b96c 100644 --- a/types/_aws_amplify_backend_deployer.DeploymentTimes.html +++ b/types/_aws_amplify_backend_deployer.DeploymentTimes.html @@ -1 +1 @@ -DeploymentTimes | Amplify Toolbox
    DeploymentTimes: {
        synthesisTime?: number;
        totalTime?: number;
    }

    Type declaration

    • Optional synthesisTime?: number
    • Optional totalTime?: number
    \ No newline at end of file +DeploymentTimes | Amplify Toolbox
    DeploymentTimes: {
        synthesisTime?: number;
        totalTime?: number;
    }

    Type declaration

    • Optional synthesisTime?: number
    • Optional totalTime?: number
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DestroyProps.html b/types/_aws_amplify_backend_deployer.DestroyProps.html index 13ec1c5926..b8eccac514 100644 --- a/types/_aws_amplify_backend_deployer.DestroyProps.html +++ b/types/_aws_amplify_backend_deployer.DestroyProps.html @@ -1 +1 @@ -DestroyProps | Amplify Toolbox
    DestroyProps: {
        profile?: string;
    }

    Type declaration

    • Optional profile?: string
    \ No newline at end of file +DestroyProps | Amplify Toolbox
    DestroyProps: {
        profile?: string;
    }

    Type declaration

    • Optional profile?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_deployer.DestroyResult.html b/types/_aws_amplify_backend_deployer.DestroyResult.html index fc76cc5b55..01e68c7167 100644 --- a/types/_aws_amplify_backend_deployer.DestroyResult.html +++ b/types/_aws_amplify_backend_deployer.DestroyResult.html @@ -1 +1 @@ -DestroyResult | Amplify Toolbox
    DestroyResult: {
        deploymentTimes: DeploymentTimes;
    }

    Type declaration

    \ No newline at end of file +DestroyResult | Amplify Toolbox
    DestroyResult: {
        deploymentTimes: DeploymentTimes;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.AddEnvironmentFactory.html b/types/_aws_amplify_backend_function.AddEnvironmentFactory.html index a8de533d59..e49ab82832 100644 --- a/types/_aws_amplify_backend_function.AddEnvironmentFactory.html +++ b/types/_aws_amplify_backend_function.AddEnvironmentFactory.html @@ -1 +1 @@ -AddEnvironmentFactory | Amplify Toolbox
    AddEnvironmentFactory: {
        addEnvironment: ((key, value) => void);
    }

    Type declaration

    • addEnvironment: ((key, value) => void)
        • (key, value): void
        • Parameters

          Returns void

    \ No newline at end of file +AddEnvironmentFactory | Amplify Toolbox
    AddEnvironmentFactory: {
        addEnvironment: ((key, value) => void);
    }

    Type declaration

    • addEnvironment: ((key, value) => void)
        • (key, value): void
        • Parameters

          Returns void

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.CronSchedule.html b/types/_aws_amplify_backend_function.CronSchedule.html index f12e57875c..04e7406c4e 100644 --- a/types/_aws_amplify_backend_function.CronSchedule.html +++ b/types/_aws_amplify_backend_function.CronSchedule.html @@ -1 +1 @@ -CronSchedule | Amplify Toolbox
    CronSchedule: `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string} ${string} ${string}`
    \ No newline at end of file +CronSchedule | Amplify Toolbox
    CronSchedule: `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string} ${string} ${string}`
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.FunctionBundlingOptions.html b/types/_aws_amplify_backend_function.FunctionBundlingOptions.html index f07bd0f31b..324a61e954 100644 --- a/types/_aws_amplify_backend_function.FunctionBundlingOptions.html +++ b/types/_aws_amplify_backend_function.FunctionBundlingOptions.html @@ -1,3 +1,3 @@ FunctionBundlingOptions | Amplify Toolbox
    FunctionBundlingOptions: {
        minify?: boolean;
    }

    Type declaration

    • Optional minify?: boolean

      Whether to minify the function code.

      Defaults to true.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.FunctionLogLevel.html b/types/_aws_amplify_backend_function.FunctionLogLevel.html index 12e8650d66..cf18c2301b 100644 --- a/types/_aws_amplify_backend_function.FunctionLogLevel.html +++ b/types/_aws_amplify_backend_function.FunctionLogLevel.html @@ -1 +1 @@ -FunctionLogLevel | Amplify Toolbox
    FunctionLogLevel: LogLevel
    \ No newline at end of file +FunctionLogLevel | Amplify Toolbox
    FunctionLogLevel: LogLevel
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.FunctionLogRetention.html b/types/_aws_amplify_backend_function.FunctionLogRetention.html index 75ed4a99c3..37a4607a36 100644 --- a/types/_aws_amplify_backend_function.FunctionLogRetention.html +++ b/types/_aws_amplify_backend_function.FunctionLogRetention.html @@ -1 +1 @@ -FunctionLogRetention | Amplify Toolbox
    FunctionLogRetention: LogRetention
    \ No newline at end of file +FunctionLogRetention | Amplify Toolbox
    FunctionLogRetention: LogRetention
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.FunctionLoggingOptions.html b/types/_aws_amplify_backend_function.FunctionLoggingOptions.html index a4ce904e7e..25d92e09ee 100644 --- a/types/_aws_amplify_backend_function.FunctionLoggingOptions.html +++ b/types/_aws_amplify_backend_function.FunctionLoggingOptions.html @@ -1 +1 @@ -FunctionLoggingOptions | Amplify Toolbox
    FunctionLoggingOptions: ({
        format: "json";
        level?: FunctionLogLevel;
    } | {
        format?: "text";
    }) & {
        retention?: FunctionLogRetention;
    }

    Type declaration

    \ No newline at end of file +FunctionLoggingOptions | Amplify Toolbox
    FunctionLoggingOptions: ({
        format: "json";
        level?: FunctionLogLevel;
    } | {
        format?: "text";
    }) & {
        retention?: FunctionLogRetention;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.FunctionProps.html b/types/_aws_amplify_backend_function.FunctionProps.html index 90821377c0..428614875c 100644 --- a/types/_aws_amplify_backend_function.FunctionProps.html +++ b/types/_aws_amplify_backend_function.FunctionProps.html @@ -47,4 +47,4 @@

    Example

    schedule
  • Optional timeoutSeconds?: number

    An amount of time in seconds between 1 second and 15 minutes. Must be a whole number. Default is 3 seconds.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.FunctionSchedule.html b/types/_aws_amplify_backend_function.FunctionSchedule.html index b85411fca3..c38c42ea60 100644 --- a/types/_aws_amplify_backend_function.FunctionSchedule.html +++ b/types/_aws_amplify_backend_function.FunctionSchedule.html @@ -1 +1 @@ -FunctionSchedule | Amplify Toolbox
    \ No newline at end of file +FunctionSchedule | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.NodeVersion.html b/types/_aws_amplify_backend_function.NodeVersion.html index 5921207c34..1fc6765fb7 100644 --- a/types/_aws_amplify_backend_function.NodeVersion.html +++ b/types/_aws_amplify_backend_function.NodeVersion.html @@ -1 +1 @@ -NodeVersion | Amplify Toolbox
    NodeVersion: 16 | 18 | 20 | 22
    \ No newline at end of file +NodeVersion | Amplify Toolbox
    NodeVersion: 16 | 18 | 20 | 22
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_function.TimeInterval.html b/types/_aws_amplify_backend_function.TimeInterval.html index 79dd82f467..ad5c857635 100644 --- a/types/_aws_amplify_backend_function.TimeInterval.html +++ b/types/_aws_amplify_backend_function.TimeInterval.html @@ -1 +1 @@ -TimeInterval | Amplify Toolbox
    TimeInterval: `every ${number}m` | `every ${number}h` | "every day" | "every week" | "every month" | "every year"
    \ No newline at end of file +TimeInterval | Amplify Toolbox
    TimeInterval: `every ${number}m` | `every ${number}h` | "every day" | "every week" | "every month" | "every year"
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.AIConversationOutput.html b/types/_aws_amplify_backend_output_schemas.AIConversationOutput.html index 6b6ba43519..c64fa4d1bb 100644 --- a/types/_aws_amplify_backend_output_schemas.AIConversationOutput.html +++ b/types/_aws_amplify_backend_output_schemas.AIConversationOutput.html @@ -1 +1 @@ -AIConversationOutput | Amplify Toolbox
    \ No newline at end of file +AIConversationOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.AuthOutput.html b/types/_aws_amplify_backend_output_schemas.AuthOutput.html index 59945e7ea1..31c8b279de 100644 --- a/types/_aws_amplify_backend_output_schemas.AuthOutput.html +++ b/types/_aws_amplify_backend_output_schemas.AuthOutput.html @@ -1 +1 @@ -AuthOutput | Amplify Toolbox
    \ No newline at end of file +AuthOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationType.html b/types/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationType.html index 8063ffb67e..3b35ed7731 100644 --- a/types/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationType.html +++ b/types/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationType.html @@ -1 +1 @@ -AwsAppsyncAuthenticationType | Amplify Toolbox
    \ No newline at end of file +AwsAppsyncAuthenticationType | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.BackendOutputEntryStackMetadata.html b/types/_aws_amplify_backend_output_schemas.BackendOutputEntryStackMetadata.html index 1a212ab19e..416dfaace8 100644 --- a/types/_aws_amplify_backend_output_schemas.BackendOutputEntryStackMetadata.html +++ b/types/_aws_amplify_backend_output_schemas.BackendOutputEntryStackMetadata.html @@ -1,2 +1,2 @@ BackendOutputEntryStackMetadata | Amplify Toolbox
    BackendOutputEntryStackMetadata: z.infer<typeof backendOutputEntryStackMetadataSchema>

    Inferred type from backendOutputEntryStackMetadataSchema

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.BackendOutputStackMetadata.html b/types/_aws_amplify_backend_output_schemas.BackendOutputStackMetadata.html index 203de87f67..2421f20219 100644 --- a/types/_aws_amplify_backend_output_schemas.BackendOutputStackMetadata.html +++ b/types/_aws_amplify_backend_output_schemas.BackendOutputStackMetadata.html @@ -1,2 +1,2 @@ BackendOutputStackMetadata | Amplify Toolbox
    BackendOutputStackMetadata: z.infer<typeof backendOutputStackMetadataSchema>

    Inferred type from backendOutputStackMetadataSchema

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.CustomOutput.html b/types/_aws_amplify_backend_output_schemas.CustomOutput.html index ad17e4a01f..a64ddce034 100644 --- a/types/_aws_amplify_backend_output_schemas.CustomOutput.html +++ b/types/_aws_amplify_backend_output_schemas.CustomOutput.html @@ -1 +1 @@ -CustomOutput | Amplify Toolbox
    \ No newline at end of file +CustomOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.FunctionOutput.html b/types/_aws_amplify_backend_output_schemas.FunctionOutput.html index 7d523a1d66..a27c1f7b93 100644 --- a/types/_aws_amplify_backend_output_schemas.FunctionOutput.html +++ b/types/_aws_amplify_backend_output_schemas.FunctionOutput.html @@ -1 +1 @@ -FunctionOutput | Amplify Toolbox
    \ No newline at end of file +FunctionOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.GraphqlOutput.html b/types/_aws_amplify_backend_output_schemas.GraphqlOutput.html index 647cdc0a47..e69bcce7c8 100644 --- a/types/_aws_amplify_backend_output_schemas.GraphqlOutput.html +++ b/types/_aws_amplify_backend_output_schemas.GraphqlOutput.html @@ -1 +1 @@ -GraphqlOutput | Amplify Toolbox
    \ No newline at end of file +GraphqlOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.StorageOutput.html b/types/_aws_amplify_backend_output_schemas.StorageOutput.html index eee212375c..5fc52dd59c 100644 --- a/types/_aws_amplify_backend_output_schemas.StorageOutput.html +++ b/types/_aws_amplify_backend_output_schemas.StorageOutput.html @@ -1 +1 @@ -StorageOutput | Amplify Toolbox
    \ No newline at end of file +StorageOutput | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_schemas.UnifiedBackendOutput.html b/types/_aws_amplify_backend_output_schemas.UnifiedBackendOutput.html index eea995435d..96b867e32f 100644 --- a/types/_aws_amplify_backend_output_schemas.UnifiedBackendOutput.html +++ b/types/_aws_amplify_backend_output_schemas.UnifiedBackendOutput.html @@ -1,3 +1,3 @@ UnifiedBackendOutput | Amplify Toolbox
    UnifiedBackendOutput: z.infer<typeof unifiedBackendOutputSchema>

    This type is a subset of the BackendOutput type that is exposed by the platform. It represents BackendOutput that has been validated against the schema of known output values

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_storage.AttributionMetadata.html b/types/_aws_amplify_backend_output_storage.AttributionMetadata.html index 08cc7b400c..02e718c0eb 100644 --- a/types/_aws_amplify_backend_output_storage.AttributionMetadata.html +++ b/types/_aws_amplify_backend_output_storage.AttributionMetadata.html @@ -3,4 +3,4 @@
  • createdWith: string

    The library version that created this metadata

  • metadata: Record<string, string>

    Field where constructs can put additional information for BI tracking

  • stackType: string

    String that identifies what type of stack this metadata is set on

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_storage.DeploymentEngineType.html b/types/_aws_amplify_backend_output_storage.DeploymentEngineType.html index 50f311ea42..8d14611487 100644 --- a/types/_aws_amplify_backend_output_storage.DeploymentEngineType.html +++ b/types/_aws_amplify_backend_output_storage.DeploymentEngineType.html @@ -1 +1 @@ -DeploymentEngineType | Amplify Toolbox
    DeploymentEngineType: "AmplifyPipelineDeploy" | "AmplifySandbox" | "AmplifyCDK"
    \ No newline at end of file +DeploymentEngineType | Amplify Toolbox
    DeploymentEngineType: "AmplifyPipelineDeploy" | "AmplifySandbox" | "AmplifyCDK"
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_output_storage.Platform.html b/types/_aws_amplify_backend_output_storage.Platform.html index a09b8ee294..033922ad50 100644 --- a/types/_aws_amplify_backend_output_storage.Platform.html +++ b/types/_aws_amplify_backend_output_storage.Platform.html @@ -1 +1 @@ -Platform | Amplify Toolbox
    Platform: "Mac" | "Windows" | "Linux" | "Other"
    \ No newline at end of file +Platform | Amplify Toolbox
    Platform: "Mac" | "Windows" | "Linux" | "Other"
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_platform_test_stubs.StackResolver.html b/types/_aws_amplify_backend_platform_test_stubs.StackResolver.html index 4277055e05..8955b17fea 100644 --- a/types/_aws_amplify_backend_platform_test_stubs.StackResolver.html +++ b/types/_aws_amplify_backend_platform_test_stubs.StackResolver.html @@ -1,2 +1,2 @@ StackResolver | Amplify Toolbox
    StackResolver: {
        getStackFor: ((resourceGroupName) => Stack);
    }

    Vends stacks for a resource grouping

    -

    Type declaration

    • getStackFor: ((resourceGroupName) => Stack)
        • (resourceGroupName): Stack
        • Parameters

          • resourceGroupName: string

          Returns Stack

    \ No newline at end of file +

    Type declaration

    • getStackFor: ((resourceGroupName) => Stack)
        • (resourceGroupName): Stack
        • Parameters

          • resourceGroupName: string

          Returns Stack

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.Secret.html b/types/_aws_amplify_backend_secret.Secret.html index 9c9069b169..a939bf0ff3 100644 --- a/types/_aws_amplify_backend_secret.Secret.html +++ b/types/_aws_amplify_backend_secret.Secret.html @@ -1,2 +1,2 @@ Secret | Amplify Toolbox
    Secret: SecretIdentifier & {
        lastUpdated?: Date;
        value: string;
    }

    The secret object.

    -

    Type declaration

    • Optional lastUpdated?: Date
    • value: string
    \ No newline at end of file +

    Type declaration

    • Optional lastUpdated?: Date
    • value: string
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.SecretClient.html b/types/_aws_amplify_backend_secret.SecretClient.html index ad5944a8de..8bf51acd05 100644 --- a/types/_aws_amplify_backend_secret.SecretClient.html +++ b/types/_aws_amplify_backend_secret.SecretClient.html @@ -3,4 +3,4 @@
  • listSecrets: ((backendIdentifier) => Promise<SecretListItem[]>)

    List secrets.

  • removeSecret: ((backendIdentifier, secretName) => Promise<void>)

    Remove a secret.

      • (backendIdentifier, secretName): Promise<void>
      • Parameters

        Returns Promise<void>

  • setSecret: ((backendIdentifier, secretName, secretValue) => Promise<SecretIdentifier>)

    Set a secret.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.SecretClientOptions.html b/types/_aws_amplify_backend_secret.SecretClientOptions.html index 1ab3d4b0b1..bb79a2b663 100644 --- a/types/_aws_amplify_backend_secret.SecretClientOptions.html +++ b/types/_aws_amplify_backend_secret.SecretClientOptions.html @@ -1,2 +1,2 @@ SecretClientOptions | Amplify Toolbox
    SecretClientOptions: {
        credentials?: AwsCredentialIdentityProvider;
        region?: string;
    }

    Secret client options.

    -

    Type declaration

    • Optional credentials?: AwsCredentialIdentityProvider
    • Optional region?: string
    \ No newline at end of file +

    Type declaration

    • Optional credentials?: AwsCredentialIdentityProvider
    • Optional region?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.SecretIdentifier.html b/types/_aws_amplify_backend_secret.SecretIdentifier.html index 89eecdc4b4..17405d1b04 100644 --- a/types/_aws_amplify_backend_secret.SecretIdentifier.html +++ b/types/_aws_amplify_backend_secret.SecretIdentifier.html @@ -1,2 +1,2 @@ SecretIdentifier | Amplify Toolbox
    SecretIdentifier: {
        name: string;
        version?: number;
    }

    The unique identifier of the secret.

    -

    Type declaration

    • name: string
    • Optional version?: number
    \ No newline at end of file +

    Type declaration

    • name: string
    • Optional version?: number
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_secret.SecretListItem.html b/types/_aws_amplify_backend_secret.SecretListItem.html index 9937096989..1c13d97bfe 100644 --- a/types/_aws_amplify_backend_secret.SecretListItem.html +++ b/types/_aws_amplify_backend_secret.SecretListItem.html @@ -1,2 +1,2 @@ SecretListItem | Amplify Toolbox
    SecretListItem: SecretIdentifier & {
        lastUpdated?: Date;
    }

    The returned object type of listSecrets API.

    -

    Type declaration

    • Optional lastUpdated?: Date
    \ No newline at end of file +

    Type declaration

    • Optional lastUpdated?: Date
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.AmplifyStorageFactoryProps.html b/types/_aws_amplify_backend_storage.AmplifyStorageFactoryProps.html index fad253a701..6a7047676a 100644 --- a/types/_aws_amplify_backend_storage.AmplifyStorageFactoryProps.html +++ b/types/_aws_amplify_backend_storage.AmplifyStorageFactoryProps.html @@ -2,4 +2,4 @@

    See

    https://docs.amplify.aws/gen2/build-a-backend/storage/#storage-access

    Example

    export const storage = defineStorage({
    access: (allow) => ({
    'foo/*': [allow.authenticated.to(['read'])],
    })
    })
    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.AmplifyStorageProps.html b/types/_aws_amplify_backend_storage.AmplifyStorageProps.html index 8abc866de9..583766bf99 100644 --- a/types/_aws_amplify_backend_storage.AmplifyStorageProps.html +++ b/types/_aws_amplify_backend_storage.AmplifyStorageProps.html @@ -11,4 +11,4 @@

    Example

    import<
     
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.AmplifyStorageTriggerEvent.html b/types/_aws_amplify_backend_storage.AmplifyStorageTriggerEvent.html index 320f305cf3..dd33ad17a7 100644 --- a/types/_aws_amplify_backend_storage.AmplifyStorageTriggerEvent.html +++ b/types/_aws_amplify_backend_storage.AmplifyStorageTriggerEvent.html @@ -1 +1 @@ -AmplifyStorageTriggerEvent | Amplify Toolbox
    AmplifyStorageTriggerEvent: "onDelete" | "onUpload"
    \ No newline at end of file +AmplifyStorageTriggerEvent | Amplify Toolbox
    AmplifyStorageTriggerEvent: "onDelete" | "onUpload"
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.EntityId.html b/types/_aws_amplify_backend_storage.EntityId.html index 9b554165ba..dad74668a5 100644 --- a/types/_aws_amplify_backend_storage.EntityId.html +++ b/types/_aws_amplify_backend_storage.EntityId.html @@ -1,4 +1,4 @@ EntityId | Amplify Toolbox
    EntityId: "identity"

    Types of entity IDs that can be substituted in access policies

    'identity' corresponds to the Cognito Identity Pool IdentityID

    Currently this is the only supported entity type.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAccessBuilder.html b/types/_aws_amplify_backend_storage.StorageAccessBuilder.html index a7437a37e8..3c379e18e4 100644 --- a/types/_aws_amplify_backend_storage.StorageAccessBuilder.html +++ b/types/_aws_amplify_backend_storage.StorageAccessBuilder.html @@ -20,4 +20,4 @@

    When configuring access for paths with the {entity_id} token, the token is replaced with a wildcard (*). For a path like media/profile-pictures/{entity_id}/*, this means access is configured for resources for any file within media/profile-pictures/*.

    -

    Returns StorageActionBuilder

    \ No newline at end of file +

    Returns StorageActionBuilder

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAccessDefinition.html b/types/_aws_amplify_backend_storage.StorageAccessDefinition.html index 3c4f063506..4c25d7d09e 100644 --- a/types/_aws_amplify_backend_storage.StorageAccessDefinition.html +++ b/types/_aws_amplify_backend_storage.StorageAccessDefinition.html @@ -16,4 +16,4 @@ }

    The validationErrorMessage will be used to print an error message in case of validation failure

    An empty array means that no uniqueness will be enforced

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAccessGenerator.html b/types/_aws_amplify_backend_storage.StorageAccessGenerator.html index 34a855bfd6..5f3e833b43 100644 --- a/types/_aws_amplify_backend_storage.StorageAccessGenerator.html +++ b/types/_aws_amplify_backend_storage.StorageAccessGenerator.html @@ -1 +1 @@ -StorageAccessGenerator | Amplify Toolbox
    StorageAccessGenerator: ((allow) => StorageAccessRecord)

    Type declaration

    \ No newline at end of file +StorageAccessGenerator | Amplify Toolbox
    StorageAccessGenerator: ((allow) => StorageAccessRecord)

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAccessRecord.html b/types/_aws_amplify_backend_storage.StorageAccessRecord.html index 6e33e737e7..85dedb2052 100644 --- a/types/_aws_amplify_backend_storage.StorageAccessRecord.html +++ b/types/_aws_amplify_backend_storage.StorageAccessRecord.html @@ -1 +1 @@ -StorageAccessRecord | Amplify Toolbox
    StorageAccessRecord: Record<StoragePath, StorageAccessDefinition[]>
    \ No newline at end of file +StorageAccessRecord | Amplify Toolbox
    StorageAccessRecord: Record<StoragePath, StorageAccessDefinition[]>
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageAction.html b/types/_aws_amplify_backend_storage.StorageAction.html index 19ea5c1c64..c0f6abceae 100644 --- a/types/_aws_amplify_backend_storage.StorageAction.html +++ b/types/_aws_amplify_backend_storage.StorageAction.html @@ -4,4 +4,4 @@

    'list' grants the ability to list object names matching the path prefix. It does NOT grant the ability to get the content of those objects.

    'write' grants the ability to upload objects with a certain prefix. Note that this allows both creating new objects and updating existing ones.

    'delete' grant the ability to delete objects with a certain prefix.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageActionBuilder.html b/types/_aws_amplify_backend_storage.StorageActionBuilder.html index 8bf6b1ece5..4147381ec5 100644 --- a/types/_aws_amplify_backend_storage.StorageActionBuilder.html +++ b/types/_aws_amplify_backend_storage.StorageActionBuilder.html @@ -2,4 +2,4 @@

    'read' is mutually exclusive with 'get' and 'list'

    \ No newline at end of file +

    Returns StorageAccessDefinition

    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StoragePath.html b/types/_aws_amplify_backend_storage.StoragePath.html index f98398d95f..79508a814a 100644 --- a/types/_aws_amplify_backend_storage.StoragePath.html +++ b/types/_aws_amplify_backend_storage.StoragePath.html @@ -1,2 +1,2 @@ StoragePath | Amplify Toolbox
    StoragePath: `${string}/*`

    Storage access paths must end with /*

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_backend_storage.StorageResources.html b/types/_aws_amplify_backend_storage.StorageResources.html index 11624c828b..c066ed00cd 100644 --- a/types/_aws_amplify_backend_storage.StorageResources.html +++ b/types/_aws_amplify_backend_storage.StorageResources.html @@ -1 +1 @@ -StorageResources | Amplify Toolbox
    StorageResources: {
        bucket: IBucket;
        cfnResources: {
            cfnBucket: CfnBucket;
        };
    }

    Type declaration

    • bucket: IBucket
    • cfnResources: {
          cfnBucket: CfnBucket;
      }
      • cfnBucket: CfnBucket
    \ No newline at end of file +StorageResources | Amplify Toolbox
    StorageResources: {
        bucket: IBucket;
        cfnResources: {
            cfnBucket: CfnBucket;
        };
    }

    Type declaration

    • bucket: IBucket
    • cfnResources: {
          cfnBucket: CfnBucket;
      }
      • cfnBucket: CfnBucket
    \ No newline at end of file diff --git a/types/_aws_amplify_cli_core.ColorName.html b/types/_aws_amplify_cli_core.ColorName.html index f71d42f2d0..6159ac8548 100644 --- a/types/_aws_amplify_cli_core.ColorName.html +++ b/types/_aws_amplify_cli_core.ColorName.html @@ -1 +1 @@ -ColorName | Amplify Toolbox
    ColorName: typeof colorNames[number]
    \ No newline at end of file +ColorName | Amplify Toolbox
    ColorName: typeof colorNames[number]
    \ No newline at end of file diff --git a/types/_aws_amplify_cli_core.RecordValue.html b/types/_aws_amplify_cli_core.RecordValue.html index b95d333c62..e665ab67fb 100644 --- a/types/_aws_amplify_cli_core.RecordValue.html +++ b/types/_aws_amplify_cli_core.RecordValue.html @@ -1 +1 @@ -RecordValue | Amplify Toolbox
    RecordValue: string | number | string[] | Date
    \ No newline at end of file +RecordValue | Amplify Toolbox
    RecordValue: string | number | string[] | Date
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.AnalyticsClientConfig.html b/types/_aws_amplify_client_config.AnalyticsClientConfig.html index 7d3310656b..1361fc89da 100644 --- a/types/_aws_amplify_client_config.AnalyticsClientConfig.html +++ b/types/_aws_amplify_client_config.AnalyticsClientConfig.html @@ -1 +1 @@ -AnalyticsClientConfig | Amplify Toolbox
    AnalyticsClientConfig: {
        Analytics?: {
            Pinpoint: {
                appId: string;
                region: string;
            };
        };
        aws_mobile_analytics_app_id?: string;
        aws_mobile_analytics_app_region?: string;
    }

    Type declaration

    • Optional Analytics?: {
          Pinpoint: {
              appId: string;
              region: string;
          };
      }
      • Pinpoint: {
            appId: string;
            region: string;
        }
        • appId: string
        • region: string
    • Optional aws_mobile_analytics_app_id?: string
    • Optional aws_mobile_analytics_app_region?: string
    \ No newline at end of file +AnalyticsClientConfig | Amplify Toolbox
    AnalyticsClientConfig: {
        Analytics?: {
            Pinpoint: {
                appId: string;
                region: string;
            };
        };
        aws_mobile_analytics_app_id?: string;
        aws_mobile_analytics_app_region?: string;
    }

    Type declaration

    • Optional Analytics?: {
          Pinpoint: {
              appId: string;
              region: string;
          };
      }
      • Pinpoint: {
            appId: string;
            region: string;
        }
        • appId: string
        • region: string
    • Optional aws_mobile_analytics_app_id?: string
    • Optional aws_mobile_analytics_app_region?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.AuthClientConfig.html b/types/_aws_amplify_client_config.AuthClientConfig.html index ee93ea74de..a006ad4f73 100644 --- a/types/_aws_amplify_client_config.AuthClientConfig.html +++ b/types/_aws_amplify_client_config.AuthClientConfig.html @@ -1,3 +1,3 @@ AuthClientConfig | Amplify Toolbox
    AuthClientConfig: {
        allowUnauthenticatedIdentities?: string;
        aws_cognito_identity_pool_id?: string;
        aws_cognito_mfa_configuration?: string;
        aws_cognito_mfa_types?: string[];
        aws_cognito_password_protection_settings?: {
            passwordPolicyCharacters?: string[];
            passwordPolicyMinLength?: number;
        };
        aws_cognito_region: string;
        aws_cognito_signup_attributes?: string[];
        aws_cognito_social_providers?: string[];
        aws_cognito_username_attributes?: string[];
        aws_cognito_verification_mechanisms?: string[];
        aws_mandatory_sign_in?: string;
        aws_user_pools_id?: string;
        aws_user_pools_web_client_id?: string;
        oauth?: {
            clientId?: string;
            domain?: string;
            redirectSignIn?: string;
            redirectSignOut?: string;
            responseType?: string;
            scope?: string[];
        };
    }

    Type declaration

    • Optional allowUnauthenticatedIdentities?: string
    • Optional aws_cognito_identity_pool_id?: string
    • Optional aws_cognito_mfa_configuration?: string
    • Optional aws_cognito_mfa_types?: string[]
    • Optional aws_cognito_password_protection_settings?: {
          passwordPolicyCharacters?: string[];
          passwordPolicyMinLength?: number;
      }
      • Optional passwordPolicyCharacters?: string[]
      • Optional passwordPolicyMinLength?: number
    • aws_cognito_region: string
    • Optional aws_cognito_signup_attributes?: string[]
    • Optional aws_cognito_social_providers?: string[]
    • Optional aws_cognito_username_attributes?: string[]
    • Optional aws_cognito_verification_mechanisms?: string[]
    • Optional aws_mandatory_sign_in?: string
    • Optional aws_user_pools_id?: string
    • Optional aws_user_pools_web_client_id?: string
    • Optional oauth?: {
          clientId?: string;
          domain?: string;
          redirectSignIn?: string;
          redirectSignOut?: string;
          responseType?: string;
          scope?: string[];
      }
      • Optional clientId?: string
      • Optional domain?: string
      • Optional redirectSignIn?: string
      • Optional redirectSignOut?: string
      • Optional responseType?: string
      • Optional scope?: string[]
    \ No newline at end of file +

    Type declaration

    • Optional allowUnauthenticatedIdentities?: string
    • Optional aws_cognito_identity_pool_id?: string
    • Optional aws_cognito_mfa_configuration?: string
    • Optional aws_cognito_mfa_types?: string[]
    • Optional aws_cognito_password_protection_settings?: {
          passwordPolicyCharacters?: string[];
          passwordPolicyMinLength?: number;
      }
      • Optional passwordPolicyCharacters?: string[]
      • Optional passwordPolicyMinLength?: number
    • aws_cognito_region: string
    • Optional aws_cognito_signup_attributes?: string[]
    • Optional aws_cognito_social_providers?: string[]
    • Optional aws_cognito_username_attributes?: string[]
    • Optional aws_cognito_verification_mechanisms?: string[]
    • Optional aws_mandatory_sign_in?: string
    • Optional aws_user_pools_id?: string
    • Optional aws_user_pools_web_client_id?: string
    • Optional oauth?: {
          clientId?: string;
          domain?: string;
          redirectSignIn?: string;
          redirectSignOut?: string;
          responseType?: string;
          scope?: string[];
      }
      • Optional clientId?: string
      • Optional domain?: string
      • Optional redirectSignIn?: string
      • Optional redirectSignOut?: string
      • Optional responseType?: string
      • Optional scope?: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.ClientConfig.html b/types/_aws_amplify_client_config.ClientConfig.html index 4c8cb2ccbe..253f99b6f8 100644 --- a/types/_aws_amplify_client_config.ClientConfig.html +++ b/types/_aws_amplify_client_config.ClientConfig.html @@ -1,4 +1,4 @@ ClientConfig | Amplify Toolbox

    Versions of client config schema supported by "this" package version. Create union for supported versions here, such as ClientConfig = clientConfigTypesV1.AWSAmplifyBackendOutputs | clientConfigTypesV2.AWSAmplifyBackendOutputs;

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.ClientConfigLegacy.html b/types/_aws_amplify_client_config.ClientConfigLegacy.html index 29aa94fe40..90e7b6e583 100644 --- a/types/_aws_amplify_client_config.ClientConfigLegacy.html +++ b/types/_aws_amplify_client_config.ClientConfigLegacy.html @@ -1,2 +1,2 @@ ClientConfigLegacy | Amplify Toolbox
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.ClientConfigVersion.html b/types/_aws_amplify_client_config.ClientConfigVersion.html index bfda950269..0434b5e69a 100644 --- a/types/_aws_amplify_client_config.ClientConfigVersion.html +++ b/types/_aws_amplify_client_config.ClientConfigVersion.html @@ -1 +1 @@ -ClientConfigVersion | Amplify Toolbox
    \ No newline at end of file +ClientConfigVersion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.ClientConfigVersionTemplateType.html b/types/_aws_amplify_client_config.ClientConfigVersionTemplateType.html index 36cebe6868..d9723f5750 100644 --- a/types/_aws_amplify_client_config.ClientConfigVersionTemplateType.html +++ b/types/_aws_amplify_client_config.ClientConfigVersionTemplateType.html @@ -6,4 +6,4 @@ : T extends '2' ? clientConfigTypesV2.AWSAmplifyBackendOutputs : never;

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.CustomClientConfig.html b/types/_aws_amplify_client_config.CustomClientConfig.html index 75e539811e..369f5c6127 100644 --- a/types/_aws_amplify_client_config.CustomClientConfig.html +++ b/types/_aws_amplify_client_config.CustomClientConfig.html @@ -1 +1 @@ -CustomClientConfig | Amplify Toolbox
    CustomClientConfig: {
        custom: Record<string, unknown>;
    }

    Type declaration

    • custom: Record<string, unknown>
    \ No newline at end of file +CustomClientConfig | Amplify Toolbox
    CustomClientConfig: {
        custom: Record<string, unknown>;
    }

    Type declaration

    • custom: Record<string, unknown>
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.GenerateClientConfigToFileResult.html b/types/_aws_amplify_client_config.GenerateClientConfigToFileResult.html index 36f183883c..e7fc889d1b 100644 --- a/types/_aws_amplify_client_config.GenerateClientConfigToFileResult.html +++ b/types/_aws_amplify_client_config.GenerateClientConfigToFileResult.html @@ -1 +1 @@ -GenerateClientConfigToFileResult | Amplify Toolbox
    GenerateClientConfigToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file +GenerateClientConfigToFileResult | Amplify Toolbox
    GenerateClientConfigToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.GeoClientConfig.html b/types/_aws_amplify_client_config.GeoClientConfig.html index b4084ae88a..2adfb95c84 100644 --- a/types/_aws_amplify_client_config.GeoClientConfig.html +++ b/types/_aws_amplify_client_config.GeoClientConfig.html @@ -1 +1 @@ -GeoClientConfig | Amplify Toolbox
    GeoClientConfig: {
        geo?: {
            amazon_location_service: {
                geofenceCollections?: {
                    default: string;
                    items: string[];
                };
                maps?: {
                    default: string;
                    items: Record<string, {
                        style: string;
                    }>;
                };
                region: string;
                search_indices?: {
                    default: string;
                    items: string[];
                };
            };
        };
    }

    Type declaration

    • Optional geo?: {
          amazon_location_service: {
              geofenceCollections?: {
                  default: string;
                  items: string[];
              };
              maps?: {
                  default: string;
                  items: Record<string, {
                      style: string;
                  }>;
              };
              region: string;
              search_indices?: {
                  default: string;
                  items: string[];
              };
          };
      }
      • amazon_location_service: {
            geofenceCollections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: Record<string, {
                    style: string;
                }>;
            };
            region: string;
            search_indices?: {
                default: string;
                items: string[];
            };
        }
        • Optional geofenceCollections?: {
              default: string;
              items: string[];
          }
          • default: string
          • items: string[]
        • Optional maps?: {
              default: string;
              items: Record<string, {
                  style: string;
              }>;
          }
          • default: string
          • items: Record<string, {
                style: string;
            }>
        • region: string
        • Optional search_indices?: {
              default: string;
              items: string[];
          }
          • default: string
          • items: string[]
    \ No newline at end of file +GeoClientConfig | Amplify Toolbox
    GeoClientConfig: {
        geo?: {
            amazon_location_service: {
                geofenceCollections?: {
                    default: string;
                    items: string[];
                };
                maps?: {
                    default: string;
                    items: Record<string, {
                        style: string;
                    }>;
                };
                region: string;
                search_indices?: {
                    default: string;
                    items: string[];
                };
            };
        };
    }

    Type declaration

    • Optional geo?: {
          amazon_location_service: {
              geofenceCollections?: {
                  default: string;
                  items: string[];
              };
              maps?: {
                  default: string;
                  items: Record<string, {
                      style: string;
                  }>;
              };
              region: string;
              search_indices?: {
                  default: string;
                  items: string[];
              };
          };
      }
      • amazon_location_service: {
            geofenceCollections?: {
                default: string;
                items: string[];
            };
            maps?: {
                default: string;
                items: Record<string, {
                    style: string;
                }>;
            };
            region: string;
            search_indices?: {
                default: string;
                items: string[];
            };
        }
        • Optional geofenceCollections?: {
              default: string;
              items: string[];
          }
          • default: string
          • items: string[]
        • Optional maps?: {
              default: string;
              items: Record<string, {
                  style: string;
              }>;
          }
          • default: string
          • items: Record<string, {
                style: string;
            }>
        • region: string
        • Optional search_indices?: {
              default: string;
              items: string[];
          }
          • default: string
          • items: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.GraphqlClientConfig.html b/types/_aws_amplify_client_config.GraphqlClientConfig.html index 35e9b04204..4e5362ea50 100644 --- a/types/_aws_amplify_client_config.GraphqlClientConfig.html +++ b/types/_aws_amplify_client_config.GraphqlClientConfig.html @@ -1,3 +1,3 @@ GraphqlClientConfig | Amplify Toolbox
    GraphqlClientConfig: {
        aws_appsync_additionalAuthenticationTypes?: string;
        aws_appsync_apiKey?: string;
        aws_appsync_authenticationType: string;
        aws_appsync_conflictResolutionMode?: string;
        aws_appsync_graphqlEndpoint: string;
        aws_appsync_region: string;
        modelIntrospection?: unknown;
    }

    Type declaration

    • Optional aws_appsync_additionalAuthenticationTypes?: string
    • Optional aws_appsync_apiKey?: string
    • aws_appsync_authenticationType: string
    • Optional aws_appsync_conflictResolutionMode?: string
    • aws_appsync_graphqlEndpoint: string
    • aws_appsync_region: string
    • Optional modelIntrospection?: unknown
    \ No newline at end of file +

    Type declaration

    • Optional aws_appsync_additionalAuthenticationTypes?: string
    • Optional aws_appsync_apiKey?: string
    • aws_appsync_authenticationType: string
    • Optional aws_appsync_conflictResolutionMode?: string
    • aws_appsync_graphqlEndpoint: string
    • aws_appsync_region: string
    • Optional modelIntrospection?: unknown
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.NotificationsClientConfig.html b/types/_aws_amplify_client_config.NotificationsClientConfig.html index 76989dc1c8..649cb33237 100644 --- a/types/_aws_amplify_client_config.NotificationsClientConfig.html +++ b/types/_aws_amplify_client_config.NotificationsClientConfig.html @@ -1 +1 @@ -NotificationsClientConfig | Amplify Toolbox
    NotificationsClientConfig: {
        Notifications?: {
            EMAIL?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            InAppMessaging?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            Push?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            SMS?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
        };
    }

    Type declaration

    • Optional Notifications?: {
          EMAIL?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          InAppMessaging?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          Push?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          SMS?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
      }
      • Optional EMAIL?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional InAppMessaging?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional Push?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional SMS?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
    \ No newline at end of file +NotificationsClientConfig | Amplify Toolbox
    NotificationsClientConfig: {
        Notifications?: {
            EMAIL?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            InAppMessaging?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            Push?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
            SMS?: {
                AWSPinpoint: {
                    appId: string;
                    region: string;
                };
            };
        };
    }

    Type declaration

    • Optional Notifications?: {
          EMAIL?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          InAppMessaging?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          Push?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
          SMS?: {
              AWSPinpoint: {
                  appId: string;
                  region: string;
              };
          };
      }
      • Optional EMAIL?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional InAppMessaging?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional Push?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
      • Optional SMS?: {
            AWSPinpoint: {
                appId: string;
                region: string;
            };
        }
        • AWSPinpoint: {
              appId: string;
              region: string;
          }
          • appId: string
          • region: string
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.PlatformClientConfig.html b/types/_aws_amplify_client_config.PlatformClientConfig.html index d2d7945e21..b0270b8076 100644 --- a/types/_aws_amplify_client_config.PlatformClientConfig.html +++ b/types/_aws_amplify_client_config.PlatformClientConfig.html @@ -1 +1 @@ -PlatformClientConfig | Amplify Toolbox
    PlatformClientConfig: {
        aws_project_region: string;
    }

    Type declaration

    • aws_project_region: string
    \ No newline at end of file +PlatformClientConfig | Amplify Toolbox
    PlatformClientConfig: {
        aws_project_region: string;
    }

    Type declaration

    • aws_project_region: string
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.StorageClientConfig.html b/types/_aws_amplify_client_config.StorageClientConfig.html index 78c945ba53..af611d1a97 100644 --- a/types/_aws_amplify_client_config.StorageClientConfig.html +++ b/types/_aws_amplify_client_config.StorageClientConfig.html @@ -1,3 +1,3 @@ StorageClientConfig | Amplify Toolbox
    StorageClientConfig: {
        aws_user_files_s3_bucket: string;
        aws_user_files_s3_bucket_region: string;
    }

    Type declaration

    • aws_user_files_s3_bucket: string
    • aws_user_files_s3_bucket_region: string
    \ No newline at end of file +

    Type declaration

    • aws_user_files_s3_bucket: string
    • aws_user_files_s3_bucket_region: string
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonCognitoStandardAttributes.html b/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonCognitoStandardAttributes.html index 26e35c03a4..720163eab8 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonCognitoStandardAttributes.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonCognitoStandardAttributes.html @@ -1,2 +1,2 @@ AmazonCognitoStandardAttributes | Amplify Toolbox
    AmazonCognitoStandardAttributes: "address" | "birthdate" | "email" | "family_name" | "gender" | "given_name" | "locale" | "middle_name" | "name" | "nickname" | "phone_number" | "picture" | "preferred_username" | "profile" | "sub" | "updated_at" | "website" | "zoneinfo"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonPinpointChannels.html b/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonPinpointChannels.html index 4fae6875b7..71e4aa906c 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonPinpointChannels.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1.AmazonPinpointChannels.html @@ -1,2 +1,2 @@ AmazonPinpointChannels | Amplify Toolbox
    AmazonPinpointChannels: "IN_APP_MESSAGING" | "FCM" | "APNS" | "EMAIL" | "SMS"

    supported channels for Amazon Pinpoint

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1.AwsAppsyncAuthorizationType.html b/types/_aws_amplify_client_config.clientConfigTypesV1.AwsAppsyncAuthorizationType.html index 837bb6c53d..eac09cfcb9 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1.AwsAppsyncAuthorizationType.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1.AwsAppsyncAuthorizationType.html @@ -1,2 +1,2 @@ AwsAppsyncAuthorizationType | Amplify Toolbox
    AwsAppsyncAuthorizationType: "AMAZON_COGNITO_USER_POOLS" | "API_KEY" | "AWS_IAM" | "AWS_LAMBDA" | "OPENID_CONNECT"

    List of supported auth types for AWS AppSync

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1.AwsRegion.html b/types/_aws_amplify_client_config.clientConfigTypesV1.AwsRegion.html index d14cea57f7..0806d939ec 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1.AwsRegion.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1.AwsRegion.html @@ -1 +1 @@ -AwsRegion | Amplify Toolbox
    \ No newline at end of file +AwsRegion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonCognitoStandardAttributes.html b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonCognitoStandardAttributes.html index 70648eece4..4b87a03e61 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonCognitoStandardAttributes.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonCognitoStandardAttributes.html @@ -1,2 +1,2 @@ AmazonCognitoStandardAttributes | Amplify Toolbox
    AmazonCognitoStandardAttributes: "address" | "birthdate" | "email" | "family_name" | "gender" | "given_name" | "locale" | "middle_name" | "name" | "nickname" | "phone_number" | "picture" | "preferred_username" | "profile" | "sub" | "updated_at" | "website" | "zoneinfo"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonPinpointChannels.html b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonPinpointChannels.html index 16323ccc6b..62c6cb793f 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonPinpointChannels.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AmazonPinpointChannels.html @@ -1,2 +1,2 @@ AmazonPinpointChannels | Amplify Toolbox
    AmazonPinpointChannels: "IN_APP_MESSAGING" | "FCM" | "APNS" | "EMAIL" | "SMS"

    supported channels for Amazon Pinpoint

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsAppsyncAuthorizationType.html b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsAppsyncAuthorizationType.html index ab125150d4..e2eb008439 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsAppsyncAuthorizationType.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsAppsyncAuthorizationType.html @@ -1,2 +1,2 @@ AwsAppsyncAuthorizationType | Amplify Toolbox
    AwsAppsyncAuthorizationType: "AMAZON_COGNITO_USER_POOLS" | "API_KEY" | "AWS_IAM" | "AWS_LAMBDA" | "OPENID_CONNECT"

    List of supported auth types for AWS AppSync

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsRegion.html b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsRegion.html index ca1ccb3a0b..3d5f3c5fba 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsRegion.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_1.AwsRegion.html @@ -1 +1 @@ -AwsRegion | Amplify Toolbox
    \ No newline at end of file +AwsRegion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonCognitoStandardAttributes.html b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonCognitoStandardAttributes.html index f5dce43657..0597aca13c 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonCognitoStandardAttributes.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonCognitoStandardAttributes.html @@ -1,2 +1,2 @@ AmazonCognitoStandardAttributes | Amplify Toolbox
    AmazonCognitoStandardAttributes: "address" | "birthdate" | "email" | "family_name" | "gender" | "given_name" | "locale" | "middle_name" | "name" | "nickname" | "phone_number" | "picture" | "preferred_username" | "profile" | "sub" | "updated_at" | "website" | "zoneinfo"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonPinpointChannels.html b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonPinpointChannels.html index 428716593e..17a2913e84 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonPinpointChannels.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmazonPinpointChannels.html @@ -1,2 +1,2 @@ AmazonPinpointChannels | Amplify Toolbox
    AmazonPinpointChannels: "IN_APP_MESSAGING" | "FCM" | "APNS" | "EMAIL" | "SMS"

    supported channels for Amazon Pinpoint

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageAccessActions.html b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageAccessActions.html index b978789840..af3d2e8d5e 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageAccessActions.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AmplifyStorageAccessActions.html @@ -1 +1 @@ -AmplifyStorageAccessActions | Amplify Toolbox
    AmplifyStorageAccessActions: "read" | "get" | "list" | "write" | "delete"
    \ No newline at end of file +AmplifyStorageAccessActions | Amplify Toolbox
    AmplifyStorageAccessActions: "read" | "get" | "list" | "write" | "delete"
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AwsAppsyncAuthorizationType.html b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AwsAppsyncAuthorizationType.html index 084d65fca4..f341275ed6 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AwsAppsyncAuthorizationType.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AwsAppsyncAuthorizationType.html @@ -1,2 +1,2 @@ AwsAppsyncAuthorizationType | Amplify Toolbox
    AwsAppsyncAuthorizationType: "AMAZON_COGNITO_USER_POOLS" | "API_KEY" | "AWS_IAM" | "AWS_LAMBDA" | "OPENID_CONNECT"

    List of supported auth types for AWS AppSync

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AwsRegion.html b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AwsRegion.html index fb542ca71f..5ddaddbf42 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_2.AwsRegion.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_2.AwsRegion.html @@ -1 +1 @@ -AwsRegion | Amplify Toolbox
    \ No newline at end of file +AwsRegion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonCognitoStandardAttributes.html b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonCognitoStandardAttributes.html index 12561f3a27..3dc032178c 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonCognitoStandardAttributes.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonCognitoStandardAttributes.html @@ -1,2 +1,2 @@ AmazonCognitoStandardAttributes | Amplify Toolbox
    AmazonCognitoStandardAttributes: "address" | "birthdate" | "email" | "family_name" | "gender" | "given_name" | "locale" | "middle_name" | "name" | "nickname" | "phone_number" | "picture" | "preferred_username" | "profile" | "sub" | "updated_at" | "website" | "zoneinfo"
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonPinpointChannels.html b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonPinpointChannels.html index 0f67f503e7..48941ebb00 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonPinpointChannels.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmazonPinpointChannels.html @@ -1,2 +1,2 @@ AmazonPinpointChannels | Amplify Toolbox
    AmazonPinpointChannels: "IN_APP_MESSAGING" | "FCM" | "APNS" | "EMAIL" | "SMS"

    supported channels for Amazon Pinpoint

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageAccessActions.html b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageAccessActions.html index 7e3c014dfb..8a9cb45ed2 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageAccessActions.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AmplifyStorageAccessActions.html @@ -1 +1 @@ -AmplifyStorageAccessActions | Amplify Toolbox
    AmplifyStorageAccessActions: "read" | "get" | "list" | "write" | "delete"
    \ No newline at end of file +AmplifyStorageAccessActions | Amplify Toolbox
    AmplifyStorageAccessActions: "read" | "get" | "list" | "write" | "delete"
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AwsAppsyncAuthorizationType.html b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AwsAppsyncAuthorizationType.html index fc0c3dcbe6..97f1124755 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AwsAppsyncAuthorizationType.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AwsAppsyncAuthorizationType.html @@ -1,2 +1,2 @@ AwsAppsyncAuthorizationType | Amplify Toolbox
    AwsAppsyncAuthorizationType: "AMAZON_COGNITO_USER_POOLS" | "API_KEY" | "AWS_IAM" | "AWS_LAMBDA" | "OPENID_CONNECT"

    List of supported auth types for AWS AppSync

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AwsRegion.html b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AwsRegion.html index b97b0d438b..7b19bcb42a 100644 --- a/types/_aws_amplify_client_config.clientConfigTypesV1_3.AwsRegion.html +++ b/types/_aws_amplify_client_config.clientConfigTypesV1_3.AwsRegion.html @@ -1 +1 @@ -AwsRegion | Amplify Toolbox
    \ No newline at end of file +AwsRegion | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.AppNameAndBranchBackendIdentifier.html b/types/_aws_amplify_deployed_backend_client.AppNameAndBranchBackendIdentifier.html index e1587240cf..c991f4cc8e 100644 --- a/types/_aws_amplify_deployed_backend_client.AppNameAndBranchBackendIdentifier.html +++ b/types/_aws_amplify_deployed_backend_client.AppNameAndBranchBackendIdentifier.html @@ -1,2 +1,2 @@ AppNameAndBranchBackendIdentifier | Amplify Toolbox
    AppNameAndBranchBackendIdentifier: {
        appName: string;
        branchName: string;
    }

    Tuple of Amplify App name and branch

    -

    Type declaration

    • appName: string
    • branchName: string
    \ No newline at end of file +

    Type declaration

    • appName: string
    • branchName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendMetadata.html b/types/_aws_amplify_deployed_backend_client.BackendMetadata.html index dacc5d10c9..87bb99af2d 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendMetadata.html +++ b/types/_aws_amplify_deployed_backend_client.BackendMetadata.html @@ -1 +1 @@ -BackendMetadata | Amplify Toolbox
    BackendMetadata: {
        apiConfiguration?: {
            additionalAuthTypes: ApiAuthType[];
            apiId: string;
            conflictResolutionMode?: ConflictResolutionMode;
            defaultAuthType: ApiAuthType;
            graphqlEndpoint: string;
            lastUpdated: Date | undefined;
            modelSchemaS3Uri: string;
            status: BackendDeploymentStatus;
        };
        authConfiguration?: {
            lastUpdated: Date | undefined;
            status: BackendDeploymentStatus;
            userPoolId: string;
        };
        deploymentType: DeploymentType;
        functionConfigurations?: FunctionConfiguration[];
        lastUpdated: Date | undefined;
        name: string;
        resources: DeployedBackendResource[];
        status: BackendDeploymentStatus;
        storageConfiguration?: {
            lastUpdated: Date | undefined;
            s3BucketName: string;
            status: BackendDeploymentStatus;
        };
    }

    Type declaration

    \ No newline at end of file +BackendMetadata | Amplify Toolbox
    BackendMetadata: {
        apiConfiguration?: {
            additionalAuthTypes: ApiAuthType[];
            apiId: string;
            conflictResolutionMode?: ConflictResolutionMode;
            defaultAuthType: ApiAuthType;
            graphqlEndpoint: string;
            lastUpdated: Date | undefined;
            modelSchemaS3Uri: string;
            status: BackendDeploymentStatus;
        };
        authConfiguration?: {
            lastUpdated: Date | undefined;
            status: BackendDeploymentStatus;
            userPoolId: string;
        };
        deploymentType: DeploymentType;
        functionConfigurations?: FunctionConfiguration[];
        lastUpdated: Date | undefined;
        name: string;
        resources: DeployedBackendResource[];
        status: BackendDeploymentStatus;
        storageConfiguration?: {
            lastUpdated: Date | undefined;
            s3BucketName: string;
            status: BackendDeploymentStatus;
        };
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendOutputClient.html b/types/_aws_amplify_deployed_backend_client.BackendOutputClient.html index 5c5dcd5730..fb7d2dc1cb 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendOutputClient.html +++ b/types/_aws_amplify_deployed_backend_client.BackendOutputClient.html @@ -1,2 +1,2 @@ BackendOutputClient | Amplify Toolbox
    BackendOutputClient: {
        getOutput: ((backendIdentifier) => Promise<UnifiedBackendOutput>);
    }

    Defines BackendOutputClient

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendOutputClientFactoryOptions.html b/types/_aws_amplify_deployed_backend_client.BackendOutputClientFactoryOptions.html index 90a7d2ba35..a0d790dba6 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendOutputClientFactoryOptions.html +++ b/types/_aws_amplify_deployed_backend_client.BackendOutputClientFactoryOptions.html @@ -1 +1 @@ -BackendOutputClientFactoryOptions | Amplify Toolbox
    \ No newline at end of file +BackendOutputClientFactoryOptions | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendOutputClientOptions.html b/types/_aws_amplify_deployed_backend_client.BackendOutputClientOptions.html index f647933b14..d9a7cc1313 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendOutputClientOptions.html +++ b/types/_aws_amplify_deployed_backend_client.BackendOutputClientOptions.html @@ -1 +1 @@ -BackendOutputClientOptions | Amplify Toolbox
    BackendOutputClientOptions: {
        amplifyClient: AmplifyClient;
        cloudFormationClient: CloudFormationClient;
    }

    Type declaration

    • amplifyClient: AmplifyClient
    • cloudFormationClient: CloudFormationClient
    \ No newline at end of file +BackendOutputClientOptions | Amplify Toolbox
    BackendOutputClientOptions: {
        amplifyClient: AmplifyClient;
        cloudFormationClient: CloudFormationClient;
    }

    Type declaration

    • amplifyClient: AmplifyClient
    • cloudFormationClient: CloudFormationClient
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendOutputCredentialsOptions.html b/types/_aws_amplify_deployed_backend_client.BackendOutputCredentialsOptions.html index f344fb597b..7bd3711f0c 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendOutputCredentialsOptions.html +++ b/types/_aws_amplify_deployed_backend_client.BackendOutputCredentialsOptions.html @@ -1 +1 @@ -BackendOutputCredentialsOptions | Amplify Toolbox
    BackendOutputCredentialsOptions: {
        credentials: AwsCredentialIdentityProvider;
    }

    Type declaration

    • credentials: AwsCredentialIdentityProvider
    \ No newline at end of file +BackendOutputCredentialsOptions | Amplify Toolbox
    BackendOutputCredentialsOptions: {
        credentials: AwsCredentialIdentityProvider;
    }

    Type declaration

    • credentials: AwsCredentialIdentityProvider
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.BackendSummaryMetadata.html b/types/_aws_amplify_deployed_backend_client.BackendSummaryMetadata.html index d0eb144a45..6524e5986e 100644 --- a/types/_aws_amplify_deployed_backend_client.BackendSummaryMetadata.html +++ b/types/_aws_amplify_deployed_backend_client.BackendSummaryMetadata.html @@ -1 +1 @@ -BackendSummaryMetadata | Amplify Toolbox
    BackendSummaryMetadata: {
        backendId: BackendIdentifier | undefined;
        lastUpdated: Date | undefined;
        name: string;
        status: BackendDeploymentStatus;
    }

    Type declaration

    \ No newline at end of file +BackendSummaryMetadata | Amplify Toolbox
    BackendSummaryMetadata: {
        backendId: BackendIdentifier | undefined;
        lastUpdated: Date | undefined;
        name: string;
        status: BackendDeploymentStatus;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.DeployedBackendClient.html b/types/_aws_amplify_deployed_backend_client.DeployedBackendClient.html index 452edfae8d..ca69dac055 100644 --- a/types/_aws_amplify_deployed_backend_client.DeployedBackendClient.html +++ b/types/_aws_amplify_deployed_backend_client.DeployedBackendClient.html @@ -1 +1 @@ -DeployedBackendClient | Amplify Toolbox
    DeployedBackendClient: {
        deleteSandbox: ((sandboxBackendIdentifier) => Promise<void>);
        getBackendMetadata: ((backendId) => Promise<BackendMetadata>);
        listBackends: ((listBackendsRequest?) => ListBackendsResponse);
    }

    Type declaration

    \ No newline at end of file +DeployedBackendClient | Amplify Toolbox
    DeployedBackendClient: {
        deleteSandbox: ((sandboxBackendIdentifier) => Promise<void>);
        getBackendMetadata: ((backendId) => Promise<BackendMetadata>);
        listBackends: ((listBackendsRequest?) => ListBackendsResponse);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.DeployedBackendIdentifier.html b/types/_aws_amplify_deployed_backend_client.DeployedBackendIdentifier.html index de0e6e8ddc..114f2e08da 100644 --- a/types/_aws_amplify_deployed_backend_client.DeployedBackendIdentifier.html +++ b/types/_aws_amplify_deployed_backend_client.DeployedBackendIdentifier.html @@ -1 +1 @@ -DeployedBackendIdentifier | Amplify Toolbox
    \ No newline at end of file +DeployedBackendIdentifier | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.DeployedBackendResource.html b/types/_aws_amplify_deployed_backend_client.DeployedBackendResource.html index 6b8e34d283..93900048ad 100644 --- a/types/_aws_amplify_deployed_backend_client.DeployedBackendResource.html +++ b/types/_aws_amplify_deployed_backend_client.DeployedBackendResource.html @@ -1 +1 @@ -DeployedBackendResource | Amplify Toolbox
    DeployedBackendResource: {
        arn?: string;
        lastUpdated?: Date;
        logicalResourceId?: string;
        physicalResourceId?: string;
        resourceStatus?: string;
        resourceStatusReason?: string;
        resourceType?: string;
    }

    Type declaration

    • Optional arn?: string
    • Optional lastUpdated?: Date
    • Optional logicalResourceId?: string
    • Optional physicalResourceId?: string
    • Optional resourceStatus?: string
    • Optional resourceStatusReason?: string
    • Optional resourceType?: string
    \ No newline at end of file +DeployedBackendResource | Amplify Toolbox
    DeployedBackendResource: {
        arn?: string;
        lastUpdated?: Date;
        logicalResourceId?: string;
        physicalResourceId?: string;
        resourceStatus?: string;
        resourceStatusReason?: string;
        resourceType?: string;
    }

    Type declaration

    • Optional arn?: string
    • Optional lastUpdated?: Date
    • Optional logicalResourceId?: string
    • Optional physicalResourceId?: string
    • Optional resourceStatus?: string
    • Optional resourceStatusReason?: string
    • Optional resourceType?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.FunctionConfiguration.html b/types/_aws_amplify_deployed_backend_client.FunctionConfiguration.html index 829ad0d8ef..f7a16eb326 100644 --- a/types/_aws_amplify_deployed_backend_client.FunctionConfiguration.html +++ b/types/_aws_amplify_deployed_backend_client.FunctionConfiguration.html @@ -1 +1 @@ -FunctionConfiguration | Amplify Toolbox
    FunctionConfiguration: {
        functionName: string;
        lastUpdated: Date | undefined;
        status: BackendDeploymentStatus;
    }

    Type declaration

    \ No newline at end of file +FunctionConfiguration | Amplify Toolbox
    FunctionConfiguration: {
        functionName: string;
        lastUpdated: Date | undefined;
        status: BackendDeploymentStatus;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.ListBackendsRequest.html b/types/_aws_amplify_deployed_backend_client.ListBackendsRequest.html index 054e8b98cf..740d4f70b0 100644 --- a/types/_aws_amplify_deployed_backend_client.ListBackendsRequest.html +++ b/types/_aws_amplify_deployed_backend_client.ListBackendsRequest.html @@ -1 +1 @@ -ListBackendsRequest | Amplify Toolbox
    ListBackendsRequest: {
        backendStatusFilters?: BackendStatus[];
        deploymentType: DeploymentType;
    }

    Type declaration

    \ No newline at end of file +ListBackendsRequest | Amplify Toolbox
    ListBackendsRequest: {
        backendStatusFilters?: BackendStatus[];
        deploymentType: DeploymentType;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.ListBackendsResponse.html b/types/_aws_amplify_deployed_backend_client.ListBackendsResponse.html index 78334d8a98..fc5c055b79 100644 --- a/types/_aws_amplify_deployed_backend_client.ListBackendsResponse.html +++ b/types/_aws_amplify_deployed_backend_client.ListBackendsResponse.html @@ -1 +1 @@ -ListBackendsResponse | Amplify Toolbox
    ListBackendsResponse: {
        getBackendSummaryByPage: (() => AsyncGenerator<BackendSummaryMetadata[]>);
    }

    Type declaration

    \ No newline at end of file +ListBackendsResponse | Amplify Toolbox
    ListBackendsResponse: {
        getBackendSummaryByPage: (() => AsyncGenerator<BackendSummaryMetadata[]>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_deployed_backend_client.StackIdentifier.html b/types/_aws_amplify_deployed_backend_client.StackIdentifier.html index 6b40eba04a..8126e83485 100644 --- a/types/_aws_amplify_deployed_backend_client.StackIdentifier.html +++ b/types/_aws_amplify_deployed_backend_client.StackIdentifier.html @@ -1 +1 @@ -StackIdentifier | Amplify Toolbox
    StackIdentifier: {
        stackName: string;
    }

    Type declaration

    • stackName: string
    \ No newline at end of file +StackIdentifier | Amplify Toolbox
    StackIdentifier: {
        stackName: string;
    }

    Type declaration

    • stackName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.FormGenerationOptions.html b/types/_aws_amplify_form_generator.FormGenerationOptions.html index 99e6a2fe75..a13631f1e7 100644 --- a/types/_aws_amplify_form_generator.FormGenerationOptions.html +++ b/types/_aws_amplify_form_generator.FormGenerationOptions.html @@ -1 +1 @@ -FormGenerationOptions | Amplify Toolbox
    FormGenerationOptions: {
        models?: string[];
    }

    Type declaration

    • Optional models?: string[]
    \ No newline at end of file +FormGenerationOptions | Amplify Toolbox
    FormGenerationOptions: {
        models?: string[];
    }

    Type declaration

    • Optional models?: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.GenerateGraphqlToFileResult.html b/types/_aws_amplify_form_generator.GenerateGraphqlToFileResult.html index c5f4575ec2..2ba2b4f19a 100644 --- a/types/_aws_amplify_form_generator.GenerateGraphqlToFileResult.html +++ b/types/_aws_amplify_form_generator.GenerateGraphqlToFileResult.html @@ -1 +1 @@ -GenerateGraphqlToFileResult | Amplify Toolbox
    GenerateGraphqlToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file +GenerateGraphqlToFileResult | Amplify Toolbox
    GenerateGraphqlToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.GraphqlFormGenerator.html b/types/_aws_amplify_form_generator.GraphqlFormGenerator.html index c961e5bdf3..3c608a8ffb 100644 --- a/types/_aws_amplify_form_generator.GraphqlFormGenerator.html +++ b/types/_aws_amplify_form_generator.GraphqlFormGenerator.html @@ -1 +1 @@ -GraphqlFormGenerator | Amplify Toolbox
    GraphqlFormGenerator: {
        generateForms: ((options?) => Promise<GraphqlGenerationResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlFormGenerator | Amplify Toolbox
    GraphqlFormGenerator: {
        generateForms: ((options?) => Promise<GraphqlGenerationResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.GraphqlGenerationResult.html b/types/_aws_amplify_form_generator.GraphqlGenerationResult.html index ed71149e7a..973b1ff87b 100644 --- a/types/_aws_amplify_form_generator.GraphqlGenerationResult.html +++ b/types/_aws_amplify_form_generator.GraphqlGenerationResult.html @@ -1 +1 @@ -GraphqlGenerationResult | Amplify Toolbox
    GraphqlGenerationResult: {
        writeToDirectory: ((directoryPath) => Promise<GenerateGraphqlToFileResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlGenerationResult | Amplify Toolbox
    GraphqlGenerationResult: {
        writeToDirectory: ((directoryPath) => Promise<GenerateGraphqlToFileResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_form_generator.LocalGraphqlFormGeneratorParams.html b/types/_aws_amplify_form_generator.LocalGraphqlFormGeneratorParams.html index 3b50ff24f1..10fbdd4b79 100644 --- a/types/_aws_amplify_form_generator.LocalGraphqlFormGeneratorParams.html +++ b/types/_aws_amplify_form_generator.LocalGraphqlFormGeneratorParams.html @@ -1 +1 @@ -LocalGraphqlFormGeneratorParams | Amplify Toolbox
    LocalGraphqlFormGeneratorParams: {
        graphqlModelDirectoryPath: string;
        introspectionSchemaUrl: string;
    }

    Type declaration

    • graphqlModelDirectoryPath: string
    • introspectionSchemaUrl: string
    \ No newline at end of file +LocalGraphqlFormGeneratorParams | Amplify Toolbox
    LocalGraphqlFormGeneratorParams: {
        graphqlModelDirectoryPath: string;
        introspectionSchemaUrl: string;
    }

    Type declaration

    • graphqlModelDirectoryPath: string
    • introspectionSchemaUrl: string
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.DocumentGenerationParameters.html b/types/_aws_amplify_model_generator.DocumentGenerationParameters.html index 2d7f480dcf..1da16a1185 100644 --- a/types/_aws_amplify_model_generator.DocumentGenerationParameters.html +++ b/types/_aws_amplify_model_generator.DocumentGenerationParameters.html @@ -1 +1 @@ -DocumentGenerationParameters | Amplify Toolbox
    DocumentGenerationParameters: {
        maxDepth?: number;
        relativeTypesPath?: string;
        targetFormat: StatementsTarget;
        typenameIntrospection?: boolean;
    }

    Type declaration

    • Optional maxDepth?: number
    • Optional relativeTypesPath?: string
    • targetFormat: StatementsTarget
    • Optional typenameIntrospection?: boolean
    \ No newline at end of file +DocumentGenerationParameters | Amplify Toolbox
    DocumentGenerationParameters: {
        maxDepth?: number;
        relativeTypesPath?: string;
        targetFormat: StatementsTarget;
        typenameIntrospection?: boolean;
    }

    Type declaration

    • Optional maxDepth?: number
    • Optional relativeTypesPath?: string
    • targetFormat: StatementsTarget
    • Optional typenameIntrospection?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateApiCodeProps.html b/types/_aws_amplify_model_generator.GenerateApiCodeProps.html index 468cc29f04..1f93d48535 100644 --- a/types/_aws_amplify_model_generator.GenerateApiCodeProps.html +++ b/types/_aws_amplify_model_generator.GenerateApiCodeProps.html @@ -1 +1 @@ -GenerateApiCodeProps | Amplify Toolbox
    GenerateApiCodeProps: GenerateOptions & DeployedBackendIdentifier & {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
    }

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    \ No newline at end of file +GenerateApiCodeProps | Amplify Toolbox
    GenerateApiCodeProps: GenerateOptions & DeployedBackendIdentifier & {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
    }

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateGraphqlCodegenOptions.html b/types/_aws_amplify_model_generator.GenerateGraphqlCodegenOptions.html index f60a7b7995..e08803248f 100644 --- a/types/_aws_amplify_model_generator.GenerateGraphqlCodegenOptions.html +++ b/types/_aws_amplify_model_generator.GenerateGraphqlCodegenOptions.html @@ -1 +1 @@ -GenerateGraphqlCodegenOptions | Amplify Toolbox
    GenerateGraphqlCodegenOptions: {
        format: GRAPHQL_CODEGEN;
        maxDepth?: number;
        multipleSwiftFiles?: boolean;
        statementTarget: GenerateApiCodeStatementTarget;
        typeNameIntrospection?: boolean;
        typeTarget?: GenerateApiCodeTypeTarget;
    }

    Type declaration

    \ No newline at end of file +GenerateGraphqlCodegenOptions | Amplify Toolbox
    GenerateGraphqlCodegenOptions: {
        format: GRAPHQL_CODEGEN;
        maxDepth?: number;
        multipleSwiftFiles?: boolean;
        statementTarget: GenerateApiCodeStatementTarget;
        typeNameIntrospection?: boolean;
        typeTarget?: GenerateApiCodeTypeTarget;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateGraphqlCodegenToFileResult.html b/types/_aws_amplify_model_generator.GenerateGraphqlCodegenToFileResult.html index d39ce18ac8..de38f657c4 100644 --- a/types/_aws_amplify_model_generator.GenerateGraphqlCodegenToFileResult.html +++ b/types/_aws_amplify_model_generator.GenerateGraphqlCodegenToFileResult.html @@ -1 +1 @@ -GenerateGraphqlCodegenToFileResult | Amplify Toolbox
    GenerateGraphqlCodegenToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file +GenerateGraphqlCodegenToFileResult | Amplify Toolbox
    GenerateGraphqlCodegenToFileResult: {
        filesWritten: string[];
    }

    Type declaration

    • filesWritten: string[]
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateIntrospectionOptions.html b/types/_aws_amplify_model_generator.GenerateIntrospectionOptions.html index 8a7ae5d17c..ee302bc8ee 100644 --- a/types/_aws_amplify_model_generator.GenerateIntrospectionOptions.html +++ b/types/_aws_amplify_model_generator.GenerateIntrospectionOptions.html @@ -1 +1 @@ -GenerateIntrospectionOptions | Amplify Toolbox
    GenerateIntrospectionOptions: {
        format: INTROSPECTION;
    }

    Type declaration

    \ No newline at end of file +GenerateIntrospectionOptions | Amplify Toolbox
    GenerateIntrospectionOptions: {
        format: INTROSPECTION;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateModelsOptions.html b/types/_aws_amplify_model_generator.GenerateModelsOptions.html index 5e7b8d3e4d..6c8e66906f 100644 --- a/types/_aws_amplify_model_generator.GenerateModelsOptions.html +++ b/types/_aws_amplify_model_generator.GenerateModelsOptions.html @@ -1 +1 @@ -GenerateModelsOptions | Amplify Toolbox
    GenerateModelsOptions: {
        addTimestampFields?: boolean;
        emitAuthProvider?: boolean;
        format: MODELGEN;
        generateIndexRules?: boolean;
        generateModelsForLazyLoadAndCustomSelectionSet?: boolean;
        handleListNullabilityTransparently?: boolean;
        modelTarget: GenerateApiCodeModelTarget;
        respectPrimaryKeyAttributesOnConnectionField?: boolean;
        transformerVersion?: number;
        useExperimentalPipelinedTransformer?: boolean;
    }

    Type declaration

    • Optional addTimestampFields?: boolean
    • Optional emitAuthProvider?: boolean
    • format: MODELGEN
    • Optional generateIndexRules?: boolean
    • Optional generateModelsForLazyLoadAndCustomSelectionSet?: boolean
    • Optional handleListNullabilityTransparently?: boolean
    • modelTarget: GenerateApiCodeModelTarget
    • Optional respectPrimaryKeyAttributesOnConnectionField?: boolean
    • Optional transformerVersion?: number
    • Optional useExperimentalPipelinedTransformer?: boolean
    \ No newline at end of file +GenerateModelsOptions | Amplify Toolbox
    GenerateModelsOptions: {
        addTimestampFields?: boolean;
        emitAuthProvider?: boolean;
        format: MODELGEN;
        generateIndexRules?: boolean;
        generateModelsForLazyLoadAndCustomSelectionSet?: boolean;
        handleListNullabilityTransparently?: boolean;
        modelTarget: GenerateApiCodeModelTarget;
        respectPrimaryKeyAttributesOnConnectionField?: boolean;
        transformerVersion?: number;
        useExperimentalPipelinedTransformer?: boolean;
    }

    Type declaration

    • Optional addTimestampFields?: boolean
    • Optional emitAuthProvider?: boolean
    • format: MODELGEN
    • Optional generateIndexRules?: boolean
    • Optional generateModelsForLazyLoadAndCustomSelectionSet?: boolean
    • Optional handleListNullabilityTransparently?: boolean
    • modelTarget: GenerateApiCodeModelTarget
    • Optional respectPrimaryKeyAttributesOnConnectionField?: boolean
    • Optional transformerVersion?: number
    • Optional useExperimentalPipelinedTransformer?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerateOptions.html b/types/_aws_amplify_model_generator.GenerateOptions.html index 822f16e6e9..d9506d7cf2 100644 --- a/types/_aws_amplify_model_generator.GenerateOptions.html +++ b/types/_aws_amplify_model_generator.GenerateOptions.html @@ -1 +1 @@ -GenerateOptions | Amplify Toolbox
    \ No newline at end of file +GenerateOptions | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GenerationResult.html b/types/_aws_amplify_model_generator.GenerationResult.html index 240cf77daf..7487d5c33b 100644 --- a/types/_aws_amplify_model_generator.GenerationResult.html +++ b/types/_aws_amplify_model_generator.GenerationResult.html @@ -1 +1 @@ -GenerationResult | Amplify Toolbox
    GenerationResult: {
        getResults: (() => Promise<Record<string, string>>);
        writeToDirectory: ((directoryPath) => Promise<GenerateGraphqlCodegenToFileResult>);
    }

    Type declaration

    \ No newline at end of file +GenerationResult | Amplify Toolbox
    GenerationResult: {
        getResults: (() => Promise<Record<string, string>>);
        writeToDirectory: ((directoryPath) => Promise<GenerateGraphqlCodegenToFileResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlDocumentGenerator.html b/types/_aws_amplify_model_generator.GraphqlDocumentGenerator.html index ca0c3fddd1..b4c2d5c07f 100644 --- a/types/_aws_amplify_model_generator.GraphqlDocumentGenerator.html +++ b/types/_aws_amplify_model_generator.GraphqlDocumentGenerator.html @@ -1 +1 @@ -GraphqlDocumentGenerator | Amplify Toolbox
    GraphqlDocumentGenerator: {
        generateModels: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlDocumentGenerator | Amplify Toolbox
    GraphqlDocumentGenerator: {
        generateModels: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlDocumentGeneratorFactoryParams.html b/types/_aws_amplify_model_generator.GraphqlDocumentGeneratorFactoryParams.html index 678134cd19..bfd3bbfb22 100644 --- a/types/_aws_amplify_model_generator.GraphqlDocumentGeneratorFactoryParams.html +++ b/types/_aws_amplify_model_generator.GraphqlDocumentGeneratorFactoryParams.html @@ -1 +1 @@ -GraphqlDocumentGeneratorFactoryParams | Amplify Toolbox
    GraphqlDocumentGeneratorFactoryParams: {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
        }>;
        backendIdentifier: DeployedBackendIdentifier;
    }

    Type declaration

    \ No newline at end of file +GraphqlDocumentGeneratorFactoryParams | Amplify Toolbox
    GraphqlDocumentGeneratorFactoryParams: {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
        }>;
        backendIdentifier: DeployedBackendIdentifier;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlModelsGenerator.html b/types/_aws_amplify_model_generator.GraphqlModelsGenerator.html index 2d92c5a265..22f84470c7 100644 --- a/types/_aws_amplify_model_generator.GraphqlModelsGenerator.html +++ b/types/_aws_amplify_model_generator.GraphqlModelsGenerator.html @@ -1 +1 @@ -GraphqlModelsGenerator | Amplify Toolbox
    GraphqlModelsGenerator: {
        generateModels: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlModelsGenerator | Amplify Toolbox
    GraphqlModelsGenerator: {
        generateModels: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlModelsGeneratorFactoryParams.html b/types/_aws_amplify_model_generator.GraphqlModelsGeneratorFactoryParams.html index c7b28622a4..d967f8a4ac 100644 --- a/types/_aws_amplify_model_generator.GraphqlModelsGeneratorFactoryParams.html +++ b/types/_aws_amplify_model_generator.GraphqlModelsGeneratorFactoryParams.html @@ -1 +1 @@ -GraphqlModelsGeneratorFactoryParams | Amplify Toolbox
    GraphqlModelsGeneratorFactoryParams: {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
        backendIdentifier: DeployedBackendIdentifier;
    } | {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
        modelSchemaS3Uri: string;
    }

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    • backendIdentifier: DeployedBackendIdentifier

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    • modelSchemaS3Uri: string
    \ No newline at end of file +GraphqlModelsGeneratorFactoryParams | Amplify Toolbox
    GraphqlModelsGeneratorFactoryParams: {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
        backendIdentifier: DeployedBackendIdentifier;
    } | {
        awsClientProvider: AWSClientProvider<{
            getAmplifyClient: AmplifyClient;
            getCloudFormationClient: CloudFormationClient;
            getS3Client: S3Client;
        }>;
        modelSchemaS3Uri: string;
    }

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    • backendIdentifier: DeployedBackendIdentifier

    Type declaration

    • awsClientProvider: AWSClientProvider<{
          getAmplifyClient: AmplifyClient;
          getCloudFormationClient: CloudFormationClient;
          getS3Client: S3Client;
      }>
    • modelSchemaS3Uri: string
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.GraphqlTypesGenerator.html b/types/_aws_amplify_model_generator.GraphqlTypesGenerator.html index 9a4036f001..97b578b622 100644 --- a/types/_aws_amplify_model_generator.GraphqlTypesGenerator.html +++ b/types/_aws_amplify_model_generator.GraphqlTypesGenerator.html @@ -1 +1 @@ -GraphqlTypesGenerator | Amplify Toolbox
    GraphqlTypesGenerator: {
        generateTypes: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file +GraphqlTypesGenerator | Amplify Toolbox
    GraphqlTypesGenerator: {
        generateTypes: ((params) => Promise<GenerationResult>);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.ModelsGenerationParameters.html b/types/_aws_amplify_model_generator.ModelsGenerationParameters.html index a303c96ac0..95d30ba073 100644 --- a/types/_aws_amplify_model_generator.ModelsGenerationParameters.html +++ b/types/_aws_amplify_model_generator.ModelsGenerationParameters.html @@ -1 +1 @@ -ModelsGenerationParameters | Amplify Toolbox
    ModelsGenerationParameters: {
        addTimestampFields?: boolean;
        emitAuthProvider?: boolean;
        generateIndexRules?: boolean;
        generateModelsForLazyLoadAndCustomSelectionSet?: boolean;
        handleListNullabilityTransparently?: boolean;
        respectPrimaryKeyAttributesOnConnectionField?: boolean;
        target: ModelsTarget;
        transformerVersion?: number;
        useExperimentalPipelinedTransformer?: boolean;
    }

    Type declaration

    • Optional addTimestampFields?: boolean
    • Optional emitAuthProvider?: boolean
    • Optional generateIndexRules?: boolean
    • Optional generateModelsForLazyLoadAndCustomSelectionSet?: boolean
    • Optional handleListNullabilityTransparently?: boolean
    • Optional respectPrimaryKeyAttributesOnConnectionField?: boolean
    • target: ModelsTarget
    • Optional transformerVersion?: number
    • Optional useExperimentalPipelinedTransformer?: boolean
    \ No newline at end of file +ModelsGenerationParameters | Amplify Toolbox
    ModelsGenerationParameters: {
        addTimestampFields?: boolean;
        emitAuthProvider?: boolean;
        generateIndexRules?: boolean;
        generateModelsForLazyLoadAndCustomSelectionSet?: boolean;
        handleListNullabilityTransparently?: boolean;
        respectPrimaryKeyAttributesOnConnectionField?: boolean;
        target: ModelsTarget;
        transformerVersion?: number;
        useExperimentalPipelinedTransformer?: boolean;
    }

    Type declaration

    • Optional addTimestampFields?: boolean
    • Optional emitAuthProvider?: boolean
    • Optional generateIndexRules?: boolean
    • Optional generateModelsForLazyLoadAndCustomSelectionSet?: boolean
    • Optional handleListNullabilityTransparently?: boolean
    • Optional respectPrimaryKeyAttributesOnConnectionField?: boolean
    • target: ModelsTarget
    • Optional transformerVersion?: number
    • Optional useExperimentalPipelinedTransformer?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_model_generator.TypesGenerationParameters.html b/types/_aws_amplify_model_generator.TypesGenerationParameters.html index b2d4f87657..3c89212019 100644 --- a/types/_aws_amplify_model_generator.TypesGenerationParameters.html +++ b/types/_aws_amplify_model_generator.TypesGenerationParameters.html @@ -1 +1 @@ -TypesGenerationParameters | Amplify Toolbox
    TypesGenerationParameters: {
        maxDepth?: number;
        multipleSwiftFiles?: boolean;
        target: TypesTarget;
        typenameIntrospection?: boolean;
    }

    Type declaration

    • Optional maxDepth?: number
    • Optional multipleSwiftFiles?: boolean
    • target: TypesTarget
    • Optional typenameIntrospection?: boolean
    \ No newline at end of file +TypesGenerationParameters | Amplify Toolbox
    TypesGenerationParameters: {
        maxDepth?: number;
        multipleSwiftFiles?: boolean;
        target: TypesTarget;
        typenameIntrospection?: boolean;
    }

    Type declaration

    • Optional maxDepth?: number
    • Optional multipleSwiftFiles?: boolean
    • target: TypesTarget
    • Optional typenameIntrospection?: boolean
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.AmplifyErrorClassification.html b/types/_aws_amplify_platform_core.AmplifyErrorClassification.html index 952be9d3f5..b5defcb8a0 100644 --- a/types/_aws_amplify_platform_core.AmplifyErrorClassification.html +++ b/types/_aws_amplify_platform_core.AmplifyErrorClassification.html @@ -1,2 +1,2 @@ AmplifyErrorClassification | Amplify Toolbox
    AmplifyErrorClassification: "FAULT" | "ERROR"

    Amplify exception classifications

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.AmplifyErrorOptions.html b/types/_aws_amplify_platform_core.AmplifyErrorOptions.html index f47672ad84..b6bfbfa001 100644 --- a/types/_aws_amplify_platform_core.AmplifyErrorOptions.html +++ b/types/_aws_amplify_platform_core.AmplifyErrorOptions.html @@ -1,2 +1,2 @@ AmplifyErrorOptions | Amplify Toolbox
    AmplifyErrorOptions: {
        code?: string;
        details?: string;
        link?: string;
        message: string;
        resolution?: string;
    }

    Amplify Error options object

    -

    Type declaration

    • Optional code?: string
    • Optional details?: string
    • Optional link?: string
    • message: string
    • Optional resolution?: string
    \ No newline at end of file +

    Type declaration

    • Optional code?: string
    • Optional details?: string
    • Optional link?: string
    • message: string
    • Optional resolution?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.AmplifyUserErrorOptions.html b/types/_aws_amplify_platform_core.AmplifyUserErrorOptions.html index 61342cb178..ceef60fee8 100644 --- a/types/_aws_amplify_platform_core.AmplifyUserErrorOptions.html +++ b/types/_aws_amplify_platform_core.AmplifyUserErrorOptions.html @@ -1,2 +1,2 @@ AmplifyUserErrorOptions | Amplify Toolbox
    AmplifyUserErrorOptions: Omit<AmplifyErrorOptions, "resolution"> & {
        resolution: string;
    }

    Same as AmplifyErrorOptions except resolution is required

    -

    Type declaration

    • resolution: string
    \ No newline at end of file +

    Type declaration

    • resolution: string
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.ConfigurationController.html b/types/_aws_amplify_platform_core.ConfigurationController.html index 34a692dd35..bc8a1e8eee 100644 --- a/types/_aws_amplify_platform_core.ConfigurationController.html +++ b/types/_aws_amplify_platform_core.ConfigurationController.html @@ -1 +1 @@ -ConfigurationController | Amplify Toolbox
    ConfigurationController: {
        clear: (() => Promise<void>);
        get: (<T>(path) => Promise<T>);
        set: ((path, value) => Promise<void>);
        write: (() => Promise<void>);
    }

    Type declaration

    • clear: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • get: (<T>(path) => Promise<T>)
        • <T>(path): Promise<T>
        • Type Parameters

          • T

          Parameters

          • path: string

          Returns Promise<T>

    • set: ((path, value) => Promise<void>)
        • (path, value): Promise<void>
        • Parameters

          • path: string
          • value: string | boolean | number

          Returns Promise<void>

    • write: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    \ No newline at end of file +ConfigurationController | Amplify Toolbox
    ConfigurationController: {
        clear: (() => Promise<void>);
        get: (<T>(path) => Promise<T>);
        set: ((path, value) => Promise<void>);
        write: (() => Promise<void>);
    }

    Type declaration

    • clear: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • get: (<T>(path) => Promise<T>)
        • <T>(path): Promise<T>
        • Type Parameters

          • T

          Parameters

          • path: string

          Returns Promise<T>

    • set: ((path, value) => Promise<void>)
        • (path, value): Promise<void>
        • Parameters

          • path: string
          • value: string | boolean | number

          Returns Promise<void>

    • write: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.LocalConfigurationFileName.html b/types/_aws_amplify_platform_core.LocalConfigurationFileName.html index 69e9b913ec..5b1243a585 100644 --- a/types/_aws_amplify_platform_core.LocalConfigurationFileName.html +++ b/types/_aws_amplify_platform_core.LocalConfigurationFileName.html @@ -1 +1 @@ -LocalConfigurationFileName | Amplify Toolbox
    LocalConfigurationFileName: "usage_data_preferences.json"
    \ No newline at end of file +LocalConfigurationFileName | Amplify Toolbox
    LocalConfigurationFileName: "usage_data_preferences.json"
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.PackageJson.html b/types/_aws_amplify_platform_core.PackageJson.html index e7d99130c5..0f8bd26e90 100644 --- a/types/_aws_amplify_platform_core.PackageJson.html +++ b/types/_aws_amplify_platform_core.PackageJson.html @@ -1 +1 @@ -PackageJson | Amplify Toolbox
    \ No newline at end of file +PackageJson | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_platform_core.UsageDataEmitter.html b/types/_aws_amplify_platform_core.UsageDataEmitter.html index a8c021957d..44a6987e87 100644 --- a/types/_aws_amplify_platform_core.UsageDataEmitter.html +++ b/types/_aws_amplify_platform_core.UsageDataEmitter.html @@ -1 +1 @@ -UsageDataEmitter | Amplify Toolbox
    UsageDataEmitter: {
        emitFailure: ((error, dimensions?) => Promise<void>);
        emitSuccess: ((metrics?, dimensions?) => Promise<void>);
    }

    Type declaration

    • emitFailure: ((error, dimensions?) => Promise<void>)
        • (error, dimensions?): Promise<void>
        • Parameters

          • error: AmplifyError
          • Optional dimensions: Record<string, string>

          Returns Promise<void>

    • emitSuccess: ((metrics?, dimensions?) => Promise<void>)
        • (metrics?, dimensions?): Promise<void>
        • Parameters

          • Optional metrics: Record<string, number>
          • Optional dimensions: Record<string, string>

          Returns Promise<void>

    \ No newline at end of file +UsageDataEmitter | Amplify Toolbox
    UsageDataEmitter: {
        emitFailure: ((error, dimensions?) => Promise<void>);
        emitSuccess: ((metrics?, dimensions?) => Promise<void>);
    }

    Type declaration

    • emitFailure: ((error, dimensions?) => Promise<void>)
        • (error, dimensions?): Promise<void>
        • Parameters

          • error: AmplifyError
          • Optional dimensions: Record<string, string>

          Returns Promise<void>

    • emitSuccess: ((metrics?, dimensions?) => Promise<void>)
        • (metrics?, dimensions?): Promise<void>
        • Parameters

          • Optional metrics: Record<string, number>
          • Optional dimensions: Record<string, string>

          Returns Promise<void>

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AWSClientProvider.html b/types/_aws_amplify_plugin_types.AWSClientProvider.html index 914314b2d1..e46a85f42a 100644 --- a/types/_aws_amplify_plugin_types.AWSClientProvider.html +++ b/types/_aws_amplify_plugin_types.AWSClientProvider.html @@ -1 +1 @@ -AWSClientProvider | Amplify Toolbox
    AWSClientProvider<T>: {
        [K in keyof T]: (() => T[K])
    }

    Type Parameters

    • T extends Record<`get${string}Client`, Client<object, MetadataBearer, unknown>>
    \ No newline at end of file +AWSClientProvider | Amplify Toolbox
    AWSClientProvider<T>: {
        [K in keyof T]: (() => T[K])
    }

    Type Parameters

    • T extends Record<`get${string}Client`, Client<object, MetadataBearer, unknown>>
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AmplifyFunction.html b/types/_aws_amplify_plugin_types.AmplifyFunction.html index 34d2606ae8..22b00d7fc2 100644 --- a/types/_aws_amplify_plugin_types.AmplifyFunction.html +++ b/types/_aws_amplify_plugin_types.AmplifyFunction.html @@ -1 +1 @@ -AmplifyFunction | Amplify Toolbox
    \ No newline at end of file +AmplifyFunction | Amplify Toolbox
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AmplifyResourceGroupName.html b/types/_aws_amplify_plugin_types.AmplifyResourceGroupName.html index 5cd0e4d6e4..43911bf453 100644 --- a/types/_aws_amplify_plugin_types.AmplifyResourceGroupName.html +++ b/types/_aws_amplify_plugin_types.AmplifyResourceGroupName.html @@ -1,2 +1,2 @@ AmplifyResourceGroupName | Amplify Toolbox
    AmplifyResourceGroupName: "auth" | "data" | "storage" | string & {
        resourceGroupNameLike?: any;
    }

    Represents the types of resource group name

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AppId.html b/types/_aws_amplify_plugin_types.AppId.html index d686129dbc..0e654f4887 100644 --- a/types/_aws_amplify_plugin_types.AppId.html +++ b/types/_aws_amplify_plugin_types.AppId.html @@ -1,2 +1,2 @@ AppId | Amplify Toolbox
    AppId: string

    These are some utility types to make the BackendIdentifier a bit more self-documenting

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AuthCfnResources.html b/types/_aws_amplify_plugin_types.AuthCfnResources.html index 5fc4d40a48..e831aa1c31 100644 --- a/types/_aws_amplify_plugin_types.AuthCfnResources.html +++ b/types/_aws_amplify_plugin_types.AuthCfnResources.html @@ -4,4 +4,4 @@
  • cfnIdentityPoolRoleAttachment: CfnIdentityPoolRoleAttachment

    The generated CfnIdentityPoolRoleAttachment L1 resource.

  • cfnUserPool: CfnUserPool

    The generated CfnUserPool L1 resource.

  • cfnUserPoolClient: CfnUserPoolClient

    The generated CfnUserPoolClient L1 resource.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AuthResources.html b/types/_aws_amplify_plugin_types.AuthResources.html index 3197f53d4b..c46cd688f3 100644 --- a/types/_aws_amplify_plugin_types.AuthResources.html +++ b/types/_aws_amplify_plugin_types.AuthResources.html @@ -8,4 +8,4 @@
  • unauthenticatedUserIamRole: IRole

    The generated unauth role.

  • userPool: IUserPool

    The generated UserPool L2 Resource.

  • userPoolClient: IUserPoolClient

    The generated UserPoolClient L2 Resource.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.AuthRoleName.html b/types/_aws_amplify_plugin_types.AuthRoleName.html index df10af1a92..c409adeac9 100644 --- a/types/_aws_amplify_plugin_types.AuthRoleName.html +++ b/types/_aws_amplify_plugin_types.AuthRoleName.html @@ -1 +1 @@ -AuthRoleName | Amplify Toolbox
    AuthRoleName: keyof Pick<AuthResources, "authenticatedUserIamRole" | "unauthenticatedUserIamRole">
    \ No newline at end of file +AuthRoleName | Amplify Toolbox
    AuthRoleName: keyof Pick<AuthResources, "authenticatedUserIamRole" | "unauthenticatedUserIamRole">
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendIdentifier.html b/types/_aws_amplify_plugin_types.BackendIdentifier.html index 9b79b45910..1e9b55e034 100644 --- a/types/_aws_amplify_plugin_types.BackendIdentifier.html +++ b/types/_aws_amplify_plugin_types.BackendIdentifier.html @@ -13,4 +13,4 @@

    While this type does not enforce any specific behavior, at the time of writing, this value defaults to package.json#name when running sandbox commands Consult upstream code for exact usage.

  • type: Readonly<Extract<DeploymentType, "sandbox">>

    Const that determines this BackendIdentifier is for a sandbox backend

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendOutput.html b/types/_aws_amplify_plugin_types.BackendOutput.html index 96dc02e4bc..fd5af0d9bc 100644 --- a/types/_aws_amplify_plugin_types.BackendOutput.html +++ b/types/_aws_amplify_plugin_types.BackendOutput.html @@ -1 +1 @@ -BackendOutput | Amplify Toolbox
    BackendOutput: Record<string, BackendOutputEntry>
    \ No newline at end of file +BackendOutput | Amplify Toolbox
    BackendOutput: Record<string, BackendOutputEntry>
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendOutputEntry.html b/types/_aws_amplify_plugin_types.BackendOutputEntry.html index 7e7e225e8a..e3d661023a 100644 --- a/types/_aws_amplify_plugin_types.BackendOutputEntry.html +++ b/types/_aws_amplify_plugin_types.BackendOutputEntry.html @@ -1 +1 @@ -BackendOutputEntry | Amplify Toolbox
    BackendOutputEntry<T>: {
        payload: T;
        version: string;
    }

    Type Parameters

    • T extends Record<string, string> = Record<string, string>

    Type declaration

    • Readonly payload: T
    • Readonly version: string
    \ No newline at end of file +BackendOutputEntry | Amplify Toolbox
    BackendOutputEntry<T>: {
        payload: T;
        version: string;
    }

    Type Parameters

    • T extends Record<string, string> = Record<string, string>

    Type declaration

    • Readonly payload: T
    • Readonly version: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendOutputRetrievalStrategy.html b/types/_aws_amplify_plugin_types.BackendOutputRetrievalStrategy.html index 79fd1c7b72..8f10b4b127 100644 --- a/types/_aws_amplify_plugin_types.BackendOutputRetrievalStrategy.html +++ b/types/_aws_amplify_plugin_types.BackendOutputRetrievalStrategy.html @@ -1,2 +1,2 @@ BackendOutputRetrievalStrategy | Amplify Toolbox
    BackendOutputRetrievalStrategy: {
        fetchBackendOutput: (() => Promise<BackendOutput>);
    }

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendOutputStorageStrategy.html b/types/_aws_amplify_plugin_types.BackendOutputStorageStrategy.html index 8a29890f2e..6535bd4dbf 100644 --- a/types/_aws_amplify_plugin_types.BackendOutputStorageStrategy.html +++ b/types/_aws_amplify_plugin_types.BackendOutputStorageStrategy.html @@ -1,2 +1,2 @@ BackendOutputStorageStrategy | Amplify Toolbox
    BackendOutputStorageStrategy<T>: {
        addBackendOutputEntry: ((keyName, backendOutputEntry) => void);
        appendToBackendOutputList: ((keyName, backendOutputEntry) => void);
    }

    Type for an object that collects output data from constructs

    -

    Type Parameters

    Type declaration

    • addBackendOutputEntry: ((keyName, backendOutputEntry) => void)
        • (keyName, backendOutputEntry): void
        • Parameters

          • keyName: string
          • backendOutputEntry: T

          Returns void

    • appendToBackendOutputList: ((keyName, backendOutputEntry) => void)
        • (keyName, backendOutputEntry): void
        • Parameters

          Returns void

    \ No newline at end of file +

    Type Parameters

    Type declaration

    • addBackendOutputEntry: ((keyName, backendOutputEntry) => void)
        • (keyName, backendOutputEntry): void
        • Parameters

          • keyName: string
          • backendOutputEntry: T

          Returns void

    • appendToBackendOutputList: ((keyName, backendOutputEntry) => void)
        • (keyName, backendOutputEntry): void
        • Parameters

          Returns void

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendSecret.html b/types/_aws_amplify_plugin_types.BackendSecret.html index 2b1fd063c8..a3bc71f0d6 100644 --- a/types/_aws_amplify_plugin_types.BackendSecret.html +++ b/types/_aws_amplify_plugin_types.BackendSecret.html @@ -1,3 +1,3 @@ BackendSecret | Amplify Toolbox
    BackendSecret: {
        resolve: ((scope, backendIdentifier) => SecretValue);
        resolvePath: ((backendIdentifier) => ResolvePathResult);
    }

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BackendSecretResolver.html b/types/_aws_amplify_plugin_types.BackendSecretResolver.html index 418f82c73a..461b2923f2 100644 --- a/types/_aws_amplify_plugin_types.BackendSecretResolver.html +++ b/types/_aws_amplify_plugin_types.BackendSecretResolver.html @@ -1 +1 @@ -BackendSecretResolver | Amplify Toolbox
    BackendSecretResolver: {
        resolvePath: ((backendSecret) => ResolvePathResult);
        resolveSecret: ((backendSecret) => SecretValue);
    }

    Type declaration

    \ No newline at end of file +BackendSecretResolver | Amplify Toolbox
    BackendSecretResolver: {
        resolvePath: ((backendSecret) => ResolvePathResult);
        resolveSecret: ((backendSecret) => SecretValue);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.BranchName.html b/types/_aws_amplify_plugin_types.BranchName.html index 6bd2607cdf..dc869494e6 100644 --- a/types/_aws_amplify_plugin_types.BranchName.html +++ b/types/_aws_amplify_plugin_types.BranchName.html @@ -1 +1 @@ -BranchName | Amplify Toolbox
    BranchName: string
    \ No newline at end of file +BranchName | Amplify Toolbox
    BranchName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ConstructContainer.html b/types/_aws_amplify_plugin_types.ConstructContainer.html index 206ba2eca8..db50476bc7 100644 --- a/types/_aws_amplify_plugin_types.ConstructContainer.html +++ b/types/_aws_amplify_plugin_types.ConstructContainer.html @@ -1,2 +1,2 @@ ConstructContainer | Amplify Toolbox
    ConstructContainer: {
        getConstructFactory: (<T>(token) => ConstructFactory<T> | undefined);
        getOrCompute: ((generator) => ResourceProvider);
        registerConstructFactory: ((token, provider) => void);
    }

    Vends Constructs based on an initializer function

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ConstructContainerEntryGenerator.html b/types/_aws_amplify_plugin_types.ConstructContainerEntryGenerator.html index 1d076a7f47..165f650ab8 100644 --- a/types/_aws_amplify_plugin_types.ConstructContainerEntryGenerator.html +++ b/types/_aws_amplify_plugin_types.ConstructContainerEntryGenerator.html @@ -2,4 +2,4 @@

    Type Parameters

    • T extends object = object

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ConstructFactory.html b/types/_aws_amplify_plugin_types.ConstructFactory.html index bcb3022ad4..ca7d439c94 100644 --- a/types/_aws_amplify_plugin_types.ConstructFactory.html +++ b/types/_aws_amplify_plugin_types.ConstructFactory.html @@ -1,4 +1,4 @@ ConstructFactory | Amplify Toolbox
    ConstructFactory<T>: {
        getInstance: ((props) => T);
        provides?: string;
    }

    Functional interface for construct factories. All objects in the backend-engine definition must implement this interface.

    Type Parameters

    Type declaration

    • getInstance: ((props) => T)
    • Optional Readonly provides?: string

      A construct factory can register that the return value implements additional interfaces Registering as a provider allows other construct factories to fetch this one based on the provides token

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ConstructFactoryGetInstanceProps.html b/types/_aws_amplify_plugin_types.ConstructFactoryGetInstanceProps.html index ab2f0da9de..d35e274374 100644 --- a/types/_aws_amplify_plugin_types.ConstructFactoryGetInstanceProps.html +++ b/types/_aws_amplify_plugin_types.ConstructFactoryGetInstanceProps.html @@ -1 +1 @@ -ConstructFactoryGetInstanceProps | Amplify Toolbox
    ConstructFactoryGetInstanceProps: {
        constructContainer: ConstructContainer;
        importPathVerifier?: ImportPathVerifier;
        outputStorageStrategy: BackendOutputStorageStrategy<BackendOutputEntry>;
        resourceNameValidator?: ResourceNameValidator;
    }

    Type declaration

    \ No newline at end of file +ConstructFactoryGetInstanceProps | Amplify Toolbox
    ConstructFactoryGetInstanceProps: {
        constructContainer: ConstructContainer;
        importPathVerifier?: ImportPathVerifier;
        outputStorageStrategy: BackendOutputStorageStrategy<BackendOutputEntry>;
        resourceNameValidator?: ResourceNameValidator;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.DeepPartial.html b/types/_aws_amplify_plugin_types.DeepPartial.html index 73b54bb5c2..8b28ae3937 100644 --- a/types/_aws_amplify_plugin_types.DeepPartial.html +++ b/types/_aws_amplify_plugin_types.DeepPartial.html @@ -2,4 +2,4 @@ The DeepPartial type recursively makes all properties of T optional. If a property is an object, it will also be made partially optional.

    Type Parameters

    • T

      The type of the object to make partially optional.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.DeepPartialAmplifyGeneratedConfigs.html b/types/_aws_amplify_plugin_types.DeepPartialAmplifyGeneratedConfigs.html index 2551d62292..6ea04f4c26 100644 --- a/types/_aws_amplify_plugin_types.DeepPartialAmplifyGeneratedConfigs.html +++ b/types/_aws_amplify_plugin_types.DeepPartialAmplifyGeneratedConfigs.html @@ -1,3 +1,3 @@ DeepPartialAmplifyGeneratedConfigs | Amplify Toolbox
    DeepPartialAmplifyGeneratedConfigs<T>: {
        [P in keyof T]?: P extends "auth" | "data" | "storage"
            ? T[P] extends object
                ? DeepPartialAmplifyGeneratedConfigs<T[P]>
                : Partial<T[P]>
            : T[P]
    }

    Makes all the properties of the entire nested object partial for Amplify generated configs instead of just the top level properties. Other properties are not changed.

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.DeploymentType.html b/types/_aws_amplify_plugin_types.DeploymentType.html index 30d98acedb..ae6c3cad46 100644 --- a/types/_aws_amplify_plugin_types.DeploymentType.html +++ b/types/_aws_amplify_plugin_types.DeploymentType.html @@ -1,4 +1,4 @@ DeploymentType | Amplify Toolbox
    DeploymentType: "branch" | "sandbox"

    Represents the types of Amplify deployments

    Branch deployments are tied to specific git branches and are designed to be used in CI/CD Sandbox deployments are local development environments

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ExecaChildProcess.html b/types/_aws_amplify_plugin_types.ExecaChildProcess.html index 404baa68f1..72ffebca52 100644 --- a/types/_aws_amplify_plugin_types.ExecaChildProcess.html +++ b/types/_aws_amplify_plugin_types.ExecaChildProcess.html @@ -1 +1 @@ -ExecaChildProcess | Amplify Toolbox
    ExecaChildProcess: {
        stderr: Readable | null;
        stdout: Readable | null;
    } & Promise<ExecaChildProcessResult>

    Type declaration

    • stderr: Readable | null
    • stdout: Readable | null
    \ No newline at end of file +ExecaChildProcess | Amplify Toolbox
    ExecaChildProcess: {
        stderr: Readable | null;
        stdout: Readable | null;
    } & Promise<ExecaChildProcessResult>

    Type declaration

    • stderr: Readable | null
    • stdout: Readable | null
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ExecaChildProcessResult.html b/types/_aws_amplify_plugin_types.ExecaChildProcessResult.html index 28ffdbebe0..34094f03ca 100644 --- a/types/_aws_amplify_plugin_types.ExecaChildProcessResult.html +++ b/types/_aws_amplify_plugin_types.ExecaChildProcessResult.html @@ -1 +1 @@ -ExecaChildProcessResult | Amplify Toolbox
    ExecaChildProcessResult: {
        exitCode?: number;
    }

    Type declaration

    • Optional exitCode?: number
    \ No newline at end of file +ExecaChildProcessResult | Amplify Toolbox
    ExecaChildProcessResult: {
        exitCode?: number;
    }

    Type declaration

    • Optional exitCode?: number
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ExecaOptions.html b/types/_aws_amplify_plugin_types.ExecaOptions.html index 64653b0f8d..7803826eb5 100644 --- a/types/_aws_amplify_plugin_types.ExecaOptions.html +++ b/types/_aws_amplify_plugin_types.ExecaOptions.html @@ -1 +1 @@ -ExecaOptions | Amplify Toolbox
    ExecaOptions: {
        env?: Record<string, string>;
        extendEnv?: boolean;
        stderr?: "pipe";
        stdin?: "inherit";
        stdout?: "pipe";
    }

    Type declaration

    • Optional env?: Record<string, string>
    • Optional extendEnv?: boolean
    • Optional stderr?: "pipe"
    • Optional stdin?: "inherit"
    • Optional stdout?: "pipe"
    \ No newline at end of file +ExecaOptions | Amplify Toolbox
    ExecaOptions: {
        env?: Record<string, string>;
        extendEnv?: boolean;
        stderr?: "pipe";
        stdin?: "inherit";
        stdout?: "pipe";
    }

    Type declaration

    • Optional env?: Record<string, string>
    • Optional extendEnv?: boolean
    • Optional stderr?: "pipe"
    • Optional stdin?: "inherit"
    • Optional stdout?: "pipe"
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.FunctionResources.html b/types/_aws_amplify_plugin_types.FunctionResources.html index da2880ab50..b429191770 100644 --- a/types/_aws_amplify_plugin_types.FunctionResources.html +++ b/types/_aws_amplify_plugin_types.FunctionResources.html @@ -1 +1 @@ -FunctionResources | Amplify Toolbox
    FunctionResources: {
        cfnResources: {
            cfnFunction: CfnFunction;
        };
        lambda: IFunction;
    }

    Type declaration

    • cfnResources: {
          cfnFunction: CfnFunction;
      }
      • cfnFunction: CfnFunction
    • lambda: IFunction
    \ No newline at end of file +FunctionResources | Amplify Toolbox
    FunctionResources: {
        cfnResources: {
            cfnFunction: CfnFunction;
        };
        lambda: IFunction;
    }

    Type declaration

    • cfnResources: {
          cfnFunction: CfnFunction;
      }
      • cfnFunction: CfnFunction
    • lambda: IFunction
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.GenerateContainerEntryProps.html b/types/_aws_amplify_plugin_types.GenerateContainerEntryProps.html index 448683891a..0e8de1050a 100644 --- a/types/_aws_amplify_plugin_types.GenerateContainerEntryProps.html +++ b/types/_aws_amplify_plugin_types.GenerateContainerEntryProps.html @@ -1 +1 @@ -GenerateContainerEntryProps | Amplify Toolbox
    GenerateContainerEntryProps: {
        backendSecretResolver: BackendSecretResolver;
        scope: Construct;
        ssmEnvironmentEntriesGenerator: SsmEnvironmentEntriesGenerator;
        stableBackendIdentifiers: StableBackendIdentifiers;
    }

    Type declaration

    \ No newline at end of file +GenerateContainerEntryProps | Amplify Toolbox
    GenerateContainerEntryProps: {
        backendSecretResolver: BackendSecretResolver;
        scope: Construct;
        ssmEnvironmentEntriesGenerator: SsmEnvironmentEntriesGenerator;
        stableBackendIdentifiers: StableBackendIdentifiers;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ImportPathVerifier.html b/types/_aws_amplify_plugin_types.ImportPathVerifier.html index 4aa4cf2532..0edfa68944 100644 --- a/types/_aws_amplify_plugin_types.ImportPathVerifier.html +++ b/types/_aws_amplify_plugin_types.ImportPathVerifier.html @@ -2,4 +2,4 @@

    Type declaration

    • verify: ((importStack, expectedImportingFile, errorMessage) => void)

      Verify that the given stack originated from an expected file path

      importStack is expected to be in the format returned by (new Error()).stack

      If the error was not imported by the expected file, an error with errorMessage is thrown

      -
        • (importStack, expectedImportingFile, errorMessage): void
        • Parameters

          • importStack: string | undefined
          • expectedImportingFile: string
          • errorMessage: string

          Returns void

    \ No newline at end of file +
      • (importStack, expectedImportingFile, errorMessage): void
      • Parameters

        • importStack: string | undefined
        • expectedImportingFile: string
        • errorMessage: string

        Returns void

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.LogLevel.html b/types/_aws_amplify_plugin_types.LogLevel.html index 65adf35899..c254eeb731 100644 --- a/types/_aws_amplify_plugin_types.LogLevel.html +++ b/types/_aws_amplify_plugin_types.LogLevel.html @@ -1 +1 @@ -LogLevel | Amplify Toolbox
    LogLevel: "info" | "debug" | "warn" | "error" | "fatal" | "trace"
    \ No newline at end of file +LogLevel | Amplify Toolbox
    LogLevel: "info" | "debug" | "warn" | "error" | "fatal" | "trace"
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.LogRetention.html b/types/_aws_amplify_plugin_types.LogRetention.html index f0b598bb15..d2cc35aeb6 100644 --- a/types/_aws_amplify_plugin_types.LogRetention.html +++ b/types/_aws_amplify_plugin_types.LogRetention.html @@ -1 +1 @@ -LogRetention | Amplify Toolbox
    LogRetention: "1 day" | "3 days" | "5 days" | "1 week" | "2 weeks" | "1 month" | "2 months" | "3 months" | "4 months" | "5 months" | "6 months" | "1 year" | "13 months" | "18 months" | "2 years" | "3 years" | "5 years" | "6 years" | "7 years" | "8 years" | "9 years" | "10 years" | "infinite"
    \ No newline at end of file +LogRetention | Amplify Toolbox
    LogRetention: "1 day" | "3 days" | "5 days" | "1 week" | "2 weeks" | "1 month" | "2 months" | "3 months" | "4 months" | "5 months" | "6 months" | "1 year" | "13 months" | "18 months" | "2 years" | "3 years" | "5 years" | "6 years" | "7 years" | "8 years" | "9 years" | "10 years" | "infinite"
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.MainStackCreator.html b/types/_aws_amplify_plugin_types.MainStackCreator.html index c5d17e0966..8ec02000a4 100644 --- a/types/_aws_amplify_plugin_types.MainStackCreator.html +++ b/types/_aws_amplify_plugin_types.MainStackCreator.html @@ -1,2 +1,2 @@ MainStackCreator | Amplify Toolbox
    MainStackCreator: {
        getOrCreateMainStack: (() => Stack);
    }

    Interface for objects that can create stacks in a given scope

    -

    Type declaration

    • getOrCreateMainStack: (() => Stack)
        • (): Stack
        • Returns Stack

    \ No newline at end of file +

    Type declaration

    • getOrCreateMainStack: (() => Stack)
        • (): Stack
        • Returns Stack

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.MainStackNameResolver.html b/types/_aws_amplify_plugin_types.MainStackNameResolver.html index a310766b9d..d326284158 100644 --- a/types/_aws_amplify_plugin_types.MainStackNameResolver.html +++ b/types/_aws_amplify_plugin_types.MainStackNameResolver.html @@ -1,2 +1,2 @@ MainStackNameResolver | Amplify Toolbox
    MainStackNameResolver: {
        resolveMainStackName: (() => Promise<string>);
    }

    Interface for objects that can resolve a stack name

    -

    Type declaration

    • resolveMainStackName: (() => Promise<string>)
        • (): Promise<string>
        • Returns Promise<string>

    \ No newline at end of file +

    Type declaration

    • resolveMainStackName: (() => Promise<string>)
        • (): Promise<string>
        • Returns Promise<string>

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.PackageManagerController.html b/types/_aws_amplify_plugin_types.PackageManagerController.html index 6ec37bc740..c5d3287c80 100644 --- a/types/_aws_amplify_plugin_types.PackageManagerController.html +++ b/types/_aws_amplify_plugin_types.PackageManagerController.html @@ -1 +1 @@ -PackageManagerController | Amplify Toolbox
    PackageManagerController: {
        allowsSignalPropagation: (() => boolean);
        getCommand: ((args) => string);
        initializeProject: (() => Promise<void>);
        initializeTsConfig: ((targetDir) => Promise<void>);
        installDependencies: ((packageNames, type) => Promise<void>);
        runWithPackageManager: ((args, dir, options?) => ExecaChildProcess);
    }

    Type declaration

    • allowsSignalPropagation: (() => boolean)
        • (): boolean
        • Returns boolean

    • getCommand: ((args) => string)
        • (args): string
        • Parameters

          • args: string[]

          Returns string

    • initializeProject: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • initializeTsConfig: ((targetDir) => Promise<void>)
        • (targetDir): Promise<void>
        • Parameters

          • targetDir: string

          Returns Promise<void>

    • installDependencies: ((packageNames, type) => Promise<void>)
        • (packageNames, type): Promise<void>
        • Parameters

          • packageNames: string[]
          • type: "dev" | "prod"

          Returns Promise<void>

    • runWithPackageManager: ((args, dir, options?) => ExecaChildProcess)
    \ No newline at end of file +PackageManagerController | Amplify Toolbox
    PackageManagerController: {
        allowsSignalPropagation: (() => boolean);
        getCommand: ((args) => string);
        initializeProject: (() => Promise<void>);
        initializeTsConfig: ((targetDir) => Promise<void>);
        installDependencies: ((packageNames, type) => Promise<void>);
        runWithPackageManager: ((args, dir, options?) => ExecaChildProcess);
    }

    Type declaration

    • allowsSignalPropagation: (() => boolean)
        • (): boolean
        • Returns boolean

    • getCommand: ((args) => string)
        • (args): string
        • Parameters

          • args: string[]

          Returns string

    • initializeProject: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • initializeTsConfig: ((targetDir) => Promise<void>)
        • (targetDir): Promise<void>
        • Parameters

          • targetDir: string

          Returns Promise<void>

    • installDependencies: ((packageNames, type) => Promise<void>)
        • (packageNames, type): Promise<void>
        • Parameters

          • packageNames: string[]
          • type: "dev" | "prod"

          Returns Promise<void>

    • runWithPackageManager: ((args, dir, options?) => ExecaChildProcess)
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ProjectName.html b/types/_aws_amplify_plugin_types.ProjectName.html index d44c8987da..9368746353 100644 --- a/types/_aws_amplify_plugin_types.ProjectName.html +++ b/types/_aws_amplify_plugin_types.ProjectName.html @@ -1 +1 @@ -ProjectName | Amplify Toolbox
    ProjectName: string
    \ No newline at end of file +ProjectName | Amplify Toolbox
    ProjectName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ReferenceAuthResources.html b/types/_aws_amplify_plugin_types.ReferenceAuthResources.html index 3b7881f4e1..7d99c58a08 100644 --- a/types/_aws_amplify_plugin_types.ReferenceAuthResources.html +++ b/types/_aws_amplify_plugin_types.ReferenceAuthResources.html @@ -6,4 +6,4 @@
  • unauthenticatedUserIamRole: IRole

    The referenced unauth role.

  • userPool: IUserPool

    The referenced UserPool L2 Resource.

  • userPoolClient: IUserPoolClient

    The referenced UserPoolClient L2 Resource.

    -
  • \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResolvePathResult.html b/types/_aws_amplify_plugin_types.ResolvePathResult.html index 741a614538..f975cf8b60 100644 --- a/types/_aws_amplify_plugin_types.ResolvePathResult.html +++ b/types/_aws_amplify_plugin_types.ResolvePathResult.html @@ -1 +1 @@ -ResolvePathResult | Amplify Toolbox
    ResolvePathResult: {
        branchSecretPath: string;
        sharedSecretPath: string;
    }

    Type declaration

    • branchSecretPath: string
    • sharedSecretPath: string
    \ No newline at end of file +ResolvePathResult | Amplify Toolbox
    ResolvePathResult: {
        branchSecretPath: string;
        sharedSecretPath: string;
    }

    Type declaration

    • branchSecretPath: string
    • sharedSecretPath: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResourceAccessAcceptor.html b/types/_aws_amplify_plugin_types.ResourceAccessAcceptor.html index f6e7b91235..210c04a3a7 100644 --- a/types/_aws_amplify_plugin_types.ResourceAccessAcceptor.html +++ b/types/_aws_amplify_plugin_types.ResourceAccessAcceptor.html @@ -1,2 +1,2 @@ ResourceAccessAcceptor | Amplify Toolbox
    ResourceAccessAcceptor: {
        acceptResourceAccess: ((policy, ssmEnvironmentEntries) => void);
        identifier: string;
    }

    Type declaration

    • acceptResourceAccess: ((policy, ssmEnvironmentEntries) => void)
        • (policy, ssmEnvironmentEntries): void
        • Parameters

          Returns void

    • identifier: string

      String used to uniquely identify this acceptor. Each instance should have it's own identifier.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResourceAccessAcceptorFactory.html b/types/_aws_amplify_plugin_types.ResourceAccessAcceptorFactory.html index 8ad81a9b13..f858f45954 100644 --- a/types/_aws_amplify_plugin_types.ResourceAccessAcceptorFactory.html +++ b/types/_aws_amplify_plugin_types.ResourceAccessAcceptorFactory.html @@ -1,4 +1,4 @@ ResourceAccessAcceptorFactory | Amplify Toolbox

    Type alias ResourceAccessAcceptorFactory<RoleIdentifier>

    ResourceAccessAcceptorFactory<RoleIdentifier>: {
        getResourceAccessAcceptor: ((...roleIdentifier) => ResourceAccessAcceptor);
    }

    Type Parameters

    • RoleIdentifier extends string | undefined = undefined

    Type declaration

    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResourceNameValidator.html b/types/_aws_amplify_plugin_types.ResourceNameValidator.html index 5545b0974d..eb2c993517 100644 --- a/types/_aws_amplify_plugin_types.ResourceNameValidator.html +++ b/types/_aws_amplify_plugin_types.ResourceNameValidator.html @@ -1,3 +1,3 @@ ResourceNameValidator | Amplify Toolbox
    ResourceNameValidator: {
        validate: ((resourceName) => void);
    }

    Implementors can validate what should be the correct resource name

    Type declaration

    • validate: ((resourceName) => void)

      executes the validation

      -
        • (resourceName): void
        • Parameters

          • resourceName: string

          Returns void

    \ No newline at end of file +
      • (resourceName): void
      • Parameters

        • resourceName: string

        Returns void

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.ResourceProvider.html b/types/_aws_amplify_plugin_types.ResourceProvider.html index ef4aef593f..926aa79f35 100644 --- a/types/_aws_amplify_plugin_types.ResourceProvider.html +++ b/types/_aws_amplify_plugin_types.ResourceProvider.html @@ -1,4 +1,4 @@ ResourceProvider | Amplify Toolbox
    ResourceProvider<T>: {
        resources: T;
    }

    Provides reference to underlying CDK resources.

    Note: we have to use object as the generic constraint rather than Record<string, unknown> so that interfaces will also satisfy the constraint See: https://stackoverflow.com/questions/63617344/how-to-satisfy-the-constraint-of-recordstring-unknown-with-interface

    -

    Type Parameters

    • T extends object = object

    Type declaration

    • resources: T
    \ No newline at end of file +

    Type Parameters

    • T extends object = object

    Type declaration

    • resources: T
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.SandboxName.html b/types/_aws_amplify_plugin_types.SandboxName.html index 01be560408..4930818441 100644 --- a/types/_aws_amplify_plugin_types.SandboxName.html +++ b/types/_aws_amplify_plugin_types.SandboxName.html @@ -1 +1 @@ -SandboxName | Amplify Toolbox
    SandboxName: string
    \ No newline at end of file +SandboxName | Amplify Toolbox
    SandboxName: string
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.SsmEnvironmentEntriesGenerator.html b/types/_aws_amplify_plugin_types.SsmEnvironmentEntriesGenerator.html index 2db197e0be..ea712c3363 100644 --- a/types/_aws_amplify_plugin_types.SsmEnvironmentEntriesGenerator.html +++ b/types/_aws_amplify_plugin_types.SsmEnvironmentEntriesGenerator.html @@ -1 +1 @@ -SsmEnvironmentEntriesGenerator | Amplify Toolbox
    SsmEnvironmentEntriesGenerator: {
        generateSsmEnvironmentEntries: ((scopeContext) => SsmEnvironmentEntry[]);
    }

    Type declaration

    \ No newline at end of file +SsmEnvironmentEntriesGenerator | Amplify Toolbox
    SsmEnvironmentEntriesGenerator: {
        generateSsmEnvironmentEntries: ((scopeContext) => SsmEnvironmentEntry[]);
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.SsmEnvironmentEntry.html b/types/_aws_amplify_plugin_types.SsmEnvironmentEntry.html index 331746e837..1adc9c54d7 100644 --- a/types/_aws_amplify_plugin_types.SsmEnvironmentEntry.html +++ b/types/_aws_amplify_plugin_types.SsmEnvironmentEntry.html @@ -1,3 +1,3 @@ SsmEnvironmentEntry | Amplify Toolbox
    SsmEnvironmentEntry: {
        name: string;
        path: string;
    }

    Type declaration

    • name: string

      The environment variable name where this SSM value will be placed at runtime

    • path: string

      The SSM parameter path that will be fetched at runtime

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.StableBackendIdentifiers.html b/types/_aws_amplify_plugin_types.StableBackendIdentifiers.html index b2715c30d1..1cd684463d 100644 --- a/types/_aws_amplify_plugin_types.StableBackendIdentifiers.html +++ b/types/_aws_amplify_plugin_types.StableBackendIdentifiers.html @@ -1 +1 @@ -StableBackendIdentifiers | Amplify Toolbox
    StableBackendIdentifiers: {
        getStableBackendHash: (() => string);
    }

    Type declaration

    • getStableBackendHash: (() => string)
        • (): string
        • Returns string

    \ No newline at end of file +StableBackendIdentifiers | Amplify Toolbox
    StableBackendIdentifiers: {
        getStableBackendHash: (() => string);
    }

    Type declaration

    • getStableBackendHash: (() => string)
        • (): string
        • Returns string

    \ No newline at end of file diff --git a/types/_aws_amplify_plugin_types.StackProvider.html b/types/_aws_amplify_plugin_types.StackProvider.html index 299a14a740..023b476594 100644 --- a/types/_aws_amplify_plugin_types.StackProvider.html +++ b/types/_aws_amplify_plugin_types.StackProvider.html @@ -1 +1 @@ -StackProvider | Amplify Toolbox
    StackProvider: {
        stack: Stack;
    }

    Type declaration

    • stack: Stack
    \ No newline at end of file +StackProvider | Amplify Toolbox
    StackProvider: {
        stack: Stack;
    }

    Type declaration

    • stack: Stack
    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.BackendIdSandboxResolver.html b/types/_aws_amplify_sandbox.BackendIdSandboxResolver.html index 0a83f4112a..d9a7bf0f58 100644 --- a/types/_aws_amplify_sandbox.BackendIdSandboxResolver.html +++ b/types/_aws_amplify_sandbox.BackendIdSandboxResolver.html @@ -1 +1 @@ -BackendIdSandboxResolver | Amplify Toolbox
    BackendIdSandboxResolver: ((identifier?) => Promise<BackendIdentifier>)

    Type declaration

    \ No newline at end of file +BackendIdSandboxResolver | Amplify Toolbox
    BackendIdSandboxResolver: ((identifier?) => Promise<BackendIdentifier>)

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.Sandbox.html b/types/_aws_amplify_sandbox.Sandbox.html index d011bafc1e..bd0f438f81 100644 --- a/types/_aws_amplify_sandbox.Sandbox.html +++ b/types/_aws_amplify_sandbox.Sandbox.html @@ -3,4 +3,4 @@
  • start: ((options) => Promise<void>)

    Starts the sandbox

      • (options): Promise<void>
      • Parameters

        • options: SandboxOptions

          such as which directory to watch for file changes

        Returns Promise<void>

  • stop: (() => Promise<void>)

    Stops watching for file changes

    -
      • (): Promise<void>
      • Returns Promise<void>

  • \ No newline at end of file +
      • (): Promise<void>
      • Returns Promise<void>

    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.SandboxDeleteOptions.html b/types/_aws_amplify_sandbox.SandboxDeleteOptions.html index 69a9ae694a..640c4f8869 100644 --- a/types/_aws_amplify_sandbox.SandboxDeleteOptions.html +++ b/types/_aws_amplify_sandbox.SandboxDeleteOptions.html @@ -1 +1 @@ -SandboxDeleteOptions | Amplify Toolbox
    SandboxDeleteOptions: {
        identifier?: string;
        profile?: string;
    }

    Type declaration

    • Optional identifier?: string
    • Optional profile?: string
    \ No newline at end of file +SandboxDeleteOptions | Amplify Toolbox
    SandboxDeleteOptions: {
        identifier?: string;
        profile?: string;
    }

    Type declaration

    • Optional identifier?: string
    • Optional profile?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.SandboxEvents.html b/types/_aws_amplify_sandbox.SandboxEvents.html index 676a6ab544..5834d1196e 100644 --- a/types/_aws_amplify_sandbox.SandboxEvents.html +++ b/types/_aws_amplify_sandbox.SandboxEvents.html @@ -1 +1 @@ -SandboxEvents | Amplify Toolbox
    SandboxEvents: "successfulDeployment" | "failedDeployment" | "successfulDeletion"
    \ No newline at end of file +SandboxEvents | Amplify Toolbox
    SandboxEvents: "successfulDeployment" | "failedDeployment" | "successfulDeletion"
    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.SandboxFunctionStreamingOptions.html b/types/_aws_amplify_sandbox.SandboxFunctionStreamingOptions.html index 972bcd8766..5d096804e2 100644 --- a/types/_aws_amplify_sandbox.SandboxFunctionStreamingOptions.html +++ b/types/_aws_amplify_sandbox.SandboxFunctionStreamingOptions.html @@ -1 +1 @@ -SandboxFunctionStreamingOptions | Amplify Toolbox
    SandboxFunctionStreamingOptions: {
        enabled: boolean;
        logsFilters?: string[];
        logsOutFile?: string;
    }

    Type declaration

    • enabled: boolean
    • Optional logsFilters?: string[]
    • Optional logsOutFile?: string
    \ No newline at end of file +SandboxFunctionStreamingOptions | Amplify Toolbox
    SandboxFunctionStreamingOptions: {
        enabled: boolean;
        logsFilters?: string[];
        logsOutFile?: string;
    }

    Type declaration

    • enabled: boolean
    • Optional logsFilters?: string[]
    • Optional logsOutFile?: string
    \ No newline at end of file diff --git a/types/_aws_amplify_sandbox.SandboxOptions.html b/types/_aws_amplify_sandbox.SandboxOptions.html index b22f1f31f8..16042816a4 100644 --- a/types/_aws_amplify_sandbox.SandboxOptions.html +++ b/types/_aws_amplify_sandbox.SandboxOptions.html @@ -1 +1 @@ -SandboxOptions | Amplify Toolbox
    SandboxOptions: {
        dir?: string;
        exclude?: string[];
        format?: ClientConfigFormat;
        functionStreamingOptions?: SandboxFunctionStreamingOptions;
        identifier?: string;
        profile?: string;
        watchForChanges?: boolean;
    }

    Type declaration

    \ No newline at end of file +SandboxOptions | Amplify Toolbox
    SandboxOptions: {
        dir?: string;
        exclude?: string[];
        format?: ClientConfigFormat;
        functionStreamingOptions?: SandboxFunctionStreamingOptions;
        identifier?: string;
        profile?: string;
        watchForChanges?: boolean;
    }

    Type declaration

    \ No newline at end of file diff --git a/types/_aws_amplify_schema_generator.SQLDataSourceConfig.html b/types/_aws_amplify_schema_generator.SQLDataSourceConfig.html index 4b0b258d41..3109952cfd 100644 --- a/types/_aws_amplify_schema_generator.SQLDataSourceConfig.html +++ b/types/_aws_amplify_schema_generator.SQLDataSourceConfig.html @@ -1 +1 @@ -SQLDataSourceConfig | Amplify Toolbox
    SQLDataSourceConfig: {
        database: string;
        engine: SQLEngine;
        host: string;
        password: string;
        port: number;
        username: string;
    }

    Type declaration

    • database: string
    • engine: SQLEngine
    • host: string
    • password: string
    • port: number
    • username: string
    \ No newline at end of file +SQLDataSourceConfig | Amplify Toolbox
    SQLDataSourceConfig: {
        database: string;
        engine: SQLEngine;
        host: string;
        password: string;
        port: number;
        username: string;
    }

    Type declaration

    • database: string
    • engine: SQLEngine
    • host: string
    • password: string
    • port: number
    • username: string
    \ No newline at end of file diff --git a/types/_aws_amplify_schema_generator.SQLEngine.html b/types/_aws_amplify_schema_generator.SQLEngine.html index 17b3bc8eee..5748d7957d 100644 --- a/types/_aws_amplify_schema_generator.SQLEngine.html +++ b/types/_aws_amplify_schema_generator.SQLEngine.html @@ -1 +1 @@ -SQLEngine | Amplify Toolbox
    SQLEngine: "mysql" | "postgresql"
    \ No newline at end of file +SQLEngine | Amplify Toolbox
    SQLEngine: "mysql" | "postgresql"
    \ No newline at end of file diff --git a/types/_aws_amplify_schema_generator.SchemaGeneratorConfig.html b/types/_aws_amplify_schema_generator.SchemaGeneratorConfig.html index 146b448e3c..b879d3c254 100644 --- a/types/_aws_amplify_schema_generator.SchemaGeneratorConfig.html +++ b/types/_aws_amplify_schema_generator.SchemaGeneratorConfig.html @@ -1 +1 @@ -SchemaGeneratorConfig | Amplify Toolbox
    SchemaGeneratorConfig: {
        connectionUri: {
            secretName: string;
            value: string;
        };
        out: string;
        sslCert?: {
            secretName: string;
            value: string;
        };
    }

    Type declaration

    • connectionUri: {
          secretName: string;
          value: string;
      }
      • secretName: string
      • value: string
    • out: string
    • Optional sslCert?: {
          secretName: string;
          value: string;
      }
      • secretName: string
      • value: string
    \ No newline at end of file +SchemaGeneratorConfig | Amplify Toolbox
    SchemaGeneratorConfig: {
        connectionUri: {
            secretName: string;
            value: string;
        };
        out: string;
        sslCert?: {
            secretName: string;
            value: string;
        };
    }

    Type declaration

    • connectionUri: {
          secretName: string;
          value: string;
      }
      • secretName: string
      • value: string
    • out: string
    • Optional sslCert?: {
          secretName: string;
          value: string;
      }
      • secretName: string
      • value: string
    \ No newline at end of file diff --git a/variables/_aws_amplify_auth_construct.triggerEvents.html b/variables/_aws_amplify_auth_construct.triggerEvents.html index d1245453d9..577d320b9c 100644 --- a/variables/_aws_amplify_auth_construct.triggerEvents.html +++ b/variables/_aws_amplify_auth_construct.triggerEvents.html @@ -1,3 +1,3 @@ triggerEvents | Amplify Toolbox
    triggerEvents: readonly ["createAuthChallenge", "customMessage", "defineAuthChallenge", "postAuthentication", "postConfirmation", "preAuthentication", "preSignUp", "preTokenGeneration", "userMigration", "verifyAuthChallengeResponse"] = ...

    Supported auth trigger events. Derived from CDK UserPoolOperation, but we can't use that to get type inference because the operation names are typed as "string" rather than a string literal

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationZodEnum.html b/variables/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationZodEnum.html index 69414670ac..2f334323af 100644 --- a/variables/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationZodEnum.html +++ b/variables/_aws_amplify_backend_output_schemas.AwsAppsyncAuthenticationZodEnum.html @@ -1 +1 @@ -AwsAppsyncAuthenticationZodEnum | Amplify Toolbox
    AwsAppsyncAuthenticationZodEnum: ZodEnum<["API_KEY", "AWS_LAMBDA", "AWS_IAM", "OPENID_CONNECT", "AMAZON_COGNITO_USER_POOLS"]> = ...
    \ No newline at end of file +AwsAppsyncAuthenticationZodEnum | Amplify Toolbox
    AwsAppsyncAuthenticationZodEnum: ZodEnum<["API_KEY", "AWS_LAMBDA", "AWS_IAM", "OPENID_CONNECT", "AMAZON_COGNITO_USER_POOLS"]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.aiConversationOutputKey.html b/variables/_aws_amplify_backend_output_schemas.aiConversationOutputKey.html index a308192260..ab9b21dcfd 100644 --- a/variables/_aws_amplify_backend_output_schemas.aiConversationOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.aiConversationOutputKey.html @@ -1,2 +1,2 @@ aiConversationOutputKey | Amplify Toolbox
    aiConversationOutputKey: "AWS::Amplify::AI::Conversation" = 'AWS::Amplify::AI::Conversation'

    Expected key that AI conversation output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.authOutputKey.html b/variables/_aws_amplify_backend_output_schemas.authOutputKey.html index 83dce77a98..fce2e8570f 100644 --- a/variables/_aws_amplify_backend_output_schemas.authOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.authOutputKey.html @@ -1,2 +1,2 @@ authOutputKey | Amplify Toolbox
    authOutputKey: "AWS::Amplify::Auth" = 'AWS::Amplify::Auth'

    Expected key that auth output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.backendOutputEntryStackMetadataSchema.html b/variables/_aws_amplify_backend_output_schemas.backendOutputEntryStackMetadataSchema.html index 13b98580ce..6ec57f66f1 100644 --- a/variables/_aws_amplify_backend_output_schemas.backendOutputEntryStackMetadataSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.backendOutputEntryStackMetadataSchema.html @@ -1,2 +1,2 @@ backendOutputEntryStackMetadataSchema | Amplify Toolbox
    backendOutputEntryStackMetadataSchema: ZodObject<{
        stackOutputs: ZodArray<ZodString, "many">;
        version: ZodString;
    }, "strip", ZodTypeAny, {
        stackOutputs: string[];
        version: string;
    }, {
        stackOutputs: string[];
        version: string;
    }> = ...

    Data schema for storing a backend output entry using stack metadata

    -

    Type declaration

    • stackOutputs: ZodArray<ZodString, "many">
    • version: ZodString

    Type declaration

    • stackOutputs: string[]
    • version: string

    Type declaration

    • stackOutputs: string[]
    • version: string
    \ No newline at end of file +

    Type declaration

    • stackOutputs: ZodArray<ZodString, "many">
    • version: ZodString

    Type declaration

    • stackOutputs: string[]
    • version: string

    Type declaration

    • stackOutputs: string[]
    • version: string
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.backendOutputStackMetadataSchema.html b/variables/_aws_amplify_backend_output_schemas.backendOutputStackMetadataSchema.html index cc4ddc7f91..1ed8c9fe38 100644 --- a/variables/_aws_amplify_backend_output_schemas.backendOutputStackMetadataSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.backendOutputStackMetadataSchema.html @@ -1,2 +1,2 @@ backendOutputStackMetadataSchema | Amplify Toolbox
    backendOutputStackMetadataSchema: ZodRecord<ZodString, ZodObject<{
        stackOutputs: ZodArray<ZodString, "many">;
        version: ZodString;
    }, "strip", ZodTypeAny, {
        stackOutputs: string[];
        version: string;
    }, {
        stackOutputs: string[];
        version: string;
    }>> = ...

    Data schema for storing backend output using stack metadata

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.customOutputKey.html b/variables/_aws_amplify_backend_output_schemas.customOutputKey.html index c99cf2378e..29f2dc8ab3 100644 --- a/variables/_aws_amplify_backend_output_schemas.customOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.customOutputKey.html @@ -1,2 +1,2 @@ customOutputKey | Amplify Toolbox
    customOutputKey: "AWS::Amplify::Custom" = 'AWS::Amplify::Custom'

    ---------- Custom exports ----------

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.functionOutputKey.html b/variables/_aws_amplify_backend_output_schemas.functionOutputKey.html index 9a630bba68..a83840b687 100644 --- a/variables/_aws_amplify_backend_output_schemas.functionOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.functionOutputKey.html @@ -1,2 +1,2 @@ functionOutputKey | Amplify Toolbox
    functionOutputKey: "AWS::Amplify::Function" = 'AWS::Amplify::Function'

    Expected key that function output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.graphqlOutputKey.html b/variables/_aws_amplify_backend_output_schemas.graphqlOutputKey.html index 9650605ab1..8d5404da1b 100644 --- a/variables/_aws_amplify_backend_output_schemas.graphqlOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.graphqlOutputKey.html @@ -1,2 +1,2 @@ graphqlOutputKey | Amplify Toolbox
    graphqlOutputKey: "AWS::Amplify::GraphQL" = 'AWS::Amplify::GraphQL'

    Expected key that graphql output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.platformOutputKey.html b/variables/_aws_amplify_backend_output_schemas.platformOutputKey.html index 5c1657cf86..f2b2575f2f 100644 --- a/variables/_aws_amplify_backend_output_schemas.platformOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.platformOutputKey.html @@ -1,2 +1,2 @@ platformOutputKey | Amplify Toolbox
    platformOutputKey: "AWS::Amplify::Platform" = 'AWS::Amplify::Platform'

    ---------- Platform exports ----------

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.storageOutputKey.html b/variables/_aws_amplify_backend_output_schemas.storageOutputKey.html index 112b395978..6843a60391 100644 --- a/variables/_aws_amplify_backend_output_schemas.storageOutputKey.html +++ b/variables/_aws_amplify_backend_output_schemas.storageOutputKey.html @@ -1,2 +1,2 @@ storageOutputKey | Amplify Toolbox
    storageOutputKey: "AWS::Amplify::Storage" = 'AWS::Amplify::Storage'

    Expected key that storage output is stored under

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.unifiedBackendOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.unifiedBackendOutputSchema.html index aa7fd47553..94dd7d65dc 100644 --- a/variables/_aws_amplify_backend_output_schemas.unifiedBackendOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.unifiedBackendOutputSchema.html @@ -1,3 +1,3 @@ unifiedBackendOutputSchema | Amplify Toolbox
    unifiedBackendOutputSchema: ZodObject<{
        AWS::Amplify::AI::Conversation: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                definedConversationHandlers: ZodString;
            }, "strip", ZodTypeAny, {
                definedConversationHandlers: string;
            }, {
                definedConversationHandlers: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                definedConversationHandlers: string;
            };
            version: "1";
        }, {
            payload: {
                definedConversationHandlers: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Auth: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                allowUnauthenticatedIdentities: ZodOptional<ZodString>;
                authRegion: ZodString;
                groups: ZodOptional<ZodString>;
                identityPoolId: ZodString;
                mfaConfiguration: ZodOptional<ZodString>;
                mfaTypes: ZodOptional<ZodString>;
                oauthClientId: ZodOptional<ZodString>;
                oauthCognitoDomain: ZodOptional<ZodString>;
                oauthRedirectSignIn: ZodOptional<ZodString>;
                oauthRedirectSignOut: ZodOptional<ZodString>;
                oauthResponseType: ZodOptional<ZodString>;
                oauthScope: ZodOptional<ZodString>;
                passwordPolicyMinLength: ZodOptional<ZodString>;
                passwordPolicyRequirements: ZodOptional<ZodString>;
                signupAttributes: ZodOptional<ZodString>;
                socialProviders: ZodOptional<ZodString>;
                userPoolId: ZodString;
                usernameAttributes: ZodOptional<ZodString>;
                verificationMechanisms: ZodOptional<ZodString>;
                webClientId: ZodString;
            }, "strip", ZodTypeAny, {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                groups?: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            }, {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                groups?: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                groups?: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        }, {
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                groups?: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Custom: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                customOutputs: ZodString;
            }, "strip", ZodTypeAny, {
                customOutputs: string;
            }, {
                customOutputs: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                customOutputs: string;
            };
            version: "1";
        }, {
            payload: {
                customOutputs: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Function: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                definedFunctions: ZodString;
            }, "strip", ZodTypeAny, {
                definedFunctions: string;
            }, {
                definedFunctions: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                definedFunctions: string;
            };
            version: "1";
        }, {
            payload: {
                definedFunctions: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::GraphQL: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                amplifyApiModelSchemaS3Uri: ZodString;
                awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
                awsAppsyncApiEndpoint: ZodString;
                awsAppsyncApiId: ZodString;
                awsAppsyncApiKey: ZodOptional<ZodString>;
                awsAppsyncAuthenticationType: ZodEnum<[(...), (...), (...), (...), (...)]>;
                awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
                awsAppsyncRegion: ZodString;
            }, "strip", ZodTypeAny, {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            }, {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            };
            version: "1";
        }, {
            payload: {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Platform: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                deploymentType: ZodString;
                region: ZodString;
            }, "strip", ZodTypeAny, {
                deploymentType: string;
                region: string;
            }, {
                deploymentType: string;
                region: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                deploymentType: string;
                region: string;
            };
            version: "1";
        }, {
            payload: {
                deploymentType: string;
                region: string;
            };
            version: "1";
        }>]>>;
        AWS::Amplify::Storage: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
            payload: ZodObject<{
                bucketName: ZodString;
                buckets: ZodOptional<ZodString>;
                storageRegion: ZodString;
            }, "strip", ZodTypeAny, {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            }, {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            }>;
            version: ZodLiteral<"1">;
        }, "strip", ZodTypeAny, {
            payload: {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            };
            version: "1";
        }, {
            payload: {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            };
            version: "1";
        }>]>>;
    }, "strip", ZodTypeAny, {
        AWS::Amplify::AI::Conversation?: {
            payload: {
                definedConversationHandlers: string;
            };
            version: "1";
        };
        AWS::Amplify::Auth?: {
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                groups?: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        };
        AWS::Amplify::Custom?: {
            payload: {
                customOutputs: string;
            };
            version: "1";
        };
        AWS::Amplify::Function?: {
            payload: {
                definedFunctions: string;
            };
            version: "1";
        };
        AWS::Amplify::GraphQL?: {
            payload: {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            };
            version: "1";
        };
        AWS::Amplify::Platform?: {
            payload: {
                deploymentType: string;
                region: string;
            };
            version: "1";
        };
        AWS::Amplify::Storage?: {
            payload: {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            };
            version: "1";
        };
    }, {
        AWS::Amplify::AI::Conversation?: {
            payload: {
                definedConversationHandlers: string;
            };
            version: "1";
        };
        AWS::Amplify::Auth?: {
            payload: {
                allowUnauthenticatedIdentities?: string;
                authRegion: string;
                groups?: string;
                identityPoolId: string;
                mfaConfiguration?: string;
                mfaTypes?: string;
                oauthClientId?: string;
                oauthCognitoDomain?: string;
                oauthRedirectSignIn?: string;
                oauthRedirectSignOut?: string;
                oauthResponseType?: string;
                oauthScope?: string;
                passwordPolicyMinLength?: string;
                passwordPolicyRequirements?: string;
                signupAttributes?: string;
                socialProviders?: string;
                userPoolId: string;
                usernameAttributes?: string;
                verificationMechanisms?: string;
                webClientId: string;
            };
            version: "1";
        };
        AWS::Amplify::Custom?: {
            payload: {
                customOutputs: string;
            };
            version: "1";
        };
        AWS::Amplify::Function?: {
            payload: {
                definedFunctions: string;
            };
            version: "1";
        };
        AWS::Amplify::GraphQL?: {
            payload: {
                amplifyApiModelSchemaS3Uri: string;
                awsAppsyncAdditionalAuthenticationTypes?: string;
                awsAppsyncApiEndpoint: string;
                awsAppsyncApiId: string;
                awsAppsyncApiKey?: string;
                awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
                awsAppsyncConflictResolutionMode?: string;
                awsAppsyncRegion: string;
            };
            version: "1";
        };
        AWS::Amplify::Platform?: {
            payload: {
                deploymentType: string;
                region: string;
            };
            version: "1";
        };
        AWS::Amplify::Storage?: {
            payload: {
                bucketName: string;
                buckets?: string;
                storageRegion: string;
            };
            version: "1";
        };
    }> = ...

    Defines the unified expected shape of Amplify backend output. As new constructs are added that need to contribute backend output, entries should be added here so that client config generation is aware of these outputs

    -

    Type declaration

    • AWS::Amplify::AI::Conversation: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              definedConversationHandlers: ZodString;
          }, "strip", ZodTypeAny, {
              definedConversationHandlers: string;
          }, {
              definedConversationHandlers: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              definedConversationHandlers: string;
          };
          version: "1";
      }, {
          payload: {
              definedConversationHandlers: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Auth: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              allowUnauthenticatedIdentities: ZodOptional<ZodString>;
              authRegion: ZodString;
              groups: ZodOptional<ZodString>;
              identityPoolId: ZodString;
              mfaConfiguration: ZodOptional<ZodString>;
              mfaTypes: ZodOptional<ZodString>;
              oauthClientId: ZodOptional<ZodString>;
              oauthCognitoDomain: ZodOptional<ZodString>;
              oauthRedirectSignIn: ZodOptional<ZodString>;
              oauthRedirectSignOut: ZodOptional<ZodString>;
              oauthResponseType: ZodOptional<ZodString>;
              oauthScope: ZodOptional<ZodString>;
              passwordPolicyMinLength: ZodOptional<ZodString>;
              passwordPolicyRequirements: ZodOptional<ZodString>;
              signupAttributes: ZodOptional<ZodString>;
              socialProviders: ZodOptional<ZodString>;
              userPoolId: ZodString;
              usernameAttributes: ZodOptional<ZodString>;
              verificationMechanisms: ZodOptional<ZodString>;
              webClientId: ZodString;
          }, "strip", ZodTypeAny, {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          }, {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }, {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Custom: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              customOutputs: ZodString;
          }, "strip", ZodTypeAny, {
              customOutputs: string;
          }, {
              customOutputs: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }, {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Function: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              definedFunctions: ZodString;
          }, "strip", ZodTypeAny, {
              definedFunctions: string;
          }, {
              definedFunctions: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }, {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::GraphQL: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              amplifyApiModelSchemaS3Uri: ZodString;
              awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
              awsAppsyncApiEndpoint: ZodString;
              awsAppsyncApiId: ZodString;
              awsAppsyncApiKey: ZodOptional<ZodString>;
              awsAppsyncAuthenticationType: ZodEnum<[(...), (...), (...), (...), (...)]>;
              awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
              awsAppsyncRegion: ZodString;
          }, "strip", ZodTypeAny, {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          }, {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }, {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Platform: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              deploymentType: ZodString;
              region: ZodString;
          }, "strip", ZodTypeAny, {
              deploymentType: string;
              region: string;
          }, {
              deploymentType: string;
              region: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }, {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Storage: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              bucketName: ZodString;
              buckets: ZodOptional<ZodString>;
              storageRegion: ZodString;
          }, "strip", ZodTypeAny, {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          }, {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }, {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }>]>>

    Type declaration

    • Optional AWS::Amplify::AI::Conversation?: {
          payload: {
              definedConversationHandlers: string;
          };
          version: "1";
      }
      • payload: {
            definedConversationHandlers: string;
        }
        • definedConversationHandlers: string
      • version: "1"
    • Optional AWS::Amplify::Auth?: {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }
      • payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }
        • Optional allowUnauthenticatedIdentities?: string
        • authRegion: string
        • Optional groups?: string
        • identityPoolId: string
        • Optional mfaConfiguration?: string
        • Optional mfaTypes?: string
        • Optional oauthClientId?: string
        • Optional oauthCognitoDomain?: string
        • Optional oauthRedirectSignIn?: string
        • Optional oauthRedirectSignOut?: string
        • Optional oauthResponseType?: string
        • Optional oauthScope?: string
        • Optional passwordPolicyMinLength?: string
        • Optional passwordPolicyRequirements?: string
        • Optional signupAttributes?: string
        • Optional socialProviders?: string
        • userPoolId: string
        • Optional usernameAttributes?: string
        • Optional verificationMechanisms?: string
        • webClientId: string
      • version: "1"
    • Optional AWS::Amplify::Custom?: {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }
      • payload: {
            customOutputs: string;
        }
        • customOutputs: string
      • version: "1"
    • Optional AWS::Amplify::Function?: {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }
      • payload: {
            definedFunctions: string;
        }
        • definedFunctions: string
      • version: "1"
    • Optional AWS::Amplify::GraphQL?: {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }
      • payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }
        • amplifyApiModelSchemaS3Uri: string
        • Optional awsAppsyncAdditionalAuthenticationTypes?: string
        • awsAppsyncApiEndpoint: string
        • awsAppsyncApiId: string
        • Optional awsAppsyncApiKey?: string
        • awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS"
        • Optional awsAppsyncConflictResolutionMode?: string
        • awsAppsyncRegion: string
      • version: "1"
    • Optional AWS::Amplify::Platform?: {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }
      • payload: {
            deploymentType: string;
            region: string;
        }
        • deploymentType: string
        • region: string
      • version: "1"
    • Optional AWS::Amplify::Storage?: {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }
      • payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }
        • bucketName: string
        • Optional buckets?: string
        • storageRegion: string
      • version: "1"

    Type declaration

    • Optional AWS::Amplify::AI::Conversation?: {
          payload: {
              definedConversationHandlers: string;
          };
          version: "1";
      }
      • payload: {
            definedConversationHandlers: string;
        }
        • definedConversationHandlers: string
      • version: "1"
    • Optional AWS::Amplify::Auth?: {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }
      • payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }
        • Optional allowUnauthenticatedIdentities?: string
        • authRegion: string
        • Optional groups?: string
        • identityPoolId: string
        • Optional mfaConfiguration?: string
        • Optional mfaTypes?: string
        • Optional oauthClientId?: string
        • Optional oauthCognitoDomain?: string
        • Optional oauthRedirectSignIn?: string
        • Optional oauthRedirectSignOut?: string
        • Optional oauthResponseType?: string
        • Optional oauthScope?: string
        • Optional passwordPolicyMinLength?: string
        • Optional passwordPolicyRequirements?: string
        • Optional signupAttributes?: string
        • Optional socialProviders?: string
        • userPoolId: string
        • Optional usernameAttributes?: string
        • Optional verificationMechanisms?: string
        • webClientId: string
      • version: "1"
    • Optional AWS::Amplify::Custom?: {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }
      • payload: {
            customOutputs: string;
        }
        • customOutputs: string
      • version: "1"
    • Optional AWS::Amplify::Function?: {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }
      • payload: {
            definedFunctions: string;
        }
        • definedFunctions: string
      • version: "1"
    • Optional AWS::Amplify::GraphQL?: {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }
      • payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }
        • amplifyApiModelSchemaS3Uri: string
        • Optional awsAppsyncAdditionalAuthenticationTypes?: string
        • awsAppsyncApiEndpoint: string
        • awsAppsyncApiId: string
        • Optional awsAppsyncApiKey?: string
        • awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS"
        • Optional awsAppsyncConflictResolutionMode?: string
        • awsAppsyncRegion: string
      • version: "1"
    • Optional AWS::Amplify::Platform?: {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }
      • payload: {
            deploymentType: string;
            region: string;
        }
        • deploymentType: string
        • region: string
      • version: "1"
    • Optional AWS::Amplify::Storage?: {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }
      • payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }
        • bucketName: string
        • Optional buckets?: string
        • storageRegion: string
      • version: "1"
    \ No newline at end of file +

    Type declaration

    • AWS::Amplify::AI::Conversation: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              definedConversationHandlers: ZodString;
          }, "strip", ZodTypeAny, {
              definedConversationHandlers: string;
          }, {
              definedConversationHandlers: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              definedConversationHandlers: string;
          };
          version: "1";
      }, {
          payload: {
              definedConversationHandlers: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Auth: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              allowUnauthenticatedIdentities: ZodOptional<ZodString>;
              authRegion: ZodString;
              groups: ZodOptional<ZodString>;
              identityPoolId: ZodString;
              mfaConfiguration: ZodOptional<ZodString>;
              mfaTypes: ZodOptional<ZodString>;
              oauthClientId: ZodOptional<ZodString>;
              oauthCognitoDomain: ZodOptional<ZodString>;
              oauthRedirectSignIn: ZodOptional<ZodString>;
              oauthRedirectSignOut: ZodOptional<ZodString>;
              oauthResponseType: ZodOptional<ZodString>;
              oauthScope: ZodOptional<ZodString>;
              passwordPolicyMinLength: ZodOptional<ZodString>;
              passwordPolicyRequirements: ZodOptional<ZodString>;
              signupAttributes: ZodOptional<ZodString>;
              socialProviders: ZodOptional<ZodString>;
              userPoolId: ZodString;
              usernameAttributes: ZodOptional<ZodString>;
              verificationMechanisms: ZodOptional<ZodString>;
              webClientId: ZodString;
          }, "strip", ZodTypeAny, {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          }, {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }, {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Custom: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              customOutputs: ZodString;
          }, "strip", ZodTypeAny, {
              customOutputs: string;
          }, {
              customOutputs: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }, {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Function: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              definedFunctions: ZodString;
          }, "strip", ZodTypeAny, {
              definedFunctions: string;
          }, {
              definedFunctions: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }, {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::GraphQL: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              amplifyApiModelSchemaS3Uri: ZodString;
              awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
              awsAppsyncApiEndpoint: ZodString;
              awsAppsyncApiId: ZodString;
              awsAppsyncApiKey: ZodOptional<ZodString>;
              awsAppsyncAuthenticationType: ZodEnum<[(...), (...), (...), (...), (...)]>;
              awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
              awsAppsyncRegion: ZodString;
          }, "strip", ZodTypeAny, {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          }, {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }, {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Platform: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              deploymentType: ZodString;
              region: ZodString;
          }, "strip", ZodTypeAny, {
              deploymentType: string;
              region: string;
          }, {
              deploymentType: string;
              region: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }, {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }>]>>
    • AWS::Amplify::Storage: ZodOptional<ZodDiscriminatedUnion<"version", [ZodObject<{
          payload: ZodObject<{
              bucketName: ZodString;
              buckets: ZodOptional<ZodString>;
              storageRegion: ZodString;
          }, "strip", ZodTypeAny, {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          }, {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          }>;
          version: ZodLiteral<"1">;
      }, "strip", ZodTypeAny, {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }, {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }>]>>

    Type declaration

    • Optional AWS::Amplify::AI::Conversation?: {
          payload: {
              definedConversationHandlers: string;
          };
          version: "1";
      }
      • payload: {
            definedConversationHandlers: string;
        }
        • definedConversationHandlers: string
      • version: "1"
    • Optional AWS::Amplify::Auth?: {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }
      • payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }
        • Optional allowUnauthenticatedIdentities?: string
        • authRegion: string
        • Optional groups?: string
        • identityPoolId: string
        • Optional mfaConfiguration?: string
        • Optional mfaTypes?: string
        • Optional oauthClientId?: string
        • Optional oauthCognitoDomain?: string
        • Optional oauthRedirectSignIn?: string
        • Optional oauthRedirectSignOut?: string
        • Optional oauthResponseType?: string
        • Optional oauthScope?: string
        • Optional passwordPolicyMinLength?: string
        • Optional passwordPolicyRequirements?: string
        • Optional signupAttributes?: string
        • Optional socialProviders?: string
        • userPoolId: string
        • Optional usernameAttributes?: string
        • Optional verificationMechanisms?: string
        • webClientId: string
      • version: "1"
    • Optional AWS::Amplify::Custom?: {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }
      • payload: {
            customOutputs: string;
        }
        • customOutputs: string
      • version: "1"
    • Optional AWS::Amplify::Function?: {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }
      • payload: {
            definedFunctions: string;
        }
        • definedFunctions: string
      • version: "1"
    • Optional AWS::Amplify::GraphQL?: {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }
      • payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }
        • amplifyApiModelSchemaS3Uri: string
        • Optional awsAppsyncAdditionalAuthenticationTypes?: string
        • awsAppsyncApiEndpoint: string
        • awsAppsyncApiId: string
        • Optional awsAppsyncApiKey?: string
        • awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS"
        • Optional awsAppsyncConflictResolutionMode?: string
        • awsAppsyncRegion: string
      • version: "1"
    • Optional AWS::Amplify::Platform?: {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }
      • payload: {
            deploymentType: string;
            region: string;
        }
        • deploymentType: string
        • region: string
      • version: "1"
    • Optional AWS::Amplify::Storage?: {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }
      • payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }
        • bucketName: string
        • Optional buckets?: string
        • storageRegion: string
      • version: "1"

    Type declaration

    • Optional AWS::Amplify::AI::Conversation?: {
          payload: {
              definedConversationHandlers: string;
          };
          version: "1";
      }
      • payload: {
            definedConversationHandlers: string;
        }
        • definedConversationHandlers: string
      • version: "1"
    • Optional AWS::Amplify::Auth?: {
          payload: {
              allowUnauthenticatedIdentities?: string;
              authRegion: string;
              groups?: string;
              identityPoolId: string;
              mfaConfiguration?: string;
              mfaTypes?: string;
              oauthClientId?: string;
              oauthCognitoDomain?: string;
              oauthRedirectSignIn?: string;
              oauthRedirectSignOut?: string;
              oauthResponseType?: string;
              oauthScope?: string;
              passwordPolicyMinLength?: string;
              passwordPolicyRequirements?: string;
              signupAttributes?: string;
              socialProviders?: string;
              userPoolId: string;
              usernameAttributes?: string;
              verificationMechanisms?: string;
              webClientId: string;
          };
          version: "1";
      }
      • payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }
        • Optional allowUnauthenticatedIdentities?: string
        • authRegion: string
        • Optional groups?: string
        • identityPoolId: string
        • Optional mfaConfiguration?: string
        • Optional mfaTypes?: string
        • Optional oauthClientId?: string
        • Optional oauthCognitoDomain?: string
        • Optional oauthRedirectSignIn?: string
        • Optional oauthRedirectSignOut?: string
        • Optional oauthResponseType?: string
        • Optional oauthScope?: string
        • Optional passwordPolicyMinLength?: string
        • Optional passwordPolicyRequirements?: string
        • Optional signupAttributes?: string
        • Optional socialProviders?: string
        • userPoolId: string
        • Optional usernameAttributes?: string
        • Optional verificationMechanisms?: string
        • webClientId: string
      • version: "1"
    • Optional AWS::Amplify::Custom?: {
          payload: {
              customOutputs: string;
          };
          version: "1";
      }
      • payload: {
            customOutputs: string;
        }
        • customOutputs: string
      • version: "1"
    • Optional AWS::Amplify::Function?: {
          payload: {
              definedFunctions: string;
          };
          version: "1";
      }
      • payload: {
            definedFunctions: string;
        }
        • definedFunctions: string
      • version: "1"
    • Optional AWS::Amplify::GraphQL?: {
          payload: {
              amplifyApiModelSchemaS3Uri: string;
              awsAppsyncAdditionalAuthenticationTypes?: string;
              awsAppsyncApiEndpoint: string;
              awsAppsyncApiId: string;
              awsAppsyncApiKey?: string;
              awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
              awsAppsyncConflictResolutionMode?: string;
              awsAppsyncRegion: string;
          };
          version: "1";
      }
      • payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }
        • amplifyApiModelSchemaS3Uri: string
        • Optional awsAppsyncAdditionalAuthenticationTypes?: string
        • awsAppsyncApiEndpoint: string
        • awsAppsyncApiId: string
        • Optional awsAppsyncApiKey?: string
        • awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS"
        • Optional awsAppsyncConflictResolutionMode?: string
        • awsAppsyncRegion: string
      • version: "1"
    • Optional AWS::Amplify::Platform?: {
          payload: {
              deploymentType: string;
              region: string;
          };
          version: "1";
      }
      • payload: {
            deploymentType: string;
            region: string;
        }
        • deploymentType: string
        • region: string
      • version: "1"
    • Optional AWS::Amplify::Storage?: {
          payload: {
              bucketName: string;
              buckets?: string;
              storageRegion: string;
          };
          version: "1";
      }
      • payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }
        • bucketName: string
        • Optional buckets?: string
        • storageRegion: string
      • version: "1"
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedAIConversationOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedAIConversationOutputSchema.html index f36ea7acac..164241a913 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedAIConversationOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedAIConversationOutputSchema.html @@ -1 +1 @@ -versionedAIConversationOutputSchema | Amplify Toolbox
    versionedAIConversationOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            definedConversationHandlers: ZodString;
        }, "strip", ZodTypeAny, {
            definedConversationHandlers: string;
        }, {
            definedConversationHandlers: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            definedConversationHandlers: string;
        };
        version: "1";
    }, {
        payload: {
            definedConversationHandlers: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedAIConversationOutputSchema | Amplify Toolbox
    versionedAIConversationOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            definedConversationHandlers: ZodString;
        }, "strip", ZodTypeAny, {
            definedConversationHandlers: string;
        }, {
            definedConversationHandlers: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            definedConversationHandlers: string;
        };
        version: "1";
    }, {
        payload: {
            definedConversationHandlers: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedAuthOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedAuthOutputSchema.html index dd550bae50..17aa0d803f 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedAuthOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedAuthOutputSchema.html @@ -1 +1 @@ -versionedAuthOutputSchema | Amplify Toolbox
    versionedAuthOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            allowUnauthenticatedIdentities: ZodOptional<ZodString>;
            authRegion: ZodString;
            groups: ZodOptional<ZodString>;
            identityPoolId: ZodString;
            mfaConfiguration: ZodOptional<ZodString>;
            mfaTypes: ZodOptional<ZodString>;
            oauthClientId: ZodOptional<ZodString>;
            oauthCognitoDomain: ZodOptional<ZodString>;
            oauthRedirectSignIn: ZodOptional<ZodString>;
            oauthRedirectSignOut: ZodOptional<ZodString>;
            oauthResponseType: ZodOptional<ZodString>;
            oauthScope: ZodOptional<ZodString>;
            passwordPolicyMinLength: ZodOptional<ZodString>;
            passwordPolicyRequirements: ZodOptional<ZodString>;
            signupAttributes: ZodOptional<ZodString>;
            socialProviders: ZodOptional<ZodString>;
            userPoolId: ZodString;
            usernameAttributes: ZodOptional<ZodString>;
            verificationMechanisms: ZodOptional<ZodString>;
            webClientId: ZodString;
        }, "strip", ZodTypeAny, {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }, {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        };
        version: "1";
    }, {
        payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedAuthOutputSchema | Amplify Toolbox
    versionedAuthOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            allowUnauthenticatedIdentities: ZodOptional<ZodString>;
            authRegion: ZodString;
            groups: ZodOptional<ZodString>;
            identityPoolId: ZodString;
            mfaConfiguration: ZodOptional<ZodString>;
            mfaTypes: ZodOptional<ZodString>;
            oauthClientId: ZodOptional<ZodString>;
            oauthCognitoDomain: ZodOptional<ZodString>;
            oauthRedirectSignIn: ZodOptional<ZodString>;
            oauthRedirectSignOut: ZodOptional<ZodString>;
            oauthResponseType: ZodOptional<ZodString>;
            oauthScope: ZodOptional<ZodString>;
            passwordPolicyMinLength: ZodOptional<ZodString>;
            passwordPolicyRequirements: ZodOptional<ZodString>;
            signupAttributes: ZodOptional<ZodString>;
            socialProviders: ZodOptional<ZodString>;
            userPoolId: ZodString;
            usernameAttributes: ZodOptional<ZodString>;
            verificationMechanisms: ZodOptional<ZodString>;
            webClientId: ZodString;
        }, "strip", ZodTypeAny, {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }, {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        };
        version: "1";
    }, {
        payload: {
            allowUnauthenticatedIdentities?: string;
            authRegion: string;
            groups?: string;
            identityPoolId: string;
            mfaConfiguration?: string;
            mfaTypes?: string;
            oauthClientId?: string;
            oauthCognitoDomain?: string;
            oauthRedirectSignIn?: string;
            oauthRedirectSignOut?: string;
            oauthResponseType?: string;
            oauthScope?: string;
            passwordPolicyMinLength?: string;
            passwordPolicyRequirements?: string;
            signupAttributes?: string;
            socialProviders?: string;
            userPoolId: string;
            usernameAttributes?: string;
            verificationMechanisms?: string;
            webClientId: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedCustomOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedCustomOutputSchema.html index 27c8e3ba0b..4c1b559c82 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedCustomOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedCustomOutputSchema.html @@ -1 +1 @@ -versionedCustomOutputSchema | Amplify Toolbox
    versionedCustomOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            customOutputs: ZodString;
        }, "strip", ZodTypeAny, {
            customOutputs: string;
        }, {
            customOutputs: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            customOutputs: string;
        };
        version: "1";
    }, {
        payload: {
            customOutputs: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedCustomOutputSchema | Amplify Toolbox
    versionedCustomOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            customOutputs: ZodString;
        }, "strip", ZodTypeAny, {
            customOutputs: string;
        }, {
            customOutputs: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            customOutputs: string;
        };
        version: "1";
    }, {
        payload: {
            customOutputs: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedFunctionOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedFunctionOutputSchema.html index ee7459a52c..119f09a6c7 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedFunctionOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedFunctionOutputSchema.html @@ -1 +1 @@ -versionedFunctionOutputSchema | Amplify Toolbox
    versionedFunctionOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            definedFunctions: ZodString;
        }, "strip", ZodTypeAny, {
            definedFunctions: string;
        }, {
            definedFunctions: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            definedFunctions: string;
        };
        version: "1";
    }, {
        payload: {
            definedFunctions: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedFunctionOutputSchema | Amplify Toolbox
    versionedFunctionOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            definedFunctions: ZodString;
        }, "strip", ZodTypeAny, {
            definedFunctions: string;
        }, {
            definedFunctions: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            definedFunctions: string;
        };
        version: "1";
    }, {
        payload: {
            definedFunctions: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedGraphqlOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedGraphqlOutputSchema.html index a0c506f60d..018be32de9 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedGraphqlOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedGraphqlOutputSchema.html @@ -1 +1 @@ -versionedGraphqlOutputSchema | Amplify Toolbox
    versionedGraphqlOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            amplifyApiModelSchemaS3Uri: ZodString;
            awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
            awsAppsyncApiEndpoint: ZodString;
            awsAppsyncApiId: ZodString;
            awsAppsyncApiKey: ZodOptional<ZodString>;
            awsAppsyncAuthenticationType: ZodEnum<["API_KEY", "AWS_LAMBDA", "AWS_IAM", "OPENID_CONNECT", "AMAZON_COGNITO_USER_POOLS"]>;
            awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
            awsAppsyncRegion: ZodString;
        }, "strip", ZodTypeAny, {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }, {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        };
        version: "1";
    }, {
        payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedGraphqlOutputSchema | Amplify Toolbox
    versionedGraphqlOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            amplifyApiModelSchemaS3Uri: ZodString;
            awsAppsyncAdditionalAuthenticationTypes: ZodOptional<ZodString>;
            awsAppsyncApiEndpoint: ZodString;
            awsAppsyncApiId: ZodString;
            awsAppsyncApiKey: ZodOptional<ZodString>;
            awsAppsyncAuthenticationType: ZodEnum<["API_KEY", "AWS_LAMBDA", "AWS_IAM", "OPENID_CONNECT", "AMAZON_COGNITO_USER_POOLS"]>;
            awsAppsyncConflictResolutionMode: ZodOptional<ZodString>;
            awsAppsyncRegion: ZodString;
        }, "strip", ZodTypeAny, {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }, {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        };
        version: "1";
    }, {
        payload: {
            amplifyApiModelSchemaS3Uri: string;
            awsAppsyncAdditionalAuthenticationTypes?: string;
            awsAppsyncApiEndpoint: string;
            awsAppsyncApiId: string;
            awsAppsyncApiKey?: string;
            awsAppsyncAuthenticationType: "API_KEY" | "AWS_LAMBDA" | "AWS_IAM" | "OPENID_CONNECT" | "AMAZON_COGNITO_USER_POOLS";
            awsAppsyncConflictResolutionMode?: string;
            awsAppsyncRegion: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_backend_output_schemas.versionedStorageOutputSchema.html b/variables/_aws_amplify_backend_output_schemas.versionedStorageOutputSchema.html index bed55b9b43..89ea349399 100644 --- a/variables/_aws_amplify_backend_output_schemas.versionedStorageOutputSchema.html +++ b/variables/_aws_amplify_backend_output_schemas.versionedStorageOutputSchema.html @@ -1 +1 @@ -versionedStorageOutputSchema | Amplify Toolbox
    versionedStorageOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            bucketName: ZodString;
            buckets: ZodOptional<ZodString>;
            storageRegion: ZodString;
        }, "strip", ZodTypeAny, {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }, {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        };
        version: "1";
    }, {
        payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file +versionedStorageOutputSchema | Amplify Toolbox
    versionedStorageOutputSchema: ZodDiscriminatedUnion<"version", [ZodObject<{
        payload: ZodObject<{
            bucketName: ZodString;
            buckets: ZodOptional<ZodString>;
            storageRegion: ZodString;
        }, "strip", ZodTypeAny, {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }, {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        }>;
        version: ZodLiteral<"1">;
    }, "strip", ZodTypeAny, {
        payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        };
        version: "1";
    }, {
        payload: {
            bucketName: string;
            buckets?: string;
            storageRegion: string;
        };
        version: "1";
    }>]> = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_cli_core.colorNames.html b/variables/_aws_amplify_cli_core.colorNames.html index f78711a349..5cbe6e135d 100644 --- a/variables/_aws_amplify_cli_core.colorNames.html +++ b/variables/_aws_amplify_cli_core.colorNames.html @@ -1 +1 @@ -colorNames | Amplify Toolbox
    colorNames: readonly ["Green", "Yellow", "Blue", "Magenta", "Cyan"] = ...
    \ No newline at end of file +colorNames | Amplify Toolbox
    colorNames: readonly ["Green", "Yellow", "Blue", "Magenta", "Cyan"] = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_cli_core.format-1.html b/variables/_aws_amplify_cli_core.format-1.html index 5868920456..d93f351406 100644 --- a/variables/_aws_amplify_cli_core.format-1.html +++ b/variables/_aws_amplify_cli_core.format-1.html @@ -1 +1 @@ -format | Amplify Toolbox
    format: Format = ...
    \ No newline at end of file +format | Amplify Toolbox
    format: Format = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_cli_core.printer-1.html b/variables/_aws_amplify_cli_core.printer-1.html index 94fd7e1d07..195bc64ce8 100644 --- a/variables/_aws_amplify_cli_core.printer-1.html +++ b/variables/_aws_amplify_cli_core.printer-1.html @@ -1 +1 @@ -printer | Amplify Toolbox
    printer: Printer = ...
    \ No newline at end of file +printer | Amplify Toolbox
    printer: Printer = ...
    \ No newline at end of file diff --git a/variables/_aws_amplify_client_config.DEFAULT_CLIENT_CONFIG_VERSION.html b/variables/_aws_amplify_client_config.DEFAULT_CLIENT_CONFIG_VERSION.html index 986e8a4e22..429ae2b257 100644 --- a/variables/_aws_amplify_client_config.DEFAULT_CLIENT_CONFIG_VERSION.html +++ b/variables/_aws_amplify_client_config.DEFAULT_CLIENT_CONFIG_VERSION.html @@ -1 +1 @@ -DEFAULT_CLIENT_CONFIG_VERSION | Amplify Toolbox
    DEFAULT_CLIENT_CONFIG_VERSION: ClientConfigVersion = ClientConfigVersionOption.V1_3
    \ No newline at end of file +DEFAULT_CLIENT_CONFIG_VERSION | Amplify Toolbox
    DEFAULT_CLIENT_CONFIG_VERSION: ClientConfigVersion = ClientConfigVersionOption.V1_3
    \ No newline at end of file diff --git a/variables/_aws_amplify_platform_core.USAGE_DATA_TRACKING_ENABLED.html b/variables/_aws_amplify_platform_core.USAGE_DATA_TRACKING_ENABLED.html index ac6951e0e9..39e7f4319c 100644 --- a/variables/_aws_amplify_platform_core.USAGE_DATA_TRACKING_ENABLED.html +++ b/variables/_aws_amplify_platform_core.USAGE_DATA_TRACKING_ENABLED.html @@ -1,2 +1,2 @@ USAGE_DATA_TRACKING_ENABLED | Amplify Toolbox
    USAGE_DATA_TRACKING_ENABLED: "telemetry.enabled" = 'telemetry.enabled'

    Key to access whether user opted-in status of usage data tracking preference.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/variables/_aws_amplify_platform_core.configControllerFactory.html b/variables/_aws_amplify_platform_core.configControllerFactory.html index 1779e8ab25..02b2049f93 100644 --- a/variables/_aws_amplify_platform_core.configControllerFactory.html +++ b/variables/_aws_amplify_platform_core.configControllerFactory.html @@ -1 +1 @@ -configControllerFactory | Amplify Toolbox
    \ No newline at end of file +configControllerFactory | Amplify Toolbox
    \ No newline at end of file diff --git a/variables/_aws_amplify_platform_core.packageJsonSchema.html b/variables/_aws_amplify_platform_core.packageJsonSchema.html index 6ea2e945db..40f5eca768 100644 --- a/variables/_aws_amplify_platform_core.packageJsonSchema.html +++ b/variables/_aws_amplify_platform_core.packageJsonSchema.html @@ -1,3 +1,3 @@ packageJsonSchema | Amplify Toolbox
    packageJsonSchema: ZodObject<{
        name: ZodOptional<ZodString>;
        type: ZodOptional<ZodUnion<[ZodLiteral<"module">, ZodLiteral<"commonjs">]>>;
        version: ZodOptional<ZodString>;
    }, "strip", ZodTypeAny, {
        name?: string;
        type?: "module" | "commonjs";
        version?: string;
    }, {
        name?: string;
        type?: "module" | "commonjs";
        version?: string;
    }> = ...

    Type for package.json content.

    Add additional validation if there are other fields we need to read

    -

    Type declaration

    • name: ZodOptional<ZodString>
    • type: ZodOptional<ZodUnion<[ZodLiteral<"module">, ZodLiteral<"commonjs">]>>
    • version: ZodOptional<ZodString>

    Type declaration

    • Optional name?: string
    • Optional type?: "module" | "commonjs"
    • Optional version?: string

    Type declaration

    • Optional name?: string
    • Optional type?: "module" | "commonjs"
    • Optional version?: string
    \ No newline at end of file +

    Type declaration

    • name: ZodOptional<ZodString>
    • type: ZodOptional<ZodUnion<[ZodLiteral<"module">, ZodLiteral<"commonjs">]>>
    • version: ZodOptional<ZodString>

    Type declaration

    • Optional name?: string
    • Optional type?: "module" | "commonjs"
    • Optional version?: string

    Type declaration

    • Optional name?: string
    • Optional type?: "module" | "commonjs"
    • Optional version?: string
    \ No newline at end of file