Class: Aws::DataExchange::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DataExchange::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb
Overview
An API client for DataExchange. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::DataExchange::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
-
#cancel_job(params = {}) ⇒ Struct
This operation cancels a job.
-
#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse
This operation creates a data set.
-
#create_job(params = {}) ⇒ Types::CreateJobResponse
This operation creates a job.
-
#create_revision(params = {}) ⇒ Types::CreateRevisionResponse
This operation creates a revision for a data set.
-
#delete_asset(params = {}) ⇒ Struct
This operation deletes an asset.
-
#delete_data_set(params = {}) ⇒ Struct
This operation deletes a data set.
-
#delete_revision(params = {}) ⇒ Struct
This operation deletes a revision.
-
#get_asset(params = {}) ⇒ Types::GetAssetResponse
This operation returns information about an asset.
-
#get_data_set(params = {}) ⇒ Types::GetDataSetResponse
This operation returns information about a data set.
-
#get_job(params = {}) ⇒ Types::GetJobResponse
This operation returns information about a job.
-
#get_revision(params = {}) ⇒ Types::GetRevisionResponse
This operation returns information about a revision.
-
#list_data_set_revisions(params = {}) ⇒ Types::ListDataSetRevisionsResponse
This operation lists a data set's revisions sorted by CreatedAt in descending order.
-
#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse
This operation lists your data sets.
-
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
This operation lists your jobs sorted by CreatedAt in descending order.
-
#list_revision_assets(params = {}) ⇒ Types::ListRevisionAssetsResponse
This operation lists a revision's assets sorted alphabetically in descending order.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
This operation lists the tags on the resource.
-
#start_job(params = {}) ⇒ Struct
This operation starts a job.
-
#tag_resource(params = {}) ⇒ Struct
This operation tags a resource.
-
#untag_resource(params = {}) ⇒ Struct
This operation removes one or more tags from a resource.
-
#update_asset(params = {}) ⇒ Types::UpdateAssetResponse
This operation updates an asset.
-
#update_data_set(params = {}) ⇒ Types::UpdateDataSetResponse
This operation updates a data set.
-
#update_revision(params = {}) ⇒ Types::UpdateRevisionResponse
This operation updates a revision.
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.
324 325 326 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 324 def initialize(*args) super end |
Instance Method Details
#cancel_job(params = {}) ⇒ Struct
This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
347 348 349 350 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 347 def cancel_job(params = {}, = {}) req = build_request(:cancel_job, params) req.send_request() end |
#create_data_set(params = {}) ⇒ Types::CreateDataSetResponse
This operation creates a data set.
416 417 418 419 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 416 def create_data_set(params = {}, = {}) req = build_request(:create_data_set, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResponse
This operation creates a job.
532 533 534 535 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 532 def create_job(params = {}, = {}) req = build_request(:create_job, params) req.send_request() end |
#create_revision(params = {}) ⇒ Types::CreateRevisionResponse
This operation creates a revision for a data set.
590 591 592 593 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 590 def create_revision(params = {}, = {}) req = build_request(:create_revision, params) req.send_request() end |
#delete_asset(params = {}) ⇒ Struct
This operation deletes an asset.
617 618 619 620 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 617 def delete_asset(params = {}, = {}) req = build_request(:delete_asset, params) req.send_request() end |
#delete_data_set(params = {}) ⇒ Struct
This operation deletes a data set.
638 639 640 641 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 638 def delete_data_set(params = {}, = {}) req = build_request(:delete_data_set, params) req.send_request() end |
#delete_revision(params = {}) ⇒ Struct
This operation deletes a revision.
662 663 664 665 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 662 def delete_revision(params = {}, = {}) req = build_request(:delete_revision, params) req.send_request() end |
#get_asset(params = {}) ⇒ Types::GetAssetResponse
This operation returns information about an asset.
713 714 715 716 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 713 def get_asset(params = {}, = {}) req = build_request(:get_asset, params) req.send_request() end |
#get_data_set(params = {}) ⇒ Types::GetDataSetResponse
This operation returns information about a data set.
761 762 763 764 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 761 def get_data_set(params = {}, = {}) req = build_request(:get_data_set, params) req.send_request() end |
#get_job(params = {}) ⇒ Types::GetJobResponse
This operation returns information about a job.
835 836 837 838 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 835 def get_job(params = {}, = {}) req = build_request(:get_job, params) req.send_request() end |
#get_revision(params = {}) ⇒ Types::GetRevisionResponse
This operation returns information about a revision.
882 883 884 885 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 882 def get_revision(params = {}, = {}) req = build_request(:get_revision, params) req.send_request() end |
#list_data_set_revisions(params = {}) ⇒ Types::ListDataSetRevisionsResponse
This operation lists a data set's revisions sorted by CreatedAt in descending order.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
928 929 930 931 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 928 def list_data_set_revisions(params = {}, = {}) req = build_request(:list_data_set_revisions, params) req.send_request() end |
#list_data_sets(params = {}) ⇒ Types::ListDataSetsResponse
This 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
978 979 980 981 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 978 def list_data_sets(params = {}, = {}) req = build_request(:list_data_sets, params) req.send_request() end |
#list_jobs(params = {}) ⇒ Types::ListJobsResponse
This operation lists your jobs sorted by CreatedAt in descending order.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1060 1061 1062 1063 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1060 def list_jobs(params = {}, = {}) req = build_request(:list_jobs, params) req.send_request() end |
#list_revision_assets(params = {}) ⇒ Types::ListRevisionAssetsResponse
This operation lists a revision's assets sorted alphabetically in descending order.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1111 def list_revision_assets(params = {}, = {}) req = build_request(:list_revision_assets, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
This operation lists the tags on the resource.
1139 1140 1141 1142 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1139 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_job(params = {}) ⇒ Struct
This operation starts a job.
1160 1161 1162 1163 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1160 def start_job(params = {}, = {}) req = build_request(:start_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
This operation tags a resource.
1186 1187 1188 1189 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1186 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
This operation removes one or more tags from a resource.
1210 1211 1212 1213 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1210 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_asset(params = {}) ⇒ Types::UpdateAssetResponse
This operation updates an asset.
1267 1268 1269 1270 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1267 def update_asset(params = {}, = {}) req = build_request(:update_asset, params) req.send_request() end |
#update_data_set(params = {}) ⇒ Types::UpdateDataSetResponse
This operation updates a data set.
1320 1321 1322 1323 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1320 def update_data_set(params = {}, = {}) req = build_request(:update_data_set, params) req.send_request() end |
#update_revision(params = {}) ⇒ Types::UpdateRevisionResponse
This operation updates a revision.
1374 1375 1376 1377 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1374 def update_revision(params = {}, = {}) req = build_request(:update_revision, params) req.send_request() end |