Struct aws_sdk_kinesisanalytics::client::Client

pub struct Client { /* private fields */ }

Client for Amazon Kinesis Analytics

Client for invoking operations on Amazon Kinesis Analytics. Each operation on Amazon Kinesis Analytics 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_kinesisanalytics::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 Config 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_kinesisanalytics::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 AddApplicationCloudWatchLoggingOption operation has a Client::add_application_cloud_watch_logging_option, 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.add_application_cloud_watch_logging_option()
    .application_name("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 add_application_cloud_watch_logging_option( &self ) -> AddApplicationCloudWatchLoggingOptionFluentBuilder

Constructs a fluent builder for the AddApplicationCloudWatchLoggingOption operation.

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

    The Kinesis Analytics application name.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    The version ID of the Kinesis Analytics application.

    
    
  • cloud_watch_logging_option(CloudWatchLoggingOption) / set_cloud_watch_logging_option(Option<CloudWatchLoggingOption>):
    required: true
    

    Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.

    
    
• On success, responds with AddApplicationCloudWatchLoggingOptionOutput
• On failure, responds with SdkError<AddApplicationCloudWatchLoggingOptionError>

impl Client

pub fn add_application_input(&self) -> AddApplicationInputFluentBuilder

Constructs a fluent builder for the AddApplicationInput operation.

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

    Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.

    
    
  • input(Input) / set_input(Option<Input>):
    required: true
    

    The Input to add.

    
    
• On success, responds with AddApplicationInputOutput
• On failure, responds with SdkError<AddApplicationInputError>

impl Client

pub fn add_application_input_processing_configuration( &self ) -> AddApplicationInputProcessingConfigurationFluentBuilder

Constructs a fluent builder for the AddApplicationInputProcessingConfiguration operation.

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

    Name of the application to which you want to add the input processing configuration.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    Version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    
    
  • input_id(impl Into<String>) / set_input_id(Option<String>):
    required: true
    

    The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.

    
    
  • input_processing_configuration(InputProcessingConfiguration) / set_input_processing_configuration(Option<InputProcessingConfiguration>):
    required: true
    

    The InputProcessingConfiguration to add to the application.

    
    
• On success, responds with AddApplicationInputProcessingConfigurationOutput
• On failure, responds with SdkError<AddApplicationInputProcessingConfigurationError>

impl Client

pub fn add_application_output(&self) -> AddApplicationOutputFluentBuilder

Constructs a fluent builder for the AddApplicationOutput operation.

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

    Name of the application to which you want to add the output configuration.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    Version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    
    
  • output(Output) / set_output(Option<Output>):
    required: true
    

    An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.

    
    
• On success, responds with AddApplicationOutputOutput
• On failure, responds with SdkError<AddApplicationOutputError>

impl Client

pub fn add_application_reference_data_source( &self ) -> AddApplicationReferenceDataSourceFluentBuilder

Constructs a fluent builder for the AddApplicationReferenceDataSource operation.

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

    Name of an existing application.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    
    
  • reference_data_source(ReferenceDataSource) / set_reference_data_source(Option<ReferenceDataSource>):
    required: true
    

    The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.

    
    
• On success, responds with AddApplicationReferenceDataSourceOutput
• On failure, responds with SdkError<AddApplicationReferenceDataSourceError>

impl Client

pub fn create_application(&self) -> CreateApplicationFluentBuilder

Constructs a fluent builder for the CreateApplication operation.

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

    Name of your Amazon Kinesis Analytics application (for example, sample-app).

    
    
  • application_description(impl Into<String>) / set_application_description(Option<String>):
    required: false
    

    Summary description of the application.

    
    
  • inputs(Input) / set_inputs(Option<Vec::<Input>>):
    required: false
    

    Use this parameter to configure the application input.

    You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).

    For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.

    To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.

    
    
  • outputs(Output) / set_outputs(Option<Vec::<Output>>):
    required: false
    

    You can configure application output to write data from any of the in-application streams to up to three destinations.

    These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three.

    In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf.

    In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.

    
    
  • cloud_watch_logging_options(CloudWatchLoggingOption) / set_cloud_watch_logging_options(Option<Vec::<CloudWatchLoggingOption>>):
    required: false
    

    Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs.

    
    
  • application_code(impl Into<String>) / set_application_code(Option<String>):
    required: false
    

    One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code.

    You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.

    Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

    
    
• On success, responds with CreateApplicationOutput with field(s):
  • application_summary(Option<ApplicationSummary>):

    In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.

• On failure, responds with SdkError<CreateApplicationError>

impl Client

pub fn delete_application(&self) -> DeleteApplicationFluentBuilder

Constructs a fluent builder for the DeleteApplication operation.

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

    Name of the Amazon Kinesis Analytics application to delete.

    
    
  • create_timestamp(DateTime) / set_create_timestamp(Option<DateTime>):
    required: true
    

    You can use the DescribeApplication operation to get this value.

    
    
• On success, responds with DeleteApplicationOutput
• On failure, responds with SdkError<DeleteApplicationError>

impl Client

pub fn delete_application_cloud_watch_logging_option( &self ) -> DeleteApplicationCloudWatchLoggingOptionFluentBuilder

Constructs a fluent builder for the DeleteApplicationCloudWatchLoggingOption operation.

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

    The Kinesis Analytics application name.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    The version ID of the Kinesis Analytics application.

    
    
  • cloud_watch_logging_option_id(impl Into<String>) / set_cloud_watch_logging_option_id(Option<String>):
    required: true
    

    The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

    
    
• On success, responds with DeleteApplicationCloudWatchLoggingOptionOutput
• On failure, responds with SdkError<DeleteApplicationCloudWatchLoggingOptionError>

impl Client

pub fn delete_application_input_processing_configuration( &self ) -> DeleteApplicationInputProcessingConfigurationFluentBuilder

Constructs a fluent builder for the DeleteApplicationInputProcessingConfiguration operation.

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

    The Kinesis Analytics application name.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    The version ID of the Kinesis Analytics application.

    
    
  • input_id(impl Into<String>) / set_input_id(Option<String>):
    required: true
    

    The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.

    
    
• On success, responds with DeleteApplicationInputProcessingConfigurationOutput
• On failure, responds with SdkError<DeleteApplicationInputProcessingConfigurationError>

impl Client

pub fn delete_application_output(&self) -> DeleteApplicationOutputFluentBuilder

Constructs a fluent builder for the DeleteApplicationOutput operation.

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

    Amazon Kinesis Analytics application name.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    Amazon Kinesis Analytics application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    
    
  • output_id(impl Into<String>) / set_output_id(Option<String>):
    required: true
    

    The ID of the configuration to delete. Each output configuration that is added to the application, either when the application is created or later using the AddApplicationOutput operation, has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.

    
    
• On success, responds with DeleteApplicationOutputOutput
• On failure, responds with SdkError<DeleteApplicationOutputError>

impl Client

pub fn delete_application_reference_data_source( &self ) -> DeleteApplicationReferenceDataSourceFluentBuilder

Constructs a fluent builder for the DeleteApplicationReferenceDataSource operation.

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

    Name of an existing application.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    Version of the application. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    
    
  • reference_id(impl Into<String>) / set_reference_id(Option<String>):
    required: true
    

    ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.

    
    
• On success, responds with DeleteApplicationReferenceDataSourceOutput
• On failure, responds with SdkError<DeleteApplicationReferenceDataSourceError>

impl Client

pub fn describe_application(&self) -> DescribeApplicationFluentBuilder

Constructs a fluent builder for the DescribeApplication operation.

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

    Name of the application.

    
    
• On success, responds with DescribeApplicationOutput with field(s):
  • application_detail(Option<ApplicationDetail>):

    Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.

• On failure, responds with SdkError<DescribeApplicationError>

impl Client

pub fn discover_input_schema(&self) -> DiscoverInputSchemaFluentBuilder

Constructs a fluent builder for the DiscoverInputSchema operation.

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

    Amazon Resource Name (ARN) of the streaming source.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.

    
    
  • input_starting_position_configuration(InputStartingPositionConfiguration) / set_input_starting_position_configuration(Option<InputStartingPositionConfiguration>):
    required: false
    

    Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.

    
    
  • s3_configuration(S3Configuration) / set_s3_configuration(Option<S3Configuration>):
    required: false
    

    Specify this parameter to discover a schema from data in an Amazon S3 object.

    
    
  • input_processing_configuration(InputProcessingConfiguration) / set_input_processing_configuration(Option<InputProcessingConfiguration>):
    required: false
    

    The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

    
    
• On success, responds with DiscoverInputSchemaOutput with field(s):
  • input_schema(Option<SourceSchema>):

    Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

  • parsed_input_records(Option<Vec::<Vec::<String>>>):

    An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

  • processed_input_records(Option<Vec::<String>>):

    Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

  • raw_input_records(Option<Vec::<String>>):

    Raw stream data that was sampled to infer the schema.

• On failure, responds with SdkError<DiscoverInputSchemaError>

impl Client

pub fn list_applications(&self) -> ListApplicationsFluentBuilder

Constructs a fluent builder for the ListApplications operation.

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

    Maximum number of applications to list.

    
    
  • exclusive_start_application_name(impl Into<String>) / set_exclusive_start_application_name(Option<String>):
    required: false
    

    Name of the application to start the list with. When using pagination to retrieve the list, you don’t need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

    
    
• On success, responds with ListApplicationsOutput with field(s):
  • application_summaries(Vec::<ApplicationSummary>):

    List of ApplicationSummary objects.

  • has_more_applications(bool):

    Returns true if there are more applications to retrieve.

• On failure, responds with SdkError<ListApplicationsError>

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 ARN of the application for which to retrieve tags.

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

    The key-value tags assigned to the application.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn start_application(&self) -> StartApplicationFluentBuilder

Constructs a fluent builder for the StartApplication operation.

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

    Name of the application.

    
    
  • input_configurations(InputConfiguration) / set_input_configurations(Option<Vec::<InputConfiguration>>):
    required: true
    

    Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.

    
    
• On success, responds with StartApplicationOutput
• On failure, responds with SdkError<StartApplicationError>

impl Client

pub fn stop_application(&self) -> StopApplicationFluentBuilder

Constructs a fluent builder for the StopApplication operation.

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

    Name of the running application to stop.

    
    
• On success, responds with StopApplicationOutput
• On failure, responds with SdkError<StopApplicationError>

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 ARN of the application to assign the tags.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The key-value tags to assign to the application.

    
    
• 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 ARN of the Kinesis Analytics application from which to remove the tags.

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

    A list of keys of tags to remove from the specified application.

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

impl Client

pub fn update_application(&self) -> UpdateApplicationFluentBuilder

Constructs a fluent builder for the UpdateApplication operation.

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

    Name of the Amazon Kinesis Analytics application to update.

    
    
  • current_application_version_id(i64) / set_current_application_version_id(Option<i64>):
    required: true
    

    The current application version ID. You can use the DescribeApplication operation to get this value.

    
    
  • application_update(ApplicationUpdate) / set_application_update(Option<ApplicationUpdate>):
    required: true
    

    Describes application updates.

    
    
• On success, responds with UpdateApplicationOutput
• On failure, responds with SdkError<UpdateApplicationError>

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 copy 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.