You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::DataExchange::Client OverviewAn API client for AWS Data Exchange. To construct a client, you need to configure a :region and :credentials.
dataexchange = Aws::DataExchange::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::DataExchange::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.
This operation cancels a job.
This operation creates a data set.
.
This operation creates a job.
.
This operation creates a revision for a data set.
.
This operation deletes an asset.
.
This operation deletes a data set.
.
This operation deletes a revision.
.
This operation returns information about an asset.
.
This operation returns information about a data set.
.
This operation returns information about a job.
.
This operation returns information about a revision.
.
This operation lists a data set's revisions sorted by CreatedAt in descending order.
.
This operation lists your data sets.
This operation lists your jobs sorted by CreatedAt in descending order.
.
This operation lists a revision's assets sorted alphabetically in descending order.
.
This operation lists the tags on the resource.
.
This operation starts a job.
.
This operation tags a resource.
.
This operation removes one or more tags from a resource.
.
This operation updates an asset.
.
This operation updates a data set.
.
This operation updates a revision.
.
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 #cancel_job(options = {}) ⇒ StructThis operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
#delete_asset(options = {}) ⇒ StructThis operation deletes an asset.
#delete_data_set(options = {}) ⇒ StructThis operation deletes a data set.
#delete_revision(options = {}) ⇒ StructThis operation deletes a revision.
#list_data_sets(options = {}) ⇒ Types::ListDataSetsResponseThis operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.
#list_jobs(options = {}) ⇒ Types::ListJobsResponseThis operation lists your jobs sorted by CreatedAt in descending order.
#start_job(options = {}) ⇒ StructThis operation starts a job.
#tag_resource(options = {}) ⇒ StructThis operation tags a resource.
#untag_resource(options = {}) ⇒ StructThis operation removes one or more tags from a resource.
#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