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
Generates a model schema for 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.
348 349 350 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#clone_backend(params = {}) ⇒ Types::CloneBackendResponse
This operation clones an existing backend.
392 393 394 395 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 392 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.
443 444 445 446 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 443 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.
526 527 528 529 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 526 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.
644 645 646 647 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 644 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.
680 681 682 683 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 680 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.
730 731 732 733 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 730 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.
764 765 766 767 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 764 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.
804 805 806 807 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 804 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.
887 888 889 890 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 887 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.
930 931 932 933 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 930 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.
972 973 974 975 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 972 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.
1002 1003 1004 1005 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1002 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.
1045 1046 1047 1048 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1045 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.
1088 1089 1090 1091 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1088 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.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1191 def get_backend_api(params = {}, = {}) req = build_request(:get_backend_api, params) req.send_request() end |
#get_backend_api_models(params = {}) ⇒ Types::GetBackendAPIModelsResponse
Generates a model schema for existing backend API resource.
1226 1227 1228 1229 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1226 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.
1307 1308 1309 1310 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1307 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.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1354 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.
1399 1400 1401 1402 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1399 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.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1435 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.
1487 1488 1489 1490 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1487 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.
1529 1530 1531 1532 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1529 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.
1586 1587 1588 1589 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1586 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.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1617 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.
1655 1656 1657 1658 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1655 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.
1682 1683 1684 1685 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1682 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.
1765 1766 1767 1768 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1765 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.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1879 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.
1924 1925 1926 1927 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1924 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.
1977 1978 1979 1980 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1977 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.
2026 2027 2028 2029 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2026 def update_backend_storage(params = {}, = {}) req = build_request(:update_backend_storage, params) req.send_request() end |