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.
410 411 412 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#create_app(params = {}) ⇒ Types::CreateAppResult
Creates a new Amplify app.
633 634 635 636 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 633 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.
684 685 686 687 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 684 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.
839 840 841 842 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 839 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.
891 892 893 894 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 891 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
972 973 974 975 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 972 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.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1014 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.
1085 1086 1087 1088 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1085 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.
1128 1129 1130 1131 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1128 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.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1191 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.
1240 1241 1242 1243 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1240 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.
1284 1285 1286 1287 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1284 def delete_job(params = {}, = {}) req = build_request(:delete_job, params) req.send_request() end |
#delete_webhook(params = {}) ⇒ Types::DeleteWebhookResult
Deletes a webhook.
1318 1319 1320 1321 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1318 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.
1361 1362 1363 1364 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1361 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.
1432 1433 1434 1435 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1432 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.
1462 1463 1464 1465 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1462 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.
1505 1506 1507 1508 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1505 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.
1568 1569 1570 1571 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1568 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.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1617 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.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1674 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.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1709 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.
1790 1791 1792 1793 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1790 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.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1840 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.
1896 1897 1898 1899 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1896 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.
1970 1971 1972 1973 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 1970 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.
2030 2031 2032 2033 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2030 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.
2085 2086 2087 2088 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2085 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).
2114 2115 2116 2117 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2114 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.
2161 2162 2163 2164 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2161 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.
2218 2219 2220 2221 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2218 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.
2288 2289 2290 2291 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2288 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.
2332 2333 2334 2335 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2332 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.
2360 2361 2362 2363 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2360 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).
2386 2387 2388 2389 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2386 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app(params = {}) ⇒ Types::UpdateAppResult
Updates an existing Amplify app.
2600 2601 2602 2603 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2600 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.
2749 2750 2751 2752 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2749 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.
2827 2828 2829 2830 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2827 def update_domain_association(params = {}, = {}) req = build_request(:update_domain_association, params) req.send_request() end |
#update_webhook(params = {}) ⇒ Types::UpdateWebhookResult
Updates a webhook.
2869 2870 2871 2872 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/client.rb', line 2869 def update_webhook(params = {}, = {}) req = build_request(:update_webhook, params) req.send_request() end |