NAME

Paws::KinesisAnalyticsV2 - Perl Interface to AWS Amazon Kinesis Analytics

SYNOPSIS

use Paws;

my $obj = Paws->service('KinesisAnalyticsV2');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

Documentation for Kinesis Data Analytics API v2

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2018-05-23

METHODS

AddApplicationCloudWatchLoggingOption

ApplicationName => Str
CloudWatchLoggingOption => Paws::KinesisAnalyticsV2::CloudWatchLoggingOption
CurrentApplicationVersionId => Int

Each argument is described in detail in: Paws::KinesisAnalyticsV2::AddApplicationCloudWatchLoggingOption

Returns: a Paws::KinesisAnalyticsV2::AddApplicationCloudWatchLoggingOptionResponse instance

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

AddApplicationInput

ApplicationName => Str
CurrentApplicationVersionId => Int
Input => Paws::KinesisAnalyticsV2::Input

Each argument is described in detail in: Paws::KinesisAnalyticsV2::AddApplicationInput

Returns: a Paws::KinesisAnalyticsV2::AddApplicationInputResponse instance

Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application.

You can add a streaming source 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.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

AddApplicationInputProcessingConfiguration

ApplicationName => Str
CurrentApplicationVersionId => Int
InputId => Str
InputProcessingConfiguration => Paws::KinesisAnalyticsV2::InputProcessingConfiguration

Each argument is described in detail in: Paws::KinesisAnalyticsV2::AddApplicationInputProcessingConfiguration

Returns: a Paws::KinesisAnalyticsV2::AddApplicationInputProcessingConfigurationResponse instance

Adds an InputProcessingConfiguration to an SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda (https://aws.amazon.com/documentation/lambda/).

AddApplicationOutput

ApplicationName => Str
CurrentApplicationVersionId => Int
Output => Paws::KinesisAnalyticsV2::Output

Each argument is described in detail in: Paws::KinesisAnalyticsV2::AddApplicationOutput

Returns: a Paws::KinesisAnalyticsV2::AddApplicationOutputResponse instance

Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application.

If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data 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.

AddApplicationReferenceDataSource

ApplicationName => Str
CurrentApplicationVersionId => Int
ReferenceDataSource => Paws::KinesisAnalyticsV2::ReferenceDataSource

Each argument is described in detail in: Paws::KinesisAnalyticsV2::AddApplicationReferenceDataSource

Returns: a Paws::KinesisAnalyticsV2::AddApplicationReferenceDataSourceResponse instance

Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application.

Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.

CreateApplication

ApplicationName => Str
RuntimeEnvironment => Str
ServiceExecutionRole => Str
[ApplicationConfiguration => Paws::KinesisAnalyticsV2::ApplicationConfiguration]
[ApplicationDescription => Str]
[CloudWatchLoggingOptions => ArrayRef[Paws::KinesisAnalyticsV2::CloudWatchLoggingOption]]

Each argument is described in detail in: Paws::KinesisAnalyticsV2::CreateApplication

Returns: a Paws::KinesisAnalyticsV2::CreateApplicationResponse instance

Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application (https://docs.aws.amazon.com/kinesisanalytics/latest/Java/creating-app.html).

SQL is not enabled for this private beta release. Using SQL parameters (such as SqlApplicationConfiguration) will result in an error.

CreateApplicationSnapshot

ApplicationName => Str
SnapshotName => Str

Each argument is described in detail in: Paws::KinesisAnalyticsV2::CreateApplicationSnapshot

Returns: a Paws::KinesisAnalyticsV2::CreateApplicationSnapshotResponse instance

Creates a snapshot of the application's state data.

DeleteApplication

ApplicationName => Str
CreateTimestamp => Str

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DeleteApplication

Returns: a Paws::KinesisAnalyticsV2::DeleteApplicationResponse instance

Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.

DeleteApplicationCloudWatchLoggingOption

ApplicationName => Str
CloudWatchLoggingOptionId => Str
CurrentApplicationVersionId => Int

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DeleteApplicationCloudWatchLoggingOption

Returns: a Paws::KinesisAnalyticsV2::DeleteApplicationCloudWatchLoggingOptionResponse instance

Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.

DeleteApplicationInputProcessingConfiguration

ApplicationName => Str
CurrentApplicationVersionId => Int
InputId => Str

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DeleteApplicationInputProcessingConfiguration

Returns: a Paws::KinesisAnalyticsV2::DeleteApplicationInputProcessingConfigurationResponse instance

Deletes an InputProcessingConfiguration from an input.

DeleteApplicationOutput

ApplicationName => Str
CurrentApplicationVersionId => Int
OutputId => Str

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DeleteApplicationOutput

Returns: a Paws::KinesisAnalyticsV2::DeleteApplicationOutputResponse instance

Deletes the output destination configuration from your SQL-based Amazon Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.

DeleteApplicationReferenceDataSource

ApplicationName => Str
CurrentApplicationVersionId => Int
ReferenceId => Str

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DeleteApplicationReferenceDataSource

Returns: a Paws::KinesisAnalyticsV2::DeleteApplicationReferenceDataSourceResponse instance

Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application's configuration.

If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

DeleteApplicationSnapshot

ApplicationName => Str
SnapshotCreationTimestamp => Str
SnapshotName => Str

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DeleteApplicationSnapshot

Returns: a Paws::KinesisAnalyticsV2::DeleteApplicationSnapshotResponse instance

Deletes a snapshot of application state.

DescribeApplication

ApplicationName => Str
[IncludeAdditionalDetails => Bool]

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DescribeApplication

Returns: a Paws::KinesisAnalyticsV2::DescribeApplicationResponse instance

Returns information about a specific Amazon Kinesis Data Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

DescribeApplicationSnapshot

ApplicationName => Str
SnapshotName => Str

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DescribeApplicationSnapshot

Returns: a Paws::KinesisAnalyticsV2::DescribeApplicationSnapshotResponse instance

Returns information about a snapshot of application state data.

DiscoverInputSchema

ServiceExecutionRole => Str
[InputProcessingConfiguration => Paws::KinesisAnalyticsV2::InputProcessingConfiguration]
[InputStartingPositionConfiguration => Paws::KinesisAnalyticsV2::InputStartingPositionConfiguration]
[ResourceARN => Str]
[S3Configuration => Paws::KinesisAnalyticsV2::S3Configuration]

Each argument is described in detail in: Paws::KinesisAnalyticsV2::DiscoverInputSchema

Returns: a Paws::KinesisAnalyticsV2::DiscoverInputSchemaResponse instance

Infers a schema for an SQL-based Amazon 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. 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. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

ListApplications

[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::KinesisAnalyticsV2::ListApplications

Returns: a Paws::KinesisAnalyticsV2::ListApplicationsResponse instance

Returns a list of Amazon Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.

If you want detailed information about a specific application, use DescribeApplication.

ListApplicationSnapshots

ApplicationName => Str
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::KinesisAnalyticsV2::ListApplicationSnapshots

Returns: a Paws::KinesisAnalyticsV2::ListApplicationSnapshotsResponse instance

Lists information about the current application snapshots.

StartApplication

ApplicationName => Str
RunConfiguration => Paws::KinesisAnalyticsV2::RunConfiguration

Each argument is described in detail in: Paws::KinesisAnalyticsV2::StartApplication

Returns: a Paws::KinesisAnalyticsV2::StartApplicationResponse instance

Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.

SQL is not enabled for this private beta. Using SQL parameters (such as RunConfiguration$SqlRunConfigurations) will result in an error.

StopApplication

ApplicationName => Str

Each argument is described in detail in: Paws::KinesisAnalyticsV2::StopApplication

Returns: a Paws::KinesisAnalyticsV2::StopApplicationResponse instance

Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state.

UpdateApplication

ApplicationName => Str
CurrentApplicationVersionId => Int
[ApplicationConfigurationUpdate => Paws::KinesisAnalyticsV2::ApplicationConfigurationUpdate]
[CloudWatchLoggingOptionUpdates => ArrayRef[Paws::KinesisAnalyticsV2::CloudWatchLoggingOptionUpdate]]
[RunConfigurationUpdate => Paws::KinesisAnalyticsV2::RunConfigurationUpdate]
[ServiceExecutionRoleUpdate => Str]

Each argument is described in detail in: Paws::KinesisAnalyticsV2::UpdateApplication

Returns: a Paws::KinesisAnalyticsV2::UpdateApplicationResponse instance

Updates an existing Amazon Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.

Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.

SQL is not enabled for this private beta. Using SQL parameters (such as SqlApplicationConfigurationUpdate) will result in an error.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllApplications(sub { },[Limit => Int, NextToken => Str])

ListAllApplications([Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- ApplicationSummaries, passing the object as the first parameter, and the string 'ApplicationSummaries' as the second parameter

If not, it will return a a Paws::KinesisAnalyticsV2::ListApplicationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllApplicationSnapshots(sub { },ApplicationName => Str, [Limit => Int, NextToken => Str])

ListAllApplicationSnapshots(ApplicationName => Str, [Limit => Int, NextToken => Str])