Class: Aws::Amplify::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Amplify::Client
- Includes:
- ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'lib/aws-sdk-amplify/client.rb', line 422 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2912 2913 2914 |
# File 'lib/aws-sdk-amplify/client.rb', line 2912 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2915 2916 2917 |
# File 'lib/aws-sdk-amplify/client.rb', line 2915 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 |
# File 'lib/aws-sdk-amplify/client.rb', line 2890 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-amplify' context[:gem_version] = '1.65.0' Seahorse::Client::Request.new(handlers, context) end |
#create_app(params = {}) ⇒ Types::CreateAppResult
Creates a new Amplify app.
645 646 647 648 |
# File 'lib/aws-sdk-amplify/client.rb', line 645 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 Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app’s backend infrastructure using Typescript code.
696 697 698 699 |
# File 'lib/aws-sdk-amplify/client.rb', line 696 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.
851 852 853 854 |
# File 'lib/aws-sdk-amplify/client.rb', line 851 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.
903 904 905 906 |
# File 'lib/aws-sdk-amplify/client.rb', line 903 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
984 985 986 987 |
# File 'lib/aws-sdk-amplify/client.rb', line 984 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.
1026 1027 1028 1029 |
# File 'lib/aws-sdk-amplify/client.rb', line 1026 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.
1097 1098 1099 1100 |
# File 'lib/aws-sdk-amplify/client.rb', line 1097 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 is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app’s backend infrastructure using Typescript code.
1140 1141 1142 1143 |
# File 'lib/aws-sdk-amplify/client.rb', line 1140 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.
1203 1204 1205 1206 |
# File 'lib/aws-sdk-amplify/client.rb', line 1203 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.
1252 1253 1254 1255 |
# File 'lib/aws-sdk-amplify/client.rb', line 1252 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.
1296 1297 1298 1299 |
# File 'lib/aws-sdk-amplify/client.rb', line 1296 def delete_job(params = {}, = {}) req = build_request(:delete_job, params) req.send_request() end |
#delete_webhook(params = {}) ⇒ Types::DeleteWebhookResult
Deletes a webhook.
1330 1331 1332 1333 |
# File 'lib/aws-sdk-amplify/client.rb', line 1330 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.
1373 1374 1375 1376 |
# File 'lib/aws-sdk-amplify/client.rb', line 1373 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.
1444 1445 1446 1447 |
# File 'lib/aws-sdk-amplify/client.rb', line 1444 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.
1474 1475 1476 1477 |
# File 'lib/aws-sdk-amplify/client.rb', line 1474 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 is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app’s backend infrastructure using Typescript code.
1517 1518 1519 1520 |
# File 'lib/aws-sdk-amplify/client.rb', line 1517 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.
1580 1581 1582 1583 |
# File 'lib/aws-sdk-amplify/client.rb', line 1580 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.
1629 1630 1631 1632 |
# File 'lib/aws-sdk-amplify/client.rb', line 1629 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.
1686 1687 1688 1689 |
# File 'lib/aws-sdk-amplify/client.rb', line 1686 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.
1721 1722 1723 1724 |
# File 'lib/aws-sdk-amplify/client.rb', line 1721 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.
1802 1803 1804 1805 |
# File 'lib/aws-sdk-amplify/client.rb', line 1802 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.
1852 1853 1854 1855 |
# File 'lib/aws-sdk-amplify/client.rb', line 1852 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 is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app’s backend infrastructure using Typescript code.
1908 1909 1910 1911 |
# File 'lib/aws-sdk-amplify/client.rb', line 1908 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.
1982 1983 1984 1985 |
# File 'lib/aws-sdk-amplify/client.rb', line 1982 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.
2042 2043 2044 2045 |
# File 'lib/aws-sdk-amplify/client.rb', line 2042 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.
2097 2098 2099 2100 |
# File 'lib/aws-sdk-amplify/client.rb', line 2097 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).
2126 2127 2128 2129 |
# File 'lib/aws-sdk-amplify/client.rb', line 2126 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.
2173 2174 2175 2176 |
# File 'lib/aws-sdk-amplify/client.rb', line 2173 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.
2230 2231 2232 2233 |
# File 'lib/aws-sdk-amplify/client.rb', line 2230 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.
2300 2301 2302 2303 |
# File 'lib/aws-sdk-amplify/client.rb', line 2300 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.
2344 2345 2346 2347 |
# File 'lib/aws-sdk-amplify/client.rb', line 2344 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.
2372 2373 2374 2375 |
# File 'lib/aws-sdk-amplify/client.rb', line 2372 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).
2398 2399 2400 2401 |
# File 'lib/aws-sdk-amplify/client.rb', line 2398 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app(params = {}) ⇒ Types::UpdateAppResult
Updates an existing Amplify app.
2612 2613 2614 2615 |
# File 'lib/aws-sdk-amplify/client.rb', line 2612 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.
2761 2762 2763 2764 |
# File 'lib/aws-sdk-amplify/client.rb', line 2761 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.
2839 2840 2841 2842 |
# File 'lib/aws-sdk-amplify/client.rb', line 2839 def update_domain_association(params = {}, = {}) req = build_request(:update_domain_association, params) req.send_request() end |
#update_webhook(params = {}) ⇒ Types::UpdateWebhookResult
Updates a webhook.
2881 2882 2883 2884 |
# File 'lib/aws-sdk-amplify/client.rb', line 2881 def update_webhook(params = {}, = {}) req = build_request(:update_webhook, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2905 2906 2907 |
# File 'lib/aws-sdk-amplify/client.rb', line 2905 def waiter_names [] end |