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.
385 386 387 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_connector(params = {}) ⇒ Types::CreateConnectorResponse
Creates a connector using the specified properties.
525 526 527 528 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 525 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.
577 578 579 580 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 577 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.
621 622 623 624 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 621 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.
656 657 658 659 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 656 def delete_connector(params = {}, = {}) req = build_request(:delete_connector, params) req.send_request() end |
#delete_custom_plugin(params = {}) ⇒ Types::DeleteCustomPluginResponse
Deletes a custom plugin.
687 688 689 690 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 687 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.
769 770 771 772 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 769 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.
818 819 820 821 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 818 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.
858 859 860 861 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 858 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.
938 939 940 941 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 938 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.
991 992 993 994 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 991 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.
1038 1039 1040 1041 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 1038 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.
1093 1094 1095 1096 |
# File 'gems/aws-sdk-kafkaconnect/lib/aws-sdk-kafkaconnect/client.rb', line 1093 def update_connector(params = {}, = {}) req = build_request(:update_connector, params) req.send_request() end |