Skip to content

KinesisAnalyticsClient#

Index > KinesisAnalytics > KinesisAnalyticsClient

Auto-generated documentation for KinesisAnalytics type annotations stubs module types-boto3-kinesisanalytics.

KinesisAnalyticsClient#

Type annotations and code completion for boto3.client("kinesisanalytics"). boto3 documentation

# KinesisAnalyticsClient usage example

from boto3.session import Session
from types_boto3_kinesisanalytics.client import KinesisAnalyticsClient

def get_kinesisanalytics_client() -> KinesisAnalyticsClient:
    return Session().client("kinesisanalytics")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("kinesisanalytics").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("kinesisanalytics")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.CodeValidationException,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.InvalidApplicationConfigurationException,
    client.exceptions.InvalidArgumentException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceProvisionedThroughputExceededException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.TooManyTagsException,
    client.exceptions.UnableToDetectSchemaException,
    client.exceptions.UnsupportedOperationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_kinesisanalytics.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("kinesisanalytics").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("kinesisanalytics").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

add_application_cloud_watch_logging_option#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").add_application_cloud_watch_logging_option method. boto3 documentation

# add_application_cloud_watch_logging_option method definition

def add_application_cloud_watch_logging_option(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    CloudWatchLoggingOption: CloudWatchLoggingOptionTypeDef,  # (1)
) -> dict[str, Any]:
    ...
  1. See CloudWatchLoggingOptionTypeDef 
# add_application_cloud_watch_logging_option method usage example with argument unpacking

kwargs: AddApplicationCloudWatchLoggingOptionRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "CloudWatchLoggingOption": ...,
}

parent.add_application_cloud_watch_logging_option(**kwargs)
  1. See AddApplicationCloudWatchLoggingOptionRequestRequestTypeDef

add_application_input#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").add_application_input method. boto3 documentation

# add_application_input method definition

def add_application_input(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    Input: InputTypeDef,  # (1)
) -> dict[str, Any]:
    ...
  1. See InputTypeDef 
# add_application_input method usage example with argument unpacking

kwargs: AddApplicationInputRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "Input": ...,
}

parent.add_application_input(**kwargs)
  1. See AddApplicationInputRequestRequestTypeDef

add_application_input_processing_configuration#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").add_application_input_processing_configuration method. boto3 documentation

# add_application_input_processing_configuration method definition

def add_application_input_processing_configuration(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    InputId: str,
    InputProcessingConfiguration: InputProcessingConfigurationTypeDef,  # (1)
) -> dict[str, Any]:
    ...
  1. See InputProcessingConfigurationTypeDef 
# add_application_input_processing_configuration method usage example with argument unpacking

kwargs: AddApplicationInputProcessingConfigurationRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "InputId": ...,
    "InputProcessingConfiguration": ...,
}

parent.add_application_input_processing_configuration(**kwargs)
  1. See AddApplicationInputProcessingConfigurationRequestRequestTypeDef

add_application_output#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").add_application_output method. boto3 documentation

# add_application_output method definition

def add_application_output(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    Output: OutputTypeDef,  # (1)
) -> dict[str, Any]:
    ...
  1. See OutputTypeDef 
# add_application_output method usage example with argument unpacking

kwargs: AddApplicationOutputRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "Output": ...,
}

parent.add_application_output(**kwargs)
  1. See AddApplicationOutputRequestRequestTypeDef

add_application_reference_data_source#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").add_application_reference_data_source method. boto3 documentation

# add_application_reference_data_source method definition

def add_application_reference_data_source(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    ReferenceDataSource: ReferenceDataSourceTypeDef,  # (1)
) -> dict[str, Any]:
    ...
  1. See ReferenceDataSourceTypeDef 
# add_application_reference_data_source method usage example with argument unpacking

kwargs: AddApplicationReferenceDataSourceRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "ReferenceDataSource": ...,
}

parent.add_application_reference_data_source(**kwargs)
  1. See AddApplicationReferenceDataSourceRequestRequestTypeDef

create_application#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    ApplicationName: str,
    ApplicationDescription: str = ...,
    Inputs: Sequence[InputTypeDef] = ...,  # (1)
    Outputs: Sequence[OutputTypeDef] = ...,  # (2)
    CloudWatchLoggingOptions: Sequence[CloudWatchLoggingOptionTypeDef] = ...,  # (3)
    ApplicationCode: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateApplicationResponseTypeDef:  # (5)
    ...
  1. See InputTypeDef
  2. See OutputTypeDef
  3. See CloudWatchLoggingOptionTypeDef
  4. See TagTypeDef
  5. See CreateApplicationResponseTypeDef 
# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

delete_application#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    ApplicationName: str,
    CreateTimestamp: TimestampTypeDef,
) -> dict[str, Any]:
    ...
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CreateTimestamp": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestRequestTypeDef

delete_application_cloud_watch_logging_option#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").delete_application_cloud_watch_logging_option method. boto3 documentation

# delete_application_cloud_watch_logging_option method definition

def delete_application_cloud_watch_logging_option(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    CloudWatchLoggingOptionId: str,
) -> dict[str, Any]:
    ...
# delete_application_cloud_watch_logging_option method usage example with argument unpacking

kwargs: DeleteApplicationCloudWatchLoggingOptionRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "CloudWatchLoggingOptionId": ...,
}

parent.delete_application_cloud_watch_logging_option(**kwargs)
  1. See DeleteApplicationCloudWatchLoggingOptionRequestRequestTypeDef

delete_application_input_processing_configuration#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").delete_application_input_processing_configuration method. boto3 documentation

# delete_application_input_processing_configuration method definition

def delete_application_input_processing_configuration(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    InputId: str,
) -> dict[str, Any]:
    ...
# delete_application_input_processing_configuration method usage example with argument unpacking

kwargs: DeleteApplicationInputProcessingConfigurationRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "InputId": ...,
}

parent.delete_application_input_processing_configuration(**kwargs)
  1. See DeleteApplicationInputProcessingConfigurationRequestRequestTypeDef

delete_application_output#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").delete_application_output method. boto3 documentation

# delete_application_output method definition

def delete_application_output(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    OutputId: str,
) -> dict[str, Any]:
    ...
# delete_application_output method usage example with argument unpacking

kwargs: DeleteApplicationOutputRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "OutputId": ...,
}

parent.delete_application_output(**kwargs)
  1. See DeleteApplicationOutputRequestRequestTypeDef

delete_application_reference_data_source#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").delete_application_reference_data_source method. boto3 documentation

# delete_application_reference_data_source method definition

def delete_application_reference_data_source(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    ReferenceId: str,
) -> dict[str, Any]:
    ...
# delete_application_reference_data_source method usage example with argument unpacking

kwargs: DeleteApplicationReferenceDataSourceRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "ReferenceId": ...,
}

parent.delete_application_reference_data_source(**kwargs)
  1. See DeleteApplicationReferenceDataSourceRequestRequestTypeDef

describe_application#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").describe_application method. boto3 documentation

# describe_application method definition

def describe_application(
    self,
    *,
    ApplicationName: str,
) -> DescribeApplicationResponseTypeDef:  # (1)
    ...
  1. See DescribeApplicationResponseTypeDef 
# describe_application method usage example with argument unpacking

kwargs: DescribeApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
}

parent.describe_application(**kwargs)
  1. See DescribeApplicationRequestRequestTypeDef

discover_input_schema#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").discover_input_schema method. boto3 documentation

# discover_input_schema method definition

def discover_input_schema(
    self,
    *,
    ResourceARN: str = ...,
    RoleARN: str = ...,
    InputStartingPositionConfiguration: InputStartingPositionConfigurationTypeDef = ...,  # (1)
    S3Configuration: S3ConfigurationTypeDef = ...,  # (2)
    InputProcessingConfiguration: InputProcessingConfigurationTypeDef = ...,  # (3)
) -> DiscoverInputSchemaResponseTypeDef:  # (4)
    ...
  1. See InputStartingPositionConfigurationTypeDef
  2. See S3ConfigurationTypeDef
  3. See InputProcessingConfigurationTypeDef
  4. See DiscoverInputSchemaResponseTypeDef 
# discover_input_schema method usage example with argument unpacking

kwargs: DiscoverInputSchemaRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.discover_input_schema(**kwargs)
  1. See DiscoverInputSchemaRequestRequestTypeDef

list_applications#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    Limit: int = ...,
    ExclusiveStartApplicationName: str = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationsResponseTypeDef 
# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestRequestTypeDef = {  # (1)
    "Limit": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestRequestTypeDef

list_tags_for_resource#

Retrieves the list of key-value tags assigned to the application.

Type annotations and code completion for boto3.client("kinesisanalytics").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_application#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").start_application method. boto3 documentation

# start_application method definition

def start_application(
    self,
    *,
    ApplicationName: str,
    InputConfigurations: Sequence[InputConfigurationTypeDef],  # (1)
) -> dict[str, Any]:
    ...
  1. See InputConfigurationTypeDef 
# start_application method usage example with argument unpacking

kwargs: StartApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "InputConfigurations": ...,
}

parent.start_application(**kwargs)
  1. See StartApplicationRequestRequestTypeDef

stop_application#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").stop_application method. boto3 documentation

# stop_application method definition

def stop_application(
    self,
    *,
    ApplicationName: str,
) -> dict[str, Any]:
    ...
# stop_application method usage example with argument unpacking

kwargs: StopApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
}

parent.stop_application(**kwargs)
  1. See StopApplicationRequestRequestTypeDef

tag_resource#

Adds one or more key-value tags to a Kinesis Analytics application.

Type annotations and code completion for boto3.client("kinesisanalytics").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes one or more tags from a Kinesis Analytics application.

Type annotations and code completion for boto3.client("kinesisanalytics").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_application#

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications.

Type annotations and code completion for boto3.client("kinesisanalytics").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    ApplicationName: str,
    CurrentApplicationVersionId: int,
    ApplicationUpdate: ApplicationUpdateTypeDef,  # (1)
) -> dict[str, Any]:
    ...
  1. See ApplicationUpdateTypeDef 
# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "CurrentApplicationVersionId": ...,
    "ApplicationUpdate": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestRequestTypeDef