AWS Amplify Admin API
", "operations" : { "CloneBackend" : "This operation clones an existing backend.
", "CreateBackend" : "This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
", "CreateBackendAPI" : "Creates a new backend API resource.
", "CreateBackendAuth" : "Creates a new backend authentication resource.
", "CreateBackendConfig" : "Creates a config object for a backend.
", "CreateBackendStorage" : "Creates a backend storage resource.
", "CreateToken" : "Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
", "DeleteBackend" : "Removes an existing environment from your Amplify project.
", "DeleteBackendAPI" : "Deletes an existing backend API resource.
", "DeleteBackendAuth" : "Deletes an existing backend authentication resource.
", "DeleteBackendStorage" : "Removes the specified backend storage resource.
", "DeleteToken" : "Deletes the challenge token based on the given appId and sessionId.
", "GenerateBackendAPIModels" : "Generates a model schema for an existing backend API resource.
", "GetBackend" : "Provides project-level details for your Amplify UI project.
", "GetBackendAPI" : "Gets the details for a backend API.
", "GetBackendAPIModels" : "Gets a model introspection schema for an existing backend API resource.
", "GetBackendAuth" : "Gets a backend auth details.
", "GetBackendJob" : "Returns information about a specific job.
", "GetBackendStorage" : "Gets details for a backend storage resource.
", "GetToken" : "Gets the challenge token based on the given appId and sessionId.
", "ImportBackendAuth" : "Imports an existing backend authentication resource.
", "ImportBackendStorage" : "Imports an existing backend storage resource.
", "ListBackendJobs" : "Lists the jobs for the backend of an Amplify app.
", "ListS3Buckets" : "The list of S3 buckets in your account.
", "RemoveAllBackends" : "Removes all backend environments from your Amplify project.
", "RemoveBackendConfig" : "Removes the AWS resources required to access the Amplify Admin UI.
", "UpdateBackendAPI" : "Updates an existing backend API resource.
", "UpdateBackendAuth" : "Updates an existing backend authentication resource.
", "UpdateBackendConfig" : "Updates the AWS resources required to access the Amplify Admin UI.
", "UpdateBackendJob" : "Updates a specific job.
", "UpdateBackendStorage" : "Updates an existing backend storage resource.
" }, "shapes" : { "AuthResources" : { "base" : null, "refs" : { "CreateBackendAuthResourceConfig$AuthResources" : "Defines whether you want to configure only authentication or both authentication and authorization settings.
", "UpdateBackendAuthResourceConfig$AuthResources" : "Defines the service name to use when configuring an authentication resource in your Amplify project.
" } }, "BackendAPIAppSyncAuthSettings" : { "base" : "The authentication settings for accessing provisioned data models in your Amplify project.
", "refs" : { "BackendAPIAuthType$Settings" : "Describes settings for the authentication mode.
" } }, "BackendAPIAuthType" : { "base" : "Describes the auth types for your configured data models.
", "refs" : { "BackendAPIResourceConfig$DefaultAuthType" : "The default authentication type for interacting with the configured data models in your Amplify project.
", "ListOfBackendAPIAuthType$member" : null } }, "BackendAPICodegenReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "BackendAPICodegenRespObj" : { "base" : "The response object sent when a backend is created.
", "refs" : { } }, "BackendAPIConflictResolution" : { "base" : "Describes the conflict resolution configuration for your data model configured in your Amplify project.
", "refs" : { "BackendAPIResourceConfig$ConflictResolution" : "The conflict resolution strategy for your data stored in the data models.
" } }, "BackendAPIReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "BackendAPIResourceConfig" : { "base" : "The resource config for the data model, configured as a part of the Amplify project.
", "refs" : { "BackendAPIReqObj$ResourceConfig" : "Defines the resource configuration for the data model in your Amplify project.
", "CreateBackendAPIReqObj$ResourceConfig" : "The resource configuration for this request.
", "GetBackendAPIRespObj$ResourceConfig" : "The resource configuration for this response object.
" } }, "BackendAPIRespObj" : { "base" : "The response object sent when a backend is created.
", "refs" : { } }, "BackendAuthAppleProviderConfig" : { "base" : "Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
", "refs" : { "SocialProviderSettings$SignInWithApple" : null } }, "BackendAuthRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "BackendAuthSocialProviderConfig" : { "base" : "Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
", "refs" : { "SocialProviderSettings$Facebook" : null, "SocialProviderSettings$Google" : null, "SocialProviderSettings$LoginWithAmazon" : null } }, "BackendConfigRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "BackendJobReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "BackendJobRespObj" : { "base" : "The response object for this operation.
", "refs" : { "ListOfBackendJobRespObj$member" : null } }, "BackendStoragePermissions" : { "base" : "Describes the read, write, and delete permissions users have against your storage S3 bucket.
", "refs" : { "CreateBackendStorageResourceConfig$Permissions" : "The authorization configuration for the storage S3 bucket.
", "GetBackendStorageResourceConfig$Permissions" : "The authorization configuration for the storage S3 bucket.
", "UpdateBackendStorageResourceConfig$Permissions" : "The authorization configuration for the storage S3 bucket.
" } }, "BackendStorageRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "BadRequestException" : { "base" : "An error returned if a request is not formed properly.
", "refs" : { } }, "CloneBackendReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "CloneBackendRespObj" : { "base" : "The response object sent when a backend is created.
", "refs" : { } }, "CreateBackendAPIReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "CreateBackendAuthForgotPasswordConfig" : { "base" : "(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.
", "refs" : { "CreateBackendAuthUserPoolConfig$ForgotPassword" : "(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "CreateBackendAuthIdentityPoolConfig" : { "base" : "Describes authorization configurations for the auth resources, configured as a part of your Amplify project.
", "refs" : { "CreateBackendAuthResourceConfig$IdentityPoolConfigs" : "Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
" } }, "CreateBackendAuthMFAConfig" : { "base" : "Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
", "refs" : { "CreateBackendAuthUserPoolConfig$Mfa" : "Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
" } }, "CreateBackendAuthOAuthConfig" : { "base" : "Creates the OAuth configuration for your Amplify project.
", "refs" : { "CreateBackendAuthUserPoolConfig$OAuth" : "Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "CreateBackendAuthPasswordPolicyConfig" : { "base" : "The password policy configuration for the backend to your Amplify project.
", "refs" : { "CreateBackendAuthUserPoolConfig$PasswordPolicy" : "Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "CreateBackendAuthReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "CreateBackendAuthResourceConfig" : { "base" : "Defines the resource configuration when creating an auth resource in your Amplify project.
", "refs" : { "CreateBackendAuthReqObj$ResourceConfig" : "The resource configuration for this request object.
", "GetBackendAuthRespObj$ResourceConfig" : "The resource configuration for authorization requests to the backend of your Amplify project.
" } }, "CreateBackendAuthUserPoolConfig" : { "base" : "Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.
", "refs" : { "CreateBackendAuthResourceConfig$UserPoolConfigs" : "Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
" } }, "CreateBackendAuthVerificationMessageConfig" : { "base" : "Creates an email or SMS verification message for the auth resource configured for your Amplify project.
", "refs" : { "CreateBackendAuthUserPoolConfig$VerificationMessage" : "Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "CreateBackendConfigReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "CreateBackendConfigRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "CreateBackendReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "CreateBackendRespObj" : { "base" : "The response object sent when a backend is created.
", "refs" : { } }, "CreateBackendStorageReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "CreateBackendStorageResourceConfig" : { "base" : "The resource configuration for creating backend storage.
", "refs" : { "CreateBackendStorageReqObj$ResourceConfig" : "The resource configuration for creating backend storage.
" } }, "CreateTokenRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "DeleteBackendRespObj" : { "base" : "The returned object for a request to delete a backend.
", "refs" : { } }, "DeleteTokenRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "DeliveryMethod" : { "base" : "The type of verification message to send.
", "refs" : { "CreateBackendAuthForgotPasswordConfig$DeliveryMethod" : "(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
", "CreateBackendAuthVerificationMessageConfig$DeliveryMethod" : "The type of verification message to send.
", "UpdateBackendAuthForgotPasswordConfig$DeliveryMethod" : "(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
", "UpdateBackendAuthVerificationMessageConfig$DeliveryMethod" : "The type of verification message to send.
" } }, "EmailSettings" : { "base" : "The settings for the email message.
", "refs" : { "CreateBackendAuthForgotPasswordConfig$EmailSettings" : "(DEPRECATED) The configuration for the email sent when an app user forgets their password.
", "CreateBackendAuthVerificationMessageConfig$EmailSettings" : "The settings for the email message.
", "UpdateBackendAuthForgotPasswordConfig$EmailSettings" : "(DEPRECATED) The configuration for the email sent when an app user forgets their password.
", "UpdateBackendAuthVerificationMessageConfig$EmailSettings" : "The settings for the email message.
" } }, "GatewayTimeoutException" : { "base" : "An error returned if there's a temporary issue with the service.
", "refs" : { } }, "GetBackendAPIModelsResponse" : { "base" : "The response object for this operation.
", "refs" : { } }, "GetBackendAPIRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "GetBackendAuthReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "GetBackendAuthRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "GetBackendReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "GetBackendRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "GetBackendStorageReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "GetBackendStorageResourceConfig" : { "base" : "The details for a backend storage resource.
", "refs" : { "GetBackendStorageRespObj$ResourceConfig" : "The resource configuration for the backend storage resource.
" } }, "GetBackendStorageRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "GetTokenRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "ImportBackendAuthReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "ImportBackendStorageReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "InternalServiceException" : { "base" : "An error returned if there's a temporary issue with the service.
", "refs" : { } }, "LimitExceededException" : { "base" : "An error that is returned when a limit of a specific type has been exceeded.
", "refs" : { } }, "ListBackendJobReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "ListBackendJobRespObj" : { "base" : "The returned list of backend jobs.
", "refs" : { } }, "ListS3BucketsReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "ListS3BucketsRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "LoginAuthConfigReqObj" : { "base" : "The request object for this operation.
", "refs" : { "BackendConfigRespObj$LoginAuthConfig" : "Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.
", "UpdateBackendConfigReqObj$LoginAuthConfig" : "Describes the Amazon Cognito configuration for Admin UI access.
" } }, "MFAMode" : { "base" : null, "refs" : { "CreateBackendAuthMFAConfig$MFAMode" : "Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
", "UpdateBackendAuthMFAConfig$MFAMode" : "The MFA mode for the backend of your Amplify project.
" } }, "Mode" : { "base" : null, "refs" : { "BackendAPIAuthType$Mode" : "Describes the authentication mode.
" } }, "NotFoundException" : { "base" : "An error returned when a specific resource type is not found.
", "refs" : { } }, "OAuthGrantType" : { "base" : null, "refs" : { "CreateBackendAuthOAuthConfig$OAuthGrantType" : "The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
", "UpdateBackendAuthOAuthConfig$OAuthGrantType" : "The OAuth grant type to allow app users to authenticate from your Amplify app.
" } }, "RemoveAllBackendsReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "RemoveAllBackendsRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "RemoveBackendAuthReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "RemoveBackendConfigRespObj" : { "base" : "The response object for this operation.
", "refs" : { } }, "RemoveBackendStorageReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "ResolutionStrategy" : { "base" : null, "refs" : { "BackendAPIConflictResolution$ResolutionStrategy" : "The strategy for conflict resolution.
" } }, "ResourceConfig" : { "base" : null, "refs" : { "CreateBackendReqObj$ResourceConfig" : "The resource configuration for creating a backend.
" } }, "S3BucketInfo" : { "base" : "Describes the metadata of the S3 bucket.
", "refs" : { "ListOfS3BucketInfo$member" : null } }, "Service" : { "base" : null, "refs" : { "CreateBackendAuthResourceConfig$Service" : "Defines the service name to use when configuring an authentication resource in your Amplify project.
", "UpdateBackendAuthResourceConfig$Service" : "Defines the service name to use when configuring an authentication resource in your Amplify project.
" } }, "ServiceName" : { "base" : null, "refs" : { "CreateBackendStorageResourceConfig$ServiceName" : "The name of the storage service.
", "GetBackendStorageResourceConfig$ServiceName" : "The name of the storage service.
", "ImportBackendStorageReqObj$ServiceName" : "The name of the storage service.
", "RemoveBackendStorageReqObj$ServiceName" : "The name of the storage service.
", "UpdateBackendStorageResourceConfig$ServiceName" : "The name of the storage service.
" } }, "Settings" : { "base" : null, "refs" : { "CreateBackendAuthMFAConfig$Settings" : "Describes the configuration settings and methods for your Amplify app users to use MFA.
", "UpdateBackendAuthMFAConfig$Settings" : "The settings of your MFA configuration for the backend of your Amplify project.
" } }, "SignInMethod" : { "base" : null, "refs" : { "CreateBackendAuthUserPoolConfig$SignInMethod" : "Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "SmsSettings" : { "base" : "The settings for the SMS message.
", "refs" : { "CreateBackendAuthForgotPasswordConfig$SmsSettings" : "(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.
", "CreateBackendAuthVerificationMessageConfig$SmsSettings" : "The settings for the SMS message.
", "UpdateBackendAuthForgotPasswordConfig$SmsSettings" : "(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.
", "UpdateBackendAuthVerificationMessageConfig$SmsSettings" : "The settings for the SMS message.
" } }, "SocialProviderSettings" : { "base" : null, "refs" : { "CreateBackendAuthOAuthConfig$SocialProviderSettings" : "The settings for using social providers to access your Amplify app.
", "UpdateBackendAuthOAuthConfig$SocialProviderSettings" : "Describes third-party social federation configurations for allowing your users to sign in with OAuth.
" } }, "Status" : { "base" : null, "refs" : { "GetBackendAPIModelsResponse$Status" : "The current status of the request.
" } }, "TooManyRequestsException" : { "base" : "An error that is returned when a limit of a specific type has been exceeded.
", "refs" : { } }, "UpdateBackendAuthForgotPasswordConfig" : { "base" : "(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.
", "refs" : { "UpdateBackendAuthUserPoolConfig$ForgotPassword" : "(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "UpdateBackendAuthIdentityPoolConfig" : { "base" : "Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
", "refs" : { "UpdateBackendAuthResourceConfig$IdentityPoolConfigs" : "Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
" } }, "UpdateBackendAuthMFAConfig" : { "base" : "Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.
", "refs" : { "UpdateBackendAuthUserPoolConfig$Mfa" : "Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
" } }, "UpdateBackendAuthOAuthConfig" : { "base" : "The OAuth configurations for authenticating users into your Amplify app.
", "refs" : { "UpdateBackendAuthUserPoolConfig$OAuth" : "Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "UpdateBackendAuthPasswordPolicyConfig" : { "base" : "Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.
", "refs" : { "UpdateBackendAuthUserPoolConfig$PasswordPolicy" : "Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "UpdateBackendAuthReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "UpdateBackendAuthResourceConfig" : { "base" : "Defines the resource configuration when updating an authentication resource in your Amplify project.
", "refs" : { "UpdateBackendAuthReqObj$ResourceConfig" : "The resource configuration for this request object.
" } }, "UpdateBackendAuthUserPoolConfig" : { "base" : "Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.
", "refs" : { "UpdateBackendAuthResourceConfig$UserPoolConfigs" : "Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
" } }, "UpdateBackendAuthVerificationMessageConfig" : { "base" : "Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.
", "refs" : { "UpdateBackendAuthUserPoolConfig$VerificationMessage" : "Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
" } }, "UpdateBackendConfigReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "UpdateBackendStorageReqObj" : { "base" : "The request object for this operation.
", "refs" : { } }, "UpdateBackendStorageResourceConfig" : { "base" : "The resource configuration for updating backend storage.
", "refs" : { "UpdateBackendStorageReqObj$ResourceConfig" : "The resource configuration for updating backend storage.
" } }, "AdditionalConstraintsElement" : { "base" : null, "refs" : { "ListOfAdditionalConstraintsElement$member" : null } }, "AuthenticatedElement" : { "base" : null, "refs" : { "ListOfAuthenticatedElement$member" : null } }, "MfaTypesElement" : { "base" : null, "refs" : { "ListOfMfaTypesElement$member" : null } }, "OAuthScopesElement" : { "base" : null, "refs" : { "ListOfOAuthScopesElement$member" : null } }, "RequiredSignUpAttributesElement" : { "base" : null, "refs" : { "ListOfRequiredSignUpAttributesElement$member" : null } }, "UnAuthenticatedElement" : { "base" : null, "refs" : { "ListOfUnAuthenticatedElement$member" : null } }, "__boolean" : { "base" : null, "refs" : { "CreateBackendAuthIdentityPoolConfig$UnauthenticatedLogin" : "Set to true or false based on whether you want to enable guest authorization to your Amplify app.
", "DeleteTokenRespObj$IsSuccess" : "Indicates whether the request succeeded or failed.
", "GetBackendStorageResourceConfig$Imported" : "Returns True if the storage resource has been imported.
", "RemoveAllBackendsReqObj$CleanAmplifyApp" : "Cleans up the Amplify Console app if this value is set to true.
", "UpdateBackendAuthIdentityPoolConfig$UnauthenticatedLogin" : "A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app.
" } }, "__double" : { "base" : null, "refs" : { "BackendAPIAppSyncAuthSettings$ExpirationTime" : "The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
", "CreateBackendAuthPasswordPolicyConfig$MinimumLength" : "The minimum length of the password used to access the backend of your Amplify project.
", "UpdateBackendAuthPasswordPolicyConfig$MinimumLength" : "Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.
" } }, "__integerMin1Max25" : { "base" : null, "refs" : { "ListBackendJobReqObj$MaxResults" : "The maximum number of results that you want in the response.
" } }, "ListOfBackendAPIAuthType" : { "base" : null, "refs" : { "BackendAPIResourceConfig$AdditionalAuthTypes" : "Additional authentication methods used to interact with your data models.
" } }, "ListOfBackendJobRespObj" : { "base" : null, "refs" : { "ListBackendJobRespObj$Jobs" : "An array of jobs and their properties.
" } }, "ListOfS3BucketInfo" : { "base" : null, "refs" : { "ListS3BucketsRespObj$Buckets" : "The list of S3 buckets.
" } }, "ListOfAdditionalConstraintsElement" : { "base" : null, "refs" : { "CreateBackendAuthPasswordPolicyConfig$AdditionalConstraints" : "Additional constraints for the password used to access the backend of your Amplify project.
", "UpdateBackendAuthPasswordPolicyConfig$AdditionalConstraints" : "Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.
" } }, "ListOfAuthenticatedElement" : { "base" : null, "refs" : { "BackendStoragePermissions$Authenticated" : "Lists all authenticated user read, write, and delete permissions for your S3 bucket.
" } }, "ListOfMfaTypesElement" : { "base" : null, "refs" : { "Settings$MfaTypes" : null } }, "ListOfOAuthScopesElement" : { "base" : null, "refs" : { "CreateBackendAuthOAuthConfig$OAuthScopes" : "List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
", "UpdateBackendAuthOAuthConfig$OAuthScopes" : "The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
" } }, "ListOfRequiredSignUpAttributesElement" : { "base" : null, "refs" : { "CreateBackendAuthUserPoolConfig$RequiredSignUpAttributes" : "The required attributes to sign up new users in the user pool.
" } }, "ListOfUnAuthenticatedElement" : { "base" : null, "refs" : { "BackendStoragePermissions$UnAuthenticated" : "Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.
" } }, "ListOf__string" : { "base" : null, "refs" : { "CreateBackendAuthOAuthConfig$RedirectSignInURIs" : "The redirected URI for signing in to your Amplify app.
", "CreateBackendAuthOAuthConfig$RedirectSignOutURIs" : "Redirect URLs that OAuth uses when a user signs out of an Amplify app.
", "GetBackendRespObj$BackendEnvironmentList" : "A list of backend environments in an array.
", "UpdateBackendAuthOAuthConfig$RedirectSignInURIs" : "Redirect URLs that OAuth uses when a user signs in to an Amplify app.
", "UpdateBackendAuthOAuthConfig$RedirectSignOutURIs" : "Redirect URLs that OAuth uses when a user signs out of an Amplify app.
" } }, "__string" : { "base" : null, "refs" : { "BackendAPIAppSyncAuthSettings$CognitoUserPoolId" : "The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
", "BackendAPIAppSyncAuthSettings$Description" : "The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
", "BackendAPIAppSyncAuthSettings$OpenIDAuthTTL" : "The expiry time for the OpenID authentication mechanism.
", "BackendAPIAppSyncAuthSettings$OpenIDClientId" : "The clientID for openID, if openID was used as an authentication setting to access your data models.
", "BackendAPIAppSyncAuthSettings$OpenIDIatTTL" : "The expiry time for the OpenID authentication mechanism.
", "BackendAPIAppSyncAuthSettings$OpenIDIssueURL" : "The openID issuer URL, if openID was used as an authentication setting to access your data models.
", "BackendAPIAppSyncAuthSettings$OpenIDProviderName" : "The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
", "BackendAPICodegenReqObj$ResourceName" : "The name of this resource.
", "BackendAPICodegenRespObj$AppId" : "The app ID.
", "BackendAPICodegenRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "BackendAPICodegenRespObj$Error" : "If the request fails, this error is returned.
", "BackendAPICodegenRespObj$JobId" : "The ID for the job.
", "BackendAPICodegenRespObj$Operation" : "The name of the operation.
", "BackendAPICodegenRespObj$Status" : "The current status of the request.
", "BackendAPIReqObj$ResourceName" : "The name of this resource.
", "BackendAPIResourceConfig$ApiName" : "The API name used to interact with the data model, configured as a part of your Amplify project.
", "BackendAPIResourceConfig$Service" : "The service used to provision and interact with the data model.
", "BackendAPIResourceConfig$TransformSchema" : "The definition of the data model in the annotated transform of the GraphQL schema.
", "BackendAPIRespObj$AppId" : "The app ID.
", "BackendAPIRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "BackendAPIRespObj$Error" : "If the request fails, this error is returned.
", "BackendAPIRespObj$JobId" : "The ID for the job.
", "BackendAPIRespObj$Operation" : "The name of the operation.
", "BackendAPIRespObj$Status" : "The current status of the request.
", "BackendAuthAppleProviderConfig$ClientId" : "Describes the client_id (also called Services ID) that comes from Apple.
", "BackendAuthAppleProviderConfig$KeyId" : "Describes the key_id that comes from Apple.
", "BackendAuthAppleProviderConfig$PrivateKey" : "Describes the private_key that comes from Apple.
", "BackendAuthAppleProviderConfig$TeamId" : "Describes the team_id that comes from Apple.
", "BackendAuthRespObj$AppId" : "The app ID.
", "BackendAuthRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "BackendAuthRespObj$Error" : "If the request fails, this error is returned.
", "BackendAuthRespObj$JobId" : "The ID for the job.
", "BackendAuthRespObj$Operation" : "The name of the operation.
", "BackendAuthRespObj$Status" : "The current status of the request.
", "BackendAuthSocialProviderConfig$ClientId" : "Describes the client_id, which can be obtained from the third-party social federation provider.
", "BackendAuthSocialProviderConfig$ClientSecret" : "Describes the client_secret, which can be obtained from third-party social federation providers.
", "BackendConfigRespObj$AppId" : "The app ID.
", "BackendConfigRespObj$BackendManagerAppId" : "The app ID for the backend manager.
", "BackendConfigRespObj$Error" : "If the request fails, this error is returned.
", "BackendJobReqObj$Operation" : "Filters the list of response objects to include only those with the specified operation name.
", "BackendJobReqObj$Status" : "Filters the list of response objects to include only those with the specified status.
", "BackendJobRespObj$AppId" : "The app ID.
", "BackendJobRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "BackendJobRespObj$CreateTime" : "The time when the job was created.
", "BackendJobRespObj$Error" : "If the request fails, this error is returned.
", "BackendJobRespObj$JobId" : "The ID for the job.
", "BackendJobRespObj$Operation" : "The name of the operation.
", "BackendJobRespObj$Status" : "The current status of the request.
", "BackendJobRespObj$UpdateTime" : "The time when the job was last updated.
", "BackendStorageRespObj$AppId" : "The app ID.
", "BackendStorageRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "BackendStorageRespObj$JobId" : "The ID for the job.
", "BackendStorageRespObj$Status" : "The current status of the request.
", "BadRequestException$Message" : "An error message to inform that the request failed.
", "CloneBackendReqObj$TargetEnvironmentName" : "The name of the destination backend environment to be created.
", "CloneBackendRespObj$AppId" : "The app ID.
", "CloneBackendRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "CloneBackendRespObj$Error" : "If the request fails, this error is returned.
", "CloneBackendRespObj$JobId" : "The ID for the job.
", "CloneBackendRespObj$Operation" : "The name of the operation.
", "CloneBackendRespObj$Status" : "The current status of the request.
", "CreateBackendAPIReqObj$BackendEnvironmentName" : "The name of the backend environment.
", "CreateBackendAPIReqObj$ResourceName" : "The name of this resource.
", "CreateBackendAuthIdentityPoolConfig$IdentityPoolName" : "Name of the Amazon Cognito identity pool used for authorization.
", "CreateBackendAuthOAuthConfig$DomainPrefix" : "The domain prefix for your Amplify app.
", "CreateBackendAuthReqObj$BackendEnvironmentName" : "The name of the backend environment.
", "CreateBackendAuthReqObj$ResourceName" : "The name of this resource.
", "CreateBackendAuthUserPoolConfig$UserPoolName" : "The Amazon Cognito user pool name.
", "CreateBackendConfigReqObj$BackendManagerAppId" : "The app ID for the backend manager.
", "CreateBackendConfigRespObj$AppId" : "The app ID.
", "CreateBackendConfigRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "CreateBackendConfigRespObj$JobId" : "The ID for the job.
", "CreateBackendConfigRespObj$Status" : "The current status of the request.
", "CreateBackendReqObj$AppId" : "The app ID.
", "CreateBackendReqObj$AppName" : "The name of the app.
", "CreateBackendReqObj$BackendEnvironmentName" : "The name of the backend environment.
", "CreateBackendReqObj$ResourceName" : "The name of the resource.
", "CreateBackendRespObj$AppId" : "The app ID.
", "CreateBackendRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "CreateBackendRespObj$Error" : "If the request fails, this error is returned.
", "CreateBackendRespObj$JobId" : "The ID for the job.
", "CreateBackendRespObj$Operation" : "The name of the operation.
", "CreateBackendRespObj$Status" : "The current status of the request.
", "CreateBackendStorageReqObj$BackendEnvironmentName" : "The name of the backend environment.
", "CreateBackendStorageReqObj$ResourceName" : "The name of the storage resource.
", "CreateBackendStorageResourceConfig$BucketName" : "The name of the S3 bucket.
", "CreateTokenRespObj$AppId" : "The app ID.
", "CreateTokenRespObj$ChallengeCode" : "One-time challenge code for authenticating into the Amplify Admin UI.
", "CreateTokenRespObj$SessionId" : "A unique ID provided when creating a new challenge token.
", "CreateTokenRespObj$Ttl" : "The expiry time for the one-time generated token code.
", "DeleteBackendRespObj$AppId" : "The app ID.
", "DeleteBackendRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "DeleteBackendRespObj$Error" : "If the request fails, this error is returned.
", "DeleteBackendRespObj$JobId" : "The ID for the job.
", "DeleteBackendRespObj$Operation" : "The name of the operation.
", "DeleteBackendRespObj$Status" : "The current status of the request.
", "EmailSettings$EmailMessage" : "The contents of the email message.
", "EmailSettings$EmailSubject" : "The contents of the subject line of the email message.
", "GetBackendAPIModelsResponse$ModelIntrospectionSchema" : "Stringified JSON of the model introspection schema for an existing backend API resource.
", "GetBackendAPIModelsResponse$Models" : "Stringified JSON of the datastore model.
", "GetBackendAPIRespObj$AppId" : "The app ID.
", "GetBackendAPIRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "GetBackendAPIRespObj$Error" : "If the request fails, this error is returned.
", "GetBackendAPIRespObj$ResourceName" : "The name of this resource.
", "GetBackendAuthReqObj$ResourceName" : "The name of this resource.
", "GetBackendAuthRespObj$AppId" : "The app ID.
", "GetBackendAuthRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "GetBackendAuthRespObj$Error" : "If the request fails, this error is returned.
", "GetBackendAuthRespObj$ResourceName" : "The name of this resource.
", "GetBackendReqObj$BackendEnvironmentName" : "The name of the backend environment.
", "GetBackendRespObj$AmplifyFeatureFlags" : "A stringified version of the cli.json file for your Amplify project.
", "GetBackendRespObj$AmplifyMetaConfig" : "A stringified version of the current configs for your Amplify project.
", "GetBackendRespObj$AppId" : "The app ID.
", "GetBackendRespObj$AppName" : "The name of the app.
", "GetBackendRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "GetBackendRespObj$Error" : "If the request failed, this is the returned error.
", "GetBackendStorageReqObj$ResourceName" : "The name of the storage resource.
", "GetBackendStorageResourceConfig$BucketName" : "The name of the S3 bucket.
", "GetBackendStorageRespObj$AppId" : "The app ID.
", "GetBackendStorageRespObj$BackendEnvironmentName" : "The name of the backend environment.
", "GetBackendStorageRespObj$ResourceName" : "The name of the storage resource.
", "GetTokenRespObj$AppId" : "The app ID.
", "GetTokenRespObj$ChallengeCode" : "The one-time challenge code for authenticating into the Amplify Admin UI.
", "GetTokenRespObj$SessionId" : "A unique ID provided when creating a new challenge token.
", "GetTokenRespObj$Ttl" : "The expiry time for the one-time generated token code.
", "ImportBackendAuthReqObj$IdentityPoolId" : "The ID of the Amazon Cognito identity pool.
", "ImportBackendAuthReqObj$NativeClientId" : "The ID of the Amazon Cognito native client.
", "ImportBackendAuthReqObj$UserPoolId" : "The ID of the Amazon Cognito user pool.
", "ImportBackendAuthReqObj$WebClientId" : "The ID of the Amazon Cognito web client.
", "ImportBackendStorageReqObj$BucketName" : "The name of the S3 bucket.
", "InternalServiceException$Message" : "An error message to inform that the request failed.
", "LimitExceededException$LimitType" : "The type of limit that was exceeded.
", "LimitExceededException$Message" : "An error message to inform that the request has failed.
", "ListBackendJobReqObj$JobId" : "The ID for the job.
", "ListBackendJobReqObj$NextToken" : "The token for the next set of results.
", "ListBackendJobReqObj$Operation" : "Filters the list of response objects to include only those with the specified operation name.
", "ListBackendJobReqObj$Status" : "Filters the list of response objects to include only those with the specified status.
", "ListBackendJobRespObj$NextToken" : "The token for the next set of results.
", "ListS3BucketsReqObj$NextToken" : "Reserved for future use.
", "ListS3BucketsRespObj$NextToken" : "Reserved for future use.
", "LoginAuthConfigReqObj$AwsCognitoIdentityPoolId" : "The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.
", "LoginAuthConfigReqObj$AwsCognitoRegion" : "The AWS Region for the Amplify Admin UI login.
", "LoginAuthConfigReqObj$AwsUserPoolsId" : "The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
", "LoginAuthConfigReqObj$AwsUserPoolsWebClientId" : "The web client ID for the Amazon Cognito user pools.
", "NotFoundException$Message" : "An error message to inform that the request has failed.
", "NotFoundException$ResourceType" : "The type of resource that is not found.
", "RemoveAllBackendsRespObj$AppId" : "The app ID.
", "RemoveAllBackendsRespObj$Error" : "If the request fails, this error is returned.
", "RemoveAllBackendsRespObj$JobId" : "The ID for the job.
", "RemoveAllBackendsRespObj$Operation" : "The name of the operation.
", "RemoveAllBackendsRespObj$Status" : "The current status of the request.
", "RemoveBackendAuthReqObj$ResourceName" : "The name of this resource.
", "RemoveBackendConfigRespObj$Error" : "If the request fails, this error is returned.
", "RemoveBackendStorageReqObj$ResourceName" : "The name of the storage resource.
", "S3BucketInfo$CreationDate" : "The creation date of the S3 bucket.
", "S3BucketInfo$Name" : "The name of the S3 bucket.
", "Settings$SmsMessage" : "The body of the SMS message.
", "SmsSettings$SmsMessage" : "The contents of the SMS message.
", "UpdateBackendAuthOAuthConfig$DomainPrefix" : "The Amazon Cognito domain prefix used to create a hosted UI for authentication.
", "UpdateBackendAuthReqObj$ResourceName" : "The name of this resource.
", "UpdateBackendStorageReqObj$ResourceName" : "The name of the storage resource.
", "ListOf__string$member" : null } } } }