Struct aws_sdk_kinesisanalyticsv2::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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_kinesisanalyticsv2::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_kinesisanalyticsv2::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_kinesisanalyticsv2::Client::from_conf(config);

Implementations

impl Client

pub fn with_config(
    client: Client<DynConnector, DynMiddleware<DynConnector>>,
    conf: Config
) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn add_application_cloud_watch_logging_option(
    &self
) -> AddApplicationCloudWatchLoggingOption

Constructs a fluent builder for the AddApplicationCloudWatchLoggingOption operation.

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

    The Kinesis Data Analytics application name.

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

    The version ID of the Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

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

    Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).

  • conditional_token(impl Into<String>) / set_conditional_token(Option<String>):

    A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application’s current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

• On success, responds with AddApplicationCloudWatchLoggingOptionOutput with field(s):
  • application_arn(Option<String>):

    The application’s ARN.

  • application_version_id(Option<i64>):

    The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

  • cloud_watch_logging_option_descriptions(Option<Vec<CloudWatchLoggingOptionDescription>>):

    The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.

• On failure, responds with SdkError<AddApplicationCloudWatchLoggingOptionError>

pub fn add_application_input(&self) -> AddApplicationInput

Constructs a fluent builder for the AddApplicationInput operation.

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

    The name of your existing application to which you want to add the streaming source.

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

    The current version of your application. You must provide the ApplicationVersionID or the ConditionalToken.You can use the DescribeApplication operation to find the current application version.

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

    The Input to add.

• On success, responds with AddApplicationInputOutput with field(s):
  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the application.

  • application_version_id(Option<i64>):

    Provides the current application version.

  • input_descriptions(Option<Vec<InputDescription>>):

    Describes the application input configuration.

• On failure, responds with SdkError<AddApplicationInputError>

pub fn add_application_input_processing_configuration(
    &self
) -> AddApplicationInputProcessingConfiguration

Constructs a fluent builder for the AddApplicationInputProcessingConfiguration operation.

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

    The 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>):

    The 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>):

    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>):

    The InputProcessingConfiguration to add to the application.

• On success, responds with AddApplicationInputProcessingConfigurationOutput with field(s):
  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the application.

  • application_version_id(Option<i64>):

    Provides the current application version.

  • input_id(Option<String>):

    The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

  • input_processing_configuration_description(Option<InputProcessingConfigurationDescription>):

    The description of the preprocessor that executes on records in this input before the application’s code is run.

• On failure, responds with SdkError<AddApplicationInputProcessingConfigurationError>

pub fn add_application_output(&self) -> AddApplicationOutput

Constructs a fluent builder for the AddApplicationOutput operation.

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

    The 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>):

    The 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>):

    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, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.

• On success, responds with AddApplicationOutputOutput with field(s):
  • application_arn(Option<String>):

    The application Amazon Resource Name (ARN).

  • application_version_id(Option<i64>):

    The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.

  • output_descriptions(Option<Vec<OutputDescription>>):

    Describes the application output configuration. For more information, see Configuring Application Output.

• On failure, responds with SdkError<AddApplicationOutputError>

pub fn add_application_reference_data_source(
    &self
) -> AddApplicationReferenceDataSource

Constructs a fluent builder for the AddApplicationReferenceDataSource operation.

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

    The name of an existing application.

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

    The 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>):

    The reference data source can be an object in your Amazon S3 bucket. Kinesis Data 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.

• On success, responds with AddApplicationReferenceDataSourceOutput with field(s):
  • application_arn(Option<String>):

    The application Amazon Resource Name (ARN).

  • application_version_id(Option<i64>):

    The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.

  • reference_data_source_descriptions(Option<Vec<ReferenceDataSourceDescription>>):

    Describes reference data sources configured for the application.

• On failure, responds with SdkError<AddApplicationReferenceDataSourceError>

pub fn add_application_vpc_configuration(
    &self
) -> AddApplicationVpcConfiguration

Constructs a fluent builder for the AddApplicationVpcConfiguration operation.

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

    The name of an existing application.

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

    The version of the application to which you want to add the VPC configuration. You must provide the CurrentApplicationVersionId or the ConditionalToken. 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. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

  • vpc_configuration(VpcConfiguration) / set_vpc_configuration(Option<VpcConfiguration>):

    Description of the VPC to add to the application.

  • conditional_token(impl Into<String>) / set_conditional_token(Option<String>):

    A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken. You get the application’s current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

• On success, responds with AddApplicationVpcConfigurationOutput with field(s):
  • application_arn(Option<String>):

    The ARN of the application.

  • application_version_id(Option<i64>):

    Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

  • vpc_configuration_description(Option<VpcConfigurationDescription>):

    The parameters of the new VPC configuration.

• On failure, responds with SdkError<AddApplicationVpcConfigurationError>

pub fn create_application(&self) -> CreateApplication

Constructs a fluent builder for the CreateApplication operation.

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

    The name of your application (for example, sample-app).

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

    A summary description of the application.

  • runtime_environment(RuntimeEnvironment) / set_runtime_environment(Option<RuntimeEnvironment>):

    The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

  • service_execution_role(impl Into<String>) / set_service_execution_role(Option<String>):

    The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

  • application_configuration(ApplicationConfiguration) / set_application_configuration(Option<ApplicationConfiguration>):

    Use this parameter to configure the application.

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

    Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

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

    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.

  • application_mode(ApplicationMode) / set_application_mode(Option<ApplicationMode>):

    Use the STREAMING mode to create a Kinesis Data Analytics Studio notebook. To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode.

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

    In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.

• On failure, responds with SdkError<CreateApplicationError>

pub fn create_application_presigned_url(&self) -> CreateApplicationPresignedUrl

Constructs a fluent builder for the CreateApplicationPresignedUrl operation.

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

    The name of the application.

  • url_type(UrlType) / set_url_type(Option<UrlType>):

    The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is FLINK_DASHBOARD_URL.

  • session_expiration_duration_in_seconds(i64) / set_session_expiration_duration_in_seconds(Option<i64>):

    The duration in seconds for which the returned URL will be valid.

• On success, responds with CreateApplicationPresignedUrlOutput with field(s):
  • authorized_url(Option<String>):

    The URL of the extension.

• On failure, responds with SdkError<CreateApplicationPresignedUrlError>

pub fn create_application_snapshot(&self) -> CreateApplicationSnapshot

Constructs a fluent builder for the CreateApplicationSnapshot operation.

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

    The name of an existing application

  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):

    An identifier for the application snapshot.

• On success, responds with CreateApplicationSnapshotOutput
• On failure, responds with SdkError<CreateApplicationSnapshotError>

pub fn delete_application(&self) -> DeleteApplication

Constructs a fluent builder for the DeleteApplication operation.

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

    The name of the application to delete.

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

    Use the DescribeApplication operation to get this value.

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

pub fn delete_application_cloud_watch_logging_option(
    &self
) -> DeleteApplicationCloudWatchLoggingOption

Constructs a fluent builder for the DeleteApplicationCloudWatchLoggingOption operation.

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

    The application name.

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

    The version ID of the application. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

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

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

  • conditional_token(impl Into<String>) / set_conditional_token(Option<String>):

    A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application’s current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

• On success, responds with DeleteApplicationCloudWatchLoggingOptionOutput with field(s):
  • application_arn(Option<String>):

    The application’s Amazon Resource Name (ARN).

  • application_version_id(Option<i64>):

    The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

  • cloud_watch_logging_option_descriptions(Option<Vec<CloudWatchLoggingOptionDescription>>):

    The descriptions of the remaining CloudWatch logging options for the application.

• On failure, responds with SdkError<DeleteApplicationCloudWatchLoggingOptionError>

pub fn delete_application_input_processing_configuration(
    &self
) -> DeleteApplicationInputProcessingConfiguration

Constructs a fluent builder for the DeleteApplicationInputProcessingConfiguration operation.

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

    The name of the application.

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

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

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

    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 with field(s):
  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the application.

  • application_version_id(Option<i64>):

    The current application version ID.

• On failure, responds with SdkError<DeleteApplicationInputProcessingConfigurationError>

pub fn delete_application_output(&self) -> DeleteApplicationOutput

Constructs a fluent builder for the DeleteApplicationOutput operation.

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

    The application name.

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

    The 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>):

    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 with field(s):
  • application_arn(Option<String>):

    The application Amazon Resource Name (ARN).

  • application_version_id(Option<i64>):

    The current application version ID.

• On failure, responds with SdkError<DeleteApplicationOutputError>

pub fn delete_application_reference_data_source(
    &self
) -> DeleteApplicationReferenceDataSource

Constructs a fluent builder for the DeleteApplicationReferenceDataSource operation.

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

    The name of an existing application.

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

    The current 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.

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

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

• On success, responds with DeleteApplicationReferenceDataSourceOutput with field(s):
  • application_arn(Option<String>):

    The application Amazon Resource Name (ARN).

  • application_version_id(Option<i64>):

    The updated version ID of the application.

• On failure, responds with SdkError<DeleteApplicationReferenceDataSourceError>

pub fn delete_application_snapshot(&self) -> DeleteApplicationSnapshot

Constructs a fluent builder for the DeleteApplicationSnapshot operation.

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

    The name of an existing application.

  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):

    The identifier for the snapshot delete.

  • snapshot_creation_timestamp(DateTime) / set_snapshot_creation_timestamp(Option<DateTime>):

    The creation timestamp of the application snapshot to delete. You can retrieve this value using or .

• On success, responds with DeleteApplicationSnapshotOutput
• On failure, responds with SdkError<DeleteApplicationSnapshotError>

pub fn delete_application_vpc_configuration(
    &self
) -> DeleteApplicationVpcConfiguration

Constructs a fluent builder for the DeleteApplicationVpcConfiguration operation.

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

    The name of an existing application.

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

    The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

  • vpc_configuration_id(impl Into<String>) / set_vpc_configuration_id(Option<String>):

    The ID of the VPC configuration to delete.

  • conditional_token(impl Into<String>) / set_conditional_token(Option<String>):

    A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application’s current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

• On success, responds with DeleteApplicationVpcConfigurationOutput with field(s):
  • application_arn(Option<String>):

    The ARN of the Kinesis Data Analytics application.

  • application_version_id(Option<i64>):

    The updated version ID of the application.

• On failure, responds with SdkError<DeleteApplicationVpcConfigurationError>

pub fn describe_application(&self) -> DescribeApplication

Constructs a fluent builder for the DescribeApplication operation.

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

    The name of the application.

  • include_additional_details(bool) / set_include_additional_details(Option<bool>):

    Displays verbose information about a Kinesis Data Analytics application, including the application’s job plan.

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

    Provides a description of the application, such as the application’s Amazon Resource Name (ARN), status, and latest version.

• On failure, responds with SdkError<DescribeApplicationError>

pub fn describe_application_snapshot(&self) -> DescribeApplicationSnapshot

Constructs a fluent builder for the DescribeApplicationSnapshot operation.

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

    The name of an existing application.

  • snapshot_name(impl Into<String>) / set_snapshot_name(Option<String>):

    The identifier of an application snapshot. You can retrieve this value using .

• On success, responds with DescribeApplicationSnapshotOutput with field(s):
  • snapshot_details(Option<SnapshotDetails>):

    An object containing information about the application snapshot.

• On failure, responds with SdkError<DescribeApplicationSnapshotError>

pub fn describe_application_version(&self) -> DescribeApplicationVersion

Constructs a fluent builder for the DescribeApplicationVersion operation.

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

    The name of the application for which you want to get the version description.

  • application_version_id(i64) / set_application_version_id(Option<i64>):

    The ID of the application version for which you want to get the description.

• On success, responds with DescribeApplicationVersionOutput with field(s):
  • application_version_detail(Option<ApplicationDetail>):

    Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

• On failure, responds with SdkError<DescribeApplicationVersionError>

pub fn discover_input_schema(&self) -> DiscoverInputSchema

Constructs a fluent builder for the DiscoverInputSchema operation.

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

    The Amazon Resource Name (ARN) of the streaming source.

  • service_execution_role(impl Into<String>) / set_service_execution_role(Option<String>):

    The ARN of the role that is used to access the streaming source.

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

    The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes.

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

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

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

    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>):

    The 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>>):

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

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

    The raw stream data that was sampled to infer the schema.

• On failure, responds with SdkError<DiscoverInputSchemaError>

pub fn list_applications(&self) -> ListApplications

Constructs a fluent builder for the ListApplications operation.

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

    The maximum number of applications to list.

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

    If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface’s Pagination Options.

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

    A list of ApplicationSummary objects.

  • next_token(Option<String>):

    The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface’s Pagination Options.

• On failure, responds with SdkError<ListApplicationsError>

pub fn list_application_snapshots(&self) -> ListApplicationSnapshots

Constructs a fluent builder for the ListApplicationSnapshots operation.

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

    The name of an existing application.

  • limit(i32) / set_limit(Option<i32>):

    The maximum number of application snapshots to list.

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

    Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call’s NextToken response to indicate where the output should continue from.

• On success, responds with ListApplicationSnapshotsOutput with field(s):
  • snapshot_summaries(Option<Vec<SnapshotDetails>>):

    A collection of objects containing information about the application snapshots.

  • next_token(Option<String>):

    The token for the next set of results, or null if there are no additional results.

• On failure, responds with SdkError<ListApplicationSnapshotsError>

pub fn list_application_versions(&self) -> ListApplicationVersions

Constructs a fluent builder for the ListApplicationVersions operation.

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

    The name of the application for which you want to list all versions.

  • limit(i32) / set_limit(Option<i32>):

    The maximum number of versions to list in this invocation of the operation.

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

    If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface’s Pagination Options.

• On success, responds with ListApplicationVersionsOutput with field(s):
  • application_version_summaries(Option<Vec<ApplicationVersionSummary>>):

    A list of the application versions and the associated configuration summaries. The list includes application versions that were rolled back.

    To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

  • next_token(Option<String>):

    The pagination token for the next set of results, or null if there are no additional results. To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see Using the Amazon Command Line Interface’s Pagination Options.

• On failure, responds with SdkError<ListApplicationVersionsError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

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

    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>

pub fn rollback_application(&self) -> RollbackApplication

Constructs a fluent builder for the RollbackApplication operation.

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

    The name of the application.

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

    The current application version ID. You can retrieve the application version ID using DescribeApplication.

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

    Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

• On failure, responds with SdkError<RollbackApplicationError>

pub fn start_application(&self) -> StartApplication

Constructs a fluent builder for the StartApplication operation.

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

    The name of the application.

  • run_configuration(RunConfiguration) / set_run_configuration(Option<RunConfiguration>):

    Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.

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

pub fn stop_application(&self) -> StopApplication

Constructs a fluent builder for the StopApplication operation.

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

    The name of the running application to stop.

  • force(bool) / set_force(Option<bool>):

    Set to true to force the application to stop. If you set Force to true, Kinesis Data Analytics stops the application without taking a snapshot.

    Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.

    You can only force stop a Flink-based Kinesis Data Analytics application. You can’t force stop a SQL-based Kinesis Data Analytics application.

    The application must be in the STARTING, UPDATING, STOPPING, AUTOSCALING, or RUNNING status.

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

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

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

    The ARN of the application to assign the tags.

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

    The key-value tags to assign to the application.

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

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

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

    The ARN of the Kinesis Data Analytics application from which to remove the tags.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

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

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

pub fn update_application(&self) -> UpdateApplication

Constructs a fluent builder for the UpdateApplication operation.

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

    The name of the application to update.

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

    The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

  • application_configuration_update(ApplicationConfigurationUpdate) / set_application_configuration_update(Option<ApplicationConfigurationUpdate>):

    Describes application configuration updates.

  • service_execution_role_update(impl Into<String>) / set_service_execution_role_update(Option<String>):

    Describes updates to the service execution role.

  • run_configuration_update(RunConfigurationUpdate) / set_run_configuration_update(Option<RunConfigurationUpdate>):

    Describes updates to the application’s starting parameters.

  • cloud_watch_logging_option_updates(Vec<CloudWatchLoggingOptionUpdate>) / set_cloud_watch_logging_option_updates(Option<Vec<CloudWatchLoggingOptionUpdate>>):

    Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.

  • conditional_token(impl Into<String>) / set_conditional_token(Option<String>):

    A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application’s current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

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

    Describes application updates.

• On failure, responds with SdkError<UpdateApplicationError>

pub fn update_application_maintenance_configuration(
    &self
) -> UpdateApplicationMaintenanceConfiguration

Constructs a fluent builder for the UpdateApplicationMaintenanceConfiguration operation.

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

    The name of the application for which you want to update the maintenance configuration.

  • application_maintenance_configuration_update(ApplicationMaintenanceConfigurationUpdate) / set_application_maintenance_configuration_update(Option<ApplicationMaintenanceConfigurationUpdate>):

    Describes the application maintenance configuration update.

• On success, responds with UpdateApplicationMaintenanceConfigurationOutput with field(s):
  • application_arn(Option<String>):

    The Amazon Resource Name (ARN) of the application.

  • application_maintenance_configuration_description(Option<ApplicationMaintenanceConfigurationDescription>):

    The application maintenance configuration description after the update.

• On failure, responds with SdkError<UpdateApplicationMaintenanceConfigurationError>

impl Client

pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
    C: SmithyConnector<Error = E> + Send + 'static,
    E: Into<ConnectorError>, 

Creates a client with the given service config and connector override.

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

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

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.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Performs the conversion.