Packages
aws
0.13.3
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
AWS clients for Elixir
Current section
Files
Jump to
Current section
Files
lib/aws/generated/amplify_backend.ex
# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.AmplifyBackend do
@moduledoc """
AWS Amplify Admin API
"""
alias AWS.Client
alias AWS.Request
def metadata do
%{
abbreviation: nil,
api_version: "2020-08-11",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "amplifybackend",
global?: false,
protocol: "rest-json",
service_id: "AmplifyBackend",
signature_version: "v4",
signing_name: "amplifybackend",
target_prefix: nil
}
end
@doc """
This operation clones an existing backend.
"""
def clone_backend(%Client{} = client, app_id, backend_environment_name, input, options \\ []) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/environments/#{AWS.Util.encode_uri(backend_environment_name)}/clone"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
This operation creates a backend for an Amplify app.
Backends are automatically created at the time of app creation.
"""
def create_backend(%Client{} = client, input, options \\ []) do
url_path = "/backend"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Creates a new backend API resource.
"""
def create_backend_api(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/api"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Creates a new backend authentication resource.
"""
def create_backend_auth(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/auth"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Creates a config object for a backend.
"""
def create_backend_config(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/config"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Creates a backend storage resource.
"""
def create_backend_storage(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/storage"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Generates a one-time challenge code to authenticate a user into your Amplify
Admin UI.
"""
def create_token(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/challenge"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Removes an existing environment from your Amplify project.
"""
def delete_backend(%Client{} = client, app_id, backend_environment_name, input, options \\ []) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/environments/#{AWS.Util.encode_uri(backend_environment_name)}/remove"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Deletes an existing backend API resource.
"""
def delete_backend_api(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/api/#{AWS.Util.encode_uri(backend_environment_name)}/remove"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Deletes an existing backend authentication resource.
"""
def delete_backend_auth(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/auth/#{AWS.Util.encode_uri(backend_environment_name)}/remove"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Removes the specified backend storage resource.
"""
def delete_backend_storage(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/storage/#{AWS.Util.encode_uri(backend_environment_name)}/remove"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Deletes the challenge token based on the given appId and sessionId.
"""
def delete_token(%Client{} = client, app_id, session_id, input, options \\ []) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/challenge/#{AWS.Util.encode_uri(session_id)}/remove"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Generates a model schema for an existing backend API resource.
"""
def generate_backend_api_models(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/api/#{AWS.Util.encode_uri(backend_environment_name)}/generateModels"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Provides project-level details for your Amplify UI project.
"""
def get_backend(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/details"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Gets the details for a backend API.
"""
def get_backend_api(%Client{} = client, app_id, backend_environment_name, input, options \\ []) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/api/#{AWS.Util.encode_uri(backend_environment_name)}/details"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Gets a model introspection schema for an existing backend API resource.
"""
def get_backend_api_models(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/api/#{AWS.Util.encode_uri(backend_environment_name)}/getModels"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Gets a backend auth details.
"""
def get_backend_auth(%Client{} = client, app_id, backend_environment_name, input, options \\ []) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/auth/#{AWS.Util.encode_uri(backend_environment_name)}/details"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Returns information about a specific job.
"""
def get_backend_job(%Client{} = client, app_id, backend_environment_name, job_id, options \\ []) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/job/#{AWS.Util.encode_uri(backend_environment_name)}/#{AWS.Util.encode_uri(job_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details for a backend storage resource.
"""
def get_backend_storage(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/storage/#{AWS.Util.encode_uri(backend_environment_name)}/details"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Gets the challenge token based on the given appId and sessionId.
"""
def get_token(%Client{} = client, app_id, session_id, options \\ []) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/challenge/#{AWS.Util.encode_uri(session_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Imports an existing backend authentication resource.
"""
def import_backend_auth(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/auth/#{AWS.Util.encode_uri(backend_environment_name)}/import"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Imports an existing backend storage resource.
"""
def import_backend_storage(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/storage/#{AWS.Util.encode_uri(backend_environment_name)}/import"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Lists the jobs for the backend of an Amplify app.
"""
def list_backend_jobs(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/job/#{AWS.Util.encode_uri(backend_environment_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
The list of S3 buckets in your account.
"""
def list_s3_buckets(%Client{} = client, input, options \\ []) do
url_path = "/s3Buckets"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Removes all backend environments from your Amplify project.
"""
def remove_all_backends(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/remove"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Removes the AWS resources required to access the Amplify Admin UI.
"""
def remove_backend_config(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/config/remove"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Updates an existing backend API resource.
"""
def update_backend_api(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/api/#{AWS.Util.encode_uri(backend_environment_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Updates an existing backend authentication resource.
"""
def update_backend_auth(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/auth/#{AWS.Util.encode_uri(backend_environment_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Updates the AWS resources required to access the Amplify Admin UI.
"""
def update_backend_config(%Client{} = client, app_id, input, options \\ []) do
url_path = "/backend/#{AWS.Util.encode_uri(app_id)}/config/update"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Updates a specific job.
"""
def update_backend_job(
%Client{} = client,
app_id,
backend_environment_name,
job_id,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/job/#{AWS.Util.encode_uri(backend_environment_name)}/#{AWS.Util.encode_uri(job_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
@doc """
Updates an existing backend storage resource.
"""
def update_backend_storage(
%Client{} = client,
app_id,
backend_environment_name,
input,
options \\ []
) do
url_path =
"/backend/#{AWS.Util.encode_uri(app_id)}/storage/#{AWS.Util.encode_uri(backend_environment_name)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
headers,
input,
options,
200
)
end
end