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.
422 423 424 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#clone_backend(params = {}) ⇒ Types::CloneBackendResponse
This operation clones an existing backend.
466 467 468 469 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 466 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.
517 518 519 520 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 517 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.
600 601 602 603 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 600 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.
718 719 720 721 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 718 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.
754 755 756 757 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 754 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.
804 805 806 807 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 804 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.
838 839 840 841 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 838 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.
878 879 880 881 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 878 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.
961 962 963 964 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 961 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.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1004 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.
1046 1047 1048 1049 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1046 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.
1076 1077 1078 1079 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1076 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.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1119 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.
1162 1163 1164 1165 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1162 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.
1265 1266 1267 1268 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1265 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.
1303 1304 1305 1306 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1303 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.
1384 1385 1386 1387 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1384 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.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1431 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.
1476 1477 1478 1479 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1476 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.
1512 1513 1514 1515 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1512 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.
1564 1565 1566 1567 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1564 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.
1606 1607 1608 1609 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1606 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.
1663 1664 1665 1666 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1663 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.
1694 1695 1696 1697 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1694 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.
1732 1733 1734 1735 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1732 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.
1759 1760 1761 1762 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1759 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.
1842 1843 1844 1845 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1842 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.
1956 1957 1958 1959 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1956 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.
2001 2002 2003 2004 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2001 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.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2054 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.
2103 2104 2105 2106 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2103 def update_backend_storage(params = {}, = {}) req = build_request(:update_backend_storage, params) req.send_request() end |