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

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using Java, SQL, or Scala. The service enables you to quickly author and run Java, SQL, or Scala code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.

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
[ConditionalToken => Str]
[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 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 a 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://docs.aws.amazon.com/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 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 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.

AddApplicationVpcConfiguration

ApplicationName => Str
VpcConfiguration => Paws::KinesisAnalyticsV2::VpcConfiguration
[ConditionalToken => Str]
[CurrentApplicationVersionId => Int]

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

Returns: a Paws::KinesisAnalyticsV2::AddApplicationVpcConfigurationResponse instance

Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely.

Note the following about VPC configurations for Kinesis Data Analytics applications:

VPC configurations are not supported for SQL applications.
When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.

CreateApplication

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

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

Returns: a Paws::KinesisAnalyticsV2::CreateApplicationResponse instance

Creates a 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/getting-started.html).

CreateApplicationPresignedUrl

ApplicationName => Str
UrlType => Str
[SessionExpirationDurationInSeconds => Int]

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

Returns: a Paws::KinesisAnalyticsV2::CreateApplicationPresignedUrlResponse instance

Creates and returns a URL that you can use to connect to an application's extension. Currently, the only available extension is the Apache Flink dashboard.

The IAM role or user used to call this API defines the permissions to access the extension. After the presigned URL is created, no additional permission is required to access this URL. IAM authorization policies for this API are also enforced for every HTTP request that attempts to connect to the extension.

You control the amount of time that the URL will be valid using the "SessionExpirationDurationInSeconds" parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.

The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes to be valid. If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.

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
[ConditionalToken => 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 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 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 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.

DeleteApplicationVpcConfiguration

ApplicationName => Str
VpcConfigurationId => Str
[ConditionalToken => Str]
[CurrentApplicationVersionId => Int]

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

Returns: a Paws::KinesisAnalyticsV2::DeleteApplicationVpcConfigurationResponse instance

Removes a VPC configuration from a Kinesis Data Analytics application.

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

DescribeApplicationVersion

ApplicationName => Str
ApplicationVersionId => Int

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

Returns: a Paws::KinesisAnalyticsV2::DescribeApplicationVersionResponse instance

Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

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

ListApplicationVersions

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

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

Returns: a Paws::KinesisAnalyticsV2::ListApplicationVersionsResponse instance

Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.

To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

ListTagsForResource

ResourceARN => Str

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

Returns: a Paws::KinesisAnalyticsV2::ListTagsForResourceResponse instance

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html).

RollbackApplication

ApplicationName => Str
CurrentApplicationVersionId => Int

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

Returns: a Paws::KinesisAnalyticsV2::RollbackApplicationResponse instance

Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status.

You can roll back an application only if it is in the "UPDATING" or "AUTOSCALING" status.

When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Kinesis Data Analytics rejects the rollback request.

This action is not supported for Kinesis Data Analytics for SQL applications.

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 Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.

StopApplication

ApplicationName => Str
[Force => Bool]

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 status, unless you set the "Force" parameter to "true".

You can use the DescribeApplication operation to find the application status.

Kinesis Data Analytics takes a snapshot when the application is stopped, unless "Force" is set to "true".

TagResource

ResourceARN => Str
Tags => ArrayRef[Paws::KinesisAnalyticsV2::Tag]

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

Returns: a Paws::KinesisAnalyticsV2::TagResourceResponse instance

Adds one or more key-value tags to a Kinesis Data 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/java/how-tagging.html).

UntagResource

ResourceARN => Str
TagKeys => ArrayRef[Str|Undef]

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

Returns: a Paws::KinesisAnalyticsV2::UntagResourceResponse instance

Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging (https://docs.aws.amazon.com/kinesisanalytics/latest/java/how-tagging.html).

UpdateApplication

ApplicationName => Str
[ApplicationConfigurationUpdate => Paws::KinesisAnalyticsV2::ApplicationConfigurationUpdate]
[CloudWatchLoggingOptionUpdates => ArrayRef[Paws::KinesisAnalyticsV2::CloudWatchLoggingOptionUpdate]]
[ConditionalToken => Str]
[CurrentApplicationVersionId => Int]
[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 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.

You cannot update the "RuntimeEnvironment" of an existing application. If you need to update an application's "RuntimeEnvironment", you must delete the application and create it again.

UpdateApplicationMaintenanceConfiguration

ApplicationMaintenanceConfigurationUpdate => Paws::KinesisAnalyticsV2::ApplicationMaintenanceConfigurationUpdate
ApplicationName => Str

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

Returns: a Paws::KinesisAnalyticsV2::UpdateApplicationMaintenanceConfigurationResponse instance

Updates the maintenance configuration of the Kinesis Data Analytics application.

You can invoke this operation on an application that is in one of the two following states: "READY" or "RUNNING". If you invoke it when the application is in a state other than these two states, it throws a "ResourceInUseException". The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead.

To see the current maintenance configuration of your application, invoke the DescribeApplication operation.

For information about application maintenance, see Kinesis Data Analytics for Apache Flink Maintenance (https://docs.aws.amazon.com/kinesisanalytics/latest/java/maintenance.html).

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

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 "param"s; 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])

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

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

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

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>