Class: Aws::BCMDataExports::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BCMDataExports::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb
Overview
An API client for BCMDataExports. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::BCMDataExports::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
-
#create_export(params = {}) ⇒ Types::CreateExportResponse
Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.
-
#delete_export(params = {}) ⇒ Types::DeleteExportResponse
Deletes an existing data export.
-
#get_execution(params = {}) ⇒ Types::GetExecutionResponse
Exports data based on the source data update.
-
#get_export(params = {}) ⇒ Types::GetExportResponse
Views the definition of an existing data export.
-
#get_table(params = {}) ⇒ Types::GetTableResponse
Returns the metadata for the specified table and table properties.
-
#list_executions(params = {}) ⇒ Types::ListExecutionsResponse
Lists the historical executions for the export.
-
#list_exports(params = {}) ⇒ Types::ListExportsResponse
Lists all data export definitions.
-
#list_tables(params = {}) ⇒ Types::ListTablesResponse
Lists all available tables in data exports.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List tags associated with an existing data export.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags for an existing data export definition.
-
#untag_resource(params = {}) ⇒ Struct
Deletes tags associated with an existing data export definition.
-
#update_export(params = {}) ⇒ Types::UpdateExportResponse
Updates an existing data export by overwriting all export parameters.
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.
420 421 422 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#create_export(params = {}) ⇒ Types::CreateExportResponse
Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.
A DataQuery
consists of both a QueryStatement
and
TableConfigurations
.
The QueryStatement
is an SQL statement. Data Exports only supports a
limited subset of the SQL syntax. For more information on the SQL
syntax that is supported, see Data query. To view the available
tables and columns, see the Data Exports table dictionary.
The TableConfigurations
is a collection of specified
TableProperties
for the table being queried in the QueryStatement
.
TableProperties are additional configurations you can provide to
change the data and schema of a table. Each table can have different
TableProperties. However, tables are not required to have any
TableProperties. Each table property has a default value that it
assumes if not specified. For more information on table
configurations, see Data query. To view the table properties
available for each table, see the Data Exports table dictionary
or use the ListTables
API to get a response of all tables and their
available properties.
515 516 517 518 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 515 def create_export(params = {}, = {}) req = build_request(:create_export, params) req.send_request() end |
#delete_export(params = {}) ⇒ Types::DeleteExportResponse
Deletes an existing data export.
543 544 545 546 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 543 def delete_export(params = {}, = {}) req = build_request(:delete_export, params) req.send_request() end |
#get_execution(params = {}) ⇒ Types::GetExecutionResponse
Exports data based on the source data update.
598 599 600 601 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 598 def get_execution(params = {}, = {}) req = build_request(:get_execution, params) req.send_request() end |
#get_export(params = {}) ⇒ Types::GetExportResponse
Views the definition of an existing data export.
646 647 648 649 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 646 def get_export(params = {}, = {}) req = build_request(:get_export, params) req.send_request() end |
#get_table(params = {}) ⇒ Types::GetTableResponse
Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.
696 697 698 699 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 696 def get_table(params = {}, = {}) req = build_request(:get_table, params) req.send_request() end |
#list_executions(params = {}) ⇒ Types::ListExecutionsResponse
Lists the historical executions for the export.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
742 743 744 745 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 742 def list_executions(params = {}, = {}) req = build_request(:list_executions, params) req.send_request() end |
#list_exports(params = {}) ⇒ Types::ListExportsResponse
Lists all data export definitions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
785 786 787 788 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 785 def list_exports(params = {}, = {}) req = build_request(:list_exports, params) req.send_request() end |
#list_tables(params = {}) ⇒ Types::ListTablesResponse
Lists all available tables in data exports.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
829 830 831 832 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 829 def list_tables(params = {}, = {}) req = build_request(:list_tables, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List tags associated with an existing data export.
869 870 871 872 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 869 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags for an existing data export definition.
901 902 903 904 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 901 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes tags associated with an existing data export definition.
927 928 929 930 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 927 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_export(params = {}) ⇒ Types::UpdateExportResponse
Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.
988 989 990 991 |
# File 'gems/aws-sdk-bcmdataexports/lib/aws-sdk-bcmdataexports/client.rb', line 988 def update_export(params = {}, = {}) req = build_request(:update_export, params) req.send_request() end |