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 specified by an app ID.
-
#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.
385 386 387 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_app(params = {}) ⇒ Types::CreateAppResult
Creates a new Amplify app.
608 609 610 611 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 608 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.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
660 661 662 663 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 660 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.
807 808 809 810 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 807 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.
The maximum duration between the CreateDeployment
call and the
StartDeployment
call cannot exceed 8 hours. If the duration exceeds
8 hours, the StartDeployment
call and the associated Job
will
fail.
859 860 861 862 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 859 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
940 941 942 943 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 940 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.
982 983 984 985 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 982 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.
1053 1054 1055 1056 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1053 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.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
1097 1098 1099 1100 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1097 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.
1160 1161 1162 1163 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1160 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.
1209 1210 1211 1212 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1209 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.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1253 def delete_job(params = {}, = {}) req = build_request(:delete_job, params) req.send_request() end |
#delete_webhook(params = {}) ⇒ Types::DeleteWebhookResult
Deletes a webhook.
1287 1288 1289 1290 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1287 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.
1330 1331 1332 1333 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1330 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 specified by an app ID.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1401 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.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1431 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.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1475 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.
1538 1539 1540 1541 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1538 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.
1587 1588 1589 1590 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1587 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.
1644 1645 1646 1647 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1644 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.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1679 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1760 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.
1810 1811 1812 1813 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1810 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.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
1867 1868 1869 1870 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1867 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1941 1942 1943 1944 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1941 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2001 2002 2003 2004 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2001 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2056 2057 2058 2059 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2056 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).
2085 2086 2087 2088 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2085 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.
2132 2133 2134 2135 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2132 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.
The maximum duration between the CreateDeployment
call and the
StartDeployment
call cannot exceed 8 hours. If the duration exceeds
8 hours, the StartDeployment
call and the associated Job
will
fail.
2189 2190 2191 2192 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2189 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.
2259 2260 2261 2262 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2259 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.
2303 2304 2305 2306 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2303 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.
2331 2332 2333 2334 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2331 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).
2357 2358 2359 2360 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2357 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app(params = {}) ⇒ Types::UpdateAppResult
Updates an existing Amplify app.
2571 2572 2573 2574 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2571 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.
2712 2713 2714 2715 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2712 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.
2790 2791 2792 2793 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2790 def update_domain_association(params = {}, = {}) req = build_request(:update_domain_association, params) req.send_request() end |
#update_webhook(params = {}) ⇒ Types::UpdateWebhookResult
Updates a webhook.
2832 2833 2834 2835 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2832 def update_webhook(params = {}, = {}) req = build_request(:update_webhook, params) req.send_request() end |