NAME

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

SYNOPSIS

  use Paws;

  my $obj = Paws->service('KinesisAnalytics');
  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

METHODS

AddApplicationInput(ApplicationName => Str, CurrentApplicationVersionId => Int, Input => Paws::KinesisAnalytics::Input)

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

Returns: a Paws::KinesisAnalytics::AddApplicationInputResponse instance

  Adds a streaming source to your Amazon Kinesis application. For
conceptual information, see Configuring Application Input.

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.

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.

This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.

AddApplicationOutput(ApplicationName => Str, CurrentApplicationVersionId => Int, Output => Paws::KinesisAnalytics::Output)

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

Returns: a Paws::KinesisAnalytics::AddApplicationOutputResponse instance

  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 or a Firehose delivery stream), 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 conceptual information, see Understanding Application Output (Destination).

Note that 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.

For the limits on the number of application inputs and outputs you can configure, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

AddApplicationReferenceDataSource(ApplicationName => Str, CurrentApplicationVersionId => Int, ReferenceDataSource => Paws::KinesisAnalytics::ReferenceDataSource)

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

Returns: a Paws::KinesisAnalytics::AddApplicationReferenceDataSourceResponse instance

  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. For the limits on data sources you can add to your application, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

CreateApplication(ApplicationName => Str, [ApplicationCode => Str, ApplicationDescription => Str, Inputs => ArrayRef[Paws::KinesisAnalytics::Input], Outputs => ArrayRef[Paws::KinesisAnalytics::Output]])

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

Returns: a Paws::KinesisAnalytics::CreateApplicationResponse instance

  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 five streaming destinations where you want
Amazon Kinesis Analytics to write the output data from your
application. For an overview, see How it Works.

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, with the option of renaming, casting and dropping columns as desired.

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 five streaming 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.

DeleteApplication(ApplicationName => Str, CreateTimestamp => Str)

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

Returns: a Paws::KinesisAnalytics::DeleteApplicationResponse instance

  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.

DeleteApplicationOutput(ApplicationName => Str, CurrentApplicationVersionId => Int, OutputId => Str)

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

Returns: a Paws::KinesisAnalytics::DeleteApplicationOutputResponse instance

  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.

DeleteApplicationReferenceDataSource(ApplicationName => Str, CurrentApplicationVersionId => Int, ReferenceId => Str)

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

Returns: a Paws::KinesisAnalytics::DeleteApplicationReferenceDataSourceResponse instance

  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 operation.

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.

DescribeApplication(ApplicationName => Str)

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

Returns: a Paws::KinesisAnalytics::DescribeApplicationResponse instance

  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 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.

DiscoverInputSchema(InputStartingPositionConfiguration => Paws::KinesisAnalytics::InputStartingPositionConfiguration, ResourceARN => Str, RoleARN => Str)

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

Returns: a Paws::KinesisAnalytics::DiscoverInputSchemaResponse instance

  Infers a schema by evaluating sample records on the specified streaming
source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery
stream). 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. 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.

ListApplications([ExclusiveStartApplicationName => Str, Limit => Int])

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

Returns: a Paws::KinesisAnalytics::ListApplicationsResponse instance

  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 C<HasMoreApplications> value as true, you can send another request
by adding the C<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.

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

StartApplication(ApplicationName => Str, InputConfigurations => ArrayRef[Paws::KinesisAnalytics::InputConfiguration])

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

Returns: a Paws::KinesisAnalytics::StartApplicationResponse instance

  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 operation.

After you start the application, you can stop the application from processing the input by calling the StopApplication operation.

This operation requires permissions to perform the kinesisanalytics:StartApplication action.

StopApplication(ApplicationName => Str)

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

Returns: a Paws::KinesisAnalytics::StopApplicationResponse instance

  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 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.

UpdateApplication(ApplicationName => Str, ApplicationUpdate => Paws::KinesisAnalytics::ApplicationUpdate, CurrentApplicationVersionId => Int)

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

Returns: a Paws::KinesisAnalytics::UpdateApplicationResponse instance

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

Note that Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.

This opeation requires permission for the kinesisanalytics:UpdateApplication action.

PAGINATORS

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

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws::SDK::Config

perl -MCPAN -e shell
install Paws::SDK::Config