Struct Client 

pub struct Client { /* private fields */ }

Client for Managed Streaming for Kafka Connect

Client for invoking operations on Managed Streaming for Kafka Connect. Each operation on Managed Streaming for Kafka Connect is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_kafkaconnect::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_kafkaconnect::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateConnector operation has a Client::create_connector, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_connector()
    .connector_description("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_connector(&self) -> CreateConnectorFluentBuilder

Constructs a fluent builder for the CreateConnector operation.

• The fluent builder is configurable:
  • capacity(Capacity) / set_capacity(Option<Capacity>):
    required: true
    

    Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.

    
    
  • connector_configuration(impl Into<String>, impl Into<String>) / set_connector_configuration(Option<HashMap::<String, String>>):
    required: true
    

    A map of keys to values that represent the configuration for the connector.

    
    
  • connector_description(impl Into<String>) / set_connector_description(Option<String>):
    required: false
    

    A summary description of the connector.

    
    
  • connector_name(impl Into<String>) / set_connector_name(Option<String>):
    required: true
    

    The name of the connector.

    
    
  • kafka_cluster(KafkaCluster) / set_kafka_cluster(Option<KafkaCluster>):
    required: true
    

    Specifies which Apache Kafka cluster to connect to.

    
    
  • kafka_cluster_client_authentication(KafkaClusterClientAuthentication) / set_kafka_cluster_client_authentication(Option<KafkaClusterClientAuthentication>):
    required: true
    

    Details of the client authentication used by the Apache Kafka cluster.

    
    
  • kafka_cluster_encryption_in_transit(KafkaClusterEncryptionInTransit) / set_kafka_cluster_encryption_in_transit(Option<KafkaClusterEncryptionInTransit>):
    required: true
    

    Details of encryption in transit to the Apache Kafka cluster.

    
    
  • kafka_connect_version(impl Into<String>) / set_kafka_connect_version(Option<String>):
    required: true
    

    The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster’s version and the plugins.

    
    
  • log_delivery(LogDelivery) / set_log_delivery(Option<LogDelivery>):
    required: false
    

    Details about log delivery.

    
    
  • plugins(Plugin) / set_plugins(Option<Vec::<Plugin>>):
    required: true
    

    Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.

    Specifies which plugin to use for the connector. You must specify a single-element list containing one customPlugin object.

    
    
  • service_execution_role_arn(impl Into<String>) / set_service_execution_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.

    
    
  • worker_configuration(WorkerConfiguration) / set_worker_configuration(Option<WorkerConfiguration>):
    required: false
    

    Specifies which worker configuration to use with the connector.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags you want to attach to the connector.

    
    
• On success, responds with CreateConnectorOutput with field(s):
  • connector_arn(Option<String>):

    The Amazon Resource Name (ARN) that Amazon assigned to the connector.

  • connector_name(Option<String>):

    The name of the connector.

  • connector_state(Option<ConnectorState>):

    The state of the connector.

• On failure, responds with SdkError<CreateConnectorError>

impl Client

pub fn create_custom_plugin(&self) -> CreateCustomPluginFluentBuilder

Constructs a fluent builder for the CreateCustomPlugin operation.

• The fluent builder is configurable:
  • content_type(CustomPluginContentType) / set_content_type(Option<CustomPluginContentType>):
    required: true
    

    The type of the plugin file.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A summary description of the custom plugin.

    
    
  • location(CustomPluginLocation) / set_location(Option<CustomPluginLocation>):
    required: true
    

    Information about the location of a custom plugin.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the custom plugin.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags you want to attach to the custom plugin.

    
    
• On success, responds with CreateCustomPluginOutput with field(s):
  • custom_plugin_arn(Option<String>):

    The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.

  • custom_plugin_state(Option<CustomPluginState>):

    The state of the custom plugin.

  • name(Option<String>):

    The name of the custom plugin.

  • revision(i64):

    The revision of the custom plugin.

• On failure, responds with SdkError<CreateCustomPluginError>

impl Client

pub fn create_worker_configuration( &self, ) -> CreateWorkerConfigurationFluentBuilder

Constructs a fluent builder for the CreateWorkerConfiguration operation.

• The fluent builder is configurable:
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A summary description of the worker configuration.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the worker configuration.

    
    
  • properties_file_content(impl Into<String>) / set_properties_file_content(Option<String>):
    required: true
    

    Base64 encoded contents of connect-distributed.properties file.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags you want to attach to the worker configuration.

    
    
• On success, responds with CreateWorkerConfigurationOutput with field(s):
  • creation_time(Option<DateTime>):

    The time that the worker configuration was created.

  • latest_revision(Option<WorkerConfigurationRevisionSummary>):

    The latest revision of the worker configuration.

  • name(Option<String>):

    The name of the worker configuration.

  • worker_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) that Amazon assigned to the worker configuration.

  • worker_configuration_state(Option<WorkerConfigurationState>):

    The state of the worker configuration.

• On failure, responds with SdkError<CreateWorkerConfigurationError>

impl Client

pub fn delete_connector(&self) -> DeleteConnectorFluentBuilder

Constructs a fluent builder for the DeleteConnector operation.

• The fluent builder is configurable:
  • connector_arn(impl Into<String>) / set_connector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the connector that you want to delete.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: false
    

    The current version of the connector that you want to delete.

    
    
• On success, responds with DeleteConnectorOutput with field(s):
  • connector_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connector that you requested to delete.

  • connector_state(Option<ConnectorState>):

    The state of the connector that you requested to delete.

• On failure, responds with SdkError<DeleteConnectorError>

impl Client

pub fn delete_custom_plugin(&self) -> DeleteCustomPluginFluentBuilder

Constructs a fluent builder for the DeleteCustomPlugin operation.

• The fluent builder is configurable:
  • custom_plugin_arn(impl Into<String>) / set_custom_plugin_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the custom plugin that you want to delete.

    
    
• On success, responds with DeleteCustomPluginOutput with field(s):
  • custom_plugin_arn(Option<String>):

    The Amazon Resource Name (ARN) of the custom plugin that you requested to delete.

  • custom_plugin_state(Option<CustomPluginState>):

    The state of the custom plugin.

• On failure, responds with SdkError<DeleteCustomPluginError>

impl Client

pub fn delete_worker_configuration( &self, ) -> DeleteWorkerConfigurationFluentBuilder

Constructs a fluent builder for the DeleteWorkerConfiguration operation.

• The fluent builder is configurable:
  • worker_configuration_arn(impl Into<String>) / set_worker_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the worker configuration that you want to delete.

    
    
• On success, responds with DeleteWorkerConfigurationOutput with field(s):
  • worker_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the worker configuration that you requested to delete.

  • worker_configuration_state(Option<WorkerConfigurationState>):

    The state of the worker configuration.

• On failure, responds with SdkError<DeleteWorkerConfigurationError>

impl Client

pub fn describe_connector(&self) -> DescribeConnectorFluentBuilder

Constructs a fluent builder for the DescribeConnector operation.

• The fluent builder is configurable:
  • connector_arn(impl Into<String>) / set_connector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the connector that you want to describe.

    
    
• On success, responds with DescribeConnectorOutput with field(s):
  • capacity(Option<CapacityDescription>):

    Information about the capacity of the connector, whether it is auto scaled or provisioned.

  • connector_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connector.

  • connector_configuration(Option<HashMap::<String, String>>):

    A map of keys to values that represent the configuration for the connector.

  • connector_description(Option<String>):

    A summary description of the connector.

  • connector_name(Option<String>):

    The name of the connector.

  • connector_state(Option<ConnectorState>):

    The state of the connector.

  • creation_time(Option<DateTime>):

    The time the connector was created.

  • current_version(Option<String>):

    The current version of the connector.

  • kafka_cluster(Option<KafkaClusterDescription>):

    The Apache Kafka cluster that the connector is connected to.

  • kafka_cluster_client_authentication(Option<KafkaClusterClientAuthenticationDescription>):

    The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

  • kafka_cluster_encryption_in_transit(Option<KafkaClusterEncryptionInTransitDescription>):

    Details of encryption in transit to the Apache Kafka cluster.

  • kafka_connect_version(Option<String>):

    The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster’s version and the plugins.

  • log_delivery(Option<LogDeliveryDescription>):

    Details about delivering logs to Amazon CloudWatch Logs.

  • plugins(Option<Vec::<PluginDescription>>):

    Specifies which plugins were used for this connector.

  • service_execution_role_arn(Option<String>):

    The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

  • worker_configuration(Option<WorkerConfigurationDescription>):

    Specifies which worker configuration was used for the connector.

  • state_description(Option<StateDescription>):

    Details about the state of a connector.

• On failure, responds with SdkError<DescribeConnectorError>

impl Client

pub fn describe_connector_operation( &self, ) -> DescribeConnectorOperationFluentBuilder

Constructs a fluent builder for the DescribeConnectorOperation operation.

• The fluent builder is configurable:
  • connector_operation_arn(impl Into<String>) / set_connector_operation_arn(Option<String>):
    required: true
    

    ARN of the connector operation to be described.

    
    
• On success, responds with DescribeConnectorOperationOutput with field(s):
  • connector_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connector.

  • connector_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connector operation.

  • connector_operation_state(Option<ConnectorOperationState>):

    The state of the connector operation.

  • connector_operation_type(Option<ConnectorOperationType>):

    The type of connector operation performed.

  • operation_steps(Option<Vec::<ConnectorOperationStep>>):

    The array of operation steps taken.

  • origin_worker_setting(Option<WorkerSetting>):

    The origin worker setting.

  • origin_connector_configuration(Option<HashMap::<String, String>>):

    The origin connector configuration.

  • target_worker_setting(Option<WorkerSetting>):

    The target worker setting.

  • target_connector_configuration(Option<HashMap::<String, String>>):

    The target connector configuration.

  • error_info(Option<StateDescription>):

    Details about the state of a resource.

  • creation_time(Option<DateTime>):

    The time when the operation was created.

  • end_time(Option<DateTime>):

    The time when the operation ended.

• On failure, responds with SdkError<DescribeConnectorOperationError>

impl Client

pub fn describe_custom_plugin(&self) -> DescribeCustomPluginFluentBuilder

Constructs a fluent builder for the DescribeCustomPlugin operation.

• The fluent builder is configurable:
  • custom_plugin_arn(impl Into<String>) / set_custom_plugin_arn(Option<String>):
    required: true
    

    Returns information about a custom plugin.

    
    
• On success, responds with DescribeCustomPluginOutput with field(s):
  • creation_time(Option<DateTime>):

    The time that the custom plugin was created.

  • custom_plugin_arn(Option<String>):

    The Amazon Resource Name (ARN) of the custom plugin.

  • custom_plugin_state(Option<CustomPluginState>):

    The state of the custom plugin.

  • description(Option<String>):

    The description of the custom plugin.

  • latest_revision(Option<CustomPluginRevisionSummary>):

    The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.

  • name(Option<String>):

    The name of the custom plugin.

  • state_description(Option<StateDescription>):

    Details about the state of a custom plugin.

• On failure, responds with SdkError<DescribeCustomPluginError>

impl Client

pub fn describe_worker_configuration( &self, ) -> DescribeWorkerConfigurationFluentBuilder

Constructs a fluent builder for the DescribeWorkerConfiguration operation.

• The fluent builder is configurable:
  • worker_configuration_arn(impl Into<String>) / set_worker_configuration_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.

    
    
• On success, responds with DescribeWorkerConfigurationOutput with field(s):
  • creation_time(Option<DateTime>):

    The time that the worker configuration was created.

  • description(Option<String>):

    The description of the worker configuration.

  • latest_revision(Option<WorkerConfigurationRevisionDescription>):

    The latest revision of the custom configuration.

  • name(Option<String>):

    The name of the worker configuration.

  • worker_configuration_arn(Option<String>):

    The Amazon Resource Name (ARN) of the custom configuration.

  • worker_configuration_state(Option<WorkerConfigurationState>):

    The state of the worker configuration.

• On failure, responds with SdkError<DescribeWorkerConfigurationError>

impl Client

pub fn list_connector_operations(&self) -> ListConnectorOperationsFluentBuilder

Constructs a fluent builder for the ListConnectorOperations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • connector_arn(impl Into<String>) / set_connector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the connector for which to list operations.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Maximum number of connector operations to fetch in one get request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response is truncated, it includes a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

    
    
• On success, responds with ListConnectorOperationsOutput with field(s):
  • connector_operations(Option<Vec::<ConnectorOperationSummary>>):

    An array of connector operation descriptions.

  • next_token(Option<String>):

    If the response is truncated, it includes a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

• On failure, responds with SdkError<ListConnectorOperationsError>

impl Client

pub fn list_connectors(&self) -> ListConnectorsFluentBuilder

Constructs a fluent builder for the ListConnectors operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • connector_name_prefix(impl Into<String>) / set_connector_name_prefix(Option<String>):
    required: false
    

    The name prefix that you want to use to search for and list connectors.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of connectors to list in one response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

    
    
• On success, responds with ListConnectorsOutput with field(s):
  • connectors(Option<Vec::<ConnectorSummary>>):

    An array of connector descriptions.

  • next_token(Option<String>):

    If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

• On failure, responds with SdkError<ListConnectorsError>

impl Client

pub fn list_custom_plugins(&self) -> ListCustomPluginsFluentBuilder

Constructs a fluent builder for the ListCustomPlugins operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of custom plugins to list in one response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

    
    
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    Lists custom plugin names that start with the specified text string.

    
    
• On success, responds with ListCustomPluginsOutput with field(s):
  • custom_plugins(Option<Vec::<CustomPluginSummary>>):

    An array of custom plugin descriptions.

  • next_token(Option<String>):

    If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

• On failure, responds with SdkError<ListCustomPluginsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which you want to list all attached tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    Lists the tags attached to the specified resource in the corresponding request.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_worker_configurations( &self, ) -> ListWorkerConfigurationsFluentBuilder

Constructs a fluent builder for the ListWorkerConfigurations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of worker configurations to list in one response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

    
    
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    Lists worker configuration names that start with the specified text string.

    
    
• On success, responds with ListWorkerConfigurationsOutput with field(s):
  • next_token(Option<String>):

    If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

  • worker_configurations(Option<Vec::<WorkerConfigurationSummary>>):

    An array of worker configuration descriptions.

• On failure, responds with SdkError<ListWorkerConfigurationsError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to which you want to attach tags.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags that you want to attach to the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource from which you want to remove tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags that you want to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_connector(&self) -> UpdateConnectorFluentBuilder

Constructs a fluent builder for the UpdateConnector operation.

• The fluent builder is configurable:
  • capacity(CapacityUpdate) / set_capacity(Option<CapacityUpdate>):
    required: false
    

    The target capacity.

    
    
  • connector_configuration(impl Into<String>, impl Into<String>) / set_connector_configuration(Option<HashMap::<String, String>>):
    required: false
    

    A map of keys to values that represent the configuration for the connector.

    
    
  • connector_arn(impl Into<String>) / set_connector_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the connector that you want to update.

    
    
  • current_version(impl Into<String>) / set_current_version(Option<String>):
    required: true
    

    The current version of the connector that you want to update.

    
    
• On success, responds with UpdateConnectorOutput with field(s):
  • connector_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connector.

  • connector_state(Option<ConnectorState>):

    The state of the connector.

  • connector_operation_arn(Option<String>):

    The Amazon Resource Name (ARN) of the connector operation.

• On failure, responds with SdkError<UpdateConnectorError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.