Class: Aws::Kafka::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Kafka::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb
Overview
An API client for Kafka. To construct a client, you need to configure a :region and :credentials.
client = Aws::Kafka::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
-
#batch_associate_scram_secret(params = {}) ⇒ Types::BatchAssociateScramSecretResponse
Associates one or more Scram Secrets with an Amazon MSK cluster.
-
#batch_disassociate_scram_secret(params = {}) ⇒ Types::BatchDisassociateScramSecretResponse
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
-
#create_assessment(params = {}) ⇒ Types::CreateAssessmentResponse
Creates a new assessment for the specified cluster.
-
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new MSK cluster.
-
#create_cluster_v2(params = {}) ⇒ Types::CreateClusterV2Response
Creates a new Amazon MSK cluster of either the provisioned or the serverless type.
-
#create_configuration(params = {}) ⇒ Types::CreateConfigurationResponse
Creates a new MSK configuration.
-
#create_replicator(params = {}) ⇒ Types::CreateReplicatorResponse
Creates a new Kafka Replicator.
-
#create_topic(params = {}) ⇒ Types::CreateTopicResponse
Creates a topic in the specified MSK cluster.
-
#create_vpc_connection(params = {}) ⇒ Types::CreateVpcConnectionResponse
Creates a new Amazon MSK VPC connection.
-
#delete_assessment(params = {}) ⇒ Types::DeleteAssessmentResponse
Deletes an assessment and its findings.
-
#delete_channel(params = {}) ⇒ Types::DeleteChannelResponse
Deletes the channel specified by channelArn from the cluster specified by clusterArn.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
-
#delete_cluster_policy(params = {}) ⇒ Struct
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in your request.
-
#delete_configuration(params = {}) ⇒ Types::DeleteConfigurationResponse
Deletes the specified MSK configuration.
-
#delete_replicator(params = {}) ⇒ Types::DeleteReplicatorResponse
Deletes a replicator.
-
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic in the specified MSK cluster.
-
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVpcConnectionResponse
Deletes the Amazon MSK VPC connection specified in your request.
-
#describe_assessment(params = {}) ⇒ Types::DescribeAssessmentResponse
Returns the status and summary of an assessment.
-
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Returns the current configuration and state of a channel.
-
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
-
#describe_cluster_operation(params = {}) ⇒ Types::DescribeClusterOperationResponse
Returns a description of the cluster operation specified by the ARN.
-
#describe_cluster_operation_v2(params = {}) ⇒ Types::DescribeClusterOperationV2Response
Returns a description of the cluster operation specified by the ARN.
-
#describe_cluster_v2(params = {}) ⇒ Types::DescribeClusterV2Response
Returns a description of the MSK cluster of either the provisioned or the serverless type whose Amazon Resource Name (ARN) is specified in the request.
-
#describe_configuration(params = {}) ⇒ Types::DescribeConfigurationResponse
Returns a description of this MSK configuration.
-
#describe_configuration_revision(params = {}) ⇒ Types::DescribeConfigurationRevisionResponse
Returns a description of this revision of the configuration.
-
#describe_replicator(params = {}) ⇒ Types::DescribeReplicatorResponse
Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.
-
#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse
Returns topic details of this topic on a MSK cluster.
-
#describe_topic_partitions(params = {}) ⇒ Types::DescribeTopicPartitionsResponse
Returns partition details of this topic on a MSK cluster.
-
#describe_topic_reassignment(params = {}) ⇒ Types::DescribeTopicReassignmentResponse
Returns the status and progress of a topic reassignment operation.
-
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVpcConnectionResponse
Displays information about the specified Amazon MSK VPC connection.
-
#get_bootstrap_brokers(params = {}) ⇒ Types::GetBootstrapBrokersResponse
A list of brokers that a client application can use to bootstrap.
-
#get_cluster_policy(params = {}) ⇒ Types::GetClusterPolicyResponse
Retrieves the contents of the specified MSK cluster policy.
-
#get_compatible_kafka_versions(params = {}) ⇒ Types::GetCompatibleKafkaVersionsResponse
Gets the Apache Kafka versions to which you can update the MSK cluster.
-
#list_assessment_findings(params = {}) ⇒ Types::ListAssessmentFindingsResponse
Returns the findings for a completed assessment.
-
#list_assessments(params = {}) ⇒ Types::ListAssessmentsResponse
Returns a list of assessments for the specified cluster.
-
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Returns the list of channels in a cluster.
-
#list_client_vpc_connections(params = {}) ⇒ Types::ListClientVpcConnectionsResponse
Displays a list of client VPC connections.
-
#list_cluster_operations(params = {}) ⇒ Types::ListClusterOperationsResponse
Returns a list of all the operations that have been performed on the specified MSK cluster.
-
#list_cluster_operations_v2(params = {}) ⇒ Types::ListClusterOperationsV2Response
Returns a list of all the operations that have been performed on the specified MSK cluster.
-
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of all the MSK clusters in the current Region.
-
#list_clusters_v2(params = {}) ⇒ Types::ListClustersV2Response
Returns a list of all the MSK clusters in the current Region.
-
#list_configuration_revisions(params = {}) ⇒ Types::ListConfigurationRevisionsResponse
Returns a list of all the revisions of an MSK configuration.
-
#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse
Returns a list of all the MSK configurations in this Region.
-
#list_kafka_versions(params = {}) ⇒ Types::ListKafkaVersionsResponse
Returns a list of Apache Kafka versions.
-
#list_nodes(params = {}) ⇒ Types::ListNodesResponse
Returns a list of the broker nodes in the cluster.
-
#list_replicators(params = {}) ⇒ Types::ListReplicatorsResponse
Lists the replicators.
-
#list_scram_secrets(params = {}) ⇒ Types::ListScramSecretsResponse
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags associated with the specified resource.
-
#list_topic_reassignments(params = {}) ⇒ Types::ListTopicReassignmentsResponse
Lists topic reassignment operations for a cluster.
-
#list_topics(params = {}) ⇒ Types::ListTopicsResponse
List topics in a MSK cluster.
-
#list_vpc_connections(params = {}) ⇒ Types::ListVpcConnectionsResponse
Displays a list of Amazon MSK VPC connections.
-
#put_cluster_policy(params = {}) ⇒ Types::PutClusterPolicyResponse
Creates or updates the specified MSK cluster policy.
-
#reboot_broker(params = {}) ⇒ Types::RebootBrokerResponse
Executes a reboot on a broker.
-
#reject_client_vpc_connection(params = {}) ⇒ Struct
Returns an empty response.
-
#start_topic_reassignment(params = {}) ⇒ Types::StartTopicReassignmentResponse
Initiates topic partition reassignment between broker types in a mixed-mode cluster.
-
#stop_topic_reassignment(params = {}) ⇒ Types::StopTopicReassignmentResponse
Stops an active topic reassignment operation.
-
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified MSK resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the tags associated with the keys that are provided in the query.
-
#update_broker_count(params = {}) ⇒ Types::UpdateBrokerCountResponse
Updates the number of broker nodes in the cluster.
-
#update_broker_storage(params = {}) ⇒ Types::UpdateBrokerStorageResponse
Updates the EBS storage associated with MSK brokers.
-
#update_broker_type(params = {}) ⇒ Types::UpdateBrokerTypeResponse
Updates all the brokers in the cluster to the specified type.
-
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Updates the destination configuration of an existing channel.
-
#update_cluster_configuration(params = {}) ⇒ Types::UpdateClusterConfigurationResponse
Updates the cluster with the configuration that is specified in the request body.
-
#update_cluster_kafka_version(params = {}) ⇒ Types::UpdateClusterKafkaVersionResponse
Updates the Apache Kafka version for the cluster.
-
#update_configuration(params = {}) ⇒ Types::UpdateConfigurationResponse
Updates an existing MSK configuration.
-
#update_connectivity(params = {}) ⇒ Types::UpdateConnectivityResponse
Updates the connectivity configuration for the MSK cluster.
-
#update_monitoring(params = {}) ⇒ Types::UpdateMonitoringResponse
Updates the monitoring settings for the cluster.
-
#update_rebalancing(params = {}) ⇒ Types::UpdateRebalancingResponse
Use this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.
-
#update_replication_info(params = {}) ⇒ Types::UpdateReplicationInfoResponse
Updates replication info of a replicator.
-
#update_security(params = {}) ⇒ Types::UpdateSecurityResponse
You can use this operation to update the encrypting and authentication settings for an existing cluster.
-
#update_storage(params = {}) ⇒ Types::UpdateStorageResponse
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
-
#update_topic(params = {}) ⇒ Types::UpdateTopicResponse
Updates the topic configuration or partition count in the specified MSK cluster.
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.
479 480 481 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 479 def initialize(*args) super end |
Instance Method Details
#batch_associate_scram_secret(params = {}) ⇒ Types::BatchAssociateScramSecretResponse
Associates one or more Scram Secrets with an Amazon MSK cluster.
516 517 518 519 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 516 def batch_associate_scram_secret(params = {}, = {}) req = build_request(:batch_associate_scram_secret, params) req.send_request() end |
#batch_disassociate_scram_secret(params = {}) ⇒ Types::BatchDisassociateScramSecretResponse
Disassociates one or more Scram Secrets from an Amazon MSK cluster.
2659 2660 2661 2662 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2659 def batch_disassociate_scram_secret(params = {}, = {}) req = build_request(:batch_disassociate_scram_secret, params) req.send_request() end |
#create_assessment(params = {}) ⇒ Types::CreateAssessmentResponse
Creates a new assessment for the specified cluster. Kicks off an asynchronous scan.
569 570 571 572 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 569 def create_assessment(params = {}, = {}) req = build_request(:create_assessment, params) req.send_request() end |
#create_channel(params = {}) ⇒ Types::CreateChannelResponse
Creates a Channel that streams records from an Amazon MSK Express cluster topic to Amazon S3 or Apache Iceberg.
1131 1132 1133 1134 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1131 def create_channel(params = {}, = {}) req = build_request(:create_channel, params) req.send_request() end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new MSK cluster.
760 761 762 763 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 760 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_cluster_v2(params = {}) ⇒ Types::CreateClusterV2Response
Creates a new Amazon MSK cluster of either the provisioned or the serverless type.
940 941 942 943 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 940 def create_cluster_v2(params = {}, = {}) req = build_request(:create_cluster_v2, params) req.send_request() end |
#create_configuration(params = {}) ⇒ Types::CreateConfigurationResponse
Creates a new MSK configuration.
991 992 993 994 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 991 def create_configuration(params = {}, = {}) req = build_request(:create_configuration, params) req.send_request() end |
#create_replicator(params = {}) ⇒ Types::CreateReplicatorResponse
Creates a new Kafka Replicator.
1282 1283 1284 1285 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1282 def create_replicator(params = {}, = {}) req = build_request(:create_replicator, params) req.send_request() end |
#create_topic(params = {}) ⇒ Types::CreateTopicResponse
Creates a topic in the specified MSK cluster.
1325 1326 1327 1328 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1325 def create_topic(params = {}, = {}) req = build_request(:create_topic, params) req.send_request() end |
#create_vpc_connection(params = {}) ⇒ Types::CreateVpcConnectionResponse
Creates a new Amazon MSK VPC connection.
1391 1392 1393 1394 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1391 def create_vpc_connection(params = {}, = {}) req = build_request(:create_vpc_connection, params) req.send_request() end |
#delete_assessment(params = {}) ⇒ Types::DeleteAssessmentResponse
Deletes an assessment and its findings. Frees one slot against the cluster's assessment quota.
1426 1427 1428 1429 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1426 def delete_assessment(params = {}, = {}) req = build_request(:delete_assessment, params) req.send_request() end |
#delete_channel(params = {}) ⇒ Types::DeleteChannelResponse
Deletes the channel specified by channelArn from the cluster specified by clusterArn. The channel transitions through DELETING and is removed when the asynchronous delete completes.
1495 1496 1497 1498 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1495 def delete_channel(params = {}, = {}) req = build_request(:delete_channel, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1459 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_cluster_policy(params = {}) ⇒ Struct
Deletes the MSK cluster policy specified by the Amazon Resource Name (ARN) in your request.
3849 3850 3851 3852 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3849 def delete_cluster_policy(params = {}, = {}) req = build_request(:delete_cluster_policy, params) req.send_request() end |
#delete_configuration(params = {}) ⇒ Types::DeleteConfigurationResponse
Deletes the specified MSK configuration. The configuration must be in the ACTIVE or DELETE_FAILED state.
1526 1527 1528 1529 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1526 def delete_configuration(params = {}, = {}) req = build_request(:delete_configuration, params) req.send_request() end |
#delete_replicator(params = {}) ⇒ Types::DeleteReplicatorResponse
Deletes a replicator.
1558 1559 1560 1561 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1558 def delete_replicator(params = {}, = {}) req = build_request(:delete_replicator, params) req.send_request() end |
#delete_topic(params = {}) ⇒ Types::DeleteTopicResponse
Deletes a topic in the specified MSK cluster.
1592 1593 1594 1595 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1592 def delete_topic(params = {}, = {}) req = build_request(:delete_topic, params) req.send_request() end |
#delete_vpc_connection(params = {}) ⇒ Types::DeleteVpcConnectionResponse
Deletes the Amazon MSK VPC connection specified in your request.
1621 1622 1623 1624 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1621 def delete_vpc_connection(params = {}, = {}) req = build_request(:delete_vpc_connection, params) req.send_request() end |
#describe_assessment(params = {}) ⇒ Types::DescribeAssessmentResponse
Returns the status and summary of an assessment.
1678 1679 1680 1681 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1678 def describe_assessment(params = {}, = {}) req = build_request(:describe_assessment, params) req.send_request() end |
#describe_channel(params = {}) ⇒ Types::DescribeChannelResponse
Returns the current configuration and state of a channel.
2244 2245 2246 2247 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2244 def describe_channel(params = {}, = {}) req = build_request(:describe_channel, params) req.send_request() end |
#describe_cluster(params = {}) ⇒ Types::DescribeClusterResponse
Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.
1766 1767 1768 1769 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1766 def describe_cluster(params = {}, = {}) req = build_request(:describe_cluster, params) req.send_request() end |
#describe_cluster_operation(params = {}) ⇒ Types::DescribeClusterOperationResponse
Returns a description of the cluster operation specified by the ARN.
2005 2006 2007 2008 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2005 def describe_cluster_operation(params = {}, = {}) req = build_request(:describe_cluster_operation, params) req.send_request() end |
#describe_cluster_operation_v2(params = {}) ⇒ Types::DescribeClusterOperationV2Response
Returns a description of the cluster operation specified by the ARN.
2151 2152 2153 2154 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2151 def describe_cluster_operation_v2(params = {}, = {}) req = build_request(:describe_cluster_operation_v2, params) req.send_request() end |
#describe_cluster_v2(params = {}) ⇒ Types::DescribeClusterV2Response
Returns a description of the MSK cluster of either the provisioned or the serverless type whose Amazon Resource Name (ARN) is specified in the request.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 1864 def describe_cluster_v2(params = {}, = {}) req = build_request(:describe_cluster_v2, params) req.send_request() end |
#describe_configuration(params = {}) ⇒ Types::DescribeConfigurationResponse
Returns a description of this MSK configuration.
2286 2287 2288 2289 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2286 def describe_configuration(params = {}, = {}) req = build_request(:describe_configuration, params) req.send_request() end |
#describe_configuration_revision(params = {}) ⇒ Types::DescribeConfigurationRevisionResponse
Returns a description of this revision of the configuration.
2324 2325 2326 2327 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2324 def describe_configuration_revision(params = {}, = {}) req = build_request(:describe_configuration_revision, params) req.send_request() end |
#describe_replicator(params = {}) ⇒ Types::DescribeReplicatorResponse
Returns a description of the Kafka Replicator whose Amazon Resource Name (ARN) is specified in the request.
2429 2430 2431 2432 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2429 def describe_replicator(params = {}, = {}) req = build_request(:describe_replicator, params) req.send_request() end |
#describe_topic(params = {}) ⇒ Types::DescribeTopicResponse
Returns topic details of this topic on a MSK cluster.
2472 2473 2474 2475 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2472 def describe_topic(params = {}, = {}) req = build_request(:describe_topic, params) req.send_request() end |
#describe_topic_partitions(params = {}) ⇒ Types::DescribeTopicPartitionsResponse
Returns partition details of this topic on a MSK cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2518 2519 2520 2521 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2518 def describe_topic_partitions(params = {}, = {}) req = build_request(:describe_topic_partitions, params) req.send_request() end |
#describe_topic_reassignment(params = {}) ⇒ Types::DescribeTopicReassignmentResponse
Returns the status and progress of a topic reassignment operation.
2577 2578 2579 2580 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2577 def describe_topic_reassignment(params = {}, = {}) req = build_request(:describe_topic_reassignment, params) req.send_request() end |
#describe_vpc_connection(params = {}) ⇒ Types::DescribeVpcConnectionResponse
Displays information about the specified Amazon MSK VPC connection.
2623 2624 2625 2626 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2623 def describe_vpc_connection(params = {}, = {}) req = build_request(:describe_vpc_connection, params) req.send_request() end |
#get_bootstrap_brokers(params = {}) ⇒ Types::GetBootstrapBrokersResponse
A list of brokers that a client application can use to bootstrap. This
list doesn't necessarily include all of the brokers in the cluster.
The following Python 3.6 example shows how you can use the Amazon
Resource Name (ARN) of a cluster to get its bootstrap brokers. If you
don't know the ARN of your cluster, you can use the ListClusters
operation to get the ARNs of all the clusters in this account and
Region.
2718 2719 2720 2721 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2718 def get_bootstrap_brokers(params = {}, = {}) req = build_request(:get_bootstrap_brokers, params) req.send_request() end |
#get_cluster_policy(params = {}) ⇒ Types::GetClusterPolicyResponse
Retrieves the contents of the specified MSK cluster policy.
3878 3879 3880 3881 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3878 def get_cluster_policy(params = {}, = {}) req = build_request(:get_cluster_policy, params) req.send_request() end |
#get_compatible_kafka_versions(params = {}) ⇒ Types::GetCompatibleKafkaVersionsResponse
Gets the Apache Kafka versions to which you can update the MSK cluster.
2749 2750 2751 2752 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2749 def get_compatible_kafka_versions(params = {}, = {}) req = build_request(:get_compatible_kafka_versions, params) req.send_request() end |
#list_assessment_findings(params = {}) ⇒ Types::ListAssessmentFindingsResponse
Returns the findings for a completed assessment. Paginated.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2809 2810 2811 2812 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2809 def list_assessment_findings(params = {}, = {}) req = build_request(:list_assessment_findings, params) req.send_request() end |
#list_assessments(params = {}) ⇒ Types::ListAssessmentsResponse
Returns a list of assessments for the specified cluster. Optionally filterable by assessment type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2862 2863 2864 2865 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2862 def list_assessments(params = {}, = {}) req = build_request(:list_assessments, params) req.send_request() end |
#list_channels(params = {}) ⇒ Types::ListChannelsResponse
Returns the list of channels in a cluster.
2913 2914 2915 2916 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 2913 def list_channels(params = {}, = {}) req = build_request(:list_channels, params) req.send_request() end |
#list_client_vpc_connections(params = {}) ⇒ Types::ListClientVpcConnectionsResponse
Displays a list of client VPC connections.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3666 3667 3668 3669 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3666 def list_client_vpc_connections(params = {}, = {}) req = build_request(:list_client_vpc_connections, params) req.send_request() end |
#list_cluster_operations(params = {}) ⇒ Types::ListClusterOperationsResponse
Returns a list of all the operations that have been performed on the specified MSK cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3066 3067 3068 3069 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3066 def list_cluster_operations(params = {}, = {}) req = build_request(:list_cluster_operations, params) req.send_request() end |
#list_cluster_operations_v2(params = {}) ⇒ Types::ListClusterOperationsV2Response
Returns a list of all the operations that have been performed on the specified MSK cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3111 3112 3113 3114 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3111 def list_cluster_operations_v2(params = {}, = {}) req = build_request(:list_cluster_operations_v2, params) req.send_request() end |
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of all the MSK clusters in the current Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3209 3210 3211 3212 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3209 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_clusters_v2(params = {}) ⇒ Types::ListClustersV2Response
Returns a list of all the MSK clusters in the current Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3326 3327 3328 3329 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3326 def list_clusters_v2(params = {}, = {}) req = build_request(:list_clusters_v2, params) req.send_request() end |
#list_configuration_revisions(params = {}) ⇒ Types::ListConfigurationRevisionsResponse
Returns a list of all the revisions of an MSK configuration.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3366 3367 3368 3369 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3366 def list_configuration_revisions(params = {}, = {}) req = build_request(:list_configuration_revisions, params) req.send_request() end |
#list_configurations(params = {}) ⇒ Types::ListConfigurationsResponse
Returns a list of all the MSK configurations in this Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3410 3411 3412 3413 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3410 def list_configurations(params = {}, = {}) req = build_request(:list_configurations, params) req.send_request() end |
#list_kafka_versions(params = {}) ⇒ Types::ListKafkaVersionsResponse
Returns a list of Apache Kafka versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3446 3447 3448 3449 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3446 def list_kafka_versions(params = {}, = {}) req = build_request(:list_kafka_versions, params) req.send_request() end |
#list_nodes(params = {}) ⇒ Types::ListNodesResponse
Returns a list of the broker nodes in the cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3505 3506 3507 3508 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3505 def list_nodes(params = {}, = {}) req = build_request(:list_nodes, params) req.send_request() end |
#list_replicators(params = {}) ⇒ Types::ListReplicatorsResponse
Lists the replicators.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3557 3558 3559 3560 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3557 def list_replicators(params = {}, = {}) req = build_request(:list_replicators, params) req.send_request() end |
#list_scram_secrets(params = {}) ⇒ Types::ListScramSecretsResponse
Returns a list of the Scram Secrets associated with an Amazon MSK cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3596 3597 3598 3599 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3596 def list_scram_secrets(params = {}, = {}) req = build_request(:list_scram_secrets, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of the tags associated with the specified resource.
3624 3625 3626 3627 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3624 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_topic_reassignments(params = {}) ⇒ Types::ListTopicReassignmentsResponse
Lists topic reassignment operations for a cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3718 3719 3720 3721 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3718 def list_topic_reassignments(params = {}, = {}) req = build_request(:list_topic_reassignments, params) req.send_request() end |
#list_topics(params = {}) ⇒ Types::ListTopicsResponse
List topics in a MSK cluster.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3805 3806 3807 3808 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3805 def list_topics(params = {}, = {}) req = build_request(:list_topics, params) req.send_request() end |
#list_vpc_connections(params = {}) ⇒ Types::ListVpcConnectionsResponse
Displays a list of Amazon MSK VPC connections.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3758 3759 3760 3761 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3758 def list_vpc_connections(params = {}, = {}) req = build_request(:list_vpc_connections, params) req.send_request() end |
#put_cluster_policy(params = {}) ⇒ Types::PutClusterPolicyResponse
Creates or updates the specified MSK cluster policy. If updating the policy, the currentVersion field is required in the request payload.
3912 3913 3914 3915 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3912 def put_cluster_policy(params = {}, = {}) req = build_request(:put_cluster_policy, params) req.send_request() end |
#reboot_broker(params = {}) ⇒ Types::RebootBrokerResponse
Executes a reboot on a broker.
3945 3946 3947 3948 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3945 def reboot_broker(params = {}, = {}) req = build_request(:reboot_broker, params) req.send_request() end |
#reject_client_vpc_connection(params = {}) ⇒ Struct
Returns an empty response.
3827 3828 3829 3830 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 3827 def reject_client_vpc_connection(params = {}, = {}) req = build_request(:reject_client_vpc_connection, params) req.send_request() end |
#start_topic_reassignment(params = {}) ⇒ Types::StartTopicReassignmentResponse
Initiates topic partition reassignment between broker types in a mixed-mode cluster.
4002 4003 4004 4005 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4002 def start_topic_reassignment(params = {}, = {}) req = build_request(:start_topic_reassignment, params) req.send_request() end |
#stop_topic_reassignment(params = {}) ⇒ Types::StopTopicReassignmentResponse
Stops an active topic reassignment operation.
4037 4038 4039 4040 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4037 def stop_topic_reassignment(params = {}, = {}) req = build_request(:stop_topic_reassignment, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to the specified MSK resource.
4064 4065 4066 4067 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4064 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the tags associated with the keys that are provided in the query.
4089 4090 4091 4092 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4089 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_broker_count(params = {}) ⇒ Types::UpdateBrokerCountResponse
Updates the number of broker nodes in the cluster. You can use this operation to increase the number of brokers in an existing cluster. You can't decrease the number of brokers.
4129 4130 4131 4132 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4129 def update_broker_count(params = {}, = {}) req = build_request(:update_broker_count, params) req.send_request() end |
#update_broker_storage(params = {}) ⇒ Types::UpdateBrokerStorageResponse
Updates the EBS storage associated with MSK brokers.
4233 4234 4235 4236 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4233 def update_broker_storage(params = {}, = {}) req = build_request(:update_broker_storage, params) req.send_request() end |
#update_broker_type(params = {}) ⇒ Types::UpdateBrokerTypeResponse
Updates all the brokers in the cluster to the specified type.
4179 4180 4181 4182 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4179 def update_broker_type(params = {}, = {}) req = build_request(:update_broker_type, params) req.send_request() end |
#update_channel(params = {}) ⇒ Types::UpdateChannelResponse
Updates the destination configuration of an existing channel. Exactly one of icebergDestinationUpdate or s3DestinationUpdate must be supplied.
4323 4324 4325 4326 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4323 def update_channel(params = {}, = {}) req = build_request(:update_channel, params) req.send_request() end |
#update_cluster_configuration(params = {}) ⇒ Types::UpdateClusterConfigurationResponse
Updates the cluster with the configuration that is specified in the request body.
4364 4365 4366 4367 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4364 def update_cluster_configuration(params = {}, = {}) req = build_request(:update_cluster_configuration, params) req.send_request() end |
#update_cluster_kafka_version(params = {}) ⇒ Types::UpdateClusterKafkaVersionResponse
Updates the Apache Kafka version for the cluster.
4408 4409 4410 4411 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4408 def update_cluster_kafka_version(params = {}, = {}) req = build_request(:update_cluster_kafka_version, params) req.send_request() end |
#update_configuration(params = {}) ⇒ Types::UpdateConfigurationResponse
Updates an existing MSK configuration. The configuration must be in the Active state.
4273 4274 4275 4276 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4273 def update_configuration(params = {}, = {}) req = build_request(:update_configuration, params) req.send_request() end |
#update_connectivity(params = {}) ⇒ Types::UpdateConnectivityResponse
Updates the connectivity configuration for the MSK cluster.
4471 4472 4473 4474 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4471 def update_connectivity(params = {}, = {}) req = build_request(:update_connectivity, params) req.send_request() end |
#update_monitoring(params = {}) ⇒ Types::UpdateMonitoringResponse
Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.
4561 4562 4563 4564 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4561 def update_monitoring(params = {}, = {}) req = build_request(:update_monitoring, params) req.send_request() end |
#update_rebalancing(params = {}) ⇒ Types::UpdateRebalancingResponse
Use this resource to update the intelligent rebalancing status of an Amazon MSK Provisioned cluster with Express brokers.
4602 4603 4604 4605 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4602 def update_rebalancing(params = {}, = {}) req = build_request(:update_rebalancing, params) req.send_request() end |
#update_replication_info(params = {}) ⇒ Types::UpdateReplicationInfoResponse
Updates replication info of a replicator.
4690 4691 4692 4693 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4690 def update_replication_info(params = {}, = {}) req = build_request(:update_replication_info, params) req.send_request() end |
#update_security(params = {}) ⇒ Types::UpdateSecurityResponse
You can use this operation to update the encrypting and authentication settings for an existing cluster.
4758 4759 4760 4761 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4758 def update_security(params = {}, = {}) req = build_request(:update_security, params) req.send_request() end |
#update_storage(params = {}) ⇒ Types::UpdateStorageResponse
Updates cluster broker volume size (or) sets cluster storage mode to TIERED.
4808 4809 4810 4811 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4808 def update_storage(params = {}, = {}) req = build_request(:update_storage, params) req.send_request() end |
#update_topic(params = {}) ⇒ Types::UpdateTopicResponse
Updates the topic configuration or partition count in the specified MSK cluster.
4849 4850 4851 4852 |
# File 'gems/aws-sdk-kafka/lib/aws-sdk-kafka/client.rb', line 4849 def update_topic(params = {}, = {}) req = build_request(:update_topic, params) req.send_request() end |