Class: AWS.KinesisAnalytics

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.

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.

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.

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.