aws-elixir

View Source AWS.AmplifyBackend (aws-elixir v1.0.4)

AWS Amplify Admin API

Link to this section Summary

Functions

clone_backend(client, app_id, backend_environment_name, input, options \\ [])

This operation clones an existing backend.

create_backend(client, input, options \\ [])

This operation creates a backend for an Amplify app.

create_backend_api(client, app_id, input, options \\ [])

Creates a new backend API resource.

create_backend_auth(client, app_id, input, options \\ [])

Creates a new backend authentication resource.

create_backend_config(client, app_id, input, options \\ [])

Creates a config object for a backend.

create_backend_storage(client, app_id, input, options \\ [])

Creates a backend storage resource.

create_token(client, app_id, input, options \\ [])

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

delete_backend(client, app_id, backend_environment_name, input, options \\ [])

Removes an existing environment from your Amplify project.

delete_backend_api(client, app_id, backend_environment_name, input, options \\ [])

Deletes an existing backend API resource.

delete_backend_auth(client, app_id, backend_environment_name, input, options \\ [])

Deletes an existing backend authentication resource.

delete_backend_storage(client, app_id, backend_environment_name, input, options \\ [])

Removes the specified backend storage resource.

delete_token(client, app_id, session_id, input, options \\ [])

Deletes the challenge token based on the given appId and sessionId.

generate_backend_api_models(client, app_id, backend_environment_name, input, options \\ [])

Generates a model schema for an existing backend API resource.

get_backend(client, app_id, input, options \\ [])

Provides project-level details for your Amplify UI project.

get_backend_api(client, app_id, backend_environment_name, input, options \\ [])

Gets the details for a backend API.

get_backend_api_models(client, app_id, backend_environment_name, input, options \\ [])

Gets a model introspection schema for an existing backend API resource.

get_backend_auth(client, app_id, backend_environment_name, input, options \\ [])

Gets a backend auth details.

get_backend_job(client, app_id, backend_environment_name, job_id, options \\ [])

Returns information about a specific job.

get_backend_storage(client, app_id, backend_environment_name, input, options \\ [])

Gets details for a backend storage resource.

get_token(client, app_id, session_id, options \\ [])

Gets the challenge token based on the given appId and sessionId.

import_backend_auth(client, app_id, backend_environment_name, input, options \\ [])

Imports an existing backend authentication resource.

import_backend_storage(client, app_id, backend_environment_name, input, options \\ [])

Imports an existing backend storage resource.

list_backend_jobs(client, app_id, backend_environment_name, input, options \\ [])

Lists the jobs for the backend of an Amplify app.

list_s3_buckets(client, input, options \\ [])

The list of S3 buckets in your account.

metadata()
remove_all_backends(client, app_id, input, options \\ [])

Removes all backend environments from your Amplify project.

remove_backend_config(client, app_id, input, options \\ [])

Removes the AWS resources required to access the Amplify Admin UI.

update_backend_api(client, app_id, backend_environment_name, input, options \\ [])

Updates an existing backend API resource.

update_backend_auth(client, app_id, backend_environment_name, input, options \\ [])

Updates an existing backend authentication resource.

update_backend_config(client, app_id, input, options \\ [])

Updates the AWS resources required to access the Amplify Admin UI.

update_backend_job(client, app_id, backend_environment_name, job_id, input, options \\ [])

Updates a specific job.

update_backend_storage(client, app_id, backend_environment_name, input, options \\ [])

Updates an existing backend storage resource.

Link to this section Functions

Link to this function

clone_backend(client, app_id, backend_environment_name, input, options \\ [])

View Source

This operation clones an existing backend.

Link to this function

create_backend(client, input, options \\ [])

View Source

This operation creates a backend for an Amplify app.

Backends are automatically created at the time of app creation.

Link to this function

create_backend_api(client, app_id, input, options \\ [])

View Source

Creates a new backend API resource.

Link to this function

create_backend_auth(client, app_id, input, options \\ [])

View Source

Creates a new backend authentication resource.

Link to this function

create_backend_config(client, app_id, input, options \\ [])

View Source

Creates a config object for a backend.

Link to this function

create_backend_storage(client, app_id, input, options \\ [])

View Source

Creates a backend storage resource.

Link to this function

create_token(client, app_id, input, options \\ [])

View Source

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

Link to this function

delete_backend(client, app_id, backend_environment_name, input, options \\ [])

View Source

Removes an existing environment from your Amplify project.

Link to this function

delete_backend_api(client, app_id, backend_environment_name, input, options \\ [])

View Source

Deletes an existing backend API resource.

Link to this function

delete_backend_auth(client, app_id, backend_environment_name, input, options \\ [])

View Source

Deletes an existing backend authentication resource.

Link to this function

delete_backend_storage(client, app_id, backend_environment_name, input, options \\ [])

View Source

Removes the specified backend storage resource.

Link to this function

delete_token(client, app_id, session_id, input, options \\ [])

View Source

Deletes the challenge token based on the given appId and sessionId.

Link to this function

generate_backend_api_models(client, app_id, backend_environment_name, input, options \\ [])

View Source

Generates a model schema for an existing backend API resource.

Link to this function

get_backend(client, app_id, input, options \\ [])

View Source

Provides project-level details for your Amplify UI project.

Link to this function

get_backend_api(client, app_id, backend_environment_name, input, options \\ [])

View Source

Gets the details for a backend API.

Link to this function

get_backend_api_models(client, app_id, backend_environment_name, input, options \\ [])

View Source

Gets a model introspection schema for an existing backend API resource.

Link to this function

get_backend_auth(client, app_id, backend_environment_name, input, options \\ [])

View Source

Gets a backend auth details.

Link to this function

get_backend_job(client, app_id, backend_environment_name, job_id, options \\ [])

View Source

Returns information about a specific job.

Link to this function

get_backend_storage(client, app_id, backend_environment_name, input, options \\ [])

View Source

Gets details for a backend storage resource.

Link to this function

get_token(client, app_id, session_id, options \\ [])

View Source

Gets the challenge token based on the given appId and sessionId.

Link to this function

import_backend_auth(client, app_id, backend_environment_name, input, options \\ [])

View Source

Imports an existing backend authentication resource.

Link to this function

import_backend_storage(client, app_id, backend_environment_name, input, options \\ [])

View Source

Imports an existing backend storage resource.

Link to this function

list_backend_jobs(client, app_id, backend_environment_name, input, options \\ [])

View Source

Lists the jobs for the backend of an Amplify app.

Link to this function

list_s3_buckets(client, input, options \\ [])

View Source

The list of S3 buckets in your account.

Link to this function

metadata()

View Source
Link to this function

remove_all_backends(client, app_id, input, options \\ [])

View Source

Removes all backend environments from your Amplify project.

Link to this function

remove_backend_config(client, app_id, input, options \\ [])

View Source

Removes the AWS resources required to access the Amplify Admin UI.

Link to this function

update_backend_api(client, app_id, backend_environment_name, input, options \\ [])

View Source

Updates an existing backend API resource.

Link to this function

update_backend_auth(client, app_id, backend_environment_name, input, options \\ [])

View Source

Updates an existing backend authentication resource.

Link to this function

update_backend_config(client, app_id, input, options \\ [])

View Source

Updates the AWS resources required to access the Amplify Admin UI.

Link to this function

update_backend_job(client, app_id, backend_environment_name, job_id, input, options \\ [])

View Source

Updates a specific job.

Link to this function

update_backend_storage(client, app_id, backend_environment_name, input, options \\ [])

View Source

Updates an existing backend storage resource.