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.
-
#send_data_set_notification(params = {}) ⇒ Struct
The type of event associated with the data set.
-
#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.
385 386 387 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 385 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.
409 410 411 412 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 409 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.
477 478 479 480 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 477 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.
537 538 539 540 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 537 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.
773 774 775 776 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 773 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.
838 839 840 841 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 838 def create_revision(params = {}, = {}) req = build_request(:create_revision, params) req.send_request() end |
#delete_asset(params = {}) ⇒ Struct
This operation deletes an asset.
868 869 870 871 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 868 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.
890 891 892 893 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 890 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.
912 913 914 915 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 912 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.
938 939 940 941 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 938 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.
1025 1026 1027 1028 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1025 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.
1074 1075 1076 1077 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1074 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.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1115 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.
1238 1239 1240 1241 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1238 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.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1293 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.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1346 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.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1401 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.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1451 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.
1586 1587 1588 1589 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1586 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.
1675 1676 1677 1678 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1675 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.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1705 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.
1762 1763 1764 1765 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1762 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.
1832 1833 1834 1835 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1832 def send_api_asset(params = {}, = {}) req = build_request(:send_api_asset, params) req.send_request() end |
#send_data_set_notification(params = {}) ⇒ Struct
The type of event associated with the data set.
1922 1923 1924 1925 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1922 def send_data_set_notification(params = {}, = {}) req = build_request(:send_data_set_notification, params) req.send_request() end |
#start_job(params = {}) ⇒ Struct
This operation starts a job.
1944 1945 1946 1947 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1944 def start_job(params = {}, = {}) req = build_request(:start_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
This operation tags a resource.
1973 1974 1975 1976 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1973 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.
2000 2001 2002 2003 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2000 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_asset(params = {}) ⇒ Types::UpdateAssetResponse
This operation updates an asset.
2098 2099 2100 2101 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2098 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.
2152 2153 2154 2155 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2152 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.
2208 2209 2210 2211 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2208 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.
2270 2271 2272 2273 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2270 def update_revision(params = {}, = {}) req = build_request(:update_revision, params) req.send_request() end |