You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.KinesisAnalyticsV2

Inherits:
AWS.Service show all
Identifier:
kinesisanalyticsv2
API Version:
2018-05-23
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

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

Sending a Request Using KinesisAnalyticsV2

var kinesisanalyticsv2 = new AWS.KinesisAnalyticsV2();
kinesisanalyticsv2.addApplicationCloudWatchLoggingOption(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the KinesisAnalyticsV2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kinesisanalyticsv2 = new AWS.KinesisAnalyticsV2({apiVersion: '2018-05-23'});

You can also set the API version globally in AWS.config.apiVersions using the kinesisanalyticsv2 service identifier:

AWS.config.apiVersions = {
  kinesisanalyticsv2: '2018-05-23',
  // other service API versions
};

var kinesisanalyticsv2 = new AWS.KinesisAnalyticsV2();

Version:

  • 2018-05-23

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.KinesisAnalyticsV2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a KinesisAnalyticsV2 object

var kinesisanalyticsv2 = new AWS.KinesisAnalyticsV2({apiVersion: '2018-05-23'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.KinesisAnalyticsV2.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.KinesisAnalyticsV2.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.KinesisAnalyticsV2.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addApplicationCloudWatchLoggingOption(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the addApplicationCloudWatchLoggingOption operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CloudWatchLoggingOption: { /* required */
    LogStreamARN: 'STRING_VALUE' /* required */
  },
  ConditionalToken: 'STRING_VALUE',
  CurrentApplicationVersionId: 'NUMBER_VALUE'
};
kinesisanalyticsv2.addApplicationCloudWatchLoggingOption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The Kinesis Data Analytics application name.

    • CurrentApplicationVersionId — (Integer)

      The version ID of the Kinesis Data Analytics application. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

    • CloudWatchLoggingOption — (map)

      Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).

      • LogStreamARN — required — (String)

        The ARN of the CloudWatch log to receive application messages.

    • ConditionalToken — (String)

      A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The application's ARN.

      • ApplicationVersionId — (Integer)

        The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

      • CloudWatchLoggingOptionDescriptions — (Array<map>)

        The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.

        • CloudWatchLoggingOptionId — (String)

          The ID of the CloudWatch logging option description.

        • LogStreamARN — required — (String)

          The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

        • RoleARN — (String)

          The IAM ARN of the role to use to send application messages.

          Note: Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addApplicationInput(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the addApplicationInput operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  Input: { /* required */
    InputSchema: { /* required */
      RecordColumns: [ /* required */
        {
          Name: 'STRING_VALUE', /* required */
          SqlType: 'STRING_VALUE', /* required */
          Mapping: 'STRING_VALUE'
        },
        /* more items */
      ],
      RecordFormat: { /* required */
        RecordFormatType: JSON | CSV, /* required */
        MappingParameters: {
          CSVMappingParameters: {
            RecordColumnDelimiter: 'STRING_VALUE', /* required */
            RecordRowDelimiter: 'STRING_VALUE' /* required */
          },
          JSONMappingParameters: {
            RecordRowPath: 'STRING_VALUE' /* required */
          }
        }
      },
      RecordEncoding: 'STRING_VALUE'
    },
    NamePrefix: 'STRING_VALUE', /* required */
    InputParallelism: {
      Count: 'NUMBER_VALUE'
    },
    InputProcessingConfiguration: {
      InputLambdaProcessor: { /* required */
        ResourceARN: 'STRING_VALUE' /* required */
      }
    },
    KinesisFirehoseInput: {
      ResourceARN: 'STRING_VALUE' /* required */
    },
    KinesisStreamsInput: {
      ResourceARN: 'STRING_VALUE' /* required */
    }
  }
};
kinesisanalyticsv2.addApplicationInput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of your existing application to which you want to add the streaming source.

    • CurrentApplicationVersionId — (Integer)

      The current version of your application. You must provide the ApplicationVersionID or the ConditionalToken.You can use the DescribeApplication operation to find the current application version.

    • Input — (map)

      The Input to add.

      • NamePrefix — required — (String)

        The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.

      • InputProcessingConfiguration — (map)

        The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

        • InputLambdaProcessor — required — (map)

          The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

          • ResourceARN — required — (String)

            The ARN of the Amazon Lambda function that operates on records in the stream.

            Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
      • KinesisStreamsInput — (map)

        If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).

        • ResourceARN — required — (String)

          The ARN of the input Kinesis data stream to read.

      • KinesisFirehoseInput — (map)

        If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.

        • ResourceARN — required — (String)

          The Amazon Resource Name (ARN) of the delivery stream.

      • InputParallelism — (map)

        Describes the number of in-application streams to create.

        • Count — (Integer)

          The number of in-application streams to create.

      • InputSchema — required — (map)

        Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

        Also used to describe the format of the reference data source.

        • RecordFormat — required — (map)

          Specifies the format of the records on the streaming source.

          • RecordFormatType — required — (String)

            The type of record format.

            Possible values include:
            • "JSON"
            • "CSV"
          • MappingParameters — (map)

            When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

            • JSONMappingParameters — (map)

              Provides additional mapping information when JSON is the record format on the streaming source.

              • RecordRowPath — required — (String)

                The path to the top-level parent that contains the records.

            • CSVMappingParameters — (map)

              Provides additional mapping information when the record format uses delimiters (for example, CSV).

              • RecordRowDelimiter — required — (String)

                The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

              • RecordColumnDelimiter — required — (String)

                The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

        • RecordEncoding — (String)

          Specifies the encoding of the records in the streaming source. For example, UTF-8.

        • RecordColumns — required — (Array<map>)

          A list of RecordColumn objects.

          • Name — required — (String)

            The name of the column that is created in the in-application input stream or reference table.

          • Mapping — (String)

            A reference to the data element in the streaming input or the reference data source.

          • SqlType — required — (String)

            The type of column created in the in-application input stream or reference table.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The Amazon Resource Name (ARN) of the application.

      • ApplicationVersionId — (Integer)

        Provides the current application version.

      • InputDescriptions — (Array<map>)

        Describes the application input configuration.

        • InputId — (String)

          The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

        • NamePrefix — (String)

          The in-application name prefix.

        • InAppStreamNames — (Array<String>)

          Returns the in-application stream names that are mapped to the stream source.

        • InputProcessingConfigurationDescription — (map)

          The description of the preprocessor that executes on records in this input before the application's code is run.

          • InputLambdaProcessorDescription — (map)

            Provides configuration information about the associated InputLambdaProcessorDescription

            • ResourceARN — required — (String)

              The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

              Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
            • RoleARN — (String)

              The ARN of the IAM role that is used to access the Amazon Lambda function.

              Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
        • KinesisStreamsInputDescription — (map)

          If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

          • ResourceARN — required — (String)

            The Amazon Resource Name (ARN) of the Kinesis data stream.

          • RoleARN — (String)

            The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

            Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
        • KinesisFirehoseInputDescription — (map)

          If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

          • ResourceARN — required — (String)

            The Amazon Resource Name (ARN) of the delivery stream.

          • RoleARN — (String)

            The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

            Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
        • InputSchema — (map)

          Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

          • RecordFormat — required — (map)

            Specifies the format of the records on the streaming source.

            • RecordFormatType — required — (String)

              The type of record format.

              Possible values include:
              • "JSON"
              • "CSV"
            • MappingParameters — (map)

              When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

              • JSONMappingParameters — (map)

                Provides additional mapping information when JSON is the record format on the streaming source.

                • RecordRowPath — required — (String)

                  The path to the top-level parent that contains the records.

              • CSVMappingParameters — (map)

                Provides additional mapping information when the record format uses delimiters (for example, CSV).

                • RecordRowDelimiter — required — (String)

                  The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                • RecordColumnDelimiter — required — (String)

                  The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

          • RecordEncoding — (String)

            Specifies the encoding of the records in the streaming source. For example, UTF-8.

          • RecordColumns — required — (Array<map>)

            A list of RecordColumn objects.

            • Name — required — (String)

              The name of the column that is created in the in-application input stream or reference table.

            • Mapping — (String)

              A reference to the data element in the streaming input or the reference data source.

            • SqlType — required — (String)

              The type of column created in the in-application input stream or reference table.

        • InputParallelism — (map)

          Describes the configured parallelism (number of in-application streams mapped to the streaming source).

          • Count — (Integer)

            The number of in-application streams to create.

        • InputStartingPositionConfiguration — (map)

          The point at which the application is configured to read from the input stream.

          • InputStartingPosition — (String)

            The starting position on the stream.

            • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

            • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

            • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

            Possible values include:
            • "NOW"
            • "TRIM_HORIZON"
            • "LAST_STOPPED_POINT"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addApplicationInputProcessingConfiguration(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the addApplicationInputProcessingConfiguration operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  InputId: 'STRING_VALUE', /* required */
  InputProcessingConfiguration: { /* required */
    InputLambdaProcessor: { /* required */
      ResourceARN: 'STRING_VALUE' /* required */
    }
  }
};
kinesisanalyticsv2.addApplicationInputProcessingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to which you want to add the input processing configuration.

    • CurrentApplicationVersionId — (Integer)

      The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    • InputId — (String)

      The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.

    • InputProcessingConfiguration — (map)

      The InputProcessingConfiguration to add to the application.

      • InputLambdaProcessor — required — (map)

        The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

        • ResourceARN — required — (String)

          The ARN of the Amazon Lambda function that operates on records in the stream.

          Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The Amazon Resource Name (ARN) of the application.

      • ApplicationVersionId — (Integer)

        Provides the current application version.

      • InputId — (String)

        The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

      • InputProcessingConfigurationDescription — (map)

        The description of the preprocessor that executes on records in this input before the application's code is run.

        • InputLambdaProcessorDescription — (map)

          Provides configuration information about the associated InputLambdaProcessorDescription

          • ResourceARN — required — (String)

            The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

            Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
          • RoleARN — (String)

            The ARN of the IAM role that is used to access the Amazon Lambda function.

            Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addApplicationOutput(params = {}, callback) ⇒ AWS.Request

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

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.

Service Reference:

Examples:

Calling the addApplicationOutput operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  Output: { /* required */
    DestinationSchema: { /* required */
      RecordFormatType: JSON | CSV /* required */
    },
    Name: 'STRING_VALUE', /* required */
    KinesisFirehoseOutput: {
      ResourceARN: 'STRING_VALUE' /* required */
    },
    KinesisStreamsOutput: {
      ResourceARN: 'STRING_VALUE' /* required */
    },
    LambdaOutput: {
      ResourceARN: 'STRING_VALUE' /* required */
    }
  }
};
kinesisanalyticsv2.addApplicationOutput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to which you want to add the output configuration.

    • CurrentApplicationVersionId — (Integer)

      The version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    • Output — (map)

      An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.

      • Name — required — (String)

        The name of the in-application stream.

      • KinesisStreamsOutput — (map)

        Identifies a Kinesis data stream as the destination.

        • ResourceARN — required — (String)

          The ARN of the destination Kinesis data stream to write to.

      • KinesisFirehoseOutput — (map)

        Identifies a Kinesis Data Firehose delivery stream as the destination.

        • ResourceARN — required — (String)

          The ARN of the destination delivery stream to write to.

      • LambdaOutput — (map)

        Identifies an Amazon Lambda function as the destination.

        • ResourceARN — required — (String)

          The Amazon Resource Name (ARN) of the destination Lambda function to write to.

          Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
      • DestinationSchema — required — (map)

        Describes the data format when records are written to the destination.

        • RecordFormatType — required — (String)

          Specifies the format of the records on the output stream.

          Possible values include:
          • "JSON"
          • "CSV"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The application Amazon Resource Name (ARN).

      • ApplicationVersionId — (Integer)

        The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.

      • OutputDescriptions — (Array<map>)

        Describes the application output configuration. For more information, see Configuring Application Output.

        • OutputId — (String)

          A unique identifier for the output configuration.

        • Name — (String)

          The name of the in-application stream that is configured as output.

        • KinesisStreamsOutputDescription — (map)

          Describes the Kinesis data stream that is configured as the destination where output is written.

          • ResourceARN — required — (String)

            The Amazon Resource Name (ARN) of the Kinesis data stream.

          • RoleARN — (String)

            The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

            Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
        • KinesisFirehoseOutputDescription — (map)

          Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

          • ResourceARN — required — (String)

            The Amazon Resource Name (ARN) of the delivery stream.

          • RoleARN — (String)

            The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

            Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
        • LambdaOutputDescription — (map)

          Describes the Lambda function that is configured as the destination where output is written.

          • ResourceARN — required — (String)

            The Amazon Resource Name (ARN) of the destination Lambda function.

          • RoleARN — (String)

            The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

            Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
        • DestinationSchema — (map)

          The data format used for writing data to the destination.

          • RecordFormatType — required — (String)

            Specifies the format of the records on the output stream.

            Possible values include:
            • "JSON"
            • "CSV"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addApplicationReferenceDataSource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the addApplicationReferenceDataSource operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  ReferenceDataSource: { /* required */
    ReferenceSchema: { /* required */
      RecordColumns: [ /* required */
        {
          Name: 'STRING_VALUE', /* required */
          SqlType: 'STRING_VALUE', /* required */
          Mapping: 'STRING_VALUE'
        },
        /* more items */
      ],
      RecordFormat: { /* required */
        RecordFormatType: JSON | CSV, /* required */
        MappingParameters: {
          CSVMappingParameters: {
            RecordColumnDelimiter: 'STRING_VALUE', /* required */
            RecordRowDelimiter: 'STRING_VALUE' /* required */
          },
          JSONMappingParameters: {
            RecordRowPath: 'STRING_VALUE' /* required */
          }
        }
      },
      RecordEncoding: 'STRING_VALUE'
    },
    TableName: 'STRING_VALUE', /* required */
    S3ReferenceDataSource: {
      BucketARN: 'STRING_VALUE',
      FileKey: 'STRING_VALUE'
    }
  }
};
kinesisanalyticsv2.addApplicationReferenceDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of an existing application.

    • CurrentApplicationVersionId — (Integer)

      The version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    • ReferenceDataSource — (map)

      The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.

      • TableName — required — (String)

        The name of the in-application table to create.

      • S3ReferenceDataSource — (map)

        Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

        • BucketARN — (String)

          The Amazon Resource Name (ARN) of the S3 bucket.

        • FileKey — (String)

          The object key name containing the reference data.

      • ReferenceSchema — required — (map)

        Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

        • RecordFormat — required — (map)

          Specifies the format of the records on the streaming source.

          • RecordFormatType — required — (String)

            The type of record format.

            Possible values include:
            • "JSON"
            • "CSV"
          • MappingParameters — (map)

            When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

            • JSONMappingParameters — (map)

              Provides additional mapping information when JSON is the record format on the streaming source.

              • RecordRowPath — required — (String)

                The path to the top-level parent that contains the records.

            • CSVMappingParameters — (map)

              Provides additional mapping information when the record format uses delimiters (for example, CSV).

              • RecordRowDelimiter — required — (String)

                The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

              • RecordColumnDelimiter — required — (String)

                The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

        • RecordEncoding — (String)

          Specifies the encoding of the records in the streaming source. For example, UTF-8.

        • RecordColumns — required — (Array<map>)

          A list of RecordColumn objects.

          • Name — required — (String)

            The name of the column that is created in the in-application input stream or reference table.

          • Mapping — (String)

            A reference to the data element in the streaming input or the reference data source.

          • SqlType — required — (String)

            The type of column created in the in-application input stream or reference table.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The application Amazon Resource Name (ARN).

      • ApplicationVersionId — (Integer)

        The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.

      • ReferenceDataSourceDescriptions — (Array<map>)

        Describes reference data sources configured for the application.

        • ReferenceId — required — (String)

          The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

        • TableName — required — (String)

          The in-application table name created by the specific reference data source configuration.

        • S3ReferenceDataSourceDescription — required — (map)

          Provides the Amazon S3 bucket name, the object key name that contains the reference data.

          • BucketARN — required — (String)

            The Amazon Resource Name (ARN) of the S3 bucket.

          • FileKey — required — (String)

            Amazon S3 object key name.

          • ReferenceRoleARN — (String)

            The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

            Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
        • ReferenceSchema — (map)

          Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

          • RecordFormat — required — (map)

            Specifies the format of the records on the streaming source.

            • RecordFormatType — required — (String)

              The type of record format.

              Possible values include:
              • "JSON"
              • "CSV"
            • MappingParameters — (map)

              When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

              • JSONMappingParameters — (map)

                Provides additional mapping information when JSON is the record format on the streaming source.

                • RecordRowPath — required — (String)

                  The path to the top-level parent that contains the records.

              • CSVMappingParameters — (map)

                Provides additional mapping information when the record format uses delimiters (for example, CSV).

                • RecordRowDelimiter — required — (String)

                  The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                • RecordColumnDelimiter — required — (String)

                  The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

          • RecordEncoding — (String)

            Specifies the encoding of the records in the streaming source. For example, UTF-8.

          • RecordColumns — required — (Array<map>)

            A list of RecordColumn objects.

            • Name — required — (String)

              The name of the column that is created in the in-application input stream or reference table.

            • Mapping — (String)

              A reference to the data element in the streaming input or the reference data source.

            • SqlType — required — (String)

              The type of column created in the in-application input stream or reference table.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addApplicationVpcConfiguration(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the addApplicationVpcConfiguration operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  VpcConfiguration: { /* required */
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  ConditionalToken: 'STRING_VALUE',
  CurrentApplicationVersionId: 'NUMBER_VALUE'
};
kinesisanalyticsv2.addApplicationVpcConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of an existing application.

    • CurrentApplicationVersionId — (Integer)

      The version of the application to which you want to add the VPC configuration. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

    • VpcConfiguration — (map)

      Description of the VPC to add to the application.

      • SubnetIds — required — (Array<String>)

        The array of Subnet IDs used by the VPC configuration.

      • SecurityGroupIds — required — (Array<String>)

        The array of SecurityGroup IDs used by the VPC configuration.

    • ConditionalToken — (String)

      A value you use to implement strong concurrency for application updates. You must provide the ApplicationVersionID or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The ARN of the application.

      • ApplicationVersionId — (Integer)

        Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

      • VpcConfigurationDescription — (map)

        The parameters of the new VPC configuration.

        • VpcConfigurationId — required — (String)

          The ID of the VPC configuration.

        • VpcId — required — (String)

          The ID of the associated VPC.

        • SubnetIds — required — (Array<String>)

          The array of Subnet IDs used by the VPC configuration.

        • SecurityGroupIds — required — (Array<String>)

          The array of SecurityGroup IDs used by the VPC configuration.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createApplication(params = {}, callback) ⇒ AWS.Request

Creates a Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  RuntimeEnvironment: SQL-1_0 | FLINK-1_6 | FLINK-1_8 | ZEPPELIN-FLINK-1_0 | FLINK-1_11 | FLINK-1_13 | ZEPPELIN-FLINK-2_0, /* required */
  ServiceExecutionRole: 'STRING_VALUE', /* required */
  ApplicationConfiguration: {
    ApplicationCodeConfiguration: {
      CodeContentType: PLAINTEXT | ZIPFILE, /* required */
      CodeContent: {
        S3ContentLocation: {
          BucketARN: 'STRING_VALUE', /* required */
          FileKey: 'STRING_VALUE', /* required */
          ObjectVersion: 'STRING_VALUE'
        },
        TextContent: 'STRING_VALUE',
        ZipFileContent: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
      }
    },
    ApplicationSnapshotConfiguration: {
      SnapshotsEnabled: true || false /* required */
    },
    EnvironmentProperties: {
      PropertyGroups: [ /* required */
        {
          PropertyGroupId: 'STRING_VALUE', /* required */
          PropertyMap: { /* required */
            '<PropertyKey>': 'STRING_VALUE',
            /* '<PropertyKey>': ... */
          }
        },
        /* more items */
      ]
    },
    FlinkApplicationConfiguration: {
      CheckpointConfiguration: {
        ConfigurationType: DEFAULT | CUSTOM, /* required */
        CheckpointInterval: 'NUMBER_VALUE',
        CheckpointingEnabled: true || false,
        MinPauseBetweenCheckpoints: 'NUMBER_VALUE'
      },
      MonitoringConfiguration: {
        ConfigurationType: DEFAULT | CUSTOM, /* required */
        LogLevel: INFO | WARN | ERROR | DEBUG,
        MetricsLevel: APPLICATION | TASK | OPERATOR | PARALLELISM
      },
      ParallelismConfiguration: {
        ConfigurationType: DEFAULT | CUSTOM, /* required */
        AutoScalingEnabled: true || false,
        Parallelism: 'NUMBER_VALUE',
        ParallelismPerKPU: 'NUMBER_VALUE'
      }
    },
    SqlApplicationConfiguration: {
      Inputs: [
        {
          InputSchema: { /* required */
            RecordColumns: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                SqlType: 'STRING_VALUE', /* required */
                Mapping: 'STRING_VALUE'
              },
              /* more items */
            ],
            RecordFormat: { /* required */
              RecordFormatType: JSON | CSV, /* required */
              MappingParameters: {
                CSVMappingParameters: {
                  RecordColumnDelimiter: 'STRING_VALUE', /* required */
                  RecordRowDelimiter: 'STRING_VALUE' /* required */
                },
                JSONMappingParameters: {
                  RecordRowPath: 'STRING_VALUE' /* required */
                }
              }
            },
            RecordEncoding: 'STRING_VALUE'
          },
          NamePrefix: 'STRING_VALUE', /* required */
          InputParallelism: {
            Count: 'NUMBER_VALUE'
          },
          InputProcessingConfiguration: {
            InputLambdaProcessor: { /* required */
              ResourceARN: 'STRING_VALUE' /* required */
            }
          },
          KinesisFirehoseInput: {
            ResourceARN: 'STRING_VALUE' /* required */
          },
          KinesisStreamsInput: {
            ResourceARN: 'STRING_VALUE' /* required */
          }
        },
        /* more items */
      ],
      Outputs: [
        {
          DestinationSchema: { /* required */
            RecordFormatType: JSON | CSV /* required */
          },
          Name: 'STRING_VALUE', /* required */
          KinesisFirehoseOutput: {
            ResourceARN: 'STRING_VALUE' /* required */
          },
          KinesisStreamsOutput: {
            ResourceARN: 'STRING_VALUE' /* required */
          },
          LambdaOutput: {
            ResourceARN: 'STRING_VALUE' /* required */
          }
        },
        /* more items */
      ],
      ReferenceDataSources: [
        {
          ReferenceSchema: { /* required */
            RecordColumns: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                SqlType: 'STRING_VALUE', /* required */
                Mapping: 'STRING_VALUE'
              },
              /* more items */
            ],
            RecordFormat: { /* required */
              RecordFormatType: JSON | CSV, /* required */
              MappingParameters: {
                CSVMappingParameters: {
                  RecordColumnDelimiter: 'STRING_VALUE', /* required */
                  RecordRowDelimiter: 'STRING_VALUE' /* required */
                },
                JSONMappingParameters: {
                  RecordRowPath: 'STRING_VALUE' /* required */
                }
              }
            },
            RecordEncoding: 'STRING_VALUE'
          },
          TableName: 'STRING_VALUE', /* required */
          S3ReferenceDataSource: {
            BucketARN: 'STRING_VALUE',
            FileKey: 'STRING_VALUE'
          }
        },
        /* more items */
      ]
    },
    VpcConfigurations: [
      {
        SecurityGroupIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    ZeppelinApplicationConfiguration: {
      CatalogConfiguration: {
        GlueDataCatalogConfiguration: { /* required */
          DatabaseARN: 'STRING_VALUE' /* required */
        }
      },
      CustomArtifactsConfiguration: [
        {
          ArtifactType: UDF | DEPENDENCY_JAR, /* required */
          MavenReference: {
            ArtifactId: 'STRING_VALUE', /* required */
            GroupId: 'STRING_VALUE', /* required */
            Version: 'STRING_VALUE' /* required */
          },
          S3ContentLocation: {
            BucketARN: 'STRING_VALUE', /* required */
            FileKey: 'STRING_VALUE', /* required */
            ObjectVersion: 'STRING_VALUE'
          }
        },
        /* more items */
      ],
      DeployAsApplicationConfiguration: {
        S3ContentLocation: { /* required */
          BucketARN: 'STRING_VALUE', /* required */
          BasePath: 'STRING_VALUE'
        }
      },
      MonitoringConfiguration: {
        LogLevel: INFO | WARN | ERROR | DEBUG /* required */
      }
    }
  },
  ApplicationDescription: 'STRING_VALUE',
  ApplicationMode: STREAMING | INTERACTIVE,
  CloudWatchLoggingOptions: [
    {
      LogStreamARN: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
kinesisanalyticsv2.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of your application (for example, sample-app).

    • ApplicationDescription — (String)

      A summary description of the application.

    • RuntimeEnvironment — (String)

      The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

      Possible values include:
      • "SQL-1_0"
      • "FLINK-1_6"
      • "FLINK-1_8"
      • "ZEPPELIN-FLINK-1_0"
      • "FLINK-1_11"
      • "FLINK-1_13"
      • "ZEPPELIN-FLINK-2_0"
    • ServiceExecutionRole — (String)

      The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

    • ApplicationConfiguration — (map)

      Use this parameter to configure the application.

      • SqlApplicationConfiguration — (map)

        The creation and update parameters for a SQL-based Kinesis Data Analytics application.

        • Inputs — (Array<map>)

          The array of Input objects describing the input streams used by the application.

          • NamePrefix — required — (String)

            The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.

          • InputProcessingConfiguration — (map)

            The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

            • InputLambdaProcessor — required — (map)

              The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

              • ResourceARN — required — (String)

                The ARN of the Amazon Lambda function that operates on records in the stream.

                Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
          • KinesisStreamsInput — (map)

            If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).

            • ResourceARN — required — (String)

              The ARN of the input Kinesis data stream to read.

          • KinesisFirehoseInput — (map)

            If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.

            • ResourceARN — required — (String)

              The Amazon Resource Name (ARN) of the delivery stream.

          • InputParallelism — (map)

            Describes the number of in-application streams to create.

            • Count — (Integer)

              The number of in-application streams to create.

          • InputSchema — required — (map)

            Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

            Also used to describe the format of the reference data source.

            • RecordFormat — required — (map)

              Specifies the format of the records on the streaming source.

              • RecordFormatType — required — (String)

                The type of record format.

                Possible values include:
                • "JSON"
                • "CSV"
              • MappingParameters — (map)

                When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                • JSONMappingParameters — (map)

                  Provides additional mapping information when JSON is the record format on the streaming source.

                  • RecordRowPath — required — (String)

                    The path to the top-level parent that contains the records.

                • CSVMappingParameters — (map)

                  Provides additional mapping information when the record format uses delimiters (for example, CSV).

                  • RecordRowDelimiter — required — (String)

                    The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                  • RecordColumnDelimiter — required — (String)

                    The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

            • RecordEncoding — (String)

              Specifies the encoding of the records in the streaming source. For example, UTF-8.

            • RecordColumns — required — (Array<map>)

              A list of RecordColumn objects.

              • Name — required — (String)

                The name of the column that is created in the in-application input stream or reference table.

              • Mapping — (String)

                A reference to the data element in the streaming input or the reference data source.

              • SqlType — required — (String)

                The type of column created in the in-application input stream or reference table.

        • Outputs — (Array<map>)

          The array of Output objects describing the destination streams used by the application.

          • Name — required — (String)

            The name of the in-application stream.

          • KinesisStreamsOutput — (map)

            Identifies a Kinesis data stream as the destination.

            • ResourceARN — required — (String)

              The ARN of the destination Kinesis data stream to write to.

          • KinesisFirehoseOutput — (map)

            Identifies a Kinesis Data Firehose delivery stream as the destination.

            • ResourceARN — required — (String)

              The ARN of the destination delivery stream to write to.

          • LambdaOutput — (map)

            Identifies an Amazon Lambda function as the destination.

            • ResourceARN — required — (String)

              The Amazon Resource Name (ARN) of the destination Lambda function to write to.

              Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
          • DestinationSchema — required — (map)

            Describes the data format when records are written to the destination.

            • RecordFormatType — required — (String)

              Specifies the format of the records on the output stream.

              Possible values include:
              • "JSON"
              • "CSV"
        • ReferenceDataSources — (Array<map>)

          The array of ReferenceDataSource objects describing the reference data sources used by the application.

          • TableName — required — (String)

            The name of the in-application table to create.

          • S3ReferenceDataSource — (map)

            Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

            • BucketARN — (String)

              The Amazon Resource Name (ARN) of the S3 bucket.

            • FileKey — (String)

              The object key name containing the reference data.

          • ReferenceSchema — required — (map)

            Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

            • RecordFormat — required — (map)

              Specifies the format of the records on the streaming source.

              • RecordFormatType — required — (String)

                The type of record format.

                Possible values include:
                • "JSON"
                • "CSV"
              • MappingParameters — (map)

                When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                • JSONMappingParameters — (map)

                  Provides additional mapping information when JSON is the record format on the streaming source.

                  • RecordRowPath — required — (String)

                    The path to the top-level parent that contains the records.

                • CSVMappingParameters — (map)

                  Provides additional mapping information when the record format uses delimiters (for example, CSV).

                  • RecordRowDelimiter — required — (String)

                    The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                  • RecordColumnDelimiter — required — (String)

                    The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

            • RecordEncoding — (String)

              Specifies the encoding of the records in the streaming source. For example, UTF-8.

            • RecordColumns — required — (Array<map>)

              A list of RecordColumn objects.

              • Name — required — (String)

                The name of the column that is created in the in-application input stream or reference table.

              • Mapping — (String)

                A reference to the data element in the streaming input or the reference data source.

              • SqlType — required — (String)

                The type of column created in the in-application input stream or reference table.

      • FlinkApplicationConfiguration — (map)

        The creation and update parameters for a Flink-based Kinesis Data Analytics application.

        • CheckpointConfiguration — (map)

          Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.

          • ConfigurationType — required — (String)

            Describes whether the application uses Kinesis Data Analytics' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

            Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:
            • CheckpointingEnabled: true
            • CheckpointInterval: 60000
            • MinPauseBetweenCheckpoints: 5000
            Possible values include:
            • "DEFAULT"
            • "CUSTOM"
          • CheckpointingEnabled — (Boolean)

            Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

            Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
          • CheckpointInterval — (Integer)

            Describes the interval in milliseconds between checkpoint operations.

            Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
          • MinPauseBetweenCheckpoints — (Integer)

            Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

            Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
        • MonitoringConfiguration — (map)

          Describes configuration parameters for Amazon CloudWatch logging for an application.

          • ConfigurationType — required — (String)

            Describes whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

            Possible values include:
            • "DEFAULT"
            • "CUSTOM"
          • MetricsLevel — (String)

            Describes the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.

            Possible values include:
            • "APPLICATION"
            • "TASK"
            • "OPERATOR"
            • "PARALLELISM"
          • LogLevel — (String)

            Describes the verbosity of the CloudWatch Logs for an application.

            Possible values include:
            • "INFO"
            • "WARN"
            • "ERROR"
            • "DEBUG"
        • ParallelismConfiguration — (map)

          Describes parameters for how an application executes multiple tasks simultaneously.

          • ConfigurationType — required — (String)

            Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

            Possible values include:
            • "DEFAULT"
            • "CUSTOM"
          • Parallelism — (Integer)

            Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the CurrentParallelism value in response to application load. The service can increase the CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

          • ParallelismPerKPU — (Integer)

            Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

          • AutoScalingEnabled — (Boolean)

            Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

      • EnvironmentProperties — (map)

        Describes execution properties for a Flink-based Kinesis Data Analytics application.

        • PropertyGroups — required — (Array<map>)

          Describes the execution property groups.

          • PropertyGroupId — required — (String)

            Describes the key of an application execution property key-value pair.

          • PropertyMap — required — (map<String>)

            Describes the value of an application execution property key-value pair.

      • ApplicationCodeConfiguration — (map)

        The code location and type parameters for a Flink-based Kinesis Data Analytics application.

        • CodeContent — (map)

          The location and type of the application code.

          • TextContent — (String)

            The text-format code for a Flink-based Kinesis Data Analytics application.

          • ZipFileContent — (Buffer, Typed Array, Blob, String)

            The zip-format code for a Flink-based Kinesis Data Analytics application.

          • S3ContentLocation — (map)

            Information about the Amazon S3 bucket that contains the application code.

            • BucketARN — required — (String)

              The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

            • FileKey — required — (String)

              The file key for the object containing the application code.

            • ObjectVersion — (String)

              The version of the object containing the application code.

        • CodeContentType — required — (String)

          Specifies whether the code content is in text or zip format.

          Possible values include:
          • "PLAINTEXT"
          • "ZIPFILE"
      • ApplicationSnapshotConfiguration — (map)

        Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

        • SnapshotsEnabled — required — (Boolean)

          Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

      • VpcConfigurations — (Array<map>)

        The array of descriptions of VPC configurations available to the application.

        • SubnetIds — required — (Array<String>)

          The array of Subnet IDs used by the VPC configuration.

        • SecurityGroupIds — required — (Array<String>)

          The array of SecurityGroup IDs used by the VPC configuration.

      • ZeppelinApplicationConfiguration — (map)

        The configuration parameters for a Kinesis Data Analytics Studio notebook.

        • MonitoringConfiguration — (map)

          The monitoring configuration of a Kinesis Data Analytics Studio notebook.

          • LogLevel — required — (String)

            The verbosity of the CloudWatch Logs for an application.

            Possible values include:
            • "INFO"
            • "WARN"
            • "ERROR"
            • "DEBUG"
        • CatalogConfiguration — (map)

          The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook.

          • GlueDataCatalogConfiguration — required — (map)

            The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.

            • DatabaseARN — required — (String)

              The Amazon Resource Name (ARN) of the database.

        • DeployAsApplicationConfiguration — (map)

          The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

          • S3ContentLocation — required — (map)

            The description of an Amazon S3 object that contains the Amazon Data Analytics application, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

            • BucketARN — required — (String)

              The Amazon Resource Name (ARN) of the S3 bucket.

            • BasePath — (String)

              The base path for the S3 bucket.

        • CustomArtifactsConfiguration — (Array<map>)

          Custom artifacts are dependency JARs and user-defined functions (UDF).

          • ArtifactType — required — (String)

            UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

            Possible values include:
            • "UDF"
            • "DEPENDENCY_JAR"
          • S3ContentLocation — (map)

            For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

            • BucketARN — required — (String)

              The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

            • FileKey — required — (String)

              The file key for the object containing the application code.

            • ObjectVersion — (String)

              The version of the object containing the application code.

          • MavenReference — (map)

            The parameters required to fully specify a Maven reference.

            • GroupId — required — (String)

              The group ID of the Maven reference.

            • ArtifactId — required — (String)

              The artifact ID of the Maven reference.

            • Version — required — (String)

              The version of the Maven reference.

    • CloudWatchLoggingOptions — (Array<map>)

      Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

      • LogStreamARN — required — (String)

        The ARN of the CloudWatch log to receive application messages.

    • Tags — (Array<map>)

      A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an 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.

      • Key — required — (String)

        The key of the key-value tag.

      • Value — (String)

        The value of the key-value tag. The value is optional.

    • ApplicationMode — (String)

      Use the STREAMING mode to create a Kinesis Data Analytics Studio notebook. To create a Kinesis Data Analytics Studio notebook, use the INTERACTIVE mode.

      Possible values include:
      • "STREAMING"
      • "INTERACTIVE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationDetail — (map)

        In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.

        • ApplicationARN — required — (String)

          The ARN of the application.

        • ApplicationDescription — (String)

          The description of the application.

        • ApplicationName — required — (String)

          The name of the application.

        • RuntimeEnvironment — required — (String)

          The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

          Possible values include:
          • "SQL-1_0"
          • "FLINK-1_6"
          • "FLINK-1_8"
          • "ZEPPELIN-FLINK-1_0"
          • "FLINK-1_11"
          • "FLINK-1_13"
          • "ZEPPELIN-FLINK-2_0"
        • ServiceExecutionRole — (String)

          Specifies the IAM role that the application uses to access external resources.

        • ApplicationStatus — required — (String)

          The status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
          • "AUTOSCALING"
          • "FORCE_STOPPING"
          • "ROLLING_BACK"
          • "MAINTENANCE"
          • "ROLLED_BACK"
        • ApplicationVersionId — required — (Integer)

          Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

        • CreateTimestamp — (Date)

          The current timestamp when the application was created.

        • LastUpdateTimestamp — (Date)

          The current timestamp when the application was last updated.

        • ApplicationConfigurationDescription — (map)

          Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

          • SqlApplicationConfigurationDescription — (map)

            The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

            • InputDescriptions — (Array<map>)

              The array of InputDescription objects describing the input streams used by the application.

              • InputId — (String)

                The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

              • NamePrefix — (String)

                The in-application name prefix.

              • InAppStreamNames — (Array<String>)

                Returns the in-application stream names that are mapped to the stream source.

              • InputProcessingConfigurationDescription — (map)

                The description of the preprocessor that executes on records in this input before the application's code is run.

                • InputLambdaProcessorDescription — (map)

                  Provides configuration information about the associated InputLambdaProcessorDescription

                  • ResourceARN — required — (String)

                    The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

                    Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
                  • RoleARN — (String)

                    The ARN of the IAM role that is used to access the Amazon Lambda function.

                    Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisStreamsInputDescription — (map)

                If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseInputDescription — (map)

                If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • InputSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

              • InputParallelism — (map)

                Describes the configured parallelism (number of in-application streams mapped to the streaming source).

                • Count — (Integer)

                  The number of in-application streams to create.

              • InputStartingPositionConfiguration — (map)

                The point at which the application is configured to read from the input stream.

                • InputStartingPosition — (String)

                  The starting position on the stream.

                  • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

                  • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

                  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

                  Possible values include:
                  • "NOW"
                  • "TRIM_HORIZON"
                  • "LAST_STOPPED_POINT"
            • OutputDescriptions — (Array<map>)

              The array of OutputDescription objects describing the destination streams used by the application.

              • OutputId — (String)

                A unique identifier for the output configuration.

              • Name — (String)

                The name of the in-application stream that is configured as output.

              • KinesisStreamsOutputDescription — (map)

                Describes the Kinesis data stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseOutputDescription — (map)

                Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • LambdaOutputDescription — (map)

                Describes the Lambda function that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the destination Lambda function.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • DestinationSchema — (map)

                The data format used for writing data to the destination.

                • RecordFormatType — required — (String)

                  Specifies the format of the records on the output stream.

                  Possible values include:
                  • "JSON"
                  • "CSV"
            • ReferenceDataSourceDescriptions — (Array<map>)

              The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.

              • ReferenceId — required — (String)

                The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

              • TableName — required — (String)

                The in-application table name created by the specific reference data source configuration.

              • S3ReferenceDataSourceDescription — required — (map)

                Provides the Amazon S3 bucket name, the object key name that contains the reference data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • FileKey — required — (String)

                  Amazon S3 object key name.

                • ReferenceRoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • ReferenceSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

          • ApplicationCodeConfigurationDescription — (map)

            The details about the application code for a Flink-based Kinesis Data Analytics application.

            • CodeContentType — required — (String)

              Specifies whether the code content is in text or zip format.

              Possible values include:
              • "PLAINTEXT"
              • "ZIPFILE"
            • CodeContentDescription — (map)

              Describes details about the location and format of the application code.

              • TextContent — (String)

                The text-format code

              • CodeMD5 — (String)

                The checksum that can be used to validate zip-format code.

              • CodeSize — (Integer)

                The size in bytes of the application code. Can be used to validate zip-format code.

              • S3ApplicationCodeLocationDescription — (map)

                The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

          • RunConfigurationDescription — (map)

            The details about the starting properties for a Kinesis Data Analytics application.

            • ApplicationRestoreConfigurationDescription — (map)

              Describes the restore behavior of a restarting application.

              • ApplicationRestoreType — required — (String)

                Specifies how the application should be restored.

                Possible values include:
                • "SKIP_RESTORE_FROM_SNAPSHOT"
                • "RESTORE_FROM_LATEST_SNAPSHOT"
                • "RESTORE_FROM_CUSTOM_SNAPSHOT"
              • SnapshotName — (String)

                The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

            • FlinkRunConfigurationDescription — (map)

              Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

              • AllowNonRestoredState — (Boolean)

                When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

                Note: This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
          • FlinkApplicationConfigurationDescription — (map)

            The details about a Flink-based Kinesis Data Analytics application.

            • CheckpointConfigurationDescription — (map)

              Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

              • ConfigurationType — (String)

                Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

                Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:
                • CheckpointingEnabled: true
                • CheckpointInterval: 60000
                • MinPauseBetweenCheckpoints: 5000
                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • CheckpointingEnabled — (Boolean)

                Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
              • CheckpointInterval — (Integer)

                Describes the interval in milliseconds between checkpoint operations.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
              • MinPauseBetweenCheckpoints — (Integer)

                Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
            • MonitoringConfigurationDescription — (map)

              Describes configuration parameters for Amazon CloudWatch logging for an application.

              • ConfigurationType — (String)

                Describes whether to use the default CloudWatch logging configuration for an application.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • MetricsLevel — (String)

                Describes the granularity of the CloudWatch Logs for an application.

                Possible values include:
                • "APPLICATION"
                • "TASK"
                • "OPERATOR"
                • "PARALLELISM"
              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • ParallelismConfigurationDescription — (map)

              Describes parameters for how an application executes multiple tasks simultaneously.

              • ConfigurationType — (String)

                Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • Parallelism — (Integer)

                Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • ParallelismPerKPU — (Integer)

                Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.

              • CurrentParallelism — (Integer)

                Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • AutoScalingEnabled — (Boolean)

                Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

            • JobPlanDescription — (String)

              The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

          • EnvironmentPropertyDescriptions — (map)

            Describes execution properties for a Flink-based Kinesis Data Analytics application.

            • PropertyGroupDescriptions — (Array<map>)

              Describes the execution property groups.

              • PropertyGroupId — required — (String)

                Describes the key of an application execution property key-value pair.

              • PropertyMap — required — (map<String>)

                Describes the value of an application execution property key-value pair.

          • ApplicationSnapshotConfigurationDescription — (map)

            Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

            • SnapshotsEnabled — required — (Boolean)

              Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

          • VpcConfigurationDescriptions — (Array<map>)

            The array of descriptions of VPC configurations available to the application.

            • VpcConfigurationId — required — (String)

              The ID of the VPC configuration.

            • VpcId — required — (String)

              The ID of the associated VPC.

            • SubnetIds — required — (Array<String>)

              The array of Subnet IDs used by the VPC configuration.

            • SecurityGroupIds — required — (Array<String>)

              The array of SecurityGroup IDs used by the VPC configuration.

          • ZeppelinApplicationConfigurationDescription — (map)

            The configuration parameters for a Kinesis Data Analytics Studio notebook.

            • MonitoringConfigurationDescription — required — (map)

              The monitoring configuration of a Kinesis Data Analytics Studio notebook.

              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • CatalogConfigurationDescription — (map)

              The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

              • GlueDataCatalogConfigurationDescription — required — (map)

                The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

                • DatabaseARN — required — (String)

                  The Amazon Resource Name (ARN) of the database.

            • DeployAsApplicationConfigurationDescription — (map)

              The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

              • S3ContentLocationDescription — required — (map)

                The location that holds the data required to specify an Amazon Data Analytics application.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • BasePath — (String)

                  The base path for the S3 bucket.

            • CustomArtifactsConfigurationDescription — (Array<map>)

              Custom artifacts are dependency JARs and user-defined functions (UDF).

              • ArtifactType — (String)

                UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

                Possible values include:
                • "UDF"
                • "DEPENDENCY_JAR"
              • S3ContentLocationDescription — (map)

                For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

              • MavenReferenceDescription — (map)

                The parameters that are required to specify a Maven dependency.

                • GroupId — required — (String)

                  The group ID of the Maven reference.

                • ArtifactId — required — (String)

                  The artifact ID of the Maven reference.

                • Version — required — (String)

                  The version of the Maven reference.

        • CloudWatchLoggingOptionDescriptions — (Array<map>)

          Describes the application Amazon CloudWatch logging options.

          • CloudWatchLoggingOptionId — (String)

            The ID of the CloudWatch logging option description.

          • LogStreamARN — required — (String)

            The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

          • RoleARN — (String)

            The IAM ARN of the role to use to send application messages.

            Note: Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
        • ApplicationMaintenanceConfigurationDescription — (map)

          The details of the maintenance configuration for the application.

          • ApplicationMaintenanceWindowStartTime — required — (String)

            The start time for the maintenance window.

          • ApplicationMaintenanceWindowEndTime — required — (String)

            The end time for the maintenance window.

        • ApplicationVersionUpdatedFrom — (Integer)

          The previous application version before the latest application update. RollbackApplication reverts the application to this version.

        • ApplicationVersionRolledBackFrom — (Integer)

          If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

        • ConditionalToken — (String)

          A value you use to implement strong concurrency for application updates.

        • ApplicationVersionRolledBackTo — (Integer)

          The version to which you want to roll back the application.

        • ApplicationMode — (String)

          To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

          Possible values include:
          • "STREAMING"
          • "INTERACTIVE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createApplicationPresignedUrl(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the createApplicationPresignedUrl operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  UrlType: FLINK_DASHBOARD_URL | ZEPPELIN_UI_URL, /* required */
  SessionExpirationDurationInSeconds: 'NUMBER_VALUE'
};
kinesisanalyticsv2.createApplicationPresignedUrl(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application.

    • UrlType — (String)

      The type of the extension for which to create and return a URL. Currently, the only valid extension URL type is FLINK_DASHBOARD_URL.

      Possible values include:
      • "FLINK_DASHBOARD_URL"
      • "ZEPPELIN_UI_URL"
    • SessionExpirationDurationInSeconds — (Integer)

      The duration in seconds for which the returned URL will be valid.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthorizedUrl — (String)

        The URL of the extension.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createApplicationSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a snapshot of the application's state data.

Service Reference:

Examples:

Calling the createApplicationSnapshot operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  SnapshotName: 'STRING_VALUE' /* required */
};
kinesisanalyticsv2.createApplicationSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of an existing application

    • SnapshotName — (String)

      An identifier for the application snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplication(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CreateTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
};
kinesisanalyticsv2.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to delete.

    • CreateTimestamp — (Date)

      Use the DescribeApplication operation to get this value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplicationCloudWatchLoggingOption(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteApplicationCloudWatchLoggingOption operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CloudWatchLoggingOptionId: 'STRING_VALUE', /* required */
  ConditionalToken: 'STRING_VALUE',
  CurrentApplicationVersionId: 'NUMBER_VALUE'
};
kinesisanalyticsv2.deleteApplicationCloudWatchLoggingOption(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The application name.

    • CurrentApplicationVersionId — (Integer)

      The version ID of the application. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

    • CloudWatchLoggingOptionId — (String)

      The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

    • ConditionalToken — (String)

      A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The application's Amazon Resource Name (ARN).

      • ApplicationVersionId — (Integer)

        The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

      • CloudWatchLoggingOptionDescriptions — (Array<map>)

        The descriptions of the remaining CloudWatch logging options for the application.

        • CloudWatchLoggingOptionId — (String)

          The ID of the CloudWatch logging option description.

        • LogStreamARN — required — (String)

          The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

        • RoleARN — (String)

          The IAM ARN of the role to use to send application messages.

          Note: Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplicationInputProcessingConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes an InputProcessingConfiguration from an input.

Service Reference:

Examples:

Calling the deleteApplicationInputProcessingConfiguration operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  InputId: 'STRING_VALUE' /* required */
};
kinesisanalyticsv2.deleteApplicationInputProcessingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application.

    • CurrentApplicationVersionId — (Integer)

      The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    • InputId — (String)

      The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The Amazon Resource Name (ARN) of the application.

      • ApplicationVersionId — (Integer)

        The current application version ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplicationOutput(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteApplicationOutput operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  OutputId: 'STRING_VALUE' /* required */
};
kinesisanalyticsv2.deleteApplicationOutput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The application name.

    • CurrentApplicationVersionId — (Integer)

      The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    • OutputId — (String)

      The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The application Amazon Resource Name (ARN).

      • ApplicationVersionId — (Integer)

        The current application version ID.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplicationReferenceDataSource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteApplicationReferenceDataSource operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  ReferenceId: 'STRING_VALUE' /* required */
};
kinesisanalyticsv2.deleteApplicationReferenceDataSource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of an existing application.

    • CurrentApplicationVersionId — (Integer)

      The current application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

    • ReferenceId — (String)

      The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The application Amazon Resource Name (ARN).

      • ApplicationVersionId — (Integer)

        The updated version ID of the application.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplicationSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes a snapshot of application state.

Service Reference:

Examples:

Calling the deleteApplicationSnapshot operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  SnapshotCreationTimestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  SnapshotName: 'STRING_VALUE' /* required */
};
kinesisanalyticsv2.deleteApplicationSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of an existing application.

    • SnapshotName — (String)

      The identifier for the snapshot delete.

    • SnapshotCreationTimestamp — (Date)

      The creation timestamp of the application snapshot to delete. You can retrieve this value using or .

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteApplicationVpcConfiguration(params = {}, callback) ⇒ AWS.Request

Removes a VPC configuration from a Kinesis Data Analytics application.

Service Reference:

Examples:

Calling the deleteApplicationVpcConfiguration operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  VpcConfigurationId: 'STRING_VALUE', /* required */
  ConditionalToken: 'STRING_VALUE',
  CurrentApplicationVersionId: 'NUMBER_VALUE'
};
kinesisanalyticsv2.deleteApplicationVpcConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of an existing application.

    • CurrentApplicationVersionId — (Integer)

      The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

    • VpcConfigurationId — (String)

      The ID of the VPC configuration to delete.

    • ConditionalToken — (String)

      A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The ARN of the Kinesis Data Analytics application.

      • ApplicationVersionId — (Integer)

        The updated version ID of the application.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeApplication(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  IncludeAdditionalDetails: true || false
};
kinesisanalyticsv2.describeApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application.

    • IncludeAdditionalDetails — (Boolean)

      Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationDetail — (map)

        Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.

        • ApplicationARN — required — (String)

          The ARN of the application.

        • ApplicationDescription — (String)

          The description of the application.

        • ApplicationName — required — (String)

          The name of the application.

        • RuntimeEnvironment — required — (String)

          The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

          Possible values include:
          • "SQL-1_0"
          • "FLINK-1_6"
          • "FLINK-1_8"
          • "ZEPPELIN-FLINK-1_0"
          • "FLINK-1_11"
          • "FLINK-1_13"
          • "ZEPPELIN-FLINK-2_0"
        • ServiceExecutionRole — (String)

          Specifies the IAM role that the application uses to access external resources.

        • ApplicationStatus — required — (String)

          The status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
          • "AUTOSCALING"
          • "FORCE_STOPPING"
          • "ROLLING_BACK"
          • "MAINTENANCE"
          • "ROLLED_BACK"
        • ApplicationVersionId — required — (Integer)

          Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

        • CreateTimestamp — (Date)

          The current timestamp when the application was created.

        • LastUpdateTimestamp — (Date)

          The current timestamp when the application was last updated.

        • ApplicationConfigurationDescription — (map)

          Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

          • SqlApplicationConfigurationDescription — (map)

            The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

            • InputDescriptions — (Array<map>)

              The array of InputDescription objects describing the input streams used by the application.

              • InputId — (String)

                The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

              • NamePrefix — (String)

                The in-application name prefix.

              • InAppStreamNames — (Array<String>)

                Returns the in-application stream names that are mapped to the stream source.

              • InputProcessingConfigurationDescription — (map)

                The description of the preprocessor that executes on records in this input before the application's code is run.

                • InputLambdaProcessorDescription — (map)

                  Provides configuration information about the associated InputLambdaProcessorDescription

                  • ResourceARN — required — (String)

                    The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

                    Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
                  • RoleARN — (String)

                    The ARN of the IAM role that is used to access the Amazon Lambda function.

                    Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisStreamsInputDescription — (map)

                If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseInputDescription — (map)

                If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • InputSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

              • InputParallelism — (map)

                Describes the configured parallelism (number of in-application streams mapped to the streaming source).

                • Count — (Integer)

                  The number of in-application streams to create.

              • InputStartingPositionConfiguration — (map)

                The point at which the application is configured to read from the input stream.

                • InputStartingPosition — (String)

                  The starting position on the stream.

                  • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

                  • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

                  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

                  Possible values include:
                  • "NOW"
                  • "TRIM_HORIZON"
                  • "LAST_STOPPED_POINT"
            • OutputDescriptions — (Array<map>)

              The array of OutputDescription objects describing the destination streams used by the application.

              • OutputId — (String)

                A unique identifier for the output configuration.

              • Name — (String)

                The name of the in-application stream that is configured as output.

              • KinesisStreamsOutputDescription — (map)

                Describes the Kinesis data stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseOutputDescription — (map)

                Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • LambdaOutputDescription — (map)

                Describes the Lambda function that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the destination Lambda function.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • DestinationSchema — (map)

                The data format used for writing data to the destination.

                • RecordFormatType — required — (String)

                  Specifies the format of the records on the output stream.

                  Possible values include:
                  • "JSON"
                  • "CSV"
            • ReferenceDataSourceDescriptions — (Array<map>)

              The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.

              • ReferenceId — required — (String)

                The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

              • TableName — required — (String)

                The in-application table name created by the specific reference data source configuration.

              • S3ReferenceDataSourceDescription — required — (map)

                Provides the Amazon S3 bucket name, the object key name that contains the reference data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • FileKey — required — (String)

                  Amazon S3 object key name.

                • ReferenceRoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • ReferenceSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

          • ApplicationCodeConfigurationDescription — (map)

            The details about the application code for a Flink-based Kinesis Data Analytics application.

            • CodeContentType — required — (String)

              Specifies whether the code content is in text or zip format.

              Possible values include:
              • "PLAINTEXT"
              • "ZIPFILE"
            • CodeContentDescription — (map)

              Describes details about the location and format of the application code.

              • TextContent — (String)

                The text-format code

              • CodeMD5 — (String)

                The checksum that can be used to validate zip-format code.

              • CodeSize — (Integer)

                The size in bytes of the application code. Can be used to validate zip-format code.

              • S3ApplicationCodeLocationDescription — (map)

                The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

          • RunConfigurationDescription — (map)

            The details about the starting properties for a Kinesis Data Analytics application.

            • ApplicationRestoreConfigurationDescription — (map)

              Describes the restore behavior of a restarting application.

              • ApplicationRestoreType — required — (String)

                Specifies how the application should be restored.

                Possible values include:
                • "SKIP_RESTORE_FROM_SNAPSHOT"
                • "RESTORE_FROM_LATEST_SNAPSHOT"
                • "RESTORE_FROM_CUSTOM_SNAPSHOT"
              • SnapshotName — (String)

                The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

            • FlinkRunConfigurationDescription — (map)

              Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

              • AllowNonRestoredState — (Boolean)

                When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

                Note: This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
          • FlinkApplicationConfigurationDescription — (map)

            The details about a Flink-based Kinesis Data Analytics application.

            • CheckpointConfigurationDescription — (map)

              Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

              • ConfigurationType — (String)

                Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

                Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:
                • CheckpointingEnabled: true
                • CheckpointInterval: 60000
                • MinPauseBetweenCheckpoints: 5000
                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • CheckpointingEnabled — (Boolean)

                Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
              • CheckpointInterval — (Integer)

                Describes the interval in milliseconds between checkpoint operations.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
              • MinPauseBetweenCheckpoints — (Integer)

                Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
            • MonitoringConfigurationDescription — (map)

              Describes configuration parameters for Amazon CloudWatch logging for an application.

              • ConfigurationType — (String)

                Describes whether to use the default CloudWatch logging configuration for an application.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • MetricsLevel — (String)

                Describes the granularity of the CloudWatch Logs for an application.

                Possible values include:
                • "APPLICATION"
                • "TASK"
                • "OPERATOR"
                • "PARALLELISM"
              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • ParallelismConfigurationDescription — (map)

              Describes parameters for how an application executes multiple tasks simultaneously.

              • ConfigurationType — (String)

                Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • Parallelism — (Integer)

                Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • ParallelismPerKPU — (Integer)

                Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.

              • CurrentParallelism — (Integer)

                Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • AutoScalingEnabled — (Boolean)

                Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

            • JobPlanDescription — (String)

              The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

          • EnvironmentPropertyDescriptions — (map)

            Describes execution properties for a Flink-based Kinesis Data Analytics application.

            • PropertyGroupDescriptions — (Array<map>)

              Describes the execution property groups.

              • PropertyGroupId — required — (String)

                Describes the key of an application execution property key-value pair.

              • PropertyMap — required — (map<String>)

                Describes the value of an application execution property key-value pair.

          • ApplicationSnapshotConfigurationDescription — (map)

            Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

            • SnapshotsEnabled — required — (Boolean)

              Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

          • VpcConfigurationDescriptions — (Array<map>)

            The array of descriptions of VPC configurations available to the application.

            • VpcConfigurationId — required — (String)

              The ID of the VPC configuration.

            • VpcId — required — (String)

              The ID of the associated VPC.

            • SubnetIds — required — (Array<String>)

              The array of Subnet IDs used by the VPC configuration.

            • SecurityGroupIds — required — (Array<String>)

              The array of SecurityGroup IDs used by the VPC configuration.

          • ZeppelinApplicationConfigurationDescription — (map)

            The configuration parameters for a Kinesis Data Analytics Studio notebook.

            • MonitoringConfigurationDescription — required — (map)

              The monitoring configuration of a Kinesis Data Analytics Studio notebook.

              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • CatalogConfigurationDescription — (map)

              The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

              • GlueDataCatalogConfigurationDescription — required — (map)

                The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

                • DatabaseARN — required — (String)

                  The Amazon Resource Name (ARN) of the database.

            • DeployAsApplicationConfigurationDescription — (map)

              The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

              • S3ContentLocationDescription — required — (map)

                The location that holds the data required to specify an Amazon Data Analytics application.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • BasePath — (String)

                  The base path for the S3 bucket.

            • CustomArtifactsConfigurationDescription — (Array<map>)

              Custom artifacts are dependency JARs and user-defined functions (UDF).

              • ArtifactType — (String)

                UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

                Possible values include:
                • "UDF"
                • "DEPENDENCY_JAR"
              • S3ContentLocationDescription — (map)

                For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

              • MavenReferenceDescription — (map)

                The parameters that are required to specify a Maven dependency.

                • GroupId — required — (String)

                  The group ID of the Maven reference.

                • ArtifactId — required — (String)

                  The artifact ID of the Maven reference.

                • Version — required — (String)

                  The version of the Maven reference.

        • CloudWatchLoggingOptionDescriptions — (Array<map>)

          Describes the application Amazon CloudWatch logging options.

          • CloudWatchLoggingOptionId — (String)

            The ID of the CloudWatch logging option description.

          • LogStreamARN — required — (String)

            The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

          • RoleARN — (String)

            The IAM ARN of the role to use to send application messages.

            Note: Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
        • ApplicationMaintenanceConfigurationDescription — (map)

          The details of the maintenance configuration for the application.

          • ApplicationMaintenanceWindowStartTime — required — (String)

            The start time for the maintenance window.

          • ApplicationMaintenanceWindowEndTime — required — (String)

            The end time for the maintenance window.

        • ApplicationVersionUpdatedFrom — (Integer)

          The previous application version before the latest application update. RollbackApplication reverts the application to this version.

        • ApplicationVersionRolledBackFrom — (Integer)

          If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

        • ConditionalToken — (String)

          A value you use to implement strong concurrency for application updates.

        • ApplicationVersionRolledBackTo — (Integer)

          The version to which you want to roll back the application.

        • ApplicationMode — (String)

          To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

          Possible values include:
          • "STREAMING"
          • "INTERACTIVE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeApplicationSnapshot(params = {}, callback) ⇒ AWS.Request

Returns information about a snapshot of application state data.

Service Reference:

Examples:

Calling the describeApplicationSnapshot operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  SnapshotName: 'STRING_VALUE' /* required */
};
kinesisanalyticsv2.describeApplicationSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of an existing application.

    • SnapshotName — (String)

      The identifier of an application snapshot. You can retrieve this value using .

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotDetails — (map)

        An object containing information about the application snapshot.

        • SnapshotName — required — (String)

          The identifier for the application snapshot.

        • SnapshotStatus — required — (String)

          The status of the application snapshot.

          Possible values include:
          • "CREATING"
          • "READY"
          • "DELETING"
          • "FAILED"
        • ApplicationVersionId — required — (Integer)

          The current application version ID when the snapshot was created.

        • SnapshotCreationTimestamp — (Date)

          The timestamp of the application snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeApplicationVersion(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the describeApplicationVersion operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  ApplicationVersionId: 'NUMBER_VALUE' /* required */
};
kinesisanalyticsv2.describeApplicationVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application for which you want to get the version description.

    • ApplicationVersionId — (Integer)

      The ID of the application version for which you want to get the description.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationVersionDetail — (map)

        Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

        • ApplicationARN — required — (String)

          The ARN of the application.

        • ApplicationDescription — (String)

          The description of the application.

        • ApplicationName — required — (String)

          The name of the application.

        • RuntimeEnvironment — required — (String)

          The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

          Possible values include:
          • "SQL-1_0"
          • "FLINK-1_6"
          • "FLINK-1_8"
          • "ZEPPELIN-FLINK-1_0"
          • "FLINK-1_11"
          • "FLINK-1_13"
          • "ZEPPELIN-FLINK-2_0"
        • ServiceExecutionRole — (String)

          Specifies the IAM role that the application uses to access external resources.

        • ApplicationStatus — required — (String)

          The status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
          • "AUTOSCALING"
          • "FORCE_STOPPING"
          • "ROLLING_BACK"
          • "MAINTENANCE"
          • "ROLLED_BACK"
        • ApplicationVersionId — required — (Integer)

          Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

        • CreateTimestamp — (Date)

          The current timestamp when the application was created.

        • LastUpdateTimestamp — (Date)

          The current timestamp when the application was last updated.

        • ApplicationConfigurationDescription — (map)

          Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

          • SqlApplicationConfigurationDescription — (map)

            The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

            • InputDescriptions — (Array<map>)

              The array of InputDescription objects describing the input streams used by the application.

              • InputId — (String)

                The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

              • NamePrefix — (String)

                The in-application name prefix.

              • InAppStreamNames — (Array<String>)

                Returns the in-application stream names that are mapped to the stream source.

              • InputProcessingConfigurationDescription — (map)

                The description of the preprocessor that executes on records in this input before the application's code is run.

                • InputLambdaProcessorDescription — (map)

                  Provides configuration information about the associated InputLambdaProcessorDescription

                  • ResourceARN — required — (String)

                    The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

                    Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
                  • RoleARN — (String)

                    The ARN of the IAM role that is used to access the Amazon Lambda function.

                    Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisStreamsInputDescription — (map)

                If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseInputDescription — (map)

                If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • InputSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

              • InputParallelism — (map)

                Describes the configured parallelism (number of in-application streams mapped to the streaming source).

                • Count — (Integer)

                  The number of in-application streams to create.

              • InputStartingPositionConfiguration — (map)

                The point at which the application is configured to read from the input stream.

                • InputStartingPosition — (String)

                  The starting position on the stream.

                  • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

                  • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

                  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

                  Possible values include:
                  • "NOW"
                  • "TRIM_HORIZON"
                  • "LAST_STOPPED_POINT"
            • OutputDescriptions — (Array<map>)

              The array of OutputDescription objects describing the destination streams used by the application.

              • OutputId — (String)

                A unique identifier for the output configuration.

              • Name — (String)

                The name of the in-application stream that is configured as output.

              • KinesisStreamsOutputDescription — (map)

                Describes the Kinesis data stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseOutputDescription — (map)

                Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • LambdaOutputDescription — (map)

                Describes the Lambda function that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the destination Lambda function.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • DestinationSchema — (map)

                The data format used for writing data to the destination.

                • RecordFormatType — required — (String)

                  Specifies the format of the records on the output stream.

                  Possible values include:
                  • "JSON"
                  • "CSV"
            • ReferenceDataSourceDescriptions — (Array<map>)

              The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.

              • ReferenceId — required — (String)

                The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

              • TableName — required — (String)

                The in-application table name created by the specific reference data source configuration.

              • S3ReferenceDataSourceDescription — required — (map)

                Provides the Amazon S3 bucket name, the object key name that contains the reference data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • FileKey — required — (String)

                  Amazon S3 object key name.

                • ReferenceRoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • ReferenceSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

          • ApplicationCodeConfigurationDescription — (map)

            The details about the application code for a Flink-based Kinesis Data Analytics application.

            • CodeContentType — required — (String)

              Specifies whether the code content is in text or zip format.

              Possible values include:
              • "PLAINTEXT"
              • "ZIPFILE"
            • CodeContentDescription — (map)

              Describes details about the location and format of the application code.

              • TextContent — (String)

                The text-format code

              • CodeMD5 — (String)

                The checksum that can be used to validate zip-format code.

              • CodeSize — (Integer)

                The size in bytes of the application code. Can be used to validate zip-format code.

              • S3ApplicationCodeLocationDescription — (map)

                The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

          • RunConfigurationDescription — (map)

            The details about the starting properties for a Kinesis Data Analytics application.

            • ApplicationRestoreConfigurationDescription — (map)

              Describes the restore behavior of a restarting application.

              • ApplicationRestoreType — required — (String)

                Specifies how the application should be restored.

                Possible values include:
                • "SKIP_RESTORE_FROM_SNAPSHOT"
                • "RESTORE_FROM_LATEST_SNAPSHOT"
                • "RESTORE_FROM_CUSTOM_SNAPSHOT"
              • SnapshotName — (String)

                The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

            • FlinkRunConfigurationDescription — (map)

              Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

              • AllowNonRestoredState — (Boolean)

                When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

                Note: This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
          • FlinkApplicationConfigurationDescription — (map)

            The details about a Flink-based Kinesis Data Analytics application.

            • CheckpointConfigurationDescription — (map)

              Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

              • ConfigurationType — (String)

                Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

                Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:
                • CheckpointingEnabled: true
                • CheckpointInterval: 60000
                • MinPauseBetweenCheckpoints: 5000
                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • CheckpointingEnabled — (Boolean)

                Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
              • CheckpointInterval — (Integer)

                Describes the interval in milliseconds between checkpoint operations.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
              • MinPauseBetweenCheckpoints — (Integer)

                Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
            • MonitoringConfigurationDescription — (map)

              Describes configuration parameters for Amazon CloudWatch logging for an application.

              • ConfigurationType — (String)

                Describes whether to use the default CloudWatch logging configuration for an application.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • MetricsLevel — (String)

                Describes the granularity of the CloudWatch Logs for an application.

                Possible values include:
                • "APPLICATION"
                • "TASK"
                • "OPERATOR"
                • "PARALLELISM"
              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • ParallelismConfigurationDescription — (map)

              Describes parameters for how an application executes multiple tasks simultaneously.

              • ConfigurationType — (String)

                Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • Parallelism — (Integer)

                Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • ParallelismPerKPU — (Integer)

                Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.

              • CurrentParallelism — (Integer)

                Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • AutoScalingEnabled — (Boolean)

                Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

            • JobPlanDescription — (String)

              The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

          • EnvironmentPropertyDescriptions — (map)

            Describes execution properties for a Flink-based Kinesis Data Analytics application.

            • PropertyGroupDescriptions — (Array<map>)

              Describes the execution property groups.

              • PropertyGroupId — required — (String)

                Describes the key of an application execution property key-value pair.

              • PropertyMap — required — (map<String>)

                Describes the value of an application execution property key-value pair.

          • ApplicationSnapshotConfigurationDescription — (map)

            Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

            • SnapshotsEnabled — required — (Boolean)

              Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

          • VpcConfigurationDescriptions — (Array<map>)

            The array of descriptions of VPC configurations available to the application.

            • VpcConfigurationId — required — (String)

              The ID of the VPC configuration.

            • VpcId — required — (String)

              The ID of the associated VPC.

            • SubnetIds — required — (Array<String>)

              The array of Subnet IDs used by the VPC configuration.

            • SecurityGroupIds — required — (Array<String>)

              The array of SecurityGroup IDs used by the VPC configuration.

          • ZeppelinApplicationConfigurationDescription — (map)

            The configuration parameters for a Kinesis Data Analytics Studio notebook.

            • MonitoringConfigurationDescription — required — (map)

              The monitoring configuration of a Kinesis Data Analytics Studio notebook.

              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • CatalogConfigurationDescription — (map)

              The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

              • GlueDataCatalogConfigurationDescription — required — (map)

                The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

                • DatabaseARN — required — (String)

                  The Amazon Resource Name (ARN) of the database.

            • DeployAsApplicationConfigurationDescription — (map)

              The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

              • S3ContentLocationDescription — required — (map)

                The location that holds the data required to specify an Amazon Data Analytics application.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • BasePath — (String)

                  The base path for the S3 bucket.

            • CustomArtifactsConfigurationDescription — (Array<map>)

              Custom artifacts are dependency JARs and user-defined functions (UDF).

              • ArtifactType — (String)

                UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

                Possible values include:
                • "UDF"
                • "DEPENDENCY_JAR"
              • S3ContentLocationDescription — (map)

                For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

              • MavenReferenceDescription — (map)

                The parameters that are required to specify a Maven dependency.

                • GroupId — required — (String)

                  The group ID of the Maven reference.

                • ArtifactId — required — (String)

                  The artifact ID of the Maven reference.

                • Version — required — (String)

                  The version of the Maven reference.

        • CloudWatchLoggingOptionDescriptions — (Array<map>)

          Describes the application Amazon CloudWatch logging options.

          • CloudWatchLoggingOptionId — (String)

            The ID of the CloudWatch logging option description.

          • LogStreamARN — required — (String)

            The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

          • RoleARN — (String)

            The IAM ARN of the role to use to send application messages.

            Note: Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
        • ApplicationMaintenanceConfigurationDescription — (map)

          The details of the maintenance configuration for the application.

          • ApplicationMaintenanceWindowStartTime — required — (String)

            The start time for the maintenance window.

          • ApplicationMaintenanceWindowEndTime — required — (String)

            The end time for the maintenance window.

        • ApplicationVersionUpdatedFrom — (Integer)

          The previous application version before the latest application update. RollbackApplication reverts the application to this version.

        • ApplicationVersionRolledBackFrom — (Integer)

          If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

        • ConditionalToken — (String)

          A value you use to implement strong concurrency for application updates.

        • ApplicationVersionRolledBackTo — (Integer)

          The version to which you want to roll back the application.

        • ApplicationMode — (String)

          To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

          Possible values include:
          • "STREAMING"
          • "INTERACTIVE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

discoverInputSchema(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the discoverInputSchema operation

var params = {
  ServiceExecutionRole: 'STRING_VALUE', /* required */
  InputProcessingConfiguration: {
    InputLambdaProcessor: { /* required */
      ResourceARN: 'STRING_VALUE' /* required */
    }
  },
  InputStartingPositionConfiguration: {
    InputStartingPosition: NOW | TRIM_HORIZON | LAST_STOPPED_POINT
  },
  ResourceARN: 'STRING_VALUE',
  S3Configuration: {
    BucketARN: 'STRING_VALUE', /* required */
    FileKey: 'STRING_VALUE' /* required */
  }
};
kinesisanalyticsv2.discoverInputSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the streaming source.

    • ServiceExecutionRole — (String)

      The ARN of the role that is used to access the streaming source.

    • InputStartingPositionConfiguration — (map)

      The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes.

      • InputStartingPosition — (String)

        The starting position on the stream.

        • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

        • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

        • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

        Possible values include:
        • "NOW"
        • "TRIM_HORIZON"
        • "LAST_STOPPED_POINT"
    • S3Configuration — (map)

      Specify this parameter to discover a schema from data in an Amazon S3 object.

      • BucketARN — required — (String)

        The ARN of the S3 bucket that contains the data.

      • FileKey — required — (String)

        The name of the object that contains the data.

    • InputProcessingConfiguration — (map)

      The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

      • InputLambdaProcessor — required — (map)

        The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

        • ResourceARN — required — (String)

          The ARN of the Amazon Lambda function that operates on records in the stream.

          Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InputSchema — (map)

        The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

        • RecordFormat — required — (map)

          Specifies the format of the records on the streaming source.

          • RecordFormatType — required — (String)

            The type of record format.

            Possible values include:
            • "JSON"
            • "CSV"
          • MappingParameters — (map)

            When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

            • JSONMappingParameters — (map)

              Provides additional mapping information when JSON is the record format on the streaming source.

              • RecordRowPath — required — (String)

                The path to the top-level parent that contains the records.

            • CSVMappingParameters — (map)

              Provides additional mapping information when the record format uses delimiters (for example, CSV).

              • RecordRowDelimiter — required — (String)

                The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

              • RecordColumnDelimiter — required — (String)

                The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

        • RecordEncoding — (String)

          Specifies the encoding of the records in the streaming source. For example, UTF-8.

        • RecordColumns — required — (Array<map>)

          A list of RecordColumn objects.

          • Name — required — (String)

            The name of the column that is created in the in-application input stream or reference table.

          • Mapping — (String)

            A reference to the data element in the streaming input or the reference data source.

          • SqlType — required — (String)

            The type of column created in the in-application input stream or reference table.

      • ParsedInputRecords — (Array<Array<String>>)

        An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

      • ProcessedInputRecords — (Array<String>)

        The stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

      • RawInputRecords — (Array<String>)

        The raw stream data that was sampled to infer the schema.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listApplications(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kinesisanalyticsv2.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Limit — (Integer)

      The maximum number of applications to list.

    • NextToken — (String)

      If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationSummaries — (Array<map>)

        A list of ApplicationSummary objects.

        • ApplicationName — required — (String)

          The name of the application.

        • ApplicationARN — required — (String)

          The ARN of the application.

        • ApplicationStatus — required — (String)

          The status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
          • "AUTOSCALING"
          • "FORCE_STOPPING"
          • "ROLLING_BACK"
          • "MAINTENANCE"
          • "ROLLED_BACK"
        • ApplicationVersionId — required — (Integer)

          Provides the current application version.

        • RuntimeEnvironment — required — (String)

          The runtime environment for the application.

          Possible values include:
          • "SQL-1_0"
          • "FLINK-1_6"
          • "FLINK-1_8"
          • "ZEPPELIN-FLINK-1_0"
          • "FLINK-1_11"
          • "FLINK-1_13"
          • "ZEPPELIN-FLINK-2_0"
        • ApplicationMode — (String)

          For a Kinesis Data Analytics for Apache Flink application, the mode is STREAMING. For a Kinesis Data Analytics Studio notebook, it is INTERACTIVE.

          Possible values include:
          • "STREAMING"
          • "INTERACTIVE"
      • NextToken — (String)

        The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listApplicationSnapshots(params = {}, callback) ⇒ AWS.Request

Lists information about the current application snapshots.

Service Reference:

Examples:

Calling the listApplicationSnapshots operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kinesisanalyticsv2.listApplicationSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of an existing application.

    • Limit — (Integer)

      The maximum number of application snapshots to list.

    • NextToken — (String)

      Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotSummaries — (Array<map>)

        A collection of objects containing information about the application snapshots.

        • SnapshotName — required — (String)

          The identifier for the application snapshot.

        • SnapshotStatus — required — (String)

          The status of the application snapshot.

          Possible values include:
          • "CREATING"
          • "READY"
          • "DELETING"
          • "FAILED"
        • ApplicationVersionId — required — (Integer)

          The current application version ID when the snapshot was created.

        • SnapshotCreationTimestamp — (Date)

          The timestamp of the application snapshot.

      • NextToken — (String)

        The token for the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listApplicationVersions(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the listApplicationVersions operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
kinesisanalyticsv2.listApplicationVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application for which you want to list all versions.

    • Limit — (Integer)

      The maximum number of versions to list in this invocation of the operation.

    • NextToken — (String)

      If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationVersionSummaries — (Array<map>)

        A list of the application versions and the associated configuration summaries. The list includes application versions that were rolled back.

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

        • ApplicationVersionId — required — (Integer)

          The ID of the application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

        • ApplicationStatus — required — (String)

          The status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
          • "AUTOSCALING"
          • "FORCE_STOPPING"
          • "ROLLING_BACK"
          • "MAINTENANCE"
          • "ROLLED_BACK"
      • NextToken — (String)

        The pagination token for the next set of results, or null if there are no additional results. To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
kinesisanalyticsv2.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The ARN of the application for which to retrieve tags.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The key-value tags assigned to the application.

        • Key — required — (String)

          The key of the key-value tag.

        • Value — (String)

          The value of the key-value tag. The value is optional.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

rollbackApplication(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the rollbackApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE' /* required */
};
kinesisanalyticsv2.rollbackApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application.

    • CurrentApplicationVersionId — (Integer)

      The current application version ID. You can retrieve the application version ID using DescribeApplication.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationDetail — (map)

        Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

        • ApplicationARN — required — (String)

          The ARN of the application.

        • ApplicationDescription — (String)

          The description of the application.

        • ApplicationName — required — (String)

          The name of the application.

        • RuntimeEnvironment — required — (String)

          The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

          Possible values include:
          • "SQL-1_0"
          • "FLINK-1_6"
          • "FLINK-1_8"
          • "ZEPPELIN-FLINK-1_0"
          • "FLINK-1_11"
          • "FLINK-1_13"
          • "ZEPPELIN-FLINK-2_0"
        • ServiceExecutionRole — (String)

          Specifies the IAM role that the application uses to access external resources.

        • ApplicationStatus — required — (String)

          The status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
          • "AUTOSCALING"
          • "FORCE_STOPPING"
          • "ROLLING_BACK"
          • "MAINTENANCE"
          • "ROLLED_BACK"
        • ApplicationVersionId — required — (Integer)

          Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

        • CreateTimestamp — (Date)

          The current timestamp when the application was created.

        • LastUpdateTimestamp — (Date)

          The current timestamp when the application was last updated.

        • ApplicationConfigurationDescription — (map)

          Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

          • SqlApplicationConfigurationDescription — (map)

            The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

            • InputDescriptions — (Array<map>)

              The array of InputDescription objects describing the input streams used by the application.

              • InputId — (String)

                The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

              • NamePrefix — (String)

                The in-application name prefix.

              • InAppStreamNames — (Array<String>)

                Returns the in-application stream names that are mapped to the stream source.

              • InputProcessingConfigurationDescription — (map)

                The description of the preprocessor that executes on records in this input before the application's code is run.

                • InputLambdaProcessorDescription — (map)

                  Provides configuration information about the associated InputLambdaProcessorDescription

                  • ResourceARN — required — (String)

                    The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

                    Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
                  • RoleARN — (String)

                    The ARN of the IAM role that is used to access the Amazon Lambda function.

                    Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisStreamsInputDescription — (map)

                If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseInputDescription — (map)

                If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • InputSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

              • InputParallelism — (map)

                Describes the configured parallelism (number of in-application streams mapped to the streaming source).

                • Count — (Integer)

                  The number of in-application streams to create.

              • InputStartingPositionConfiguration — (map)

                The point at which the application is configured to read from the input stream.

                • InputStartingPosition — (String)

                  The starting position on the stream.

                  • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

                  • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

                  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

                  Possible values include:
                  • "NOW"
                  • "TRIM_HORIZON"
                  • "LAST_STOPPED_POINT"
            • OutputDescriptions — (Array<map>)

              The array of OutputDescription objects describing the destination streams used by the application.

              • OutputId — (String)

                A unique identifier for the output configuration.

              • Name — (String)

                The name of the in-application stream that is configured as output.

              • KinesisStreamsOutputDescription — (map)

                Describes the Kinesis data stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseOutputDescription — (map)

                Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • LambdaOutputDescription — (map)

                Describes the Lambda function that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the destination Lambda function.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • DestinationSchema — (map)

                The data format used for writing data to the destination.

                • RecordFormatType — required — (String)

                  Specifies the format of the records on the output stream.

                  Possible values include:
                  • "JSON"
                  • "CSV"
            • ReferenceDataSourceDescriptions — (Array<map>)

              The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.

              • ReferenceId — required — (String)

                The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

              • TableName — required — (String)

                The in-application table name created by the specific reference data source configuration.

              • S3ReferenceDataSourceDescription — required — (map)

                Provides the Amazon S3 bucket name, the object key name that contains the reference data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • FileKey — required — (String)

                  Amazon S3 object key name.

                • ReferenceRoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • ReferenceSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

          • ApplicationCodeConfigurationDescription — (map)

            The details about the application code for a Flink-based Kinesis Data Analytics application.

            • CodeContentType — required — (String)

              Specifies whether the code content is in text or zip format.

              Possible values include:
              • "PLAINTEXT"
              • "ZIPFILE"
            • CodeContentDescription — (map)

              Describes details about the location and format of the application code.

              • TextContent — (String)

                The text-format code

              • CodeMD5 — (String)

                The checksum that can be used to validate zip-format code.

              • CodeSize — (Integer)

                The size in bytes of the application code. Can be used to validate zip-format code.

              • S3ApplicationCodeLocationDescription — (map)

                The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

          • RunConfigurationDescription — (map)

            The details about the starting properties for a Kinesis Data Analytics application.

            • ApplicationRestoreConfigurationDescription — (map)

              Describes the restore behavior of a restarting application.

              • ApplicationRestoreType — required — (String)

                Specifies how the application should be restored.

                Possible values include:
                • "SKIP_RESTORE_FROM_SNAPSHOT"
                • "RESTORE_FROM_LATEST_SNAPSHOT"
                • "RESTORE_FROM_CUSTOM_SNAPSHOT"
              • SnapshotName — (String)

                The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

            • FlinkRunConfigurationDescription — (map)

              Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

              • AllowNonRestoredState — (Boolean)

                When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

                Note: This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
          • FlinkApplicationConfigurationDescription — (map)

            The details about a Flink-based Kinesis Data Analytics application.

            • CheckpointConfigurationDescription — (map)

              Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

              • ConfigurationType — (String)

                Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

                Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:
                • CheckpointingEnabled: true
                • CheckpointInterval: 60000
                • MinPauseBetweenCheckpoints: 5000
                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • CheckpointingEnabled — (Boolean)

                Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
              • CheckpointInterval — (Integer)

                Describes the interval in milliseconds between checkpoint operations.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
              • MinPauseBetweenCheckpoints — (Integer)

                Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
            • MonitoringConfigurationDescription — (map)

              Describes configuration parameters for Amazon CloudWatch logging for an application.

              • ConfigurationType — (String)

                Describes whether to use the default CloudWatch logging configuration for an application.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • MetricsLevel — (String)

                Describes the granularity of the CloudWatch Logs for an application.

                Possible values include:
                • "APPLICATION"
                • "TASK"
                • "OPERATOR"
                • "PARALLELISM"
              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • ParallelismConfigurationDescription — (map)

              Describes parameters for how an application executes multiple tasks simultaneously.

              • ConfigurationType — (String)

                Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • Parallelism — (Integer)

                Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • ParallelismPerKPU — (Integer)

                Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.

              • CurrentParallelism — (Integer)

                Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • AutoScalingEnabled — (Boolean)

                Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

            • JobPlanDescription — (String)

              The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

          • EnvironmentPropertyDescriptions — (map)

            Describes execution properties for a Flink-based Kinesis Data Analytics application.

            • PropertyGroupDescriptions — (Array<map>)

              Describes the execution property groups.

              • PropertyGroupId — required — (String)

                Describes the key of an application execution property key-value pair.

              • PropertyMap — required — (map<String>)

                Describes the value of an application execution property key-value pair.

          • ApplicationSnapshotConfigurationDescription — (map)

            Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

            • SnapshotsEnabled — required — (Boolean)

              Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

          • VpcConfigurationDescriptions — (Array<map>)

            The array of descriptions of VPC configurations available to the application.

            • VpcConfigurationId — required — (String)

              The ID of the VPC configuration.

            • VpcId — required — (String)

              The ID of the associated VPC.

            • SubnetIds — required — (Array<String>)

              The array of Subnet IDs used by the VPC configuration.

            • SecurityGroupIds — required — (Array<String>)

              The array of SecurityGroup IDs used by the VPC configuration.

          • ZeppelinApplicationConfigurationDescription — (map)

            The configuration parameters for a Kinesis Data Analytics Studio notebook.

            • MonitoringConfigurationDescription — required — (map)

              The monitoring configuration of a Kinesis Data Analytics Studio notebook.

              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • CatalogConfigurationDescription — (map)

              The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

              • GlueDataCatalogConfigurationDescription — required — (map)

                The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

                • DatabaseARN — required — (String)

                  The Amazon Resource Name (ARN) of the database.

            • DeployAsApplicationConfigurationDescription — (map)

              The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

              • S3ContentLocationDescription — required — (map)

                The location that holds the data required to specify an Amazon Data Analytics application.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • BasePath — (String)

                  The base path for the S3 bucket.

            • CustomArtifactsConfigurationDescription — (Array<map>)

              Custom artifacts are dependency JARs and user-defined functions (UDF).

              • ArtifactType — (String)

                UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

                Possible values include:
                • "UDF"
                • "DEPENDENCY_JAR"
              • S3ContentLocationDescription — (map)

                For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

              • MavenReferenceDescription — (map)

                The parameters that are required to specify a Maven dependency.

                • GroupId — required — (String)

                  The group ID of the Maven reference.

                • ArtifactId — required — (String)

                  The artifact ID of the Maven reference.

                • Version — required — (String)

                  The version of the Maven reference.

        • CloudWatchLoggingOptionDescriptions — (Array<map>)

          Describes the application Amazon CloudWatch logging options.

          • CloudWatchLoggingOptionId — (String)

            The ID of the CloudWatch logging option description.

          • LogStreamARN — required — (String)

            The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

          • RoleARN — (String)

            The IAM ARN of the role to use to send application messages.

            Note: Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
        • ApplicationMaintenanceConfigurationDescription — (map)

          The details of the maintenance configuration for the application.

          • ApplicationMaintenanceWindowStartTime — required — (String)

            The start time for the maintenance window.

          • ApplicationMaintenanceWindowEndTime — required — (String)

            The end time for the maintenance window.

        • ApplicationVersionUpdatedFrom — (Integer)

          The previous application version before the latest application update. RollbackApplication reverts the application to this version.

        • ApplicationVersionRolledBackFrom — (Integer)

          If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

        • ConditionalToken — (String)

          A value you use to implement strong concurrency for application updates.

        • ApplicationVersionRolledBackTo — (Integer)

          The version to which you want to roll back the application.

        • ApplicationMode — (String)

          To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

          Possible values include:
          • "STREAMING"
          • "INTERACTIVE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startApplication(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the startApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  RunConfiguration: {
    ApplicationRestoreConfiguration: {
      ApplicationRestoreType: SKIP_RESTORE_FROM_SNAPSHOT | RESTORE_FROM_LATEST_SNAPSHOT | RESTORE_FROM_CUSTOM_SNAPSHOT, /* required */
      SnapshotName: 'STRING_VALUE'
    },
    FlinkRunConfiguration: {
      AllowNonRestoredState: true || false
    },
    SqlRunConfigurations: [
      {
        InputId: 'STRING_VALUE', /* required */
        InputStartingPositionConfiguration: { /* required */
          InputStartingPosition: NOW | TRIM_HORIZON | LAST_STOPPED_POINT
        }
      },
      /* more items */
    ]
  }
};
kinesisanalyticsv2.startApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application.

    • RunConfiguration — (map)

      Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.

      • FlinkRunConfiguration — (map)

        Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

        • AllowNonRestoredState — (Boolean)

          When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

          Note: This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
      • SqlRunConfigurations — (Array<map>)

        Describes the starting parameters for a SQL-based Kinesis Data Analytics application application.

        • InputId — required — (String)

          The input source ID. You can get this ID by calling the DescribeApplication operation.

        • InputStartingPositionConfiguration — required — (map)

          The point at which you want the application to start processing records from the streaming source.

          • InputStartingPosition — (String)

            The starting position on the stream.

            • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

            • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

            • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

            Possible values include:
            • "NOW"
            • "TRIM_HORIZON"
            • "LAST_STOPPED_POINT"
      • ApplicationRestoreConfiguration — (map)

        Describes the restore behavior of a restarting application.

        • ApplicationRestoreType — required — (String)

          Specifies how the application should be restored.

          Possible values include:
          • "SKIP_RESTORE_FROM_SNAPSHOT"
          • "RESTORE_FROM_LATEST_SNAPSHOT"
          • "RESTORE_FROM_CUSTOM_SNAPSHOT"
        • SnapshotName — (String)

          The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopApplication(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the stopApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  Force: true || false
};
kinesisanalyticsv2.stopApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the running application to stop.

    • Force — (Boolean)

      Set to true to force the application to stop. If you set Force to true, Kinesis Data Analytics stops the application without taking a snapshot.

      Note: Force-stopping your application may lead to data loss or duplication. To prevent data loss or duplicate processing of data during application restarts, we recommend you to take frequent snapshots of your application.

      You can only force stop a Flink-based Kinesis Data Analytics application. You can't force stop a SQL-based Kinesis Data Analytics application.

      The application must be in the STARTING, UPDATING, STOPPING, AUTOSCALING, or RUNNING status.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
kinesisanalyticsv2.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The ARN of the application to assign the tags.

    • Tags — (Array<map>)

      The key-value tags to assign to the application.

      • Key — required — (String)

        The key of the key-value tag.

      • Value — (String)

        The value of the key-value tag. The value is optional.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from a Kinesis Data Analytics application. For more information, see Using Tagging.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
kinesisanalyticsv2.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceARN — (String)

      The ARN of the Kinesis Data Analytics application from which to remove the tags.

    • TagKeys — (Array<String>)

      A list of keys of tags to remove from the specified application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApplication(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the updateApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  ApplicationConfigurationUpdate: {
    ApplicationCodeConfigurationUpdate: {
      CodeContentTypeUpdate: PLAINTEXT | ZIPFILE,
      CodeContentUpdate: {
        S3ContentLocationUpdate: {
          BucketARNUpdate: 'STRING_VALUE',
          FileKeyUpdate: 'STRING_VALUE',
          ObjectVersionUpdate: 'STRING_VALUE'
        },
        TextContentUpdate: 'STRING_VALUE',
        ZipFileContentUpdate: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
      }
    },
    ApplicationSnapshotConfigurationUpdate: {
      SnapshotsEnabledUpdate: true || false /* required */
    },
    EnvironmentPropertyUpdates: {
      PropertyGroups: [ /* required */
        {
          PropertyGroupId: 'STRING_VALUE', /* required */
          PropertyMap: { /* required */
            '<PropertyKey>': 'STRING_VALUE',
            /* '<PropertyKey>': ... */
          }
        },
        /* more items */
      ]
    },
    FlinkApplicationConfigurationUpdate: {
      CheckpointConfigurationUpdate: {
        CheckpointIntervalUpdate: 'NUMBER_VALUE',
        CheckpointingEnabledUpdate: true || false,
        ConfigurationTypeUpdate: DEFAULT | CUSTOM,
        MinPauseBetweenCheckpointsUpdate: 'NUMBER_VALUE'
      },
      MonitoringConfigurationUpdate: {
        ConfigurationTypeUpdate: DEFAULT | CUSTOM,
        LogLevelUpdate: INFO | WARN | ERROR | DEBUG,
        MetricsLevelUpdate: APPLICATION | TASK | OPERATOR | PARALLELISM
      },
      ParallelismConfigurationUpdate: {
        AutoScalingEnabledUpdate: true || false,
        ConfigurationTypeUpdate: DEFAULT | CUSTOM,
        ParallelismPerKPUUpdate: 'NUMBER_VALUE',
        ParallelismUpdate: 'NUMBER_VALUE'
      }
    },
    SqlApplicationConfigurationUpdate: {
      InputUpdates: [
        {
          InputId: 'STRING_VALUE', /* required */
          InputParallelismUpdate: {
            CountUpdate: 'NUMBER_VALUE' /* required */
          },
          InputProcessingConfigurationUpdate: {
            InputLambdaProcessorUpdate: { /* required */
              ResourceARNUpdate: 'STRING_VALUE' /* required */
            }
          },
          InputSchemaUpdate: {
            RecordColumnUpdates: [
              {
                Name: 'STRING_VALUE', /* required */
                SqlType: 'STRING_VALUE', /* required */
                Mapping: 'STRING_VALUE'
              },
              /* more items */
            ],
            RecordEncodingUpdate: 'STRING_VALUE',
            RecordFormatUpdate: {
              RecordFormatType: JSON | CSV, /* required */
              MappingParameters: {
                CSVMappingParameters: {
                  RecordColumnDelimiter: 'STRING_VALUE', /* required */
                  RecordRowDelimiter: 'STRING_VALUE' /* required */
                },
                JSONMappingParameters: {
                  RecordRowPath: 'STRING_VALUE' /* required */
                }
              }
            }
          },
          KinesisFirehoseInputUpdate: {
            ResourceARNUpdate: 'STRING_VALUE' /* required */
          },
          KinesisStreamsInputUpdate: {
            ResourceARNUpdate: 'STRING_VALUE' /* required */
          },
          NamePrefixUpdate: 'STRING_VALUE'
        },
        /* more items */
      ],
      OutputUpdates: [
        {
          OutputId: 'STRING_VALUE', /* required */
          DestinationSchemaUpdate: {
            RecordFormatType: JSON | CSV /* required */
          },
          KinesisFirehoseOutputUpdate: {
            ResourceARNUpdate: 'STRING_VALUE' /* required */
          },
          KinesisStreamsOutputUpdate: {
            ResourceARNUpdate: 'STRING_VALUE' /* required */
          },
          LambdaOutputUpdate: {
            ResourceARNUpdate: 'STRING_VALUE' /* required */
          },
          NameUpdate: 'STRING_VALUE'
        },
        /* more items */
      ],
      ReferenceDataSourceUpdates: [
        {
          ReferenceId: 'STRING_VALUE', /* required */
          ReferenceSchemaUpdate: {
            RecordColumns: [ /* required */
              {
                Name: 'STRING_VALUE', /* required */
                SqlType: 'STRING_VALUE', /* required */
                Mapping: 'STRING_VALUE'
              },
              /* more items */
            ],
            RecordFormat: { /* required */
              RecordFormatType: JSON | CSV, /* required */
              MappingParameters: {
                CSVMappingParameters: {
                  RecordColumnDelimiter: 'STRING_VALUE', /* required */
                  RecordRowDelimiter: 'STRING_VALUE' /* required */
                },
                JSONMappingParameters: {
                  RecordRowPath: 'STRING_VALUE' /* required */
                }
              }
            },
            RecordEncoding: 'STRING_VALUE'
          },
          S3ReferenceDataSourceUpdate: {
            BucketARNUpdate: 'STRING_VALUE',
            FileKeyUpdate: 'STRING_VALUE'
          },
          TableNameUpdate: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    VpcConfigurationUpdates: [
      {
        VpcConfigurationId: 'STRING_VALUE', /* required */
        SecurityGroupIdUpdates: [
          'STRING_VALUE',
          /* more items */
        ],
        SubnetIdUpdates: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ],
    ZeppelinApplicationConfigurationUpdate: {
      CatalogConfigurationUpdate: {
        GlueDataCatalogConfigurationUpdate: { /* required */
          DatabaseARNUpdate: 'STRING_VALUE' /* required */
        }
      },
      CustomArtifactsConfigurationUpdate: [
        {
          ArtifactType: UDF | DEPENDENCY_JAR, /* required */
          MavenReference: {
            ArtifactId: 'STRING_VALUE', /* required */
            GroupId: 'STRING_VALUE', /* required */
            Version: 'STRING_VALUE' /* required */
          },
          S3ContentLocation: {
            BucketARN: 'STRING_VALUE', /* required */
            FileKey: 'STRING_VALUE', /* required */
            ObjectVersion: 'STRING_VALUE'
          }
        },
        /* more items */
      ],
      DeployAsApplicationConfigurationUpdate: {
        S3ContentLocationUpdate: {
          BasePathUpdate: 'STRING_VALUE',
          BucketARNUpdate: 'STRING_VALUE'
        }
      },
      MonitoringConfigurationUpdate: {
        LogLevelUpdate: INFO | WARN | ERROR | DEBUG /* required */
      }
    }
  },
  CloudWatchLoggingOptionUpdates: [
    {
      CloudWatchLoggingOptionId: 'STRING_VALUE', /* required */
      LogStreamARNUpdate: 'STRING_VALUE'
    },
    /* more items */
  ],
  ConditionalToken: 'STRING_VALUE',
  CurrentApplicationVersionId: 'NUMBER_VALUE',
  RunConfigurationUpdate: {
    ApplicationRestoreConfiguration: {
      ApplicationRestoreType: SKIP_RESTORE_FROM_SNAPSHOT | RESTORE_FROM_LATEST_SNAPSHOT | RESTORE_FROM_CUSTOM_SNAPSHOT, /* required */
      SnapshotName: 'STRING_VALUE'
    },
    FlinkRunConfiguration: {
      AllowNonRestoredState: true || false
    }
  },
  ServiceExecutionRoleUpdate: 'STRING_VALUE'
};
kinesisanalyticsv2.updateApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application to update.

    • CurrentApplicationVersionId — (Integer)

      The current application version ID. You must provide the CurrentApplicationVersionId or the ConditionalToken.You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

    • ApplicationConfigurationUpdate — (map)

      Describes application configuration updates.

      • SqlApplicationConfigurationUpdate — (map)

        Describes updates to a SQL-based Kinesis Data Analytics application's configuration.

        • InputUpdates — (Array<map>)

          The array of InputUpdate objects describing the new input streams used by the application.

          • InputId — required — (String)

            The input ID of the application input to be updated.

          • NamePrefixUpdate — (String)

            The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.

          • InputProcessingConfigurationUpdate — (map)

            Describes updates to an InputProcessingConfiguration.

            • InputLambdaProcessorUpdate — required — (map)

              Provides update information for an InputLambdaProcessor.

              • ResourceARNUpdate — required — (String)

                The Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to preprocess the records in the stream.

                Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
          • KinesisStreamsInputUpdate — (map)

            If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).

            • ResourceARNUpdate — required — (String)

              The Amazon Resource Name (ARN) of the input Kinesis data stream to read.

          • KinesisFirehoseInputUpdate — (map)

            If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.

            • ResourceARNUpdate — required — (String)

              The Amazon Resource Name (ARN) of the input delivery stream to read.

          • InputSchemaUpdate — (map)

            Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.

            • RecordFormatUpdate — (map)

              Specifies the format of the records on the streaming source.

              • RecordFormatType — required — (String)

                The type of record format.

                Possible values include:
                • "JSON"
                • "CSV"
              • MappingParameters — (map)

                When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                • JSONMappingParameters — (map)

                  Provides additional mapping information when JSON is the record format on the streaming source.

                  • RecordRowPath — required — (String)

                    The path to the top-level parent that contains the records.

                • CSVMappingParameters — (map)

                  Provides additional mapping information when the record format uses delimiters (for example, CSV).

                  • RecordRowDelimiter — required — (String)

                    The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                  • RecordColumnDelimiter — required — (String)

                    The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

            • RecordEncodingUpdate — (String)

              Specifies the encoding of the records in the streaming source; for example, UTF-8.

            • RecordColumnUpdates — (Array<map>)

              A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.

              • Name — required — (String)

                The name of the column that is created in the in-application input stream or reference table.

              • Mapping — (String)

                A reference to the data element in the streaming input or the reference data source.

              • SqlType — required — (String)

                The type of column created in the in-application input stream or reference table.

          • InputParallelismUpdate — (map)

            Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).

            • CountUpdate — required — (Integer)

              The number of in-application streams to create for the specified streaming source.

        • OutputUpdates — (Array<map>)

          The array of OutputUpdate objects describing the new destination streams used by the application.

          • OutputId — required — (String)

            Identifies the specific output configuration that you want to update.

          • NameUpdate — (String)

            If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.

          • KinesisStreamsOutputUpdate — (map)

            Describes a Kinesis data stream as the destination for the output.

            • ResourceARNUpdate — required — (String)

              The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.

          • KinesisFirehoseOutputUpdate — (map)

            Describes a Kinesis Data Firehose delivery stream as the destination for the output.

            • ResourceARNUpdate — required — (String)

              The Amazon Resource Name (ARN) of the delivery stream to write to.

          • LambdaOutputUpdate — (map)

            Describes an Amazon Lambda function as the destination for the output.

            • ResourceARNUpdate — required — (String)

              The Amazon Resource Name (ARN) of the destination Amazon Lambda function.

              Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
          • DestinationSchemaUpdate — (map)

            Describes the data format when records are written to the destination.

            • RecordFormatType — required — (String)

              Specifies the format of the records on the output stream.

              Possible values include:
              • "JSON"
              • "CSV"
        • ReferenceDataSourceUpdates — (Array<map>)

          The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.

          • ReferenceId — required — (String)

            The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.

          • TableNameUpdate — (String)

            The in-application table name that is created by this update.

          • S3ReferenceDataSourceUpdate — (map)

            Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

            • BucketARNUpdate — (String)

              The Amazon Resource Name (ARN) of the S3 bucket.

            • FileKeyUpdate — (String)

              The object key name.

          • ReferenceSchemaUpdate — (map)

            Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

            • RecordFormat — required — (map)

              Specifies the format of the records on the streaming source.

              • RecordFormatType — required — (String)

                The type of record format.

                Possible values include:
                • "JSON"
                • "CSV"
              • MappingParameters — (map)

                When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                • JSONMappingParameters — (map)

                  Provides additional mapping information when JSON is the record format on the streaming source.

                  • RecordRowPath — required — (String)

                    The path to the top-level parent that contains the records.

                • CSVMappingParameters — (map)

                  Provides additional mapping information when the record format uses delimiters (for example, CSV).

                  • RecordRowDelimiter — required — (String)

                    The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                  • RecordColumnDelimiter — required — (String)

                    The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

            • RecordEncoding — (String)

              Specifies the encoding of the records in the streaming source. For example, UTF-8.

            • RecordColumns — required — (Array<map>)

              A list of RecordColumn objects.

              • Name — required — (String)

                The name of the column that is created in the in-application input stream or reference table.

              • Mapping — (String)

                A reference to the data element in the streaming input or the reference data source.

              • SqlType — required — (String)

                The type of column created in the in-application input stream or reference table.

      • ApplicationCodeConfigurationUpdate — (map)

        Describes updates to an application's code configuration.

        • CodeContentTypeUpdate — (String)

          Describes updates to the code content type.

          Possible values include:
          • "PLAINTEXT"
          • "ZIPFILE"
        • CodeContentUpdate — (map)

          Describes updates to the code content of an application.

          • TextContentUpdate — (String)

            Describes an update to the text code for an application.

          • ZipFileContentUpdate — (Buffer, Typed Array, Blob, String)

            Describes an update to the zipped code for an application.

          • S3ContentLocationUpdate — (map)

            Describes an update to the location of code for an application.

            • BucketARNUpdate — (String)

              The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.

            • FileKeyUpdate — (String)

              The new file key for the object containing the application code.

            • ObjectVersionUpdate — (String)

              The new version of the object containing the application code.

      • FlinkApplicationConfigurationUpdate — (map)

        Describes updates to a Flink-based Kinesis Data Analytics application's configuration.

        • CheckpointConfigurationUpdate — (map)

          Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

          • ConfigurationTypeUpdate — (String)

            Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

            Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:
            • CheckpointingEnabled: true
            • CheckpointInterval: 60000
            • MinPauseBetweenCheckpoints: 5000
            Possible values include:
            • "DEFAULT"
            • "CUSTOM"
          • CheckpointingEnabledUpdate — (Boolean)

            Describes updates to whether checkpointing is enabled for an application.

            Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
          • CheckpointIntervalUpdate — (Integer)

            Describes updates to the interval in milliseconds between checkpoint operations.

            Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
          • MinPauseBetweenCheckpointsUpdate — (Integer)

            Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

            Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
        • MonitoringConfigurationUpdate — (map)

          Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.

          • ConfigurationTypeUpdate — (String)

            Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set this property to CUSTOM in order to set the LogLevel or MetricsLevel parameters.

            Possible values include:
            • "DEFAULT"
            • "CUSTOM"
          • MetricsLevelUpdate — (String)

            Describes updates to the granularity of the CloudWatch Logs for an application. The Parallelism level is not recommended for applications with a Parallelism over 64 due to excessive costs.

            Possible values include:
            • "APPLICATION"
            • "TASK"
            • "OPERATOR"
            • "PARALLELISM"
          • LogLevelUpdate — (String)

            Describes updates to the verbosity of the CloudWatch Logs for an application.

            Possible values include:
            • "INFO"
            • "WARN"
            • "ERROR"
            • "DEBUG"
        • ParallelismConfigurationUpdate — (map)

          Describes updates to the parameters for how an application executes multiple tasks simultaneously.

          • ConfigurationTypeUpdate — (String)

            Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used. You must set this property to CUSTOM in order to change your application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU properties.

            Possible values include:
            • "DEFAULT"
            • "CUSTOM"
          • ParallelismUpdate — (Integer)

            Describes updates to the initial number of parallel tasks an application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service will reduce CurrentParallelism down to the Parallelism setting.

          • ParallelismPerKPUUpdate — (Integer)

            Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.

          • AutoScalingEnabledUpdate — (Boolean)

            Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of a Flink-based Kinesis Data Analytics application in response to increased throughput.

      • EnvironmentPropertyUpdates — (map)

        Describes updates to the environment properties for a Flink-based Kinesis Data Analytics application.

        • PropertyGroups — required — (Array<map>)

          Describes updates to the execution property groups.

          • PropertyGroupId — required — (String)

            Describes the key of an application execution property key-value pair.

          • PropertyMap — required — (map<String>)

            Describes the value of an application execution property key-value pair.

      • ApplicationSnapshotConfigurationUpdate — (map)

        Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

        • SnapshotsEnabledUpdate — required — (Boolean)

          Describes updates to whether snapshots are enabled for an application.

      • VpcConfigurationUpdates — (Array<map>)

        Updates to the array of descriptions of VPC configurations available to the application.

        • VpcConfigurationId — required — (String)

          Describes an update to the ID of the VPC configuration.

        • SubnetIdUpdates — (Array<String>)

          Describes updates to the array of Subnet IDs used by the VPC configuration.

        • SecurityGroupIdUpdates — (Array<String>)

          Describes updates to the array of SecurityGroup IDs used by the VPC configuration.

      • ZeppelinApplicationConfigurationUpdate — (map)

        Updates to the configuration of a Kinesis Data Analytics Studio notebook.

        • MonitoringConfigurationUpdate — (map)

          Updates to the monitoring configuration of a Kinesis Data Analytics Studio notebook.

          • LogLevelUpdate — required — (String)

            Updates to the logging level for Apache Zeppelin within a Kinesis Data Analytics Studio notebook.

            Possible values include:
            • "INFO"
            • "WARN"
            • "ERROR"
            • "DEBUG"
        • CatalogConfigurationUpdate — (map)

          Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

          • GlueDataCatalogConfigurationUpdate — required — (map)

            Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

            • DatabaseARNUpdate — required — (String)

              The updated Amazon Resource Name (ARN) of the database.

        • DeployAsApplicationConfigurationUpdate — (map)

          Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.

          • S3ContentLocationUpdate — (map)

            Updates to the location that holds the data required to specify an Amazon Data Analytics application.

            • BucketARNUpdate — (String)

              The updated Amazon Resource Name (ARN) of the S3 bucket.

            • BasePathUpdate — (String)

              The updated S3 bucket path.

        • CustomArtifactsConfigurationUpdate — (Array<map>)

          Updates to the customer artifacts. Custom artifacts are dependency JAR files and user-defined functions (UDF).

          • ArtifactType — required — (String)

            UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

            Possible values include:
            • "UDF"
            • "DEPENDENCY_JAR"
          • S3ContentLocation — (map)

            For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

            • BucketARN — required — (String)

              The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

            • FileKey — required — (String)

              The file key for the object containing the application code.

            • ObjectVersion — (String)

              The version of the object containing the application code.

          • MavenReference — (map)

            The parameters required to fully specify a Maven reference.

            • GroupId — required — (String)

              The group ID of the Maven reference.

            • ArtifactId — required — (String)

              The artifact ID of the Maven reference.

            • Version — required — (String)

              The version of the Maven reference.

    • ServiceExecutionRoleUpdate — (String)

      Describes updates to the service execution role.

    • RunConfigurationUpdate — (map)

      Describes updates to the application's starting parameters.

      • FlinkRunConfiguration — (map)

        Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

        • AllowNonRestoredState — (Boolean)

          When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

          Note: This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
      • ApplicationRestoreConfiguration — (map)

        Describes updates to the restore behavior of a restarting application.

        • ApplicationRestoreType — required — (String)

          Specifies how the application should be restored.

          Possible values include:
          • "SKIP_RESTORE_FROM_SNAPSHOT"
          • "RESTORE_FROM_LATEST_SNAPSHOT"
          • "RESTORE_FROM_CUSTOM_SNAPSHOT"
        • SnapshotName — (String)

          The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

    • CloudWatchLoggingOptionUpdates — (Array<map>)

      Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.

      • CloudWatchLoggingOptionId — required — (String)

        The ID of the CloudWatch logging option to update

      • LogStreamARNUpdate — (String)

        The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

    • ConditionalToken — (String)

      A value you use to implement strong concurrency for application updates. You must provide the CurrentApplicationVersionId or the ConditionalToken. You get the application's current ConditionalToken using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationDetail — (map)

        Describes application updates.

        • ApplicationARN — required — (String)

          The ARN of the application.

        • ApplicationDescription — (String)

          The description of the application.

        • ApplicationName — required — (String)

          The name of the application.

        • RuntimeEnvironment — required — (String)

          The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

          Possible values include:
          • "SQL-1_0"
          • "FLINK-1_6"
          • "FLINK-1_8"
          • "ZEPPELIN-FLINK-1_0"
          • "FLINK-1_11"
          • "FLINK-1_13"
          • "ZEPPELIN-FLINK-2_0"
        • ServiceExecutionRole — (String)

          Specifies the IAM role that the application uses to access external resources.

        • ApplicationStatus — required — (String)

          The status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
          • "AUTOSCALING"
          • "FORCE_STOPPING"
          • "ROLLING_BACK"
          • "MAINTENANCE"
          • "ROLLED_BACK"
        • ApplicationVersionId — required — (Integer)

          Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

        • CreateTimestamp — (Date)

          The current timestamp when the application was created.

        • LastUpdateTimestamp — (Date)

          The current timestamp when the application was last updated.

        • ApplicationConfigurationDescription — (map)

          Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

          • SqlApplicationConfigurationDescription — (map)

            The details about inputs, outputs, and reference data sources for a SQL-based Kinesis Data Analytics application.

            • InputDescriptions — (Array<map>)

              The array of InputDescription objects describing the input streams used by the application.

              • InputId — (String)

                The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

              • NamePrefix — (String)

                The in-application name prefix.

              • InAppStreamNames — (Array<String>)

                Returns the in-application stream names that are mapped to the stream source.

              • InputProcessingConfigurationDescription — (map)

                The description of the preprocessor that executes on records in this input before the application's code is run.

                • InputLambdaProcessorDescription — (map)

                  Provides configuration information about the associated InputLambdaProcessorDescription

                  • ResourceARN — required — (String)

                    The ARN of the Amazon Lambda function that is used to preprocess the records in the stream.

                    Note: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
                  • RoleARN — (String)

                    The ARN of the IAM role that is used to access the Amazon Lambda function.

                    Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisStreamsInputDescription — (map)

                If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseInputDescription — (map)

                If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • InputSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

              • InputParallelism — (map)

                Describes the configured parallelism (number of in-application streams mapped to the streaming source).

                • Count — (Integer)

                  The number of in-application streams to create.

              • InputStartingPositionConfiguration — (map)

                The point at which the application is configured to read from the input stream.

                • InputStartingPosition — (String)

                  The starting position on the stream.

                  • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

                  • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

                  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

                  Possible values include:
                  • "NOW"
                  • "TRIM_HORIZON"
                  • "LAST_STOPPED_POINT"
            • OutputDescriptions — (Array<map>)

              The array of OutputDescription objects describing the destination streams used by the application.

              • OutputId — (String)

                A unique identifier for the output configuration.

              • Name — (String)

                The name of the in-application stream that is configured as output.

              • KinesisStreamsOutputDescription — (map)

                Describes the Kinesis data stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the Kinesis data stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • KinesisFirehoseOutputDescription — (map)

                Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the delivery stream.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • LambdaOutputDescription — (map)

                Describes the Lambda function that is configured as the destination where output is written.

                • ResourceARN — required — (String)

                  The Amazon Resource Name (ARN) of the destination Lambda function.

                • RoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • DestinationSchema — (map)

                The data format used for writing data to the destination.

                • RecordFormatType — required — (String)

                  Specifies the format of the records on the output stream.

                  Possible values include:
                  • "JSON"
                  • "CSV"
            • ReferenceDataSourceDescriptions — (Array<map>)

              The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.

              • ReferenceId — required — (String)

                The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

              • TableName — required — (String)

                The in-application table name created by the specific reference data source configuration.

              • S3ReferenceDataSourceDescription — required — (map)

                Provides the Amazon S3 bucket name, the object key name that contains the reference data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • FileKey — required — (String)

                  Amazon S3 object key name.

                • ReferenceRoleARN — (String)

                  The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

                  Note: Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.
              • ReferenceSchema — (map)

                Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

                • RecordFormat — required — (map)

                  Specifies the format of the records on the streaming source.

                  • RecordFormatType — required — (String)

                    The type of record format.

                    Possible values include:
                    • "JSON"
                    • "CSV"
                  • MappingParameters — (map)

                    When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

                    • JSONMappingParameters — (map)

                      Provides additional mapping information when JSON is the record format on the streaming source.

                      • RecordRowPath — required — (String)

                        The path to the top-level parent that contains the records.

                    • CSVMappingParameters — (map)

                      Provides additional mapping information when the record format uses delimiters (for example, CSV).

                      • RecordRowDelimiter — required — (String)

                        The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.

                      • RecordColumnDelimiter — required — (String)

                        The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.

                • RecordEncoding — (String)

                  Specifies the encoding of the records in the streaming source. For example, UTF-8.

                • RecordColumns — required — (Array<map>)

                  A list of RecordColumn objects.

                  • Name — required — (String)

                    The name of the column that is created in the in-application input stream or reference table.

                  • Mapping — (String)

                    A reference to the data element in the streaming input or the reference data source.

                  • SqlType — required — (String)

                    The type of column created in the in-application input stream or reference table.

          • ApplicationCodeConfigurationDescription — (map)

            The details about the application code for a Flink-based Kinesis Data Analytics application.

            • CodeContentType — required — (String)

              Specifies whether the code content is in text or zip format.

              Possible values include:
              • "PLAINTEXT"
              • "ZIPFILE"
            • CodeContentDescription — (map)

              Describes details about the location and format of the application code.

              • TextContent — (String)

                The text-format code

              • CodeMD5 — (String)

                The checksum that can be used to validate zip-format code.

              • CodeSize — (Integer)

                The size in bytes of the application code. Can be used to validate zip-format code.

              • S3ApplicationCodeLocationDescription — (map)

                The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

          • RunConfigurationDescription — (map)

            The details about the starting properties for a Kinesis Data Analytics application.

            • ApplicationRestoreConfigurationDescription — (map)

              Describes the restore behavior of a restarting application.

              • ApplicationRestoreType — required — (String)

                Specifies how the application should be restored.

                Possible values include:
                • "SKIP_RESTORE_FROM_SNAPSHOT"
                • "RESTORE_FROM_LATEST_SNAPSHOT"
                • "RESTORE_FROM_CUSTOM_SNAPSHOT"
              • SnapshotName — (String)

                The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

            • FlinkRunConfigurationDescription — (map)

              Describes the starting parameters for a Flink-based Kinesis Data Analytics application.

              • AllowNonRestoredState — (Boolean)

                When restoring from a snapshot, specifies whether the runtime is allowed to skip a state that cannot be mapped to the new program. This will happen if the program is updated between snapshots to remove stateful parameters, and state data in the snapshot no longer corresponds to valid application data. For more information, see Allowing Non-Restored State in the Apache Flink documentation.

                Note: This value defaults to false. If you update your application without specifying this parameter, AllowNonRestoredState will be set to false, even if it was previously set to true.
          • FlinkApplicationConfigurationDescription — (map)

            The details about a Flink-based Kinesis Data Analytics application.

            • CheckpointConfigurationDescription — (map)

              Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

              • ConfigurationType — (String)

                Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

                Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:
                • CheckpointingEnabled: true
                • CheckpointInterval: 60000
                • MinPauseBetweenCheckpoints: 5000
                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • CheckpointingEnabled — (Boolean)

                Describes whether checkpointing is enabled for a Flink-based Kinesis Data Analytics application.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
              • CheckpointInterval — (Integer)

                Describes the interval in milliseconds between checkpoint operations.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointInterval value of 60000, even if this value is set to another value using this API or in application code.
              • MinPauseBetweenCheckpoints — (Integer)

                Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

                Note: If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application code.
            • MonitoringConfigurationDescription — (map)

              Describes configuration parameters for Amazon CloudWatch logging for an application.

              • ConfigurationType — (String)

                Describes whether to use the default CloudWatch logging configuration for an application.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • MetricsLevel — (String)

                Describes the granularity of the CloudWatch Logs for an application.

                Possible values include:
                • "APPLICATION"
                • "TASK"
                • "OPERATOR"
                • "PARALLELISM"
              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • ParallelismConfigurationDescription — (map)

              Describes parameters for how an application executes multiple tasks simultaneously.

              • ConfigurationType — (String)

                Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

                Possible values include:
                • "DEFAULT"
                • "CUSTOM"
              • Parallelism — (Integer)

                Describes the initial number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the CurrentParallelism value in response to application load. The service can increase CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • ParallelismPerKPU — (Integer)

                Describes the number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.

              • CurrentParallelism — (Integer)

                Describes the current number of parallel tasks that a Flink-based Kinesis Data Analytics application can perform. If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to application load. The service can increase this value up to the maximum parallelism, which is ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service can reduce the CurrentParallelism value down to the Parallelism setting.

              • AutoScalingEnabled — (Boolean)

                Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

            • JobPlanDescription — (String)

              The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

          • EnvironmentPropertyDescriptions — (map)

            Describes execution properties for a Flink-based Kinesis Data Analytics application.

            • PropertyGroupDescriptions — (Array<map>)

              Describes the execution property groups.

              • PropertyGroupId — required — (String)

                Describes the key of an application execution property key-value pair.

              • PropertyMap — required — (map<String>)

                Describes the value of an application execution property key-value pair.

          • ApplicationSnapshotConfigurationDescription — (map)

            Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

            • SnapshotsEnabled — required — (Boolean)

              Describes whether snapshots are enabled for a Flink-based Kinesis Data Analytics application.

          • VpcConfigurationDescriptions — (Array<map>)

            The array of descriptions of VPC configurations available to the application.

            • VpcConfigurationId — required — (String)

              The ID of the VPC configuration.

            • VpcId — required — (String)

              The ID of the associated VPC.

            • SubnetIds — required — (Array<String>)

              The array of Subnet IDs used by the VPC configuration.

            • SecurityGroupIds — required — (Array<String>)

              The array of SecurityGroup IDs used by the VPC configuration.

          • ZeppelinApplicationConfigurationDescription — (map)

            The configuration parameters for a Kinesis Data Analytics Studio notebook.

            • MonitoringConfigurationDescription — required — (map)

              The monitoring configuration of a Kinesis Data Analytics Studio notebook.

              • LogLevel — (String)

                Describes the verbosity of the CloudWatch Logs for an application.

                Possible values include:
                • "INFO"
                • "WARN"
                • "ERROR"
                • "DEBUG"
            • CatalogConfigurationDescription — (map)

              The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.

              • GlueDataCatalogConfigurationDescription — required — (map)

                The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.

                • DatabaseARN — required — (String)

                  The Amazon Resource Name (ARN) of the database.

            • DeployAsApplicationConfigurationDescription — (map)

              The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.

              • S3ContentLocationDescription — required — (map)

                The location that holds the data required to specify an Amazon Data Analytics application.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) of the S3 bucket.

                • BasePath — (String)

                  The base path for the S3 bucket.

            • CustomArtifactsConfigurationDescription — (Array<map>)

              Custom artifacts are dependency JARs and user-defined functions (UDF).

              • ArtifactType — (String)

                UDF stands for user-defined functions. This type of artifact must be in an S3 bucket. A DEPENDENCY_JAR can be in either Maven or an S3 bucket.

                Possible values include:
                • "UDF"
                • "DEPENDENCY_JAR"
              • S3ContentLocationDescription — (map)

                For a Kinesis Data Analytics application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

                • BucketARN — required — (String)

                  The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

                • FileKey — required — (String)

                  The file key for the object containing the application code.

                • ObjectVersion — (String)

                  The version of the object containing the application code.

              • MavenReferenceDescription — (map)

                The parameters that are required to specify a Maven dependency.

                • GroupId — required — (String)

                  The group ID of the Maven reference.

                • ArtifactId — required — (String)

                  The artifact ID of the Maven reference.

                • Version — required — (String)

                  The version of the Maven reference.

        • CloudWatchLoggingOptionDescriptions — (Array<map>)

          Describes the application Amazon CloudWatch logging options.

          • CloudWatchLoggingOptionId — (String)

            The ID of the CloudWatch logging option description.

          • LogStreamARN — required — (String)

            The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

          • RoleARN — (String)

            The IAM ARN of the role to use to send application messages.

            Note: Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
        • ApplicationMaintenanceConfigurationDescription — (map)

          The details of the maintenance configuration for the application.

          • ApplicationMaintenanceWindowStartTime — required — (String)

            The start time for the maintenance window.

          • ApplicationMaintenanceWindowEndTime — required — (String)

            The end time for the maintenance window.

        • ApplicationVersionUpdatedFrom — (Integer)

          The previous application version before the latest application update. RollbackApplication reverts the application to this version.

        • ApplicationVersionRolledBackFrom — (Integer)

          If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

        • ConditionalToken — (String)

          A value you use to implement strong concurrency for application updates.

        • ApplicationVersionRolledBackTo — (Integer)

          The version to which you want to roll back the application.

        • ApplicationMode — (String)

          To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

          Possible values include:
          • "STREAMING"
          • "INTERACTIVE"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApplicationMaintenanceConfiguration(params = {}, callback) ⇒ AWS.Request

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.

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

Service Reference:

Examples:

Calling the updateApplicationMaintenanceConfiguration operation

var params = {
  ApplicationMaintenanceConfigurationUpdate: { /* required */
    ApplicationMaintenanceWindowStartTimeUpdate: 'STRING_VALUE' /* required */
  },
  ApplicationName: 'STRING_VALUE' /* required */
};
kinesisanalyticsv2.updateApplicationMaintenanceConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationName — (String)

      The name of the application for which you want to update the maintenance configuration.

    • ApplicationMaintenanceConfigurationUpdate — (map)

      Describes the application maintenance configuration update.

      • ApplicationMaintenanceWindowStartTimeUpdate — required — (String)

        The updated start time for the maintenance window.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ApplicationARN — (String)

        The Amazon Resource Name (ARN) of the application.

      • ApplicationMaintenanceConfigurationDescription — (map)

        The application maintenance configuration description after the update.

        • ApplicationMaintenanceWindowStartTime — required — (String)

          The start time for the maintenance window.

        • ApplicationMaintenanceWindowEndTime — required — (String)

          The end time for the maintenance window.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.