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

Amplify enables developers to develop and deploy cloud-powered mobile and web apps.

Amplify Hosting provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.

Link to this section Summary

Functions

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

Creates a new Amplify app.

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

Creates a new backend environment for an Amplify app.

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

Creates a new branch for an Amplify app.

create_deployment(client, app_id, branch_name, input, options \\ [])

Creates a deployment for a manually deployed Amplify app.

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

Creates a new domain association for an Amplify app.

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

Creates a new webhook on an Amplify app.

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

Deletes an existing Amplify app specified by an app ID.

delete_backend_environment(client, app_id, environment_name, input, options \\ [])

Deletes a backend environment for an Amplify app.

delete_branch(client, app_id, branch_name, input, options \\ [])

Deletes a branch for an Amplify app.

delete_domain_association(client, app_id, domain_name, input, options \\ [])

Deletes a domain association for an Amplify app.

delete_job(client, app_id, branch_name, job_id, input, options \\ [])

Deletes a job for a branch of an Amplify app.

delete_webhook(client, webhook_id, input, options \\ [])

Deletes a webhook.

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

Returns the website access logs for a specific time range using a presigned URL.

get_app(client, app_id, options \\ [])

Returns an existing Amplify app specified by an app ID.

get_artifact_url(client, artifact_id, options \\ [])

Returns the artifact info that corresponds to an artifact id.

get_backend_environment(client, app_id, environment_name, options \\ [])

Returns a backend environment for an Amplify app.

get_branch(client, app_id, branch_name, options \\ [])

Returns a branch for an Amplify app.

get_domain_association(client, app_id, domain_name, options \\ [])

Returns the domain information for an Amplify app.

get_job(client, app_id, branch_name, job_id, options \\ [])

Returns a job for a branch of an Amplify app.

get_webhook(client, webhook_id, options \\ [])

Returns the webhook information that corresponds to a specified webhook ID.

list_apps(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of the existing Amplify apps.

list_artifacts(client, app_id, branch_name, job_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of artifacts for a specified app, branch, and job.

list_backend_environments(client, app_id, environment_name \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the backend environments for an Amplify app.

list_branches(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the branches of an Amplify app.

list_domain_associations(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns the domain associations for an Amplify app.

list_jobs(client, app_id, branch_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the jobs for a branch of an Amplify app.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of tags for a specified Amazon Resource Name (ARN).

list_webhooks(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of webhooks for an Amplify app.

metadata()

start_deployment(client, app_id, branch_name, input, options \\ [])

Starts a deployment for a manually deployed app.

start_job(client, app_id, branch_name, input, options \\ [])

Starts a new job for a branch of an Amplify app.

stop_job(client, app_id, branch_name, job_id, input, options \\ [])

Stops a job that is in progress for a branch of an Amplify app.

tag_resource(client, resource_arn, input, options \\ [])

Tags the resource with a tag key and value.

untag_resource(client, resource_arn, input, options \\ [])

Untags a resource with a specified Amazon Resource Name (ARN).

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

Updates an existing Amplify app.

update_branch(client, app_id, branch_name, input, options \\ [])

Updates a branch for an Amplify app.

update_domain_association(client, app_id, domain_name, input, options \\ [])

Creates a new domain association for an Amplify app.

update_webhook(client, webhook_id, input, options \\ [])

Updates a webhook.

Link to this section Functions

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

Creates a new Amplify app.

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

Creates a new backend environment for an Amplify app.

This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

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

Creates a new branch for an Amplify app.

create_deployment(client, app_id, branch_name, input, options \\ [])

Creates a deployment for a manually deployed Amplify app.

Manually deployed apps are not connected to a Git repository.

The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.

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

Creates a new domain association for an Amplify app.

This action associates a custom domain with the Amplify app

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

Creates a new webhook on an Amplify app.

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

Deletes an existing Amplify app specified by an app ID.

delete_backend_environment(client, app_id, environment_name, input, options \\ [])

Deletes a backend environment for an Amplify app.

delete_branch(client, app_id, branch_name, input, options \\ [])

Deletes a branch for an Amplify app.

delete_domain_association(client, app_id, domain_name, input, options \\ [])

Deletes a domain association for an Amplify app.

delete_job(client, app_id, branch_name, job_id, input, options \\ [])

Deletes a job for a branch of an Amplify app.

delete_webhook(client, webhook_id, input, options \\ [])

Deletes a webhook.

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

Returns the website access logs for a specific time range using a presigned URL.

get_app(client, app_id, options \\ [])

Returns an existing Amplify app specified by an app ID.

get_artifact_url(client, artifact_id, options \\ [])

Returns the artifact info that corresponds to an artifact id.

get_backend_environment(client, app_id, environment_name, options \\ [])

Returns a backend environment for an Amplify app.

get_branch(client, app_id, branch_name, options \\ [])

Returns a branch for an Amplify app.

get_domain_association(client, app_id, domain_name, options \\ [])

Returns the domain information for an Amplify app.

get_job(client, app_id, branch_name, job_id, options \\ [])

Returns a job for a branch of an Amplify app.

get_webhook(client, webhook_id, options \\ [])

Returns the webhook information that corresponds to a specified webhook ID.

list_apps(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of the existing Amplify apps.

list_artifacts(client, app_id, branch_name, job_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of artifacts for a specified app, branch, and job.

list_backend_environments(client, app_id, environment_name \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the backend environments for an Amplify app.

list_branches(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the branches of an Amplify app.

list_domain_associations(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns the domain associations for an Amplify app.

list_jobs(client, app_id, branch_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the jobs for a branch of an Amplify app.

list_tags_for_resource(client, resource_arn, options \\ [])

Returns a list of tags for a specified Amazon Resource Name (ARN).

list_webhooks(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of webhooks for an Amplify app.

metadata()

start_deployment(client, app_id, branch_name, input, options \\ [])

Starts a deployment for a manually deployed app.

Manually deployed apps are not connected to a Git repository.

start_job(client, app_id, branch_name, input, options \\ [])

Starts a new job for a branch of an Amplify app.

stop_job(client, app_id, branch_name, job_id, input, options \\ [])

Stops a job that is in progress for a branch of an Amplify app.

tag_resource(client, resource_arn, input, options \\ [])

Tags the resource with a tag key and value.

untag_resource(client, resource_arn, input, options \\ [])

Untags a resource with a specified Amazon Resource Name (ARN).

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

Updates an existing Amplify app.

update_branch(client, app_id, branch_name, input, options \\ [])

Updates a branch for an Amplify app.

update_domain_association(client, app_id, domain_name, input, options \\ [])

Creates a new domain association for an Amplify app.

update_webhook(client, webhook_id, input, options \\ [])

Updates a webhook.

Settings View Source AWS.Amplify (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

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

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

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

create_deployment(client, app_id, branch_name, input, options \\ [])

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

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

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

delete_backend_environment(client, app_id, environment_name, input, options \\ [])

delete_branch(client, app_id, branch_name, input, options \\ [])

delete_domain_association(client, app_id, domain_name, input, options \\ [])

delete_job(client, app_id, branch_name, job_id, input, options \\ [])

delete_webhook(client, webhook_id, input, options \\ [])

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

get_app(client, app_id, options \\ [])

get_artifact_url(client, artifact_id, options \\ [])

get_backend_environment(client, app_id, environment_name, options \\ [])

get_branch(client, app_id, branch_name, options \\ [])

get_domain_association(client, app_id, domain_name, options \\ [])

get_job(client, app_id, branch_name, job_id, options \\ [])

get_webhook(client, webhook_id, options \\ [])

list_apps(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_artifacts(client, app_id, branch_name, job_id, max_results \\ nil, next_token \\ nil, options \\ [])

list_backend_environments(client, app_id, environment_name \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

list_branches(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

list_domain_associations(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

list_jobs(client, app_id, branch_name, max_results \\ nil, next_token \\ nil, options \\ [])

list_tags_for_resource(client, resource_arn, options \\ [])

list_webhooks(client, app_id, max_results \\ nil, next_token \\ nil, options \\ [])

metadata()

start_deployment(client, app_id, branch_name, input, options \\ [])

start_job(client, app_id, branch_name, input, options \\ [])

stop_job(client, app_id, branch_name, job_id, input, options \\ [])

tag_resource(client, resource_arn, input, options \\ [])

untag_resource(client, resource_arn, input, options \\ [])

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

update_branch(client, app_id, branch_name, input, options \\ [])

update_domain_association(client, app_id, domain_name, input, options \\ [])

update_webhook(client, webhook_id, input, options \\ [])

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