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_event_action(params = {}) ⇒ Types::CreateEventActionResponse
This operation creates an event action.
-
#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_event_action(params = {}) ⇒ Struct
This operation deletes the event action.
-
#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_event_action(params = {}) ⇒ Types::GetEventActionResponse
This operation retrieves information about an event action.
-
#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_event_actions(params = {}) ⇒ Types::ListEventActionsResponse
This operation lists your event actions.
-
#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.
-
#revoke_revision(params = {}) ⇒ Types::RevokeRevisionResponse
This operation revokes subscribers' access to a revision.
-
#send_api_asset(params = {}) ⇒ Types::SendApiAssetResponse
This operation invokes an API Gateway API asset.
-
#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_event_action(params = {}) ⇒ Types::UpdateEventActionResponse
This operation updates the event action.
-
#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.
348 349 350 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 348 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.
371 372 373 374 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 371 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.
439 440 441 442 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 439 def create_data_set(params = {}, = {}) req = build_request(:create_data_set, params) req.send_request() end |
#create_event_action(params = {}) ⇒ Types::CreateEventActionResponse
This operation creates an event action.
499 500 501 502 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 499 def create_event_action(params = {}, = {}) req = build_request(:create_event_action, params) req.send_request() end |
#create_job(params = {}) ⇒ Types::CreateJobResponse
This operation creates a job.
672 673 674 675 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 672 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.
736 737 738 739 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 736 def create_revision(params = {}, = {}) req = build_request(:create_revision, params) req.send_request() end |
#delete_asset(params = {}) ⇒ Struct
This operation deletes an asset.
763 764 765 766 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 763 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.
784 785 786 787 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 784 def delete_data_set(params = {}, = {}) req = build_request(:delete_data_set, params) req.send_request() end |
#delete_event_action(params = {}) ⇒ Struct
This operation deletes the event action.
805 806 807 808 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 805 def delete_event_action(params = {}, = {}) req = build_request(:delete_event_action, params) req.send_request() end |
#delete_revision(params = {}) ⇒ Struct
This operation deletes a revision.
829 830 831 832 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 829 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.
890 891 892 893 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 890 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.
938 939 940 941 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 938 def get_data_set(params = {}, = {}) req = build_request(:get_data_set, params) req.send_request() end |
#get_event_action(params = {}) ⇒ Types::GetEventActionResponse
This operation retrieves information about an event action.
978 979 980 981 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 978 def get_event_action(params = {}, = {}) req = build_request(:get_event_action, params) req.send_request() end |
#get_job(params = {}) ⇒ Types::GetJobResponse
This operation returns information about a job.
1075 1076 1077 1078 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1075 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.
1128 1129 1130 1131 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1128 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.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1177 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.
1227 1228 1229 1230 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1227 def list_data_sets(params = {}, = {}) req = build_request(:list_data_sets, params) req.send_request() end |
#list_event_actions(params = {}) ⇒ Types::ListEventActionsResponse
This operation lists your event actions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1273 def list_event_actions(params = {}, = {}) req = build_request(:list_event_actions, 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.
1378 1379 1380 1381 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1378 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.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1439 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.
1467 1468 1469 1470 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1467 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#revoke_revision(params = {}) ⇒ Types::RevokeRevisionResponse
This operation revokes subscribers' access to a revision.
1522 1523 1524 1525 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1522 def revoke_revision(params = {}, = {}) req = build_request(:revoke_revision, params) req.send_request() end |
#send_api_asset(params = {}) ⇒ Types::SendApiAssetResponse
This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.
1578 1579 1580 1581 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1578 def send_api_asset(params = {}, = {}) req = build_request(:send_api_asset, params) req.send_request() end |
#start_job(params = {}) ⇒ Struct
This operation starts a job.
1599 1600 1601 1602 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1599 def start_job(params = {}, = {}) req = build_request(:start_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
This operation tags a resource.
1625 1626 1627 1628 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1625 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.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1649 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_asset(params = {}) ⇒ Types::UpdateAssetResponse
This operation updates an asset.
1719 1720 1721 1722 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1719 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.
1772 1773 1774 1775 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1772 def update_data_set(params = {}, = {}) req = build_request(:update_data_set, params) req.send_request() end |
#update_event_action(params = {}) ⇒ Types::UpdateEventActionResponse
This operation updates the event action.
1827 1828 1829 1830 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1827 def update_event_action(params = {}, = {}) req = build_request(:update_event_action, params) req.send_request() end |
#update_revision(params = {}) ⇒ Types::UpdateRevisionResponse
This operation updates a revision.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1887 def update_revision(params = {}, = {}) req = build_request(:update_revision, params) req.send_request() end |