Packages
aws
1.0.12
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
AWS clients for Elixir
Current section
Files
Jump to
Current section
Files
lib/aws/generated/kinesis_analytics.ex
# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.KinesisAnalytics do
@moduledoc """
Amazon Kinesis Analytics
## Overview
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
This is the *Amazon Kinesis Analytics v1 API Reference*.
The Amazon Kinesis Analytics Developer Guide provides additional information.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
resource_provisioned_throughput_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_provisioned_throughput_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_input_processing_configuration_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CurrentApplicationVersionId") => float(),
required("InputId") => String.t() | atom()
}
"""
@type delete_application_input_processing_configuration_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
kinesis_firehose_output() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type kinesis_firehose_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
code_validation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type code_validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_application_configuration_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_application_configuration_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_description() :: %{
"InAppStreamNames" => list(String.t() | atom()),
"InputId" => String.t() | atom(),
"InputParallelism" => input_parallelism(),
"InputProcessingConfigurationDescription" => input_processing_configuration_description(),
"InputSchema" => source_schema(),
"InputStartingPositionConfiguration" => input_starting_position_configuration(),
"KinesisFirehoseInputDescription" => kinesis_firehose_input_description(),
"KinesisStreamsInputDescription" => kinesis_streams_input_description(),
"NamePrefix" => String.t() | atom()
}
"""
@type input_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_processing_configuration_update() :: %{
"InputLambdaProcessorUpdate" => input_lambda_processor_update()
}
"""
@type input_processing_configuration_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_unavailable_exception() :: %{
"message" => String.t() | atom()
}
"""
@type service_unavailable_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_firehose_output_description() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type kinesis_firehose_output_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
concurrent_modification_exception() :: %{
"message" => String.t() | atom()
}
"""
@type concurrent_modification_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_reference_data_source_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CurrentApplicationVersionId") => float(),
required("ReferenceDataSource") => reference_data_source()
}
"""
@type add_application_reference_data_source_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_schema_update() :: %{
"RecordColumnUpdates" => list(record_column()),
"RecordEncodingUpdate" => String.t() | atom(),
"RecordFormatUpdate" => record_format()
}
"""
@type input_schema_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
reference_data_source_update() :: %{
"ReferenceId" => String.t() | atom(),
"ReferenceSchemaUpdate" => source_schema(),
"S3ReferenceDataSourceUpdate" => s3_reference_data_source_update(),
"TableNameUpdate" => String.t() | atom()
}
"""
@type reference_data_source_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_application_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("InputConfigurations") => list(input_configuration())
}
"""
@type start_application_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
json_mapping_parameters() :: %{
"RecordRowPath" => String.t() | atom()
}
"""
@type json_mapping_parameters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"Key" => String.t() | atom(),
"Value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cloud_watch_logging_option_update() :: %{
"CloudWatchLoggingOptionId" => String.t() | atom(),
"LogStreamARNUpdate" => String.t() | atom(),
"RoleARNUpdate" => String.t() | atom()
}
"""
@type cloud_watch_logging_option_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
limit_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type limit_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_output_response() :: %{}
"""
@type delete_application_output_response() :: %{}
@typedoc """
## Example:
describe_application_response() :: %{
"ApplicationDetail" => application_detail()
}
"""
@type describe_application_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_output_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CurrentApplicationVersionId") => float(),
required("OutputId") => String.t() | atom()
}
"""
@type delete_application_output_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
destination_schema() :: %{
"RecordFormatType" => list(any())
}
"""
@type destination_schema() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_streams_input() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type kinesis_streams_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_application_response() :: %{}
"""
@type start_application_response() :: %{}
@typedoc """
## Example:
cloud_watch_logging_option_description() :: %{
"CloudWatchLoggingOptionId" => String.t() | atom(),
"LogStreamARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type cloud_watch_logging_option_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_cloud_watch_logging_option_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CloudWatchLoggingOption") => cloud_watch_logging_option(),
required("CurrentApplicationVersionId") => float()
}
"""
@type add_application_cloud_watch_logging_option_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_application_request() :: %{
optional("ApplicationCode") => String.t() | atom(),
optional("ApplicationDescription") => String.t() | atom(),
optional("CloudWatchLoggingOptions") => list(cloud_watch_logging_option()),
optional("Inputs") => list(input()),
optional("Outputs") => list(output()),
optional("Tags") => list(tag()),
required("ApplicationName") => String.t() | atom()
}
"""
@type create_application_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_input_processing_configuration_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CurrentApplicationVersionId") => float(),
required("InputId") => String.t() | atom(),
required("InputProcessingConfiguration") => input_processing_configuration()
}
"""
@type add_application_input_processing_configuration_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
kinesis_streams_input_description() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type kinesis_streams_input_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_lambda_processor_update() :: %{
"ResourceARNUpdate" => String.t() | atom(),
"RoleARNUpdate" => String.t() | atom()
}
"""
@type input_lambda_processor_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
discover_input_schema_request() :: %{
optional("InputProcessingConfiguration") => input_processing_configuration(),
optional("InputStartingPositionConfiguration") => input_starting_position_configuration(),
optional("ResourceARN") => String.t() | atom(),
optional("RoleARN") => String.t() | atom(),
optional("S3Configuration") => s3_configuration()
}
"""
@type discover_input_schema_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
output() :: %{
"DestinationSchema" => destination_schema(),
"KinesisFirehoseOutput" => kinesis_firehose_output(),
"KinesisStreamsOutput" => kinesis_streams_output(),
"LambdaOutput" => lambda_output(),
"Name" => String.t() | atom()
}
"""
@type output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
mapping_parameters() :: %{
"CSVMappingParameters" => csv_mapping_parameters(),
"JSONMappingParameters" => json_mapping_parameters()
}
"""
@type mapping_parameters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
lambda_output_update() :: %{
"ResourceARNUpdate" => String.t() | atom(),
"RoleARNUpdate" => String.t() | atom()
}
"""
@type lambda_output_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_cloud_watch_logging_option_response() :: %{}
"""
@type add_application_cloud_watch_logging_option_response() :: %{}
@typedoc """
## Example:
output_update() :: %{
"DestinationSchemaUpdate" => destination_schema(),
"KinesisFirehoseOutputUpdate" => kinesis_firehose_output_update(),
"KinesisStreamsOutputUpdate" => kinesis_streams_output_update(),
"LambdaOutputUpdate" => lambda_output_update(),
"NameUpdate" => String.t() | atom(),
"OutputId" => String.t() | atom()
}
"""
@type output_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_streams_input_update() :: %{
"ResourceARNUpdate" => String.t() | atom(),
"RoleARNUpdate" => String.t() | atom()
}
"""
@type kinesis_streams_input_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_firehose_input_update() :: %{
"ResourceARNUpdate" => String.t() | atom(),
"RoleARNUpdate" => String.t() | atom()
}
"""
@type kinesis_firehose_input_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
output_description() :: %{
"DestinationSchema" => destination_schema(),
"KinesisFirehoseOutputDescription" => kinesis_firehose_output_description(),
"KinesisStreamsOutputDescription" => kinesis_streams_output_description(),
"LambdaOutputDescription" => lambda_output_description(),
"Name" => String.t() | atom(),
"OutputId" => String.t() | atom()
}
"""
@type output_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_firehose_output_update() :: %{
"ResourceARNUpdate" => String.t() | atom(),
"RoleARNUpdate" => String.t() | atom()
}
"""
@type kinesis_firehose_output_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_input_processing_configuration_response() :: %{}
"""
@type add_application_input_processing_configuration_response() :: %{}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_applications_response() :: %{
"ApplicationSummaries" => list(application_summary()),
"HasMoreApplications" => boolean()
}
"""
@type list_applications_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_reference_data_source_response() :: %{}
"""
@type add_application_reference_data_source_response() :: %{}
@typedoc """
## Example:
input_update() :: %{
"InputId" => String.t() | atom(),
"InputParallelismUpdate" => input_parallelism_update(),
"InputProcessingConfigurationUpdate" => input_processing_configuration_update(),
"InputSchemaUpdate" => input_schema_update(),
"KinesisFirehoseInputUpdate" => kinesis_firehose_input_update(),
"KinesisStreamsInputUpdate" => kinesis_streams_input_update(),
"NamePrefixUpdate" => String.t() | atom()
}
"""
@type input_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("ResourceARN") => String.t() | atom(),
required("Tags") => list(tag())
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_lambda_processor() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type input_lambda_processor() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
application_detail() :: %{
"ApplicationARN" => String.t() | atom(),
"ApplicationCode" => String.t() | atom(),
"ApplicationDescription" => String.t() | atom(),
"ApplicationName" => String.t() | atom(),
"ApplicationStatus" => list(any()),
"ApplicationVersionId" => float(),
"CloudWatchLoggingOptionDescriptions" => list(cloud_watch_logging_option_description()),
"CreateTimestamp" => non_neg_integer(),
"InputDescriptions" => list(input_description()),
"LastUpdateTimestamp" => non_neg_integer(),
"OutputDescriptions" => list(output_description()),
"ReferenceDataSourceDescriptions" => list(reference_data_source_description())
}
"""
@type application_detail() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unsupported_operation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type unsupported_operation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CreateTimestamp") => non_neg_integer()
}
"""
@type delete_application_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
application_update() :: %{
"ApplicationCodeUpdate" => String.t() | atom(),
"CloudWatchLoggingOptionUpdates" => list(cloud_watch_logging_option_update()),
"InputUpdates" => list(input_update()),
"OutputUpdates" => list(output_update()),
"ReferenceDataSourceUpdates" => list(reference_data_source_update())
}
"""
@type application_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_application_response() :: %{}
"""
@type update_application_response() :: %{}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
unable_to_detect_schema_exception() :: %{
"ProcessedInputRecords" => list(String.t() | atom()),
"RawInputRecords" => list(String.t() | atom()),
"message" => String.t() | atom()
}
"""
@type unable_to_detect_schema_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invalid_argument_exception() :: %{
"message" => String.t() | atom()
}
"""
@type invalid_argument_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_in_use_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_in_use_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_response() :: %{}
"""
@type delete_application_response() :: %{}
@typedoc """
## Example:
list_applications_request() :: %{
optional("ExclusiveStartApplicationName") => String.t() | atom(),
optional("Limit") => integer()
}
"""
@type list_applications_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
csv_mapping_parameters() :: %{
"RecordColumnDelimiter" => String.t() | atom(),
"RecordRowDelimiter" => String.t() | atom()
}
"""
@type csv_mapping_parameters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_starting_position_configuration() :: %{
"InputStartingPosition" => list(any())
}
"""
@type input_starting_position_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
input_processing_configuration() :: %{
"InputLambdaProcessor" => input_lambda_processor()
}
"""
@type input_processing_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_application_request() :: %{
required("ApplicationName") => String.t() | atom()
}
"""
@type describe_application_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_output_response() :: %{}
"""
@type add_application_output_response() :: %{}
@typedoc """
## Example:
record_column() :: %{
"Mapping" => String.t() | atom(),
"Name" => String.t() | atom(),
"SqlType" => String.t() | atom()
}
"""
@type record_column() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("ResourceARN") => String.t() | atom(),
required("TagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_reference_data_source_update() :: %{
"BucketARNUpdate" => String.t() | atom(),
"FileKeyUpdate" => String.t() | atom(),
"ReferenceRoleARNUpdate" => String.t() | atom()
}
"""
@type s3_reference_data_source_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_input_processing_configuration_response() :: %{}
"""
@type delete_application_input_processing_configuration_response() :: %{}
@typedoc """
## Example:
s3_reference_data_source() :: %{
"BucketARN" => String.t() | atom(),
"FileKey" => String.t() | atom(),
"ReferenceRoleARN" => String.t() | atom()
}
"""
@type s3_reference_data_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_cloud_watch_logging_option_response() :: %{}
"""
@type delete_application_cloud_watch_logging_option_response() :: %{}
@typedoc """
## Example:
add_application_input_response() :: %{}
"""
@type add_application_input_response() :: %{}
@typedoc """
## Example:
create_application_response() :: %{
"ApplicationSummary" => application_summary()
}
"""
@type create_application_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_input_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CurrentApplicationVersionId") => float(),
required("Input") => input()
}
"""
@type add_application_input_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_streams_output() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type kinesis_streams_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
add_application_output_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CurrentApplicationVersionId") => float(),
required("Output") => output()
}
"""
@type add_application_output_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cloud_watch_logging_option() :: %{
"LogStreamARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type cloud_watch_logging_option() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_reference_data_source_response() :: %{}
"""
@type delete_application_reference_data_source_response() :: %{}
@typedoc """
## Example:
stop_application_request() :: %{
required("ApplicationName") => String.t() | atom()
}
"""
@type stop_application_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
application_summary() :: %{
"ApplicationARN" => String.t() | atom(),
"ApplicationName" => String.t() | atom(),
"ApplicationStatus" => list(any())
}
"""
@type application_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"Tags" => list(tag())
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_processing_configuration_description() :: %{
"InputLambdaProcessorDescription" => input_lambda_processor_description()
}
"""
@type input_processing_configuration_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_application_response() :: %{}
"""
@type stop_application_response() :: %{}
@typedoc """
## Example:
too_many_tags_exception() :: %{
"message" => String.t() | atom()
}
"""
@type too_many_tags_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_configuration() :: %{
"Id" => String.t() | atom(),
"InputStartingPositionConfiguration" => input_starting_position_configuration()
}
"""
@type input_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_parallelism() :: %{
"Count" => integer()
}
"""
@type input_parallelism() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_streams_output_update() :: %{
"ResourceARNUpdate" => String.t() | atom(),
"RoleARNUpdate" => String.t() | atom()
}
"""
@type kinesis_streams_output_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
reference_data_source_description() :: %{
"ReferenceId" => String.t() | atom(),
"ReferenceSchema" => source_schema(),
"S3ReferenceDataSourceDescription" => s3_reference_data_source_description(),
"TableName" => String.t() | atom()
}
"""
@type reference_data_source_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
discover_input_schema_response() :: %{
"InputSchema" => source_schema(),
"ParsedInputRecords" => list(list(String.t() | atom())()),
"ProcessedInputRecords" => list(String.t() | atom()),
"RawInputRecords" => list(String.t() | atom())
}
"""
@type discover_input_schema_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_parallelism_update() :: %{
"CountUpdate" => integer()
}
"""
@type input_parallelism_update() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
source_schema() :: %{
"RecordColumns" => list(record_column()),
"RecordEncoding" => String.t() | atom(),
"RecordFormat" => record_format()
}
"""
@type source_schema() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_reference_data_source_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CurrentApplicationVersionId") => float(),
required("ReferenceId") => String.t() | atom()
}
"""
@type delete_application_reference_data_source_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_application_cloud_watch_logging_option_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("CloudWatchLoggingOptionId") => String.t() | atom(),
required("CurrentApplicationVersionId") => float()
}
"""
@type delete_application_cloud_watch_logging_option_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
s3_configuration() :: %{
"BucketARN" => String.t() | atom(),
"FileKey" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type s3_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_application_request() :: %{
required("ApplicationName") => String.t() | atom(),
required("ApplicationUpdate") => application_update(),
required("CurrentApplicationVersionId") => float()
}
"""
@type update_application_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_firehose_input_description() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type kinesis_firehose_input_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
lambda_output_description() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type lambda_output_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_reference_data_source_description() :: %{
"BucketARN" => String.t() | atom(),
"FileKey" => String.t() | atom(),
"ReferenceRoleARN" => String.t() | atom()
}
"""
@type s3_reference_data_source_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
lambda_output() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type lambda_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_streams_output_description() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type kinesis_streams_output_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input_lambda_processor_description() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type input_lambda_processor_description() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kinesis_firehose_input() :: %{
"ResourceARN" => String.t() | atom(),
"RoleARN" => String.t() | atom()
}
"""
@type kinesis_firehose_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{
required("ResourceARN") => String.t() | atom()
}
"""
@type list_tags_for_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
record_format() :: %{
"MappingParameters" => mapping_parameters(),
"RecordFormatType" => list(any())
}
"""
@type record_format() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
input() :: %{
"InputParallelism" => input_parallelism(),
"InputProcessingConfiguration" => input_processing_configuration(),
"InputSchema" => source_schema(),
"KinesisFirehoseInput" => kinesis_firehose_input(),
"KinesisStreamsInput" => kinesis_streams_input(),
"NamePrefix" => String.t() | atom()
}
"""
@type input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
reference_data_source() :: %{
"ReferenceSchema" => source_schema(),
"S3ReferenceDataSource" => s3_reference_data_source(),
"TableName" => String.t() | atom()
}
"""
@type reference_data_source() :: %{(String.t() | atom()) => any()}
@type add_application_cloud_watch_logging_option_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type add_application_input_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
| code_validation_exception()
@type add_application_input_processing_configuration_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type add_application_output_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type add_application_reference_data_source_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type create_application_errors() ::
too_many_tags_exception()
| resource_in_use_exception()
| invalid_argument_exception()
| limit_exceeded_exception()
| concurrent_modification_exception()
| code_validation_exception()
@type delete_application_errors() ::
resource_in_use_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type delete_application_cloud_watch_logging_option_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type delete_application_input_processing_configuration_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type delete_application_output_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type delete_application_reference_data_source_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type describe_application_errors() ::
unsupported_operation_exception() | resource_not_found_exception()
@type discover_input_schema_errors() ::
invalid_argument_exception()
| unable_to_detect_schema_exception()
| service_unavailable_exception()
| resource_provisioned_throughput_exceeded_exception()
@type list_tags_for_resource_errors() ::
invalid_argument_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type start_application_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| invalid_application_configuration_exception()
@type stop_application_errors() ::
resource_in_use_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
@type tag_resource_errors() ::
too_many_tags_exception()
| resource_in_use_exception()
| invalid_argument_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type untag_resource_errors() ::
too_many_tags_exception()
| resource_in_use_exception()
| invalid_argument_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
@type update_application_errors() ::
resource_in_use_exception()
| invalid_argument_exception()
| unsupported_operation_exception()
| resource_not_found_exception()
| concurrent_modification_exception()
| code_validation_exception()
def metadata do
%{
api_version: "2015-08-14",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "kinesisanalytics",
global?: false,
hostname: nil,
protocol: "json",
service_id: "Kinesis Analytics",
signature_version: "v4",
signing_name: "kinesisanalytics",
target_prefix: "KinesisAnalytics_20150814"
}
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Adds a CloudWatch log stream to monitor application configuration errors. For
more
information about using CloudWatch log streams with Amazon Kinesis Analytics
applications, see [Working with Amazon CloudWatch
Logs](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html).
"""
@spec add_application_cloud_watch_logging_option(
map(),
add_application_cloud_watch_logging_option_request(),
list()
) ::
{:ok, add_application_cloud_watch_logging_option_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, add_application_cloud_watch_logging_option_errors()}
def add_application_cloud_watch_logging_option(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "AddApplicationCloudWatchLoggingOption", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Adds a streaming source to your Amazon Kinesis application.
For conceptual information,
see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
You can add a streaming source either when you create an application or you can
use
this operation to add a streaming source after you create an application. For
more information, see
[CreateApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_CreateApplication.html).
Any configuration update, including adding a streaming source using this
operation,
results in a new version of the application. You can use the
[DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html)
operation
to find the current application version.
This operation requires permissions to perform the
`kinesisanalytics:AddApplicationInput` action.
"""
@spec add_application_input(map(), add_application_input_request(), list()) ::
{:ok, add_application_input_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, add_application_input_errors()}
def add_application_input(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "AddApplicationInput", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Adds an
[InputProcessingConfiguration](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html) to an application. An input processor preprocesses records on the input stream
before the application's SQL code executes. Currently, the only input processor
available is
[AWS Lambda](https://docs.aws.amazon.com/lambda/).
"""
@spec add_application_input_processing_configuration(
map(),
add_application_input_processing_configuration_request(),
list()
) ::
{:ok, add_application_input_processing_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, add_application_input_processing_configuration_errors()}
def add_application_input_processing_configuration(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(
client,
meta,
"AddApplicationInputProcessingConfiguration",
input,
options
)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Adds an external destination to your Amazon Kinesis Analytics application.
If you want Amazon Kinesis Analytics to deliver data from an in-application
stream
within your application to an external destination (such as an Amazon Kinesis
stream, an
Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the
relevant configuration to your application using this operation. You can
configure one
or more outputs for your application. Each output configuration maps an
in-application
stream and an external destination.
You can use one of the output configurations to deliver data from your
in-application error stream to an external destination so that you can analyze
the
errors. For more information, see [Understanding Application Output
(Destination)](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html).
Any configuration update, including adding a streaming source using this
operation, results in a new version of the application. You can use the
[DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation to find the current application
version.
For the limits on the number of application inputs and outputs
you can configure, see
[Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).
This operation requires permissions to perform the
`kinesisanalytics:AddApplicationOutput` action.
"""
@spec add_application_output(map(), add_application_output_request(), list()) ::
{:ok, add_application_output_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, add_application_output_errors()}
def add_application_output(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "AddApplicationOutput", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Adds a reference data source to an existing application.
Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and
creates an in-application table within your application. In the request, you
provide the source (S3 bucket name and object key name), name of the
in-application table to create, and the necessary mapping information that
describes how data in Amazon S3 object maps to columns in the resulting
in-application table.
For conceptual information,
see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
For the limits on data sources you can add to your application, see
[Limits](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html).
This operation requires permissions to perform the
`kinesisanalytics:AddApplicationOutput` action.
"""
@spec add_application_reference_data_source(
map(),
add_application_reference_data_source_request(),
list()
) ::
{:ok, add_application_reference_data_source_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, add_application_reference_data_source_errors()}
def add_application_reference_data_source(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "AddApplicationReferenceDataSource", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Creates an Amazon Kinesis Analytics application.
You can configure each application with one streaming source as input,
application code to process the input, and up to
three destinations where
you want Amazon Kinesis Analytics to write the output data from your
application.
For an overview, see
[How it Works](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html).
In the input configuration, you map the streaming source to an in-application
stream, which you can think of as a constantly updating table. In the mapping,
you must provide a schema for the in-application stream and map each data column
in the in-application stream to a
data element in the streaming source.
Your application code is one or more SQL statements that read input data,
transform it, and generate output. Your application code can create one or more
SQL artifacts like SQL streams or pumps.
In the output configuration, you can configure the application to write data
from in-application streams created in your applications to up to three
destinations.
To read data from your source stream or write data to destination streams,
Amazon Kinesis Analytics
needs your permissions. You grant these permissions by creating IAM roles. This
operation requires permissions to perform the
`kinesisanalytics:CreateApplication` action.
For introductory exercises to create an Amazon Kinesis Analytics application,
see
[Getting Started](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html).
"""
@spec create_application(map(), create_application_request(), list()) ::
{:ok, create_application_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_application_errors()}
def create_application(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "CreateApplication", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes the specified application. Amazon Kinesis Analytics halts application
execution and deletes the application, including any application artifacts (such
as in-application streams, reference table, and application code).
This operation requires permissions to perform the
`kinesisanalytics:DeleteApplication` action.
"""
@spec delete_application(map(), delete_application_request(), list()) ::
{:ok, delete_application_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_application_errors()}
def delete_application(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DeleteApplication", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes a CloudWatch log stream from an application. For more information about
using CloudWatch log streams with Amazon Kinesis Analytics applications, see
[Working with Amazon CloudWatch Logs](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html).
"""
@spec delete_application_cloud_watch_logging_option(
map(),
delete_application_cloud_watch_logging_option_request(),
list()
) ::
{:ok, delete_application_cloud_watch_logging_option_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_application_cloud_watch_logging_option_errors()}
def delete_application_cloud_watch_logging_option(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DeleteApplicationCloudWatchLoggingOption", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes an
[InputProcessingConfiguration](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_InputProcessingConfiguration.html)
from an input.
"""
@spec delete_application_input_processing_configuration(
map(),
delete_application_input_processing_configuration_request(),
list()
) ::
{:ok, delete_application_input_processing_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_application_input_processing_configuration_errors()}
def delete_application_input_processing_configuration(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(
client,
meta,
"DeleteApplicationInputProcessingConfiguration",
input,
options
)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes output destination configuration from your application configuration.
Amazon Kinesis Analytics will no longer write data from the corresponding
in-application stream to the external output destination.
This operation requires permissions to perform the
`kinesisanalytics:DeleteApplicationOutput` action.
"""
@spec delete_application_output(map(), delete_application_output_request(), list()) ::
{:ok, delete_application_output_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_application_output_errors()}
def delete_application_output(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DeleteApplicationOutput", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Deletes a reference data source configuration from the specified application
configuration.
If the application is running, Amazon Kinesis Analytics immediately removes the
in-application table
that you created using the
[AddApplicationReferenceDataSource](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_AddApplicationReferenceDataSource.html)
operation.
This operation requires permissions to perform the
`kinesisanalytics.DeleteApplicationReferenceDataSource`
action.
"""
@spec delete_application_reference_data_source(
map(),
delete_application_reference_data_source_request(),
list()
) ::
{:ok, delete_application_reference_data_source_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_application_reference_data_source_errors()}
def delete_application_reference_data_source(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DeleteApplicationReferenceDataSource", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Returns information about a specific Amazon Kinesis Analytics application.
If you want to retrieve a list of all applications in your account,
use the
[ListApplications](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html)
operation.
This operation requires permissions to perform the
`kinesisanalytics:DescribeApplication`
action. You can use `DescribeApplication` to get the current application
versionId, which you need to call other
operations such as `Update`.
"""
@spec describe_application(map(), describe_application_request(), list()) ::
{:ok, describe_application_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_application_errors()}
def describe_application(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DescribeApplication", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Infers a schema by evaluating sample records on the specified streaming source
(Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object.
In the response, the operation returns the inferred schema and also the sample
records that the operation used to infer the schema.
You can use the inferred schema when configuring a streaming source
for your application. For conceptual information,
see [Configuring Application Input](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html).
Note that when you create an application using the Amazon Kinesis Analytics
console,
the console uses this operation to infer a schema and show it in the console
user interface.
This operation requires permissions to perform the
`kinesisanalytics:DiscoverInputSchema` action.
"""
@spec discover_input_schema(map(), discover_input_schema_request(), list()) ::
{:ok, discover_input_schema_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, discover_input_schema_errors()}
def discover_input_schema(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "DiscoverInputSchema", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Returns a list of Amazon Kinesis Analytics applications in your account.
For each application, the response includes the application name,
Amazon Resource Name (ARN), and status.
If the response returns the `HasMoreApplications` value as true,
you can send another request by adding the
`ExclusiveStartApplicationName` in the request body, and
set the value of this to the last application name from
the previous response.
If you want detailed information about a specific application, use
[DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html).
This operation requires permissions to perform the
`kinesisanalytics:ListApplications` action.
"""
@spec list_applications(map(), list_applications_request(), list()) ::
{:ok, list_applications_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
def list_applications(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListApplications", input, options)
end
@doc """
Retrieves the list of key-value tags assigned to the application.
For more information, see [Using Tagging](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html).
"""
@spec list_tags_for_resource(map(), list_tags_for_resource_request(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "ListTagsForResource", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Starts the specified Amazon Kinesis Analytics application. After creating an
application, you must exclusively call this operation to start your application.
After the application starts, it begins consuming the input data, processes it,
and writes the output to the configured destination.
The application status must be `READY` for you to start an application. You can
get the application status in the console or using the
[DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) operation.
After you start the application, you can stop the application from processing
the input by calling the
[StopApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_StopApplication.html)
operation.
This operation requires permissions to perform the
`kinesisanalytics:StartApplication` action.
"""
@spec start_application(map(), start_application_request(), list()) ::
{:ok, start_application_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_application_errors()}
def start_application(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "StartApplication", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Stops the application from processing input data. You can stop
an application only if it is in the running state.
You can use the
[DescribeApplication](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html)
operation to find the application state.
After the application is stopped,
Amazon Kinesis Analytics stops reading data from the input, the
application stops processing data, and there is no output written to the
destination.
This operation requires permissions to perform the
`kinesisanalytics:StopApplication` action.
"""
@spec stop_application(map(), stop_application_request(), list()) ::
{:ok, stop_application_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, stop_application_errors()}
def stop_application(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "StopApplication", input, options)
end
@doc """
Adds one or more key-value tags to a Kinesis Analytics 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](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html).
"""
@spec tag_resource(map(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "TagResource", input, options)
end
@doc """
Removes one or more tags from a Kinesis Analytics application.
For more information, see [Using Tagging](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-tagging.html).
"""
@spec untag_resource(map(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UntagResource", input, options)
end
@doc """
This documentation is for version 1 of the Amazon Kinesis Data Analytics API,
which only supports SQL applications.
Version 2 of the API supports SQL and Java applications. For more information
about version 2, see [Amazon Kinesis Data Analytics API V2 Documentation](/kinesisanalytics/latest/apiv2/Welcome.html).
Updates an existing Amazon Kinesis Analytics application. Using this API,
you can update application code, input configuration, and
output configuration.
Note that Amazon Kinesis Analytics updates the `CurrentApplicationVersionId`
each time you update your application.
This operation requires permission for the
`kinesisanalytics:UpdateApplication` action.
"""
@spec update_application(map(), update_application_request(), list()) ::
{:ok, update_application_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_application_errors()}
def update_application(%Client{} = client, input, options \\ []) do
meta =
metadata()
Request.request_post(client, meta, "UpdateApplication", input, options)
end
end