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.
409 410 411 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#clone_backend(params = {}) ⇒ Types::CloneBackendResponse
This operation clones an existing backend.
453 454 455 456 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 453 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.
504 505 506 507 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 504 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.
587 588 589 590 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 587 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.
705 706 707 708 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 705 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.
741 742 743 744 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 741 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.
791 792 793 794 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 791 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.
825 826 827 828 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 825 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.
865 866 867 868 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 865 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.
948 949 950 951 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 948 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.
991 992 993 994 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 991 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.
1033 1034 1035 1036 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1033 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.
1063 1064 1065 1066 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1063 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.
1106 1107 1108 1109 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1106 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.
1149 1150 1151 1152 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1149 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.
1252 1253 1254 1255 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1252 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.
1290 1291 1292 1293 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1290 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.
1371 1372 1373 1374 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1371 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.
1418 1419 1420 1421 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1418 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.
1463 1464 1465 1466 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1463 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.
1499 1500 1501 1502 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1499 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.
1551 1552 1553 1554 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1551 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.
1593 1594 1595 1596 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1593 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.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1650 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.
1681 1682 1683 1684 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1681 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.
1719 1720 1721 1722 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1719 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.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1746 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.
1829 1830 1831 1832 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1829 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.
1943 1944 1945 1946 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1943 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.
1988 1989 1990 1991 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1988 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.
2041 2042 2043 2044 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2041 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.
2090 2091 2092 2093 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2090 def update_backend_storage(params = {}, = {}) req = build_request(:update_backend_storage, params) req.send_request() end |