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

Inherits:
AWS.Service show all
Identifier:
kinesisanalytics
API Version:
2015-08-14
Defined in:
(unknown)

Overview

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

Service Description

Overview

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.

Sending a Request Using KinesisAnalytics

var kinesisanalytics = new AWS.KinesisAnalytics();
kinesisanalytics.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 KinesisAnalytics object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var kinesisanalytics = new AWS.KinesisAnalytics({apiVersion: '2015-08-14'});

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

AWS.config.apiVersions = {
  kinesisanalytics: '2015-08-14',
  // other service API versions
};

var kinesisanalytics = new AWS.KinesisAnalytics();

Version:

  • 2015-08-14

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.KinesisAnalytics(options = {}) ⇒ Object

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

Examples:

Constructing a KinesisAnalytics object

var kinesisanalytics = new AWS.KinesisAnalytics({apiVersion: '2015-08-14'});

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.KinesisAnalytics.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.KinesisAnalytics.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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

Service Reference:

Examples:

Calling the addApplicationCloudWatchLoggingOption operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CloudWatchLoggingOption: { /* required */
    LogStreamARN: 'STRING_VALUE', /* required */
    RoleARN: 'STRING_VALUE' /* required */
  },
  CurrentApplicationVersionId: 'NUMBER_VALUE' /* required */
};
kinesisanalytics.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 Analytics application name.

    • CurrentApplicationVersionId — (Integer)

      The version ID of the Kinesis Analytics application.

    • CloudWatchLoggingOption — (map)

      Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.

      • LogStreamARN — required — (String)

        ARN of the CloudWatch log to receive application messages.

      • RoleARN — required — (String)

        IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.

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.

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

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

You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

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

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

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 */
        RoleARN: 'STRING_VALUE' /* required */
      }
    },
    KinesisFirehoseInput: {
      ResourceARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE' /* required */
    },
    KinesisStreamsInput: {
      ResourceARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE' /* required */
    }
  }
};
kinesisanalytics.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)

      Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.

    • CurrentApplicationVersionId — (Integer)

      Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.

    • Input — (map)

      The Input to add.

      • NamePrefix — required — (String)

        Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with 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 AWS 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: AWS Lambda
          • RoleARN — required — (String)

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

      • KinesisStreamsInput — (map)

        If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

        Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

        • ResourceARN — required — (String)

          ARN of the input Amazon Kinesis stream to read.

        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

      • KinesisFirehoseInput — (map)

        If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

        Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

        • ResourceARN — required — (String)

          ARN of the input delivery stream.

        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.

      • InputParallelism — (map)

        Describes the number of in-application streams to create.

        Data from your source is routed to these in-application input streams.

        (see Configuring Application Input.

        • Count — (Integer)

          Number of in-application streams to create. For more information, see Limits.

      • 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 configuring 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)

                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)

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

              • RecordColumnDelimiter — required — (String)

                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)

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

          • Mapping — (String)

            Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

          • SqlType — required — (String)

            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.

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.

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 */
      RoleARN: 'STRING_VALUE' /* required */
    }
  }
};
kinesisanalytics.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)

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

    • CurrentApplicationVersionId — (Integer)

      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 AWS 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: AWS Lambda
        • RoleARN — required — (String)

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

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.

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds an external destination to your Amazon Kinesis Analytics application.

If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination).

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

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

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

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 */
      RoleARN: 'STRING_VALUE' /* required */
    },
    KinesisStreamsOutput: {
      ResourceARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE' /* required */
    },
    LambdaOutput: {
      ResourceARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE' /* required */
    }
  }
};
kinesisanalytics.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)

      Name of the application to which you want to add the output configuration.

    • CurrentApplicationVersionId — (Integer)

      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, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.

      • Name — required — (String)

        Name of the in-application stream.

      • KinesisStreamsOutput — (map)

        Identifies an Amazon Kinesis stream as the destination.

        • ResourceARN — required — (String)

          ARN of the destination Amazon Kinesis stream to write to.

        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

      • KinesisFirehoseOutput — (map)

        Identifies an Amazon Kinesis Firehose delivery stream as the destination.

        • ResourceARN — required — (String)

          ARN of the destination Amazon Kinesis Firehose delivery stream to write to.

        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

      • LambdaOutput — (map)

        Identifies an AWS Lambda function as the destination.

        • ResourceARN — required — (String)

          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: AWS Lambda
        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.

      • DestinationSchema — required — (map)

        Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

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

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds a reference data source to an existing application.

Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.

For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.

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

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', /* required */
      FileKey: 'STRING_VALUE', /* required */
      ReferenceRoleARN: 'STRING_VALUE' /* required */
    }
  }
};
kinesisanalytics.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)

      Name of an existing application.

    • CurrentApplicationVersionId — (Integer)

      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. Amazon Kinesis 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. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.

      • TableName — required — (String)

        Name of the in-application table to create.

      • S3ReferenceDataSource — (map)

        Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis 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 — required — (String)

          Amazon Resource Name (ARN) of the S3 bucket.

        • FileKey — required — (String)

          Object key name containing reference data.

        • ReferenceRoleARN — required — (String)

          ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

      • 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 configuring 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)

                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)

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

              • RecordColumnDelimiter — required — (String)

                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)

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

          • Mapping — (String)

            Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

          • SqlType — required — (String)

            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.

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works.

In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.

Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.

In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations.

To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.

For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  ApplicationCode: 'STRING_VALUE',
  ApplicationDescription: 'STRING_VALUE',
  CloudWatchLoggingOptions: [
    {
      LogStreamARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  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 */
          RoleARN: 'STRING_VALUE' /* required */
        }
      },
      KinesisFirehoseInput: {
        ResourceARN: 'STRING_VALUE', /* required */
        RoleARN: 'STRING_VALUE' /* required */
      },
      KinesisStreamsInput: {
        ResourceARN: 'STRING_VALUE', /* required */
        RoleARN: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  Outputs: [
    {
      DestinationSchema: { /* required */
        RecordFormatType: JSON | CSV /* required */
      },
      Name: 'STRING_VALUE', /* required */
      KinesisFirehoseOutput: {
        ResourceARN: 'STRING_VALUE', /* required */
        RoleARN: 'STRING_VALUE' /* required */
      },
      KinesisStreamsOutput: {
        ResourceARN: 'STRING_VALUE', /* required */
        RoleARN: 'STRING_VALUE' /* required */
      },
      LambdaOutput: {
        ResourceARN: 'STRING_VALUE', /* required */
        RoleARN: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
kinesisanalytics.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)

      Name of your Amazon Kinesis Analytics application (for example, sample-app).

    • ApplicationDescription — (String)

      Summary description of the application.

    • Inputs — (Array<map>)

      Use this parameter to configure the application input.

      You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).

      For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.

      To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.

      • NamePrefix — required — (String)

        Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with 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 AWS 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: AWS Lambda
          • RoleARN — required — (String)

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

      • KinesisStreamsInput — (map)

        If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

        Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

        • ResourceARN — required — (String)

          ARN of the input Amazon Kinesis stream to read.

        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

      • KinesisFirehoseInput — (map)

        If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

        Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

        • ResourceARN — required — (String)

          ARN of the input delivery stream.

        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.

      • InputParallelism — (map)

        Describes the number of in-application streams to create.

        Data from your source is routed to these in-application input streams.

        (see Configuring Application Input.

        • Count — (Integer)

          Number of in-application streams to create. For more information, see Limits.

      • 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 configuring 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)

                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)

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

              • RecordColumnDelimiter — required — (String)

                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)

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

          • Mapping — (String)

            Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

          • SqlType — required — (String)

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

    • Outputs — (Array<map>)

      You can configure application output to write data from any of the in-application streams to up to three destinations.

      These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three.

      In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf.

      In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.

      • Name — required — (String)

        Name of the in-application stream.

      • KinesisStreamsOutput — (map)

        Identifies an Amazon Kinesis stream as the destination.

        • ResourceARN — required — (String)

          ARN of the destination Amazon Kinesis stream to write to.

        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

      • KinesisFirehoseOutput — (map)

        Identifies an Amazon Kinesis Firehose delivery stream as the destination.

        • ResourceARN — required — (String)

          ARN of the destination Amazon Kinesis Firehose delivery stream to write to.

        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

      • LambdaOutput — (map)

        Identifies an AWS Lambda function as the destination.

        • ResourceARN — required — (String)

          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: AWS Lambda
        • RoleARN — required — (String)

          ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.

      • DestinationSchema — required — (map)

        Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

        • RecordFormatType — required — (String)

          Specifies the format of the records on the output stream.

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

      Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs.

      • LogStreamARN — required — (String)

        ARN of the CloudWatch log to receive application messages.

      • RoleARN — required — (String)

        IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.

    • ApplicationCode — (String)

      One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code.

      You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.

      Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams.

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

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:

      • ApplicationSummary — (map)

        In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.

        • ApplicationName — required — (String)

          Name of the application.

        • ApplicationARN — required — (String)

          ARN of the application.

        • ApplicationStatus — required — (String)

          Status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).

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

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 */
};
kinesisanalytics.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)

      Name of the Amazon Kinesis Analytics application to delete.

    • CreateTimestamp — (Date)

      You can 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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

Service Reference:

Examples:

Calling the deleteApplicationCloudWatchLoggingOption operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CloudWatchLoggingOptionId: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE' /* required */
};
kinesisanalytics.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 Kinesis Analytics application name.

    • CurrentApplicationVersionId — (Integer)

      The version ID of the Kinesis Analytics application.

    • CloudWatchLoggingOptionId — (String)

      The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId 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.

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

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 */
};
kinesisanalytics.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 Kinesis Analytics application name.

    • CurrentApplicationVersionId — (Integer)

      The version ID of the Kinesis Analytics application.

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

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

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

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

Service Reference:

Examples:

Calling the deleteApplicationOutput operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  OutputId: 'STRING_VALUE' /* required */
};
kinesisanalytics.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)

      Amazon Kinesis Analytics application name.

    • CurrentApplicationVersionId — (Integer)

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

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Deletes a reference data source configuration from the specified application configuration.

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

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

Service Reference:

Examples:

Calling the deleteApplicationReferenceDataSource operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  CurrentApplicationVersionId: 'NUMBER_VALUE', /* required */
  ReferenceId: 'STRING_VALUE' /* required */
};
kinesisanalytics.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)

      Name of an existing application.

    • CurrentApplicationVersionId — (Integer)

      Version of the application. 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)

      ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis 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.

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Returns information about a specific Amazon Kinesis Analytics application.

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

This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.

Service Reference:

Examples:

Calling the describeApplication operation

var params = {
  ApplicationName: 'STRING_VALUE' /* required */
};
kinesisanalytics.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)

      Name of the 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. The data object has the following properties:

      • ApplicationDetail — (map)

        Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.

        • ApplicationName — required — (String)

          Name of the application.

        • ApplicationDescription — (String)

          Description of the application.

        • ApplicationARN — required — (String)

          ARN of the application.

        • ApplicationStatus — required — (String)

          Status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
        • CreateTimestamp — (Date)

          Time stamp when the application version was created.

        • LastUpdateTimestamp — (Date)

          Time stamp when the application was last updated.

        • InputDescriptions — (Array<map>)

          Describes the application input configuration. For more information, see Configuring Application Input.

          • InputId — (String)

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

          • NamePrefix — (String)

            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 — (String)

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

              • RoleARN — (String)

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

          • KinesisStreamsInputDescription — (map)

            If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

            • ResourceARN — (String)

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

            • RoleARN — (String)

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

          • KinesisFirehoseInputDescription — (map)

            If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

            • ResourceARN — (String)

              Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

            • RoleARN — (String)

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

          • 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 configuring 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)

                    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)

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

                  • RecordColumnDelimiter — required — (String)

                    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)

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

              • Mapping — (String)

                Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

              • SqlType — required — (String)

                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)

              Number of in-application streams to create. For more information, see Limits.

          • InputStartingPositionConfiguration — (map)

            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, start at the request time stamp 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 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>)

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

          • OutputId — (String)

            A unique identifier for the output configuration.

          • Name — (String)

            Name of the in-application stream configured as output.

          • KinesisStreamsOutputDescription — (map)

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

            • ResourceARN — (String)

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

            • RoleARN — (String)

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

          • KinesisFirehoseOutputDescription — (map)

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

            • ResourceARN — (String)

              Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

            • RoleARN — (String)

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

          • LambdaOutputDescription — (map)

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

            • ResourceARN — (String)

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

            • RoleARN — (String)

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

          • DestinationSchema — (map)

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

          Describes reference data sources configured for the application. For more information, see Configuring Application Input.

          • ReferenceId — required — (String)

            ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.

          • TableName — required — (String)

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

          • S3ReferenceDataSourceDescription — required — (map)

            Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

            • BucketARN — required — (String)

              Amazon Resource Name (ARN) of the S3 bucket.

            • FileKey — required — (String)

              Amazon S3 object key name.

            • ReferenceRoleARN — required — (String)

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

          • 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 configuring 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)

                    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)

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

                  • RecordColumnDelimiter — required — (String)

                    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)

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

              • Mapping — (String)

                Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

              • SqlType — required — (String)

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

        • CloudWatchLoggingOptionDescriptions — (Array<map>)

          Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

          • CloudWatchLoggingOptionId — (String)

            ID of the CloudWatch logging option description.

          • LogStreamARN — required — (String)

            ARN of the CloudWatch log to receive application messages.

          • RoleARN — required — (String)

            IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.

        • ApplicationCode — (String)

          Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.

        • ApplicationVersionId — required — (Integer)

          Provides the current application version.

Returns:

  • (AWS.Request) —

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

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

Service Reference:

Examples:

Calling the discoverInputSchema operation

var params = {
  InputProcessingConfiguration: {
    InputLambdaProcessor: { /* required */
      ResourceARN: 'STRING_VALUE', /* required */
      RoleARN: 'STRING_VALUE' /* required */
    }
  },
  InputStartingPositionConfiguration: {
    InputStartingPosition: NOW | TRIM_HORIZON | LAST_STOPPED_POINT
  },
  ResourceARN: 'STRING_VALUE',
  RoleARN: 'STRING_VALUE',
  S3Configuration: {
    BucketARN: 'STRING_VALUE', /* required */
    FileKey: 'STRING_VALUE', /* required */
    RoleARN: 'STRING_VALUE' /* required */
  }
};
kinesisanalytics.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)

      Amazon Resource Name (ARN) of the streaming source.

    • RoleARN — (String)

      ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.

    • InputStartingPositionConfiguration — (map)

      Point at which you want Amazon Kinesis 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, start at the request time stamp 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 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.

      • RoleARN — required — (String)

        IAM ARN of the role used to access the data.

      • BucketARN — required — (String)

        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 AWS 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: AWS Lambda
        • RoleARN — required — (String)

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

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)

        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 configuring 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)

                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)

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

              • RecordColumnDelimiter — required — (String)

                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)

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

          • Mapping — (String)

            Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

          • SqlType — required — (String)

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

        Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

      • RawInputRecords — (Array<String>)

        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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

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

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

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  ExclusiveStartApplicationName: 'STRING_VALUE',
  Limit: 'NUMBER_VALUE'
};
kinesisanalytics.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)

      Maximum number of applications to list.

    • ExclusiveStartApplicationName — (String)

      Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

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

        List of ApplicationSummary objects.

        • ApplicationName — required — (String)

          Name of the application.

        • ApplicationARN — required — (String)

          ARN of the application.

        • ApplicationStatus — required — (String)

          Status of the application.

          Possible values include:
          • "DELETING"
          • "STARTING"
          • "STOPPING"
          • "READY"
          • "RUNNING"
          • "UPDATING"
      • HasMoreApplications — (Boolean)

        Returns true if there are more applications to retrieve.

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 */
};
kinesisanalytics.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.

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

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

After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.

The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation.

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

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

Service Reference:

Examples:

Calling the startApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  InputConfigurations: [ /* required */
    {
      Id: 'STRING_VALUE', /* required */
      InputStartingPositionConfiguration: { /* required */
        InputStartingPosition: NOW | TRIM_HORIZON | LAST_STOPPED_POINT
      }
    },
    /* more items */
  ]
};
kinesisanalytics.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)

      Name of the application.

    • InputConfigurations — (Array<map>)

      Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.

      • Id — required — (String)

        Input source ID. You can get this ID by calling the DescribeApplication operation.

      • InputStartingPositionConfiguration — required — (map)

        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, start at the request time stamp 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 Firehose delivery stream.

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

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

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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.

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

Service Reference:

Examples:

Calling the stopApplication operation

var params = {
  ApplicationName: 'STRING_VALUE' /* required */
};
kinesisanalytics.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)

      Name of the running application to stop.

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 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 */
  ]
};
kinesisanalytics.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 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 */
  ]
};
kinesisanalytics.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 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

Note: This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

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

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

This operation requires permission for the kinesisanalytics:UpdateApplication action.

Service Reference:

Examples:

Calling the updateApplication operation

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  ApplicationUpdate: { /* required */
    ApplicationCodeUpdate: 'STRING_VALUE',
    CloudWatchLoggingOptionUpdates: [
      {
        CloudWatchLoggingOptionId: 'STRING_VALUE', /* required */
        LogStreamARNUpdate: 'STRING_VALUE',
        RoleARNUpdate: 'STRING_VALUE'
      },
      /* more items */
    ],
    InputUpdates: [
      {
        InputId: 'STRING_VALUE', /* required */
        InputParallelismUpdate: {
          CountUpdate: 'NUMBER_VALUE'
        },
        InputProcessingConfigurationUpdate: {
          InputLambdaProcessorUpdate: { /* required */
            ResourceARNUpdate: 'STRING_VALUE',
            RoleARNUpdate: 'STRING_VALUE'
          }
        },
        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',
          RoleARNUpdate: 'STRING_VALUE'
        },
        KinesisStreamsInputUpdate: {
          ResourceARNUpdate: 'STRING_VALUE',
          RoleARNUpdate: 'STRING_VALUE'
        },
        NamePrefixUpdate: 'STRING_VALUE'
      },
      /* more items */
    ],
    OutputUpdates: [
      {
        OutputId: 'STRING_VALUE', /* required */
        DestinationSchemaUpdate: {
          RecordFormatType: JSON | CSV /* required */
        },
        KinesisFirehoseOutputUpdate: {
          ResourceARNUpdate: 'STRING_VALUE',
          RoleARNUpdate: 'STRING_VALUE'
        },
        KinesisStreamsOutputUpdate: {
          ResourceARNUpdate: 'STRING_VALUE',
          RoleARNUpdate: 'STRING_VALUE'
        },
        LambdaOutputUpdate: {
          ResourceARNUpdate: 'STRING_VALUE',
          RoleARNUpdate: 'STRING_VALUE'
        },
        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',
          ReferenceRoleARNUpdate: 'STRING_VALUE'
        },
        TableNameUpdate: 'STRING_VALUE'
      },
      /* more items */
    ]
  },
  CurrentApplicationVersionId: 'NUMBER_VALUE' /* required */
};
kinesisanalytics.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)

      Name of the Amazon Kinesis Analytics application to update.

    • CurrentApplicationVersionId — (Integer)

      The current application version ID. You can use the DescribeApplication operation to get this value.

    • ApplicationUpdate — (map)

      Describes application updates.

      • InputUpdates — (Array<map>)

        Describes application input configuration updates.

        • InputId — required — (String)

          Input ID of the application input to be updated.

        • NamePrefixUpdate — (String)

          Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.

        • InputProcessingConfigurationUpdate — (map)

          Describes updates for an input processing configuration.

          • InputLambdaProcessorUpdate — required — (map)

            Provides update information for an InputLambdaProcessor.

            • ResourceARNUpdate — (String)

              The Amazon Resource Name (ARN) of the new AWS 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: AWS Lambda
            • RoleARNUpdate — (String)

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

        • KinesisStreamsInputUpdate — (map)

          If an Amazon Kinesis stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.

          • ResourceARNUpdate — (String)

            Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.

          • RoleARNUpdate — (String)

            ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

        • KinesisFirehoseInputUpdate — (map)

          If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.

          • ResourceARNUpdate — (String)

            Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to read.

          • RoleARNUpdate — (String)

            ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

        • 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 configuring 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)

                  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)

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

                • RecordColumnDelimiter — required — (String)

                  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)

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

            • Mapping — (String)

              Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

            • SqlType — required — (String)

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

        • InputParallelismUpdate — (map)

          Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the specific streaming source).

          • CountUpdate — (Integer)

            Number of in-application streams to create for the specified streaming source.

      • ApplicationCodeUpdate — (String)

        Describes application code updates.

      • OutputUpdates — (Array<map>)

        Describes application output configuration updates.

        • 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 an Amazon Kinesis stream as the destination for the output.

          • ResourceARNUpdate — (String)

            Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.

          • RoleARNUpdate — (String)

            ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

        • KinesisFirehoseOutputUpdate — (map)

          Describes an Amazon Kinesis Firehose delivery stream as the destination for the output.

          • ResourceARNUpdate — (String)

            Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.

          • RoleARNUpdate — (String)

            ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

        • LambdaOutputUpdate — (map)

          Describes an AWS Lambda function as the destination for the output.

          • ResourceARNUpdate — (String)

            Amazon Resource Name (ARN) of the destination 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: AWS Lambda
          • RoleARNUpdate — (String)

            ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.

        • DestinationSchemaUpdate — (map)

          Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

          • RecordFormatType — required — (String)

            Specifies the format of the records on the output stream.

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

        Describes application reference data source updates.

        • ReferenceId — required — (String)

          ID of the reference data source being updated. You can use the DescribeApplication operation to get this value.

        • TableNameUpdate — (String)

          In-application table name that is created by this update.

        • S3ReferenceDataSourceUpdate — (map)

          Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

          • BucketARNUpdate — (String)

            Amazon Resource Name (ARN) of the S3 bucket.

          • FileKeyUpdate — (String)

            Object key name.

          • ReferenceRoleARNUpdate — (String)

            ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.

        • 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 configuring 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)

                  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)

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

                • RecordColumnDelimiter — required — (String)

                  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)

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

            • Mapping — (String)

              Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

            • SqlType — required — (String)

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

      • CloudWatchLoggingOptionUpdates — (Array<map>)

        Describes application CloudWatch logging option updates.

        • CloudWatchLoggingOptionId — required — (String)

          ID of the CloudWatch logging option to update

        • LogStreamARNUpdate — (String)

          ARN of the CloudWatch log to receive application messages.

        • RoleARNUpdate — (String)

          IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.

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.