KinesisAnalyticsV2Client#
Index > KinesisAnalyticsV2 > KinesisAnalyticsV2Client
Auto-generated documentation for KinesisAnalyticsV2 type annotations stubs module mypy-boto3-kinesisanalyticsv2.
KinesisAnalyticsV2Client#
Type annotations and code completion for boto3.client("kinesisanalyticsv2")
.
boto3 documentation
# KinesisAnalyticsV2Client usage example
from boto3.session import Session
from mypy_boto3_kinesisanalyticsv2.client import KinesisAnalyticsV2Client
def get_kinesisanalyticsv2_client() -> KinesisAnalyticsV2Client:
return Session().client("kinesisanalyticsv2")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("kinesisanalyticsv2").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("kinesisanalyticsv2")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.CodeValidationException,
client.exceptions.ConcurrentModificationException,
client.exceptions.InvalidApplicationConfigurationException,
client.exceptions.InvalidArgumentException,
client.exceptions.InvalidRequestException,
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 mypy_boto3_kinesisanalyticsv2.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
add_application_cloud_watch_logging_option#
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").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,
CloudWatchLoggingOption: CloudWatchLoggingOptionTypeDef, # (1)
CurrentApplicationVersionId: int = ...,
ConditionalToken: str = ...,
) -> AddApplicationCloudWatchLoggingOptionResponseTypeDef: # (2)
...
# add_application_cloud_watch_logging_option method usage example with argument unpacking
kwargs: AddApplicationCloudWatchLoggingOptionRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CloudWatchLoggingOption": ...,
}
parent.add_application_cloud_watch_logging_option(**kwargs)
add_application_input#
Adds a streaming source to your SQL-based Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").add_application_input
method.
boto3 documentation
# add_application_input method definition
def add_application_input(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
Input: InputTypeDef, # (1)
) -> AddApplicationInputResponseTypeDef: # (2)
...
# add_application_input method usage example with argument unpacking
kwargs: AddApplicationInputRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CurrentApplicationVersionId": ...,
"Input": ...,
}
parent.add_application_input(**kwargs)
add_application_input_processing_configuration#
Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").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)
) -> AddApplicationInputProcessingConfigurationResponseTypeDef: # (2)
...
- See InputProcessingConfigurationTypeDef
- See AddApplicationInputProcessingConfigurationResponseTypeDef
# 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)
add_application_output#
Adds an external destination to your SQL-based Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").add_application_output
method.
boto3 documentation
# add_application_output method definition
def add_application_output(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
Output: OutputTypeDef, # (1)
) -> AddApplicationOutputResponseTypeDef: # (2)
...
# add_application_output method usage example with argument unpacking
kwargs: AddApplicationOutputRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CurrentApplicationVersionId": ...,
"Output": ...,
}
parent.add_application_output(**kwargs)
add_application_reference_data_source#
Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").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)
) -> AddApplicationReferenceDataSourceResponseTypeDef: # (2)
...
# add_application_reference_data_source method usage example with argument unpacking
kwargs: AddApplicationReferenceDataSourceRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CurrentApplicationVersionId": ...,
"ReferenceDataSource": ...,
}
parent.add_application_reference_data_source(**kwargs)
add_application_vpc_configuration#
Adds a Virtual Private Cloud (VPC) configuration to the application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").add_application_vpc_configuration
method.
boto3 documentation
# add_application_vpc_configuration method definition
def add_application_vpc_configuration(
self,
*,
ApplicationName: str,
VpcConfiguration: VpcConfigurationTypeDef, # (1)
CurrentApplicationVersionId: int = ...,
ConditionalToken: str = ...,
) -> AddApplicationVpcConfigurationResponseTypeDef: # (2)
...
# add_application_vpc_configuration method usage example with argument unpacking
kwargs: AddApplicationVpcConfigurationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"VpcConfiguration": ...,
}
parent.add_application_vpc_configuration(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_application#
Creates a Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").create_application
method.
boto3 documentation
# create_application method definition
def create_application(
self,
*,
ApplicationName: str,
RuntimeEnvironment: RuntimeEnvironmentType, # (1)
ServiceExecutionRole: str,
ApplicationDescription: str = ...,
ApplicationConfiguration: ApplicationConfigurationTypeDef = ..., # (2)
CloudWatchLoggingOptions: Sequence[CloudWatchLoggingOptionTypeDef] = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
ApplicationMode: ApplicationModeType = ..., # (5)
) -> CreateApplicationResponseTypeDef: # (6)
...
- See RuntimeEnvironmentType
- See ApplicationConfigurationTypeDef
- See CloudWatchLoggingOptionTypeDef
- See TagTypeDef
- See ApplicationModeType
- See CreateApplicationResponseTypeDef
# create_application method usage example with argument unpacking
kwargs: CreateApplicationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"RuntimeEnvironment": ...,
"ServiceExecutionRole": ...,
}
parent.create_application(**kwargs)
create_application_presigned_url#
Creates and returns a URL that you can use to connect to an application's extension.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").create_application_presigned_url
method.
boto3 documentation
# create_application_presigned_url method definition
def create_application_presigned_url(
self,
*,
ApplicationName: str,
UrlType: UrlTypeType, # (1)
SessionExpirationDurationInSeconds: int = ...,
) -> CreateApplicationPresignedUrlResponseTypeDef: # (2)
...
# create_application_presigned_url method usage example with argument unpacking
kwargs: CreateApplicationPresignedUrlRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"UrlType": ...,
}
parent.create_application_presigned_url(**kwargs)
create_application_snapshot#
Creates a snapshot of the application's state data.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").create_application_snapshot
method.
boto3 documentation
# create_application_snapshot method definition
def create_application_snapshot(
self,
*,
ApplicationName: str,
SnapshotName: str,
) -> Dict[str, Any]:
...
# create_application_snapshot method usage example with argument unpacking
kwargs: CreateApplicationSnapshotRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"SnapshotName": ...,
}
parent.create_application_snapshot(**kwargs)
delete_application#
Deletes the specified application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").delete_application
method.
boto3 documentation
# delete_application method definition
def delete_application(
self,
*,
ApplicationName: str,
CreateTimestamp: Union[datetime, str],
) -> Dict[str, Any]:
...
# delete_application method usage example with argument unpacking
kwargs: DeleteApplicationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CreateTimestamp": ...,
}
parent.delete_application(**kwargs)
delete_application_cloud_watch_logging_option#
Deletes an Amazon CloudWatch log stream from an Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").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,
CloudWatchLoggingOptionId: str,
CurrentApplicationVersionId: int = ...,
ConditionalToken: str = ...,
) -> DeleteApplicationCloudWatchLoggingOptionResponseTypeDef: # (1)
...
# delete_application_cloud_watch_logging_option method usage example with argument unpacking
kwargs: DeleteApplicationCloudWatchLoggingOptionRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CloudWatchLoggingOptionId": ...,
}
parent.delete_application_cloud_watch_logging_option(**kwargs)
delete_application_input_processing_configuration#
Deletes an InputProcessingConfiguration from an input.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").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,
) -> DeleteApplicationInputProcessingConfigurationResponseTypeDef: # (1)
...
# delete_application_input_processing_configuration method usage example with argument unpacking
kwargs: DeleteApplicationInputProcessingConfigurationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CurrentApplicationVersionId": ...,
"InputId": ...,
}
parent.delete_application_input_processing_configuration(**kwargs)
delete_application_output#
Deletes the output destination configuration from your SQL-based Kinesis Data Analytics application's configuration.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").delete_application_output
method.
boto3 documentation
# delete_application_output method definition
def delete_application_output(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
OutputId: str,
) -> DeleteApplicationOutputResponseTypeDef: # (1)
...