You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Amplify::Client OverviewAn API client for AWS Amplify. To construct a client, you need to configure a :region and :credentials.
amplify = Aws::Amplify::Client.new(
region: region_name,
credentials: credentials,
)
See #initialize for a full list of supported configuration options.
RegionYou can configure a default region in the following locations:
ENV['AWS_REGION']Aws.config[:region]Go here for a list of supported regions.
CredentialsDefault credentials are loaded automatically from the following locations:
ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']Aws.config[:credentials]~/.aws/credentials (more information)You can also construct a credentials object from one of the following classes:
Alternatively, you configure credentials with :access_key_id and :secret_access_key:
creds = YAML.load(File.read('/path/to/secrets'))
Aws::Amplify::Client.new(
access_key_id: creds['access_key_id'],
secret_access_key: creds['secret_access_key']
)
Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.
Attribute Summary collapseConstructs an API client.
Creates a new Amplify app.
Creates a new backend environment for an Amplify app.
Creates a new branch for an Amplify app.
Creates a deployment for a manually deployed Amplify app.
Creates a new domain association for an Amplify app.
Creates a new webhook on an Amplify app.
Deletes an existing Amplify app specified by an app ID.
Deletes a backend environment for an Amplify app.
Deletes a branch for an Amplify app.
Deletes a domain association for an Amplify app.
Deletes a job for a branch of an Amplify app.
Returns the website access logs for a specific time range using a presigned URL.
Returns an existing Amplify app by appID.
Returns the artifact info that corresponds to an artifact id.
Returns a backend environment for an Amplify app.
Returns a branch for an Amplify app.
Returns the domain information for an Amplify app.
Returns a job for a branch of an Amplify app.
Returns the webhook information that corresponds to a specified webhook ID.
Returns a list of the existing Amplify apps.
Returns a list of artifacts for a specified app, branch, and job.
Lists the backend environments for an Amplify app.
Lists the branches of an Amplify app.
Returns the domain associations for an Amplify app.
Lists the jobs for a branch of an Amplify app.
Returns a list of tags for a specified Amazon Resource Name (ARN).
Returns a list of webhooks for an Amplify app.
Starts a deployment for a manually deployed app.
Starts a new job for a branch of an Amplify app.
Stops a job that is in progress for a branch of an Amplify app.
Tags the resource with a tag key and value.
Untags a resource with a specified Amazon Resource Name (ARN).
Updates an existing Amplify app.
Updates a branch for an Amplify app.
Creates a new domain association for an Amplify app.
.
Waiters polls an API operation until a resource enters a desired state.
Returns the list of supported waiters.
add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder#handle, #handle_request, #handle_response
Instance Method Details #create_deployment(options = {}) ⇒ Types::CreateDeploymentResultCreates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
#create_domain_association(options = {}) ⇒ Types::CreateDomainAssociationResultCreates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
#get_webhook(options = {}) ⇒ Types::GetWebhookResultReturns the webhook information that corresponds to a specified webhook ID.
#start_deployment(options = {}) ⇒ Types::StartDeploymentResultStarts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
#stop_job(options = {}) ⇒ Types::StopJobResultStops a job that is in progress for a branch of an Amplify app.
#tag_resource(options = {}) ⇒ StructTags the resource with a tag key and value.
#untag_resource(options = {}) ⇒ StructUntags a resource with a specified Amazon Resource Name (ARN).
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ BooleanWaiters polls an API operation until a resource enters a desired state.
Basic UsageWaiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)
ConfigurationYou can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:
# poll for ~25 seconds
client.wait_until(...) do |w|
w.max_attempts = 5
w.delay = 5
end
You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(...) do |w|
# disable max attempts
w.max_attempts = nil
# poll for 1 hour, instead of a number of attempts
w.before_wait do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
end
When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:
Waiter Name Client Method Default Delay: Default Max Attempts:RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4