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
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.
client = boto3.client("kinesisanalyticsv2")
try:
do_something(client)
except (
client.ClientError,
client.CodeValidationException,
client.ConcurrentModificationException,
client.InvalidApplicationConfigurationException,
client.InvalidArgumentException,
client.InvalidRequestException,
client.LimitExceededException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.ResourceProvisionedThroughputExceededException,
client.ServiceUnavailableException,
client.TooManyTagsException,
client.UnableToDetectSchemaException,
client.UnsupportedOperationException,
) as e:
print(e)
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
def add_application_cloud_watch_logging_option(
self,
*,
ApplicationName: str,
CloudWatchLoggingOption: CloudWatchLoggingOptionTypeDef, # (1)
CurrentApplicationVersionId: int = ...,
ConditionalToken: str = ...,
) -> AddApplicationCloudWatchLoggingOptionResponseTypeDef: # (2)
...
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
def add_application_input(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
Input: InputTypeDef, # (1)
) -> AddApplicationInputResponseTypeDef: # (2)
...
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
def add_application_input_processing_configuration(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
InputId: str,
InputProcessingConfiguration: InputProcessingConfigurationTypeDef, # (1)
) -> AddApplicationInputProcessingConfigurationResponseTypeDef: # (2)
...
- See InputProcessingConfigurationTypeDef
- See AddApplicationInputProcessingConfigurationResponseTypeDef
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
def add_application_output(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
Output: OutputTypeDef, # (1)
) -> AddApplicationOutputResponseTypeDef: # (2)
...
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
def add_application_reference_data_source(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
ReferenceDataSource: ReferenceDataSourceTypeDef, # (1)
) -> AddApplicationReferenceDataSourceResponseTypeDef: # (2)
...
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
def add_application_vpc_configuration(
self,
*,
ApplicationName: str,
VpcConfiguration: VpcConfigurationTypeDef, # (1)
CurrentApplicationVersionId: int = ...,
ConditionalToken: str = ...,
) -> AddApplicationVpcConfigurationResponseTypeDef: # (2)
...
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").close
method.
boto3 documentation
create_application
Creates a Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").create_application
method.
boto3 documentation
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
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
def create_application_presigned_url(
self,
*,
ApplicationName: str,
UrlType: UrlTypeType, # (1)
SessionExpirationDurationInSeconds: int = ...,
) -> CreateApplicationPresignedUrlResponseTypeDef: # (2)
...
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
def create_application_snapshot(
self,
*,
ApplicationName: str,
SnapshotName: str,
) -> Dict[str, Any]:
...
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
def delete_application(
self,
*,
ApplicationName: str,
CreateTimestamp: Union[datetime, str],
) -> Dict[str, Any]:
...
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
def delete_application_cloud_watch_logging_option(
self,
*,
ApplicationName: str,
CloudWatchLoggingOptionId: str,
CurrentApplicationVersionId: int = ...,
ConditionalToken: str = ...,
) -> DeleteApplicationCloudWatchLoggingOptionResponseTypeDef: # (1)
...
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
def delete_application_input_processing_configuration(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
InputId: str,
) -> DeleteApplicationInputProcessingConfigurationResponseTypeDef: # (1)
...
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
def delete_application_output(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
OutputId: str,
) -> DeleteApplicationOutputResponseTypeDef: # (1)
...
kwargs: DeleteApplicationOutputRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CurrentApplicationVersionId": ...,
"OutputId": ...,
}
parent.delete_application_output(**kwargs)
delete_application_reference_data_source
Deletes a reference data source configuration from the specified SQL-based Kinesis Data Analytics application's configuration.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").delete_application_reference_data_source
method.
boto3 documentation
def delete_application_reference_data_source(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
ReferenceId: str,
) -> DeleteApplicationReferenceDataSourceResponseTypeDef: # (1)
...
kwargs: DeleteApplicationReferenceDataSourceRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CurrentApplicationVersionId": ...,
"ReferenceId": ...,
}
parent.delete_application_reference_data_source(**kwargs)
delete_application_snapshot
Deletes a snapshot of application state.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").delete_application_snapshot
method.
boto3 documentation
def delete_application_snapshot(
self,
*,
ApplicationName: str,
SnapshotName: str,
SnapshotCreationTimestamp: Union[datetime, str],
) -> Dict[str, Any]:
...
kwargs: DeleteApplicationSnapshotRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"SnapshotName": ...,
"SnapshotCreationTimestamp": ...,
}
parent.delete_application_snapshot(**kwargs)
delete_application_vpc_configuration
Removes a VPC configuration from a Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").delete_application_vpc_configuration
method.
boto3 documentation
def delete_application_vpc_configuration(
self,
*,
ApplicationName: str,
VpcConfigurationId: str,
CurrentApplicationVersionId: int = ...,
ConditionalToken: str = ...,
) -> DeleteApplicationVpcConfigurationResponseTypeDef: # (1)
...
kwargs: DeleteApplicationVpcConfigurationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"VpcConfigurationId": ...,
}
parent.delete_application_vpc_configuration(**kwargs)
describe_application
Returns information about a specific Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").describe_application
method.
boto3 documentation
def describe_application(
self,
*,
ApplicationName: str,
IncludeAdditionalDetails: bool = ...,
) -> DescribeApplicationResponseTypeDef: # (1)
...
kwargs: DescribeApplicationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
}
parent.describe_application(**kwargs)
describe_application_snapshot
Returns information about a snapshot of application state data.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").describe_application_snapshot
method.
boto3 documentation
def describe_application_snapshot(
self,
*,
ApplicationName: str,
SnapshotName: str,
) -> DescribeApplicationSnapshotResponseTypeDef: # (1)
...
kwargs: DescribeApplicationSnapshotRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"SnapshotName": ...,
}
parent.describe_application_snapshot(**kwargs)
describe_application_version
Provides a detailed description of a specified version of the application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").describe_application_version
method.
boto3 documentation
def describe_application_version(
self,
*,
ApplicationName: str,
ApplicationVersionId: int,
) -> DescribeApplicationVersionResponseTypeDef: # (1)
...
kwargs: DescribeApplicationVersionRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"ApplicationVersionId": ...,
}
parent.describe_application_version(**kwargs)
discover_input_schema
Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").discover_input_schema
method.
boto3 documentation
def discover_input_schema(
self,
*,
ServiceExecutionRole: str,
ResourceARN: str = ...,
InputStartingPositionConfiguration: InputStartingPositionConfigurationTypeDef = ..., # (1)
S3Configuration: S3ConfigurationTypeDef = ..., # (2)
InputProcessingConfiguration: InputProcessingConfigurationTypeDef = ..., # (3)
) -> DiscoverInputSchemaResponseTypeDef: # (4)
...
- See InputStartingPositionConfigurationTypeDef
- See S3ConfigurationTypeDef
- See InputProcessingConfigurationTypeDef
- See DiscoverInputSchemaResponseTypeDef
kwargs: DiscoverInputSchemaRequestRequestTypeDef = { # (1)
"ServiceExecutionRole": ...,
}
parent.discover_input_schema(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_application_snapshots
Lists information about the current application snapshots.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").list_application_snapshots
method.
boto3 documentation
def list_application_snapshots(
self,
*,
ApplicationName: str,
Limit: int = ...,
NextToken: str = ...,
) -> ListApplicationSnapshotsResponseTypeDef: # (1)
...
kwargs: ListApplicationSnapshotsRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
}
parent.list_application_snapshots(**kwargs)
list_application_versions
Lists all the versions for the specified application, including versions that were rolled back.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").list_application_versions
method.
boto3 documentation
def list_application_versions(
self,
*,
ApplicationName: str,
Limit: int = ...,
NextToken: str = ...,
) -> ListApplicationVersionsResponseTypeDef: # (1)
...
kwargs: ListApplicationVersionsRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
}
parent.list_application_versions(**kwargs)
list_applications
Returns a list of Kinesis Data Analytics applications in your account.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").list_applications
method.
boto3 documentation
def list_applications(
self,
*,
Limit: int = ...,
NextToken: str = ...,
) -> ListApplicationsResponseTypeDef: # (1)
...
kwargs: ListApplicationsRequestRequestTypeDef = { # (1)
"Limit": ...,
}
parent.list_applications(**kwargs)
list_tags_for_resource
Retrieves the list of key-value tags assigned to the application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
rollback_application
Reverts the application to the previous running version.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").rollback_application
method.
boto3 documentation
def rollback_application(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int,
) -> RollbackApplicationResponseTypeDef: # (1)
...
kwargs: RollbackApplicationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"CurrentApplicationVersionId": ...,
}
parent.rollback_application(**kwargs)
start_application
Starts the specified Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").start_application
method.
boto3 documentation
def start_application(
self,
*,
ApplicationName: str,
RunConfiguration: RunConfigurationTypeDef = ..., # (1)
) -> Dict[str, Any]:
...
kwargs: StartApplicationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
}
parent.start_application(**kwargs)
stop_application
Stops the application from processing data.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").stop_application
method.
boto3 documentation
def stop_application(
self,
*,
ApplicationName: str,
Force: bool = ...,
) -> Dict[str, Any]:
...
kwargs: StopApplicationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
}
parent.stop_application(**kwargs)
tag_resource
Adds one or more key-value tags to a Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes one or more tags from a Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_application
Updates an existing Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").update_application
method.
boto3 documentation
def update_application(
self,
*,
ApplicationName: str,
CurrentApplicationVersionId: int = ...,
ApplicationConfigurationUpdate: ApplicationConfigurationUpdateTypeDef = ..., # (1)
ServiceExecutionRoleUpdate: str = ...,
RunConfigurationUpdate: RunConfigurationUpdateTypeDef = ..., # (2)
CloudWatchLoggingOptionUpdates: Sequence[CloudWatchLoggingOptionUpdateTypeDef] = ..., # (3)
ConditionalToken: str = ...,
) -> UpdateApplicationResponseTypeDef: # (4)
...
- See ApplicationConfigurationUpdateTypeDef
- See RunConfigurationUpdateTypeDef
- See CloudWatchLoggingOptionUpdateTypeDef
- See UpdateApplicationResponseTypeDef
kwargs: UpdateApplicationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
}
parent.update_application(**kwargs)
update_application_maintenance_configuration
Updates the maintenance configuration of the Kinesis Data Analytics application.
Type annotations and code completion for boto3.client("kinesisanalyticsv2").update_application_maintenance_configuration
method.
boto3 documentation
def update_application_maintenance_configuration(
self,
*,
ApplicationName: str,
ApplicationMaintenanceConfigurationUpdate: ApplicationMaintenanceConfigurationUpdateTypeDef, # (1)
) -> UpdateApplicationMaintenanceConfigurationResponseTypeDef: # (2)
...
- See ApplicationMaintenanceConfigurationUpdateTypeDef
- See UpdateApplicationMaintenanceConfigurationResponseTypeDef
kwargs: UpdateApplicationMaintenanceConfigurationRequestRequestTypeDef = { # (1)
"ApplicationName": ...,
"ApplicationMaintenanceConfigurationUpdate": ...,
}
parent.update_application_maintenance_configuration(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("kinesisanalyticsv2").get_paginator
method with overloads.
client.get_paginator("list_application_snapshots")
-> ListApplicationSnapshotsPaginatorclient.get_paginator("list_applications")
-> ListApplicationsPaginator