Class: Aws::Amplify::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Amplify::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb
Overview
An API client for Amplify. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Amplify::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
-
#create_app(params = {}) ⇒ Types::CreateAppResult
Creates a new Amplify app.
-
#create_backend_environment(params = {}) ⇒ Types::CreateBackendEnvironmentResult
Creates a new backend environment for an Amplify app.
-
#create_branch(params = {}) ⇒ Types::CreateBranchResult
Creates a new branch for an Amplify app.
-
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResult
Creates a deployment for a manually deployed Amplify app.
-
#create_domain_association(params = {}) ⇒ Types::CreateDomainAssociationResult
Creates a new domain association for an Amplify app.
-
#create_webhook(params = {}) ⇒ Types::CreateWebhookResult
Creates a new webhook on an Amplify app.
-
#delete_app(params = {}) ⇒ Types::DeleteAppResult
Deletes an existing Amplify app specified by an app ID.
-
#delete_backend_environment(params = {}) ⇒ Types::DeleteBackendEnvironmentResult
Deletes a backend environment for an Amplify app.
-
#delete_branch(params = {}) ⇒ Types::DeleteBranchResult
Deletes a branch for an Amplify app.
-
#delete_domain_association(params = {}) ⇒ Types::DeleteDomainAssociationResult
Deletes a domain association for an Amplify app.
-
#delete_job(params = {}) ⇒ Types::DeleteJobResult
Deletes a job for a branch of an Amplify app.
-
#delete_webhook(params = {}) ⇒ Types::DeleteWebhookResult
Deletes a webhook.
-
#generate_access_logs(params = {}) ⇒ Types::GenerateAccessLogsResult
Returns the website access logs for a specific time range using a presigned URL.
-
#get_app(params = {}) ⇒ Types::GetAppResult
Returns an existing Amplify app by appID.
-
#get_artifact_url(params = {}) ⇒ Types::GetArtifactUrlResult
Returns the artifact info that corresponds to an artifact id.
-
#get_backend_environment(params = {}) ⇒ Types::GetBackendEnvironmentResult
Returns a backend environment for an Amplify app.
-
#get_branch(params = {}) ⇒ Types::GetBranchResult
Returns a branch for an Amplify app.
-
#get_domain_association(params = {}) ⇒ Types::GetDomainAssociationResult
Returns the domain information for an Amplify app.
-
#get_job(params = {}) ⇒ Types::GetJobResult
Returns a job for a branch of an Amplify app.
-
#get_webhook(params = {}) ⇒ Types::GetWebhookResult
Returns the webhook information that corresponds to a specified webhook ID.
-
#list_apps(params = {}) ⇒ Types::ListAppsResult
Returns a list of the existing Amplify apps.
-
#list_artifacts(params = {}) ⇒ Types::ListArtifactsResult
Returns a list of artifacts for a specified app, branch, and job.
-
#list_backend_environments(params = {}) ⇒ Types::ListBackendEnvironmentsResult
Lists the backend environments for an Amplify app.
-
#list_branches(params = {}) ⇒ Types::ListBranchesResult
Lists the branches of an Amplify app.
-
#list_domain_associations(params = {}) ⇒ Types::ListDomainAssociationsResult
Returns the domain associations for an Amplify app.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Lists the jobs for a branch of an Amplify app.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a specified Amazon Resource Name (ARN).
-
#list_webhooks(params = {}) ⇒ Types::ListWebhooksResult
Returns a list of webhooks for an Amplify app.
-
#start_deployment(params = {}) ⇒ Types::StartDeploymentResult
Starts a deployment for a manually deployed app.
-
#start_job(params = {}) ⇒ Types::StartJobResult
Starts a new job for a branch of an Amplify app.
-
#stop_job(params = {}) ⇒ Types::StopJobResult
Stops a job that is in progress for a branch of an Amplify app.
-
#tag_resource(params = {}) ⇒ Struct
Tags the resource with a tag key and value.
-
#untag_resource(params = {}) ⇒ Struct
Untags a resource with a specified Amazon Resource Name (ARN).
-
#update_app(params = {}) ⇒ Types::UpdateAppResult
Updates an existing Amplify app.
-
#update_branch(params = {}) ⇒ Types::UpdateBranchResult
Updates a branch for an Amplify app.
-
#update_domain_association(params = {}) ⇒ Types::UpdateDomainAssociationResult
Creates a new domain association for an Amplify app.
-
#update_webhook(params = {}) ⇒ Types::UpdateWebhookResult
Updates a webhook.
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-amplify/lib/aws-sdk-amplify/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#create_app(params = {}) ⇒ Types::CreateAppResult
Creates a new Amplify app.
559 560 561 562 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 559 def create_app(params = {}, = {}) req = build_request(:create_app, params) req.send_request() end |
#create_backend_environment(params = {}) ⇒ Types::CreateBackendEnvironmentResult
Creates a new backend environment for an Amplify app.
604 605 606 607 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 604 def create_backend_environment(params = {}, = {}) req = build_request(:create_backend_environment, params) req.send_request() end |
#create_branch(params = {}) ⇒ Types::CreateBranchResult
Creates a new branch for an Amplify app.
743 744 745 746 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 743 def create_branch(params = {}, = {}) req = build_request(:create_branch, params) req.send_request() end |
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResult
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
790 791 792 793 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 790 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_domain_association(params = {}) ⇒ Types::CreateDomainAssociationResult
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
858 859 860 861 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 858 def create_domain_association(params = {}, = {}) req = build_request(:create_domain_association, params) req.send_request() end |
#create_webhook(params = {}) ⇒ Types::CreateWebhookResult
Creates a new webhook on an Amplify app.
900 901 902 903 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 900 def create_webhook(params = {}, = {}) req = build_request(:create_webhook, params) req.send_request() end |
#delete_app(params = {}) ⇒ Types::DeleteAppResult
Deletes an existing Amplify app specified by an app ID.
971 972 973 974 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 971 def delete_app(params = {}, = {}) req = build_request(:delete_app, params) req.send_request() end |
#delete_backend_environment(params = {}) ⇒ Types::DeleteBackendEnvironmentResult
Deletes a backend environment for an Amplify app.
1008 1009 1010 1011 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1008 def delete_backend_environment(params = {}, = {}) req = build_request(:delete_backend_environment, params) req.send_request() end |
#delete_branch(params = {}) ⇒ Types::DeleteBranchResult
Deletes a branch for an Amplify app.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1070 def delete_branch(params = {}, = {}) req = build_request(:delete_branch, params) req.send_request() end |
#delete_domain_association(params = {}) ⇒ Types::DeleteDomainAssociationResult
Deletes a domain association for an Amplify app.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1115 def delete_domain_association(params = {}, = {}) req = build_request(:delete_domain_association, params) req.send_request() end |
#delete_job(params = {}) ⇒ Types::DeleteJobResult
Deletes a job for a branch of an Amplify app.
1159 1160 1161 1162 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1159 def delete_job(params = {}, = {}) req = build_request(:delete_job, params) req.send_request() end |
#delete_webhook(params = {}) ⇒ Types::DeleteWebhookResult
Deletes a webhook.
1193 1194 1195 1196 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1193 def delete_webhook(params = {}, = {}) req = build_request(:delete_webhook, params) req.send_request() end |
#generate_access_logs(params = {}) ⇒ Types::GenerateAccessLogsResult
Returns the website access logs for a specific time range using a presigned URL.
1236 1237 1238 1239 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1236 def generate_access_logs(params = {}, = {}) req = build_request(:generate_access_logs, params) req.send_request() end |
#get_app(params = {}) ⇒ Types::GetAppResult
Returns an existing Amplify app by appID.
1307 1308 1309 1310 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1307 def get_app(params = {}, = {}) req = build_request(:get_app, params) req.send_request() end |
#get_artifact_url(params = {}) ⇒ Types::GetArtifactUrlResult
Returns the artifact info that corresponds to an artifact id.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1337 def get_artifact_url(params = {}, = {}) req = build_request(:get_artifact_url, params) req.send_request() end |
#get_backend_environment(params = {}) ⇒ Types::GetBackendEnvironmentResult
Returns a backend environment for an Amplify app.
1374 1375 1376 1377 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1374 def get_backend_environment(params = {}, = {}) req = build_request(:get_backend_environment, params) req.send_request() end |
#get_branch(params = {}) ⇒ Types::GetBranchResult
Returns a branch for an Amplify app.
1436 1437 1438 1439 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1436 def get_branch(params = {}, = {}) req = build_request(:get_branch, params) req.send_request() end |
#get_domain_association(params = {}) ⇒ Types::GetDomainAssociationResult
Returns the domain information for an Amplify app.
1481 1482 1483 1484 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1481 def get_domain_association(params = {}, = {}) req = build_request(:get_domain_association, params) req.send_request() end |
#get_job(params = {}) ⇒ Types::GetJobResult
Returns a job for a branch of an Amplify app.
1538 1539 1540 1541 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1538 def get_job(params = {}, = {}) req = build_request(:get_job, params) req.send_request() end |
#get_webhook(params = {}) ⇒ Types::GetWebhookResult
Returns the webhook information that corresponds to a specified webhook ID.
1573 1574 1575 1576 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1573 def get_webhook(params = {}, = {}) req = build_request(:get_webhook, params) req.send_request() end |
#list_apps(params = {}) ⇒ Types::ListAppsResult
Returns a list of the existing Amplify apps.
1652 1653 1654 1655 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1652 def list_apps(params = {}, = {}) req = build_request(:list_apps, params) req.send_request() end |
#list_artifacts(params = {}) ⇒ Types::ListArtifactsResult
Returns a list of artifacts for a specified app, branch, and job.
1702 1703 1704 1705 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1702 def list_artifacts(params = {}, = {}) req = build_request(:list_artifacts, params) req.send_request() end |
#list_backend_environments(params = {}) ⇒ Types::ListBackendEnvironmentsResult
Lists the backend environments for an Amplify app.
1752 1753 1754 1755 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1752 def list_backend_environments(params = {}, = {}) req = build_request(:list_backend_environments, params) req.send_request() end |
#list_branches(params = {}) ⇒ Types::ListBranchesResult
Lists the branches of an Amplify app.
1823 1824 1825 1826 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1823 def list_branches(params = {}, = {}) req = build_request(:list_branches, params) req.send_request() end |
#list_domain_associations(params = {}) ⇒ Types::ListDomainAssociationsResult
Returns the domain associations for an Amplify app.
1877 1878 1879 1880 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1877 def list_domain_associations(params = {}, = {}) req = build_request(:list_domain_associations, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResult
Lists the jobs for a branch of an Amplify app.
1930 1931 1932 1933 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1930 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags for a specified Amazon Resource Name (ARN).
1959 1960 1961 1962 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1959 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_webhooks(params = {}) ⇒ Types::ListWebhooksResult
Returns a list of webhooks for an Amplify app.
2006 2007 2008 2009 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2006 def list_webhooks(params = {}, = {}) req = build_request(:list_webhooks, params) req.send_request() end |
#start_deployment(params = {}) ⇒ Types::StartDeploymentResult
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
2058 2059 2060 2061 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2058 def start_deployment(params = {}, = {}) req = build_request(:start_deployment, params) req.send_request() end |
#start_job(params = {}) ⇒ Types::StartJobResult
Starts a new job for a branch of an Amplify app.
2127 2128 2129 2130 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2127 def start_job(params = {}, = {}) req = build_request(:start_job, params) req.send_request() end |
#stop_job(params = {}) ⇒ Types::StopJobResult
Stops a job that is in progress for a branch of an Amplify app.
2171 2172 2173 2174 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2171 def stop_job(params = {}, = {}) req = build_request(:stop_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags the resource with a tag key and value.
2199 2200 2201 2202 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2199 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Untags a resource with a specified Amazon Resource Name (ARN).
2225 2226 2227 2228 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2225 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app(params = {}) ⇒ Types::UpdateAppResult
Updates an existing Amplify app.
2435 2436 2437 2438 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2435 def update_app(params = {}, = {}) req = build_request(:update_app, params) req.send_request() end |
#update_branch(params = {}) ⇒ Types::UpdateBranchResult
Updates a branch for an Amplify app.
2568 2569 2570 2571 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2568 def update_branch(params = {}, = {}) req = build_request(:update_branch, params) req.send_request() end |
#update_domain_association(params = {}) ⇒ Types::UpdateDomainAssociationResult
Creates a new domain association for an Amplify app.
2635 2636 2637 2638 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2635 def update_domain_association(params = {}, = {}) req = build_request(:update_domain_association, params) req.send_request() end |
#update_webhook(params = {}) ⇒ Types::UpdateWebhookResult
Updates a webhook.
2677 2678 2679 2680 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2677 def update_webhook(params = {}, = {}) req = build_request(:update_webhook, params) req.send_request() end |