Class: Aws::AmplifyBackend::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::AmplifyBackend::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb
Overview
An API client for AmplifyBackend. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::AmplifyBackend::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#clone_backend(params = {}) ⇒ Types::CloneBackendResponse
This operation clones an existing backend.
-
#create_backend(params = {}) ⇒ Types::CreateBackendResponse
This operation creates a backend for an Amplify app.
-
#create_backend_api(params = {}) ⇒ Types::CreateBackendAPIResponse
Creates a new backend API resource.
-
#create_backend_auth(params = {}) ⇒ Types::CreateBackendAuthResponse
Creates a new backend authentication resource.
-
#create_backend_config(params = {}) ⇒ Types::CreateBackendConfigResponse
Creates a config object for a backend.
-
#create_backend_storage(params = {}) ⇒ Types::CreateBackendStorageResponse
Creates a backend storage resource.
-
#create_token(params = {}) ⇒ Types::CreateTokenResponse
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
-
#delete_backend(params = {}) ⇒ Types::DeleteBackendResponse
Removes an existing environment from your Amplify project.
-
#delete_backend_api(params = {}) ⇒ Types::DeleteBackendAPIResponse
Deletes an existing backend API resource.
-
#delete_backend_auth(params = {}) ⇒ Types::DeleteBackendAuthResponse
Deletes an existing backend authentication resource.
-
#delete_backend_storage(params = {}) ⇒ Types::DeleteBackendStorageResponse
Removes the specified backend storage resource.
-
#delete_token(params = {}) ⇒ Types::DeleteTokenResponse
Deletes the challenge token based on the given appId and sessionId.
-
#generate_backend_api_models(params = {}) ⇒ Types::GenerateBackendAPIModelsResponse
Generates a model schema for an existing backend API resource.
-
#get_backend(params = {}) ⇒ Types::GetBackendResponse
Provides project-level details for your Amplify UI project.
-
#get_backend_api(params = {}) ⇒ Types::GetBackendAPIResponse
Gets the details for a backend API.
-
#get_backend_api_models(params = {}) ⇒ Types::GetBackendAPIModelsResponse
Gets a model introspection schema for an existing backend API resource.
-
#get_backend_auth(params = {}) ⇒ Types::GetBackendAuthResponse
Gets a backend auth details.
-
#get_backend_job(params = {}) ⇒ Types::GetBackendJobResponse
Returns information about a specific job.
-
#get_backend_storage(params = {}) ⇒ Types::GetBackendStorageResponse
Gets details for a backend storage resource.
-
#get_token(params = {}) ⇒ Types::GetTokenResponse
Gets the challenge token based on the given appId and sessionId.
-
#import_backend_auth(params = {}) ⇒ Types::ImportBackendAuthResponse
Imports an existing backend authentication resource.
-
#import_backend_storage(params = {}) ⇒ Types::ImportBackendStorageResponse
Imports an existing backend storage resource.
-
#list_backend_jobs(params = {}) ⇒ Types::ListBackendJobsResponse
Lists the jobs for the backend of an Amplify app.
-
#list_s3_buckets(params = {}) ⇒ Types::ListS3BucketsResponse
The list of S3 buckets in your account.
-
#remove_all_backends(params = {}) ⇒ Types::RemoveAllBackendsResponse
Removes all backend environments from your Amplify project.
-
#remove_backend_config(params = {}) ⇒ Types::RemoveBackendConfigResponse
Removes the AWS resources required to access the Amplify Admin UI.
-
#update_backend_api(params = {}) ⇒ Types::UpdateBackendAPIResponse
Updates an existing backend API resource.
-
#update_backend_auth(params = {}) ⇒ Types::UpdateBackendAuthResponse
Updates an existing backend authentication resource.
-
#update_backend_config(params = {}) ⇒ Types::UpdateBackendConfigResponse
Updates the AWS resources required to access the Amplify Admin UI.
-
#update_backend_job(params = {}) ⇒ Types::UpdateBackendJobResponse
Updates a specific job.
-
#update_backend_storage(params = {}) ⇒ Types::UpdateBackendStorageResponse
Updates an existing backend storage resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
410 411 412 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#clone_backend(params = {}) ⇒ Types::CloneBackendResponse
This operation clones an existing backend.
454 455 456 457 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 454 def clone_backend(params = {}, = {}) req = build_request(:clone_backend, params) req.send_request() end |
#create_backend(params = {}) ⇒ Types::CreateBackendResponse
This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
505 506 507 508 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 505 def create_backend(params = {}, = {}) req = build_request(:create_backend, params) req.send_request() end |
#create_backend_api(params = {}) ⇒ Types::CreateBackendAPIResponse
Creates a new backend API resource.
588 589 590 591 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 588 def create_backend_api(params = {}, = {}) req = build_request(:create_backend_api, params) req.send_request() end |
#create_backend_auth(params = {}) ⇒ Types::CreateBackendAuthResponse
Creates a new backend authentication resource.
706 707 708 709 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 706 def create_backend_auth(params = {}, = {}) req = build_request(:create_backend_auth, params) req.send_request() end |
#create_backend_config(params = {}) ⇒ Types::CreateBackendConfigResponse
Creates a config object for a backend.
742 743 744 745 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 742 def create_backend_config(params = {}, = {}) req = build_request(:create_backend_config, params) req.send_request() end |
#create_backend_storage(params = {}) ⇒ Types::CreateBackendStorageResponse
Creates a backend storage resource.
792 793 794 795 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 792 def create_backend_storage(params = {}, = {}) req = build_request(:create_backend_storage, params) req.send_request() end |
#create_token(params = {}) ⇒ Types::CreateTokenResponse
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
826 827 828 829 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 826 def create_token(params = {}, = {}) req = build_request(:create_token, params) req.send_request() end |
#delete_backend(params = {}) ⇒ Types::DeleteBackendResponse
Removes an existing environment from your Amplify project.
866 867 868 869 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 866 def delete_backend(params = {}, = {}) req = build_request(:delete_backend, params) req.send_request() end |
#delete_backend_api(params = {}) ⇒ Types::DeleteBackendAPIResponse
Deletes an existing backend API resource.
949 950 951 952 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 949 def delete_backend_api(params = {}, = {}) req = build_request(:delete_backend_api, params) req.send_request() end |
#delete_backend_auth(params = {}) ⇒ Types::DeleteBackendAuthResponse
Deletes an existing backend authentication resource.
992 993 994 995 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 992 def delete_backend_auth(params = {}, = {}) req = build_request(:delete_backend_auth, params) req.send_request() end |
#delete_backend_storage(params = {}) ⇒ Types::DeleteBackendStorageResponse
Removes the specified backend storage resource.
1034 1035 1036 1037 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1034 def delete_backend_storage(params = {}, = {}) req = build_request(:delete_backend_storage, params) req.send_request() end |
#delete_token(params = {}) ⇒ Types::DeleteTokenResponse
Deletes the challenge token based on the given appId and sessionId.
1064 1065 1066 1067 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1064 def delete_token(params = {}, = {}) req = build_request(:delete_token, params) req.send_request() end |
#generate_backend_api_models(params = {}) ⇒ Types::GenerateBackendAPIModelsResponse
Generates a model schema for an existing backend API resource.
1107 1108 1109 1110 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1107 def generate_backend_api_models(params = {}, = {}) req = build_request(:generate_backend_api_models, params) req.send_request() end |
#get_backend(params = {}) ⇒ Types::GetBackendResponse
Provides project-level details for your Amplify UI project.
1150 1151 1152 1153 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1150 def get_backend(params = {}, = {}) req = build_request(:get_backend, params) req.send_request() end |
#get_backend_api(params = {}) ⇒ Types::GetBackendAPIResponse
Gets the details for a backend API.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1253 def get_backend_api(params = {}, = {}) req = build_request(:get_backend_api, params) req.send_request() end |
#get_backend_api_models(params = {}) ⇒ Types::GetBackendAPIModelsResponse
Gets a model introspection schema for an existing backend API resource.
1291 1292 1293 1294 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1291 def get_backend_api_models(params = {}, = {}) req = build_request(:get_backend_api_models, params) req.send_request() end |
#get_backend_auth(params = {}) ⇒ Types::GetBackendAuthResponse
Gets a backend auth details.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1372 def get_backend_auth(params = {}, = {}) req = build_request(:get_backend_auth, params) req.send_request() end |
#get_backend_job(params = {}) ⇒ Types::GetBackendJobResponse
Returns information about a specific job.
1419 1420 1421 1422 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1419 def get_backend_job(params = {}, = {}) req = build_request(:get_backend_job, params) req.send_request() end |
#get_backend_storage(params = {}) ⇒ Types::GetBackendStorageResponse
Gets details for a backend storage resource.
1464 1465 1466 1467 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1464 def get_backend_storage(params = {}, = {}) req = build_request(:get_backend_storage, params) req.send_request() end |
#get_token(params = {}) ⇒ Types::GetTokenResponse
Gets the challenge token based on the given appId and sessionId.
1500 1501 1502 1503 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1500 def get_token(params = {}, = {}) req = build_request(:get_token, params) req.send_request() end |
#import_backend_auth(params = {}) ⇒ Types::ImportBackendAuthResponse
Imports an existing backend authentication resource.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1552 def import_backend_auth(params = {}, = {}) req = build_request(:import_backend_auth, params) req.send_request() end |
#import_backend_storage(params = {}) ⇒ Types::ImportBackendStorageResponse
Imports an existing backend storage resource.
1594 1595 1596 1597 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1594 def import_backend_storage(params = {}, = {}) req = build_request(:import_backend_storage, params) req.send_request() end |
#list_backend_jobs(params = {}) ⇒ Types::ListBackendJobsResponse
Lists the jobs for the backend of an Amplify app.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1651 1652 1653 1654 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1651 def list_backend_jobs(params = {}, = {}) req = build_request(:list_backend_jobs, params) req.send_request() end |
#list_s3_buckets(params = {}) ⇒ Types::ListS3BucketsResponse
The list of S3 buckets in your account.
1682 1683 1684 1685 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1682 def list_s3_buckets(params = {}, = {}) req = build_request(:list_s3_buckets, params) req.send_request() end |
#remove_all_backends(params = {}) ⇒ Types::RemoveAllBackendsResponse
Removes all backend environments from your Amplify project.
1720 1721 1722 1723 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1720 def remove_all_backends(params = {}, = {}) req = build_request(:remove_all_backends, params) req.send_request() end |
#remove_backend_config(params = {}) ⇒ Types::RemoveBackendConfigResponse
Removes the AWS resources required to access the Amplify Admin UI.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1747 def remove_backend_config(params = {}, = {}) req = build_request(:remove_backend_config, params) req.send_request() end |
#update_backend_api(params = {}) ⇒ Types::UpdateBackendAPIResponse
Updates an existing backend API resource.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1830 def update_backend_api(params = {}, = {}) req = build_request(:update_backend_api, params) req.send_request() end |
#update_backend_auth(params = {}) ⇒ Types::UpdateBackendAuthResponse
Updates an existing backend authentication resource.
1944 1945 1946 1947 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1944 def update_backend_auth(params = {}, = {}) req = build_request(:update_backend_auth, params) req.send_request() end |
#update_backend_config(params = {}) ⇒ Types::UpdateBackendConfigResponse
Updates the AWS resources required to access the Amplify Admin UI.
1989 1990 1991 1992 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1989 def update_backend_config(params = {}, = {}) req = build_request(:update_backend_config, params) req.send_request() end |
#update_backend_job(params = {}) ⇒ Types::UpdateBackendJobResponse
Updates a specific job.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2042 def update_backend_job(params = {}, = {}) req = build_request(:update_backend_job, params) req.send_request() end |
#update_backend_storage(params = {}) ⇒ Types::UpdateBackendStorageResponse
Updates an existing backend storage resource.
2091 2092 2093 2094 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2091 def update_backend_storage(params = {}, = {}) req = build_request(:update_backend_storage, params) req.send_request() end |