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.
385 386 387 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#clone_backend(params = {}) ⇒ Types::CloneBackendResponse
This operation clones an existing backend.
429 430 431 432 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 429 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.
480 481 482 483 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 480 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.
563 564 565 566 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 563 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.
681 682 683 684 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 681 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.
717 718 719 720 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 717 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.
767 768 769 770 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 767 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.
801 802 803 804 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 801 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.
841 842 843 844 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 841 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.
924 925 926 927 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 924 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.
967 968 969 970 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 967 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.
1009 1010 1011 1012 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1009 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.
1039 1040 1041 1042 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1039 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.
1082 1083 1084 1085 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1082 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.
1125 1126 1127 1128 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1125 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.
1228 1229 1230 1231 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1228 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.
1266 1267 1268 1269 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1266 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.
1347 1348 1349 1350 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1347 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.
1394 1395 1396 1397 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1394 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.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1439 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1475 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.
1527 1528 1529 1530 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1527 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.
1569 1570 1571 1572 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1569 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.
1626 1627 1628 1629 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1626 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.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1657 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.
1695 1696 1697 1698 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1695 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.
1722 1723 1724 1725 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1722 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.
1805 1806 1807 1808 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1805 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.
1919 1920 1921 1922 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1919 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.
1964 1965 1966 1967 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 1964 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.
2017 2018 2019 2020 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2017 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.
2066 2067 2068 2069 |
# File 'gems/aws-sdk-amplifybackend/lib/aws-sdk-amplifybackend/client.rb', line 2066 def update_backend_storage(params = {}, = {}) req = build_request(:update_backend_storage, params) req.send_request() end |