Amplifybackend
This page documents function available when using the Amplifybackend module, created with @service Amplifybackend.
Index
Main.Amplifybackend.clone_backendMain.Amplifybackend.create_backendMain.Amplifybackend.create_backend_apiMain.Amplifybackend.create_backend_authMain.Amplifybackend.create_backend_configMain.Amplifybackend.create_backend_storageMain.Amplifybackend.create_tokenMain.Amplifybackend.delete_backendMain.Amplifybackend.delete_backend_apiMain.Amplifybackend.delete_backend_authMain.Amplifybackend.delete_backend_storageMain.Amplifybackend.delete_tokenMain.Amplifybackend.generate_backend_apimodelsMain.Amplifybackend.get_backendMain.Amplifybackend.get_backend_apiMain.Amplifybackend.get_backend_apimodelsMain.Amplifybackend.get_backend_authMain.Amplifybackend.get_backend_jobMain.Amplifybackend.get_backend_storageMain.Amplifybackend.get_tokenMain.Amplifybackend.import_backend_authMain.Amplifybackend.import_backend_storageMain.Amplifybackend.list_backend_jobsMain.Amplifybackend.list_s3_bucketsMain.Amplifybackend.remove_all_backendsMain.Amplifybackend.remove_backend_configMain.Amplifybackend.update_backend_apiMain.Amplifybackend.update_backend_authMain.Amplifybackend.update_backend_configMain.Amplifybackend.update_backend_jobMain.Amplifybackend.update_backend_storage
Documentation
Main.Amplifybackend.clone_backend — Methodclone_backend(app_id, backend_environment_name, target_environment_name)
clone_backend(app_id, backend_environment_name, target_environment_name, params::Dict{String,<:Any})This operation clones an existing backend.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.target_environment_name: The name of the destination backend environment to be created.
Main.Amplifybackend.create_backend — Methodcreate_backend(app_id, app_name, backend_environment_name)
create_backend(app_id, app_name, backend_environment_name, params::Dict{String,<:Any})This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
Arguments
app_id: The app ID.app_name: The name of the app.backend_environment_name: The name of the backend environment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"resourceConfig": The resource configuration for creating a backend."resourceName": The name of the resource.
Main.Amplifybackend.create_backend_api — Methodcreate_backend_api(app_id, backend_environment_name, resource_config, resource_name)
create_backend_api(app_id, backend_environment_name, resource_config, resource_name, params::Dict{String,<:Any})Creates a new backend API resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_config: The resource configuration for this request.resource_name: The name of this resource.
Main.Amplifybackend.create_backend_auth — Methodcreate_backend_auth(app_id, backend_environment_name, resource_config, resource_name)
create_backend_auth(app_id, backend_environment_name, resource_config, resource_name, params::Dict{String,<:Any})Creates a new backend authentication resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_config: The resource configuration for this request object.resource_name: The name of this resource.
Main.Amplifybackend.create_backend_config — Methodcreate_backend_config(app_id)
create_backend_config(app_id, params::Dict{String,<:Any})Creates a config object for a backend.
Arguments
app_id: The app ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"backendManagerAppId": The app ID for the backend manager.
Main.Amplifybackend.create_backend_storage — Methodcreate_backend_storage(app_id, backend_environment_name, resource_config, resource_name)
create_backend_storage(app_id, backend_environment_name, resource_config, resource_name, params::Dict{String,<:Any})Creates a backend storage resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_config: The resource configuration for creating backend storage.resource_name: The name of the storage resource.
Main.Amplifybackend.create_token — Methodcreate_token(app_id)
create_token(app_id, params::Dict{String,<:Any})Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
Arguments
app_id: The app ID.
Main.Amplifybackend.delete_backend — Methoddelete_backend(app_id, backend_environment_name)
delete_backend(app_id, backend_environment_name, params::Dict{String,<:Any})Removes an existing environment from your Amplify project.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.
Main.Amplifybackend.delete_backend_api — Methoddelete_backend_api(app_id, backend_environment_name, resource_name)
delete_backend_api(app_id, backend_environment_name, resource_name, params::Dict{String,<:Any})Deletes an existing backend API resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of this resource.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"resourceConfig": Defines the resource configuration for the data model in your Amplify project.
Main.Amplifybackend.delete_backend_auth — Methoddelete_backend_auth(app_id, backend_environment_name, resource_name)
delete_backend_auth(app_id, backend_environment_name, resource_name, params::Dict{String,<:Any})Deletes an existing backend authentication resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of this resource.
Main.Amplifybackend.delete_backend_storage — Methoddelete_backend_storage(app_id, backend_environment_name, resource_name, service_name)
delete_backend_storage(app_id, backend_environment_name, resource_name, service_name, params::Dict{String,<:Any})Removes the specified backend storage resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of the storage resource.service_name: The name of the storage service.
Main.Amplifybackend.delete_token — Methoddelete_token(app_id, session_id)
delete_token(app_id, session_id, params::Dict{String,<:Any})Deletes the challenge token based on the given appId and sessionId.
Arguments
app_id: The app ID.session_id: The session ID.
Main.Amplifybackend.generate_backend_apimodels — Methodgenerate_backend_apimodels(app_id, backend_environment_name, resource_name)
generate_backend_apimodels(app_id, backend_environment_name, resource_name, params::Dict{String,<:Any})Generates a model schema for an existing backend API resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of this resource.
Main.Amplifybackend.get_backend — Methodget_backend(app_id)
get_backend(app_id, params::Dict{String,<:Any})Provides project-level details for your Amplify UI project.
Arguments
app_id: The app ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"backendEnvironmentName": The name of the backend environment.
Main.Amplifybackend.get_backend_api — Methodget_backend_api(app_id, backend_environment_name, resource_name)
get_backend_api(app_id, backend_environment_name, resource_name, params::Dict{String,<:Any})Gets the details for a backend API.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of this resource.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"resourceConfig": Defines the resource configuration for the data model in your Amplify project.
Main.Amplifybackend.get_backend_apimodels — Methodget_backend_apimodels(app_id, backend_environment_name, resource_name)
get_backend_apimodels(app_id, backend_environment_name, resource_name, params::Dict{String,<:Any})Gets a model introspection schema for an existing backend API resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of this resource.
Main.Amplifybackend.get_backend_auth — Methodget_backend_auth(app_id, backend_environment_name, resource_name)
get_backend_auth(app_id, backend_environment_name, resource_name, params::Dict{String,<:Any})Gets a backend auth details.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of this resource.
Main.Amplifybackend.get_backend_job — Methodget_backend_job(app_id, backend_environment_name, job_id)
get_backend_job(app_id, backend_environment_name, job_id, params::Dict{String,<:Any})Returns information about a specific job.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.job_id: The ID for the job.
Main.Amplifybackend.get_backend_storage — Methodget_backend_storage(app_id, backend_environment_name, resource_name)
get_backend_storage(app_id, backend_environment_name, resource_name, params::Dict{String,<:Any})Gets details for a backend storage resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of the storage resource.
Main.Amplifybackend.get_token — Methodget_token(app_id, session_id)
get_token(app_id, session_id, params::Dict{String,<:Any})Gets the challenge token based on the given appId and sessionId.
Arguments
app_id: The app ID.session_id: The session ID.
Main.Amplifybackend.import_backend_auth — Methodimport_backend_auth(app_id, backend_environment_name, native_client_id, user_pool_id, web_client_id)
import_backend_auth(app_id, backend_environment_name, native_client_id, user_pool_id, web_client_id, params::Dict{String,<:Any})Imports an existing backend authentication resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.native_client_id: The ID of the Amazon Cognito native client.user_pool_id: The ID of the Amazon Cognito user pool.web_client_id: The ID of the Amazon Cognito web client.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"identityPoolId": The ID of the Amazon Cognito identity pool.
Main.Amplifybackend.import_backend_storage — Methodimport_backend_storage(app_id, backend_environment_name, service_name)
import_backend_storage(app_id, backend_environment_name, service_name, params::Dict{String,<:Any})Imports an existing backend storage resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.service_name: The name of the storage service.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"bucketName": The name of the S3 bucket.
Main.Amplifybackend.list_backend_jobs — Methodlist_backend_jobs(app_id, backend_environment_name)
list_backend_jobs(app_id, backend_environment_name, params::Dict{String,<:Any})Lists the jobs for the backend of an Amplify app.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"jobId": The ID for the job."maxResults": The maximum number of results that you want in the response."nextToken": The token for the next set of results."operation": Filters the list of response objects to include only those with the specified operation name."status": Filters the list of response objects to include only those with the specified status.
Main.Amplifybackend.list_s3_buckets — Methodlist_s3_buckets()
list_s3_buckets(params::Dict{String,<:Any})The list of S3 buckets in your account.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"nextToken": Reserved for future use.
Main.Amplifybackend.remove_all_backends — Methodremove_all_backends(app_id)
remove_all_backends(app_id, params::Dict{String,<:Any})Removes all backend environments from your Amplify project.
Arguments
app_id: The app ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"cleanAmplifyApp": Cleans up the Amplify Console app if this value is set to true.
Main.Amplifybackend.remove_backend_config — Methodremove_backend_config(app_id)
remove_backend_config(app_id, params::Dict{String,<:Any})Removes the AWS resources required to access the Amplify Admin UI.
Arguments
app_id: The app ID.
Main.Amplifybackend.update_backend_api — Methodupdate_backend_api(app_id, backend_environment_name, resource_name)
update_backend_api(app_id, backend_environment_name, resource_name, params::Dict{String,<:Any})Updates an existing backend API resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_name: The name of this resource.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"resourceConfig": Defines the resource configuration for the data model in your Amplify project.
Main.Amplifybackend.update_backend_auth — Methodupdate_backend_auth(app_id, backend_environment_name, resource_config, resource_name)
update_backend_auth(app_id, backend_environment_name, resource_config, resource_name, params::Dict{String,<:Any})Updates an existing backend authentication resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_config: The resource configuration for this request object.resource_name: The name of this resource.
Main.Amplifybackend.update_backend_config — Methodupdate_backend_config(app_id)
update_backend_config(app_id, params::Dict{String,<:Any})Updates the AWS resources required to access the Amplify Admin UI.
Arguments
app_id: The app ID.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"loginAuthConfig": Describes the Amazon Cognito configuration for Admin UI access.
Main.Amplifybackend.update_backend_job — Methodupdate_backend_job(app_id, backend_environment_name, job_id)
update_backend_job(app_id, backend_environment_name, job_id, params::Dict{String,<:Any})Updates a specific job.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.job_id: The ID for the job.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"operation": Filters the list of response objects to include only those with the specified operation name."status": Filters the list of response objects to include only those with the specified status.
Main.Amplifybackend.update_backend_storage — Methodupdate_backend_storage(app_id, backend_environment_name, resource_config, resource_name)
update_backend_storage(app_id, backend_environment_name, resource_config, resource_name, params::Dict{String,<:Any})Updates an existing backend storage resource.
Arguments
app_id: The app ID.backend_environment_name: The name of the backend environment.resource_config: The resource configuration for updating backend storage.resource_name: The name of the storage resource.