aws-sdk-kafka 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0f626b4a3502ddc7a5e785dc3cef37682967e825
4
+ data.tar.gz: 1e2fb4cde98675ea898ad2ca3a9e224339f66635
5
+ SHA512:
6
+ metadata.gz: eb567aed6ce3d08b73915fefb49f486193f3953fa6d58ef53ae0b96e1aa113f6a1cadf58252b6a097131fef901d20a601859b02e7549dcc799de659f8b9a9c17
7
+ data.tar.gz: e53bc3dd4b34fd1e8e8eaea38ce7a517815e499ca18a7c92712c0a4b5d944251e6f144e3685c6214abf3f91135f16086636ec892c54458e9e2d973132e03f5b8
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-kafka/types'
12
+ require_relative 'aws-sdk-kafka/client_api'
13
+ require_relative 'aws-sdk-kafka/client'
14
+ require_relative 'aws-sdk-kafka/errors'
15
+ require_relative 'aws-sdk-kafka/resource'
16
+ require_relative 'aws-sdk-kafka/customizations'
17
+
18
+ # This module provides support for Managed Streaming for Kafka. This module is available in the
19
+ # `aws-sdk-kafka` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Managed Streaming for Kafka all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::Kafka::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::Kafka
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,520 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
19
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
20
+ require 'aws-sdk-core/plugins/response_paging.rb'
21
+ require 'aws-sdk-core/plugins/stub_responses.rb'
22
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
23
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
+ require 'aws-sdk-core/plugins/signature_v4.rb'
27
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
28
+
29
+ Aws::Plugins::GlobalConfiguration.add_identifier(:kafka)
30
+
31
+ module Aws::Kafka
32
+ class Client < Seahorse::Client::Base
33
+
34
+ include Aws::ClientStubs
35
+
36
+ @identifier = :kafka
37
+
38
+ set_api(ClientApi::API)
39
+
40
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
41
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
42
+ add_plugin(Aws::Plugins::Logging)
43
+ add_plugin(Aws::Plugins::ParamConverter)
44
+ add_plugin(Aws::Plugins::ParamValidator)
45
+ add_plugin(Aws::Plugins::UserAgent)
46
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
47
+ add_plugin(Aws::Plugins::RetryErrors)
48
+ add_plugin(Aws::Plugins::GlobalConfiguration)
49
+ add_plugin(Aws::Plugins::RegionalEndpoint)
50
+ add_plugin(Aws::Plugins::EndpointDiscovery)
51
+ add_plugin(Aws::Plugins::EndpointPattern)
52
+ add_plugin(Aws::Plugins::ResponsePaging)
53
+ add_plugin(Aws::Plugins::StubResponses)
54
+ add_plugin(Aws::Plugins::IdempotencyToken)
55
+ add_plugin(Aws::Plugins::JsonvalueConverter)
56
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
57
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
58
+ add_plugin(Aws::Plugins::SignatureV4)
59
+ add_plugin(Aws::Plugins::Protocols::RestJson)
60
+
61
+ # @overload initialize(options)
62
+ # @param [Hash] options
63
+ # @option options [required, Aws::CredentialProvider] :credentials
64
+ # Your AWS credentials. This can be an instance of any one of the
65
+ # following classes:
66
+ #
67
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
68
+ # credentials.
69
+ #
70
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
71
+ # from an EC2 IMDS on an EC2 instance.
72
+ #
73
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
74
+ # shared file, such as `~/.aws/config`.
75
+ #
76
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
77
+ #
78
+ # When `:credentials` are not configured directly, the following
79
+ # locations will be searched for credentials:
80
+ #
81
+ # * `Aws.config[:credentials]`
82
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
83
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
84
+ # * `~/.aws/credentials`
85
+ # * `~/.aws/config`
86
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
87
+ # very aggressive. Construct and pass an instance of
88
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
89
+ # timeouts.
90
+ #
91
+ # @option options [required, String] :region
92
+ # The AWS region to connect to. The configured `:region` is
93
+ # used to determine the service `:endpoint`. When not passed,
94
+ # a default `:region` is search for in the following locations:
95
+ #
96
+ # * `Aws.config[:region]`
97
+ # * `ENV['AWS_REGION']`
98
+ # * `ENV['AMAZON_REGION']`
99
+ # * `ENV['AWS_DEFAULT_REGION']`
100
+ # * `~/.aws/credentials`
101
+ # * `~/.aws/config`
102
+ #
103
+ # @option options [String] :access_key_id
104
+ #
105
+ # @option options [Boolean] :active_endpoint_cache (false)
106
+ # When set to `true`, a thread polling for endpoints will be running in
107
+ # the background every 60 secs (default). Defaults to `false`.
108
+ #
109
+ # @option options [Boolean] :client_side_monitoring (false)
110
+ # When `true`, client-side metrics will be collected for all API requests from
111
+ # this client.
112
+ #
113
+ # @option options [String] :client_side_monitoring_client_id ("")
114
+ # Allows you to provide an identifier for this client which will be attached to
115
+ # all generated client side metrics. Defaults to an empty string.
116
+ #
117
+ # @option options [Integer] :client_side_monitoring_port (31000)
118
+ # Required for publishing client metrics. The port that the client side monitoring
119
+ # agent is running on, where client metrics will be published via UDP.
120
+ #
121
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
122
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
123
+ # will use the Client Side Monitoring Agent Publisher.
124
+ #
125
+ # @option options [Boolean] :convert_params (true)
126
+ # When `true`, an attempt is made to coerce request parameters into
127
+ # the required types.
128
+ #
129
+ # @option options [Boolean] :disable_host_prefix_injection (false)
130
+ # Set to true to disable SDK automatically adding host prefix
131
+ # to default service endpoint when available.
132
+ #
133
+ # @option options [String] :endpoint
134
+ # The client endpoint is normally constructed from the `:region`
135
+ # option. You should only configure an `:endpoint` when connecting
136
+ # to test endpoints. This should be avalid HTTP(S) URI.
137
+ #
138
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
139
+ # Used for the maximum size limit of the LRU cache storing endpoints data
140
+ # for endpoint discovery enabled operations. Defaults to 1000.
141
+ #
142
+ # @option options [Integer] :endpoint_cache_max_threads (10)
143
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
144
+ #
145
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
146
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
147
+ # Use this option to config the time interval in seconds for making
148
+ # requests fetching endpoints information. Defaults to 60 sec.
149
+ #
150
+ # @option options [Boolean] :endpoint_discovery (false)
151
+ # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
152
+ #
153
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
154
+ # The log formatter.
155
+ #
156
+ # @option options [Symbol] :log_level (:info)
157
+ # The log level to send messages to the `:logger` at.
158
+ #
159
+ # @option options [Logger] :logger
160
+ # The Logger instance to send log messages to. If this option
161
+ # is not set, logging will be disabled.
162
+ #
163
+ # @option options [String] :profile ("default")
164
+ # Used when loading credentials from the shared credentials file
165
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
166
+ #
167
+ # @option options [Float] :retry_base_delay (0.3)
168
+ # The base delay in seconds used by the default backoff function.
169
+ #
170
+ # @option options [Symbol] :retry_jitter (:none)
171
+ # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
172
+ #
173
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
174
+ #
175
+ # @option options [Integer] :retry_limit (3)
176
+ # The maximum number of times to retry failed requests. Only
177
+ # ~ 500 level server errors and certain ~ 400 level client errors
178
+ # are retried. Generally, these are throttling errors, data
179
+ # checksum errors, networking errors, timeout errors and auth
180
+ # errors from expired credentials.
181
+ #
182
+ # @option options [Integer] :retry_max_delay (0)
183
+ # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
184
+ #
185
+ # @option options [String] :secret_access_key
186
+ #
187
+ # @option options [String] :session_token
188
+ #
189
+ # @option options [Boolean] :stub_responses (false)
190
+ # Causes the client to return stubbed responses. By default
191
+ # fake responses are generated and returned. You can specify
192
+ # the response data to return or errors to raise by calling
193
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
194
+ #
195
+ # ** Please note ** When response stubbing is enabled, no HTTP
196
+ # requests are made, and retries are disabled.
197
+ #
198
+ # @option options [Boolean] :validate_params (true)
199
+ # When `true`, request parameters are validated before
200
+ # sending the request.
201
+ #
202
+ def initialize(*args)
203
+ super
204
+ end
205
+
206
+ # @!group API Operations
207
+
208
+ # Creates a new MSK cluster.
209
+ #
210
+ # @option params [required, Types::BrokerNodeGroupInfo] :broker_node_group_info
211
+ # Information about the broker nodes in the cluster.
212
+ #
213
+ # @option params [required, String] :cluster_name
214
+ # The name of the cluster.
215
+ #
216
+ # @option params [Types::EncryptionInfo] :encryption_info
217
+ # Includes all encryption-related information.
218
+ #
219
+ # @option params [String] :enhanced_monitoring
220
+ # Specifies the level of monitoring for the MSK cluster. The possible
221
+ # values are DEFAULT, PER\_BROKER, and PER\_TOPIC\_PER\_BROKER.
222
+ #
223
+ # @option params [required, String] :kafka_version
224
+ # The version of Apache Kafka.
225
+ #
226
+ # @option params [required, Integer] :number_of_broker_nodes
227
+ # The number of Kafka broker nodes in the Amazon MSK cluster.
228
+ #
229
+ # @return [Types::CreateClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
230
+ #
231
+ # * {Types::CreateClusterResponse#cluster_arn #cluster_arn} => String
232
+ # * {Types::CreateClusterResponse#cluster_name #cluster_name} => String
233
+ # * {Types::CreateClusterResponse#state #state} => String
234
+ #
235
+ # @example Request syntax with placeholder values
236
+ #
237
+ # resp = client.create_cluster({
238
+ # broker_node_group_info: { # required
239
+ # broker_az_distribution: "DEFAULT", # accepts DEFAULT
240
+ # client_subnets: ["__string"], # required
241
+ # instance_type: "__stringMin5Max32", # required
242
+ # security_groups: ["__string"],
243
+ # storage_info: {
244
+ # ebs_storage_info: {
245
+ # volume_size: 1,
246
+ # },
247
+ # },
248
+ # },
249
+ # cluster_name: "__stringMin1Max64", # required
250
+ # encryption_info: {
251
+ # encryption_at_rest: {
252
+ # data_volume_kms_key_id: "__string", # required
253
+ # },
254
+ # },
255
+ # enhanced_monitoring: "DEFAULT", # accepts DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER
256
+ # kafka_version: "__stringMin1Max128", # required
257
+ # number_of_broker_nodes: 1, # required
258
+ # })
259
+ #
260
+ # @example Response structure
261
+ #
262
+ # resp.cluster_arn #=> String
263
+ # resp.cluster_name #=> String
264
+ # resp.state #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED"
265
+ #
266
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/CreateCluster AWS API Documentation
267
+ #
268
+ # @overload create_cluster(params = {})
269
+ # @param [Hash] params ({})
270
+ def create_cluster(params = {}, options = {})
271
+ req = build_request(:create_cluster, params)
272
+ req.send_request(options)
273
+ end
274
+
275
+ # Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in
276
+ # the request.
277
+ #
278
+ # @option params [required, String] :cluster_arn
279
+ #
280
+ # @option params [String] :current_version
281
+ #
282
+ # @return [Types::DeleteClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
283
+ #
284
+ # * {Types::DeleteClusterResponse#cluster_arn #cluster_arn} => String
285
+ # * {Types::DeleteClusterResponse#state #state} => String
286
+ #
287
+ # @example Request syntax with placeholder values
288
+ #
289
+ # resp = client.delete_cluster({
290
+ # cluster_arn: "__string", # required
291
+ # current_version: "__string",
292
+ # })
293
+ #
294
+ # @example Response structure
295
+ #
296
+ # resp.cluster_arn #=> String
297
+ # resp.state #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED"
298
+ #
299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DeleteCluster AWS API Documentation
300
+ #
301
+ # @overload delete_cluster(params = {})
302
+ # @param [Hash] params ({})
303
+ def delete_cluster(params = {}, options = {})
304
+ req = build_request(:delete_cluster, params)
305
+ req.send_request(options)
306
+ end
307
+
308
+ # Returns a description of the MSK cluster whose Amazon Resource Name
309
+ # (ARN) is specified in the request.
310
+ #
311
+ # @option params [required, String] :cluster_arn
312
+ #
313
+ # @return [Types::DescribeClusterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
314
+ #
315
+ # * {Types::DescribeClusterResponse#cluster_info #cluster_info} => Types::ClusterInfo
316
+ #
317
+ # @example Request syntax with placeholder values
318
+ #
319
+ # resp = client.describe_cluster({
320
+ # cluster_arn: "__string", # required
321
+ # })
322
+ #
323
+ # @example Response structure
324
+ #
325
+ # resp.cluster_info.broker_node_group_info.broker_az_distribution #=> String, one of "DEFAULT"
326
+ # resp.cluster_info.broker_node_group_info.client_subnets #=> Array
327
+ # resp.cluster_info.broker_node_group_info.client_subnets[0] #=> String
328
+ # resp.cluster_info.broker_node_group_info.instance_type #=> String
329
+ # resp.cluster_info.broker_node_group_info.security_groups #=> Array
330
+ # resp.cluster_info.broker_node_group_info.security_groups[0] #=> String
331
+ # resp.cluster_info.broker_node_group_info.storage_info.ebs_storage_info.volume_size #=> Integer
332
+ # resp.cluster_info.cluster_arn #=> String
333
+ # resp.cluster_info.cluster_name #=> String
334
+ # resp.cluster_info.creation_time #=> Time
335
+ # resp.cluster_info.current_broker_software_info.configuration_arn #=> String
336
+ # resp.cluster_info.current_broker_software_info.configuration_revision #=> String
337
+ # resp.cluster_info.current_broker_software_info.kafka_version #=> String
338
+ # resp.cluster_info.current_version #=> String
339
+ # resp.cluster_info.encryption_info.encryption_at_rest.data_volume_kms_key_id #=> String
340
+ # resp.cluster_info.enhanced_monitoring #=> String, one of "DEFAULT", "PER_BROKER", "PER_TOPIC_PER_BROKER"
341
+ # resp.cluster_info.number_of_broker_nodes #=> Integer
342
+ # resp.cluster_info.state #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED"
343
+ # resp.cluster_info.zookeeper_connect_string #=> String
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/DescribeCluster AWS API Documentation
346
+ #
347
+ # @overload describe_cluster(params = {})
348
+ # @param [Hash] params ({})
349
+ def describe_cluster(params = {}, options = {})
350
+ req = build_request(:describe_cluster, params)
351
+ req.send_request(options)
352
+ end
353
+
354
+ # A list of brokers that a client application can use to bootstrap.
355
+ #
356
+ # @option params [required, String] :cluster_arn
357
+ #
358
+ # @return [Types::GetBootstrapBrokersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
359
+ #
360
+ # * {Types::GetBootstrapBrokersResponse#bootstrap_broker_string #bootstrap_broker_string} => String
361
+ #
362
+ # @example Request syntax with placeholder values
363
+ #
364
+ # resp = client.get_bootstrap_brokers({
365
+ # cluster_arn: "__string", # required
366
+ # })
367
+ #
368
+ # @example Response structure
369
+ #
370
+ # resp.bootstrap_broker_string #=> String
371
+ #
372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/GetBootstrapBrokers AWS API Documentation
373
+ #
374
+ # @overload get_bootstrap_brokers(params = {})
375
+ # @param [Hash] params ({})
376
+ def get_bootstrap_brokers(params = {}, options = {})
377
+ req = build_request(:get_bootstrap_brokers, params)
378
+ req.send_request(options)
379
+ end
380
+
381
+ # Returns a list of clusters in an account.
382
+ #
383
+ # @option params [String] :cluster_name_filter
384
+ #
385
+ # @option params [Integer] :max_results
386
+ #
387
+ # @option params [String] :next_token
388
+ #
389
+ # @return [Types::ListClustersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
390
+ #
391
+ # * {Types::ListClustersResponse#cluster_info_list #cluster_info_list} => Array&lt;Types::ClusterInfo&gt;
392
+ # * {Types::ListClustersResponse#next_token #next_token} => String
393
+ #
394
+ # @example Request syntax with placeholder values
395
+ #
396
+ # resp = client.list_clusters({
397
+ # cluster_name_filter: "__string",
398
+ # max_results: 1,
399
+ # next_token: "__string",
400
+ # })
401
+ #
402
+ # @example Response structure
403
+ #
404
+ # resp.cluster_info_list #=> Array
405
+ # resp.cluster_info_list[0].broker_node_group_info.broker_az_distribution #=> String, one of "DEFAULT"
406
+ # resp.cluster_info_list[0].broker_node_group_info.client_subnets #=> Array
407
+ # resp.cluster_info_list[0].broker_node_group_info.client_subnets[0] #=> String
408
+ # resp.cluster_info_list[0].broker_node_group_info.instance_type #=> String
409
+ # resp.cluster_info_list[0].broker_node_group_info.security_groups #=> Array
410
+ # resp.cluster_info_list[0].broker_node_group_info.security_groups[0] #=> String
411
+ # resp.cluster_info_list[0].broker_node_group_info.storage_info.ebs_storage_info.volume_size #=> Integer
412
+ # resp.cluster_info_list[0].cluster_arn #=> String
413
+ # resp.cluster_info_list[0].cluster_name #=> String
414
+ # resp.cluster_info_list[0].creation_time #=> Time
415
+ # resp.cluster_info_list[0].current_broker_software_info.configuration_arn #=> String
416
+ # resp.cluster_info_list[0].current_broker_software_info.configuration_revision #=> String
417
+ # resp.cluster_info_list[0].current_broker_software_info.kafka_version #=> String
418
+ # resp.cluster_info_list[0].current_version #=> String
419
+ # resp.cluster_info_list[0].encryption_info.encryption_at_rest.data_volume_kms_key_id #=> String
420
+ # resp.cluster_info_list[0].enhanced_monitoring #=> String, one of "DEFAULT", "PER_BROKER", "PER_TOPIC_PER_BROKER"
421
+ # resp.cluster_info_list[0].number_of_broker_nodes #=> Integer
422
+ # resp.cluster_info_list[0].state #=> String, one of "ACTIVE", "CREATING", "DELETING", "FAILED"
423
+ # resp.cluster_info_list[0].zookeeper_connect_string #=> String
424
+ # resp.next_token #=> String
425
+ #
426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListClusters AWS API Documentation
427
+ #
428
+ # @overload list_clusters(params = {})
429
+ # @param [Hash] params ({})
430
+ def list_clusters(params = {}, options = {})
431
+ req = build_request(:list_clusters, params)
432
+ req.send_request(options)
433
+ end
434
+
435
+ # Returns a list of the broker nodes in the cluster.
436
+ #
437
+ # @option params [required, String] :cluster_arn
438
+ #
439
+ # @option params [Integer] :max_results
440
+ #
441
+ # @option params [String] :next_token
442
+ #
443
+ # @return [Types::ListNodesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
444
+ #
445
+ # * {Types::ListNodesResponse#next_token #next_token} => String
446
+ # * {Types::ListNodesResponse#node_info_list #node_info_list} => Array&lt;Types::NodeInfo&gt;
447
+ #
448
+ # @example Request syntax with placeholder values
449
+ #
450
+ # resp = client.list_nodes({
451
+ # cluster_arn: "__string", # required
452
+ # max_results: 1,
453
+ # next_token: "__string",
454
+ # })
455
+ #
456
+ # @example Response structure
457
+ #
458
+ # resp.next_token #=> String
459
+ # resp.node_info_list #=> Array
460
+ # resp.node_info_list[0].added_to_cluster_time #=> String
461
+ # resp.node_info_list[0].broker_node_info.attached_eni_id #=> String
462
+ # resp.node_info_list[0].broker_node_info.broker_id #=> Float
463
+ # resp.node_info_list[0].broker_node_info.client_subnet #=> String
464
+ # resp.node_info_list[0].broker_node_info.client_vpc_ip_address #=> String
465
+ # resp.node_info_list[0].broker_node_info.current_broker_software_info.configuration_arn #=> String
466
+ # resp.node_info_list[0].broker_node_info.current_broker_software_info.configuration_revision #=> String
467
+ # resp.node_info_list[0].broker_node_info.current_broker_software_info.kafka_version #=> String
468
+ # resp.node_info_list[0].instance_type #=> String
469
+ # resp.node_info_list[0].node_arn #=> String
470
+ # resp.node_info_list[0].node_type #=> String, one of "BROKER"
471
+ # resp.node_info_list[0].zookeeper_node_info.attached_eni_id #=> String
472
+ # resp.node_info_list[0].zookeeper_node_info.client_vpc_ip_address #=> String
473
+ # resp.node_info_list[0].zookeeper_node_info.zookeeper_id #=> Float
474
+ # resp.node_info_list[0].zookeeper_node_info.zookeeper_version #=> String
475
+ #
476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/ListNodes AWS API Documentation
477
+ #
478
+ # @overload list_nodes(params = {})
479
+ # @param [Hash] params ({})
480
+ def list_nodes(params = {}, options = {})
481
+ req = build_request(:list_nodes, params)
482
+ req.send_request(options)
483
+ end
484
+
485
+ # @!endgroup
486
+
487
+ # @param params ({})
488
+ # @api private
489
+ def build_request(operation_name, params = {})
490
+ handlers = @handlers.for(operation_name)
491
+ context = Seahorse::Client::RequestContext.new(
492
+ operation_name: operation_name,
493
+ operation: config.api.operation(operation_name),
494
+ client: self,
495
+ params: params,
496
+ config: config)
497
+ context[:gem_name] = 'aws-sdk-kafka'
498
+ context[:gem_version] = '1.0.0'
499
+ Seahorse::Client::Request.new(handlers, context)
500
+ end
501
+
502
+ # @api private
503
+ # @deprecated
504
+ def waiter_names
505
+ []
506
+ end
507
+
508
+ class << self
509
+
510
+ # @api private
511
+ attr_reader :identifier
512
+
513
+ # @api private
514
+ def errors_module
515
+ Errors
516
+ end
517
+
518
+ end
519
+ end
520
+ end