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.
410 411 412 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 410 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.
434 435 436 437 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 434 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.
502 503 504 505 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 502 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.
562 563 564 565 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 562 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.
798 799 800 801 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 798 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.
863 864 865 866 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 863 def create_revision(params = {}, = {}) req = build_request(:create_revision, params) req.send_request() end |
#delete_asset(params = {}) ⇒ Struct
This operation deletes an asset.
893 894 895 896 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 893 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.
915 916 917 918 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 915 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.
937 938 939 940 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 937 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.
963 964 965 966 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 963 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.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1050 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.
1099 1100 1101 1102 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1099 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.
1140 1141 1142 1143 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1140 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.
1263 1264 1265 1266 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1263 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.
1318 1319 1320 1321 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1318 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.
1371 1372 1373 1374 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1371 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.
1426 1427 1428 1429 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1426 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.
1476 1477 1478 1479 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1476 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.
1611 1612 1613 1614 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1611 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.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1700 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.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1730 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.
1787 1788 1789 1790 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1787 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.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1857 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.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1947 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.
1969 1970 1971 1972 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1969 def start_job(params = {}, = {}) req = build_request(:start_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
This operation tags a resource.
1998 1999 2000 2001 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 1998 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.
2025 2026 2027 2028 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2025 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_asset(params = {}) ⇒ Types::UpdateAssetResponse
This operation updates an asset.
2123 2124 2125 2126 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2123 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.
2177 2178 2179 2180 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2177 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.
2233 2234 2235 2236 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2233 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.
2295 2296 2297 2298 |
# File 'gems/aws-sdk-dataexchange/lib/aws-sdk-dataexchange/client.rb', line 2295 def update_revision(params = {}, = {}) req = build_request(:update_revision, params) req.send_request() end |