Class: Aws::KafkaConnect::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::KafkaConnect::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb
Overview
An API client for KafkaConnect. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::KafkaConnect::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_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates a connector using the specified properties.
-
#create_custom_plugin(params = {}) ⇒ Types::CreateCustomPluginResponse
Creates a custom plugin using the specified properties.
-
#create_worker_configuration(params = {}) ⇒ Types::CreateWorkerConfigurationResponse
Creates a worker configuration using the specified properties.
-
#delete_connector(params = {}) ⇒ Types::DeleteConnectorResponse
Deletes the specified connector.
-
#delete_custom_plugin(params = {}) ⇒ Types::DeleteCustomPluginResponse
Deletes a custom plugin.
-
#describe_connector(params = {}) ⇒ Types::DescribeConnectorResponse
Returns summary information about the connector.
-
#describe_custom_plugin(params = {}) ⇒ Types::DescribeCustomPluginResponse
A summary description of the custom plugin.
-
#describe_worker_configuration(params = {}) ⇒ Types::DescribeWorkerConfigurationResponse
Returns information about a worker configuration.
-
#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse
Returns a list of all the connectors in this account and Region.
-
#list_custom_plugins(params = {}) ⇒ Types::ListCustomPluginsResponse
Returns a list of all of the custom plugins in this account and Region.
-
#list_worker_configurations(params = {}) ⇒ Types::ListWorkerConfigurationsResponse
Returns a list of all of the worker configurations in this account and Region.
-
#update_connector(params = {}) ⇒ Types::UpdateConnectorResponse
Updates the specified connector.
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.
365 366 367 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 365 def initialize(*args) super end |
Instance Method Details
#create_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates a connector using the specified properties.
505 506 507 508 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 505 def create_connector(params = {}, = {}) req = build_request(:create_connector, params) req.send_request() end |
#create_custom_plugin(params = {}) ⇒ Types::CreateCustomPluginResponse
Creates a custom plugin using the specified properties.
557 558 559 560 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 557 def create_custom_plugin(params = {}, = {}) req = build_request(:create_custom_plugin, params) req.send_request() end |
#create_worker_configuration(params = {}) ⇒ Types::CreateWorkerConfigurationResponse
Creates a worker configuration using the specified properties.
601 602 603 604 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 601 def create_worker_configuration(params = {}, = {}) req = build_request(:create_worker_configuration, params) req.send_request() end |
#delete_connector(params = {}) ⇒ Types::DeleteConnectorResponse
Deletes the specified connector.
636 637 638 639 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 636 def delete_connector(params = {}, = {}) req = build_request(:delete_connector, params) req.send_request() end |
#delete_custom_plugin(params = {}) ⇒ Types::DeleteCustomPluginResponse
Deletes a custom plugin.
667 668 669 670 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 667 def delete_custom_plugin(params = {}, = {}) req = build_request(:delete_custom_plugin, params) req.send_request() end |
#describe_connector(params = {}) ⇒ Types::DescribeConnectorResponse
Returns summary information about the connector.
749 750 751 752 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 749 def describe_connector(params = {}, = {}) req = build_request(:describe_connector, params) req.send_request() end |
#describe_custom_plugin(params = {}) ⇒ Types::DescribeCustomPluginResponse
A summary description of the custom plugin.
798 799 800 801 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 798 def describe_custom_plugin(params = {}, = {}) req = build_request(:describe_custom_plugin, params) req.send_request() end |
#describe_worker_configuration(params = {}) ⇒ Types::DescribeWorkerConfigurationResponse
Returns information about a worker configuration.
838 839 840 841 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 838 def describe_worker_configuration(params = {}, = {}) req = build_request(:describe_worker_configuration, params) req.send_request() end |
#list_connectors(params = {}) ⇒ Types::ListConnectorsResponse
Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
918 919 920 921 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 918 def list_connectors(params = {}, = {}) req = build_request(:list_connectors, params) req.send_request() end |
#list_custom_plugins(params = {}) ⇒ Types::ListCustomPluginsResponse
Returns a list of all of the custom plugins in this account and Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
971 972 973 974 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 971 def list_custom_plugins(params = {}, = {}) req = build_request(:list_custom_plugins, params) req.send_request() end |
#list_worker_configurations(params = {}) ⇒ Types::ListWorkerConfigurationsResponse
Returns a list of all of the worker configurations in this account and Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1018 1019 1020 1021 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 1018 def list_worker_configurations(params = {}, = {}) req = build_request(:list_worker_configurations, params) req.send_request() end |
#update_connector(params = {}) ⇒ Types::UpdateConnectorResponse
Updates the specified connector.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 1073 def update_connector(params = {}, = {}) req = build_request(:update_connector, params) req.send_request() end |