Class: AWS.KinesisAnalyticsV2

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

Parameters:

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

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

  • CurrentApplicationVersionId — (Integer)

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

  • Input — (map)

    The Input to add.

    • NamePrefix — required — (String)

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

    • InputProcessingConfiguration — (map)

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

      • InputLambdaProcessor — required — (map)

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

        • ResourceARN — required — (String)

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

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

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

      • ResourceARN — required — (String)

        The ARN of the input Kinesis data stream to read.

    • KinesisFirehoseInput — (map)

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

      • ResourceARN — required — (String)

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

    • InputParallelism — (map)

      Describes the number of in-application streams to create.

      • Count — (Integer)

        The number of in-application streams to create.

    • InputSchema — required — (map)

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

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

      • RecordFormat — required — (map)

        Specifies the format of the records on the streaming source.

        • RecordFormatType — required — (String)

          The type of record format.

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

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

          • JSONMappingParameters — (map)

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

            • RecordRowPath — required — (String)

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

          • CSVMappingParameters — (map)

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

            • RecordRowDelimiter — required — (String)

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

            • RecordColumnDelimiter — required — (String)

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

      • RecordEncoding — (String)

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

      • RecordColumns — required — (Array<map>)

        A list of RecordColumn objects.

        • Name — required — (String)

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

        • Mapping — (String)

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

        • SqlType — required — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The Amazon Resource Name (ARN) of the application.

    • ApplicationVersionId — (Integer)

      Provides the current application version.

    • InputDescriptions — (Array<map>)

      Describes the application input configuration.

      • InputId — (String)

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

      • NamePrefix — (String)

        The in-application name prefix.

      • InAppStreamNames — (Array<String>)

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

      • InputProcessingConfigurationDescription — (map)

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

        • InputLambdaProcessorDescription — (map)

          Provides configuration information about the associated InputLambdaProcessorDescription

          • ResourceARN — required — (String)

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

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

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

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

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

        • ResourceARN — required — (String)

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

        • RoleARN — (String)

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

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

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

        • ResourceARN — required — (String)

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

        • RoleARN — (String)

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

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

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

        • RecordFormat — required — (map)

          Specifies the format of the records on the streaming source.

          • RecordFormatType — required — (String)

            The type of record format.

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

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

            • JSONMappingParameters — (map)

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

              • RecordRowPath — required — (String)

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

            • CSVMappingParameters — (map)

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

              • RecordRowDelimiter — required — (String)

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

              • RecordColumnDelimiter — required — (String)

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

        • RecordEncoding — (String)

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

        • RecordColumns — required — (Array<map>)

          A list of RecordColumn objects.

          • Name — required — (String)

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

          • Mapping — (String)

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

          • SqlType — required — (String)

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

      • InputParallelism — (map)

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

        • Count — (Integer)

          The number of in-application streams to create.

      • InputStartingPositionConfiguration — (map)

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

        • InputStartingPosition — (String)

          The starting position on the stream.

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

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

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • CurrentApplicationVersionId — (Integer)

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

  • InputId — (String)

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

  • InputProcessingConfiguration — (map)

    The InputProcessingConfiguration to add to the application.

    • InputLambdaProcessor — required — (map)

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

      • ResourceARN — required — (String)

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The Amazon Resource Name (ARN) of the application.

    • ApplicationVersionId — (Integer)

      Provides the current application version.

    • InputId — (String)

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

    • InputProcessingConfigurationDescription — (map)

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

      • InputLambdaProcessorDescription — (map)

        Provides configuration information about the associated InputLambdaProcessorDescription

        • ResourceARN — required — (String)

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

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

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • CurrentApplicationVersionId — (Integer)

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

  • Output — (map)

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

    • Name — required — (String)

      The name of the in-application stream.

    • KinesisStreamsOutput — (map)

      Identifies a Kinesis data stream as the destination.

      • ResourceARN — required — (String)

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

    • KinesisFirehoseOutput — (map)

      Identifies a Kinesis Data Firehose delivery stream as the destination.

      • ResourceARN — required — (String)

        The ARN of the destination delivery stream to write to.

    • LambdaOutput — (map)

      Identifies an Amazon Lambda function as the destination.

      • ResourceARN — required — (String)

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

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

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

      • RecordFormatType — required — (String)

        Specifies the format of the records on the output stream.

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The application Amazon Resource Name (ARN).

    • ApplicationVersionId — (Integer)

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

    • OutputDescriptions — (Array<map>)

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

      • OutputId — (String)

        A unique identifier for the output configuration.

      • Name — (String)

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

      • KinesisStreamsOutputDescription — (map)

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

        • ResourceARN — required — (String)

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

        • RoleARN — (String)

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

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

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

        • ResourceARN — required — (String)

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

        • RoleARN — (String)

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

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

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

        • ResourceARN — required — (String)

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

        • RoleARN — (String)

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

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

        The data format used for writing data to the destination.

        • RecordFormatType — required — (String)

          Specifies the format of the records on the output stream.

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of an existing application.

  • CurrentApplicationVersionId — (Integer)

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

  • ReferenceDataSource — (map)

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

    • TableName — required — (String)

      The name of the in-application table to create.

    • S3ReferenceDataSource — (map)

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

      • BucketARN — (String)

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

      • FileKey — (String)

        The object key name containing the reference data.

    • ReferenceSchema — required — (map)

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

      • RecordFormat — required — (map)

        Specifies the format of the records on the streaming source.

        • RecordFormatType — required — (String)

          The type of record format.

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

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

          • JSONMappingParameters — (map)

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

            • RecordRowPath — required — (String)

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

          • CSVMappingParameters — (map)

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

            • RecordRowDelimiter — required — (String)

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

            • RecordColumnDelimiter — required — (String)

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

      • RecordEncoding — (String)

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

      • RecordColumns — required — (Array<map>)

        A list of RecordColumn objects.

        • Name — required — (String)

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

        • Mapping — (String)

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

        • SqlType — required — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The application Amazon Resource Name (ARN).

    • ApplicationVersionId — (Integer)

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

    • ReferenceDataSourceDescriptions — (Array<map>)

      Describes reference data sources configured for the application.

      • ReferenceId — required — (String)

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

      • TableName — required — (String)

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

      • S3ReferenceDataSourceDescription — required — (map)

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

        • BucketARN — required — (String)

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

        • FileKey — required — (String)

          Amazon S3 object key name.

        • ReferenceRoleARN — (String)

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

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

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

        • RecordFormat — required — (map)

          Specifies the format of the records on the streaming source.

          • RecordFormatType — required — (String)

            The type of record format.

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

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

            • JSONMappingParameters — (map)

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

              • RecordRowPath — required — (String)

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

            • CSVMappingParameters — (map)

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

              • RecordRowDelimiter — required — (String)

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

              • RecordColumnDelimiter — required — (String)

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

        • RecordEncoding — (String)

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

        • RecordColumns — required — (Array<map>)

          A list of RecordColumn objects.

          • Name — required — (String)

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

          • Mapping — (String)

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

          • SqlType — required — (String)

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of an existing application.

  • CurrentApplicationVersionId — (Integer)

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

  • VpcConfiguration — (map)

    Description of the VPC to add to the application.

    • SubnetIds — required — (Array<String>)

      The array of Subnet IDs used by the VPC configuration.

    • SecurityGroupIds — required — (Array<String>)

      The array of SecurityGroup IDs used by the VPC configuration.

  • ConditionalToken — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The ARN of the application.

    • ApplicationVersionId — (Integer)

      Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.

    • VpcConfigurationDescription — (map)

      The parameters of the new VPC configuration.

      • VpcConfigurationId — required — (String)

        The ID of the VPC configuration.

      • VpcId — required — (String)

        The ID of the associated VPC.

      • SubnetIds — required — (Array<String>)

        The array of Subnet IDs used by the VPC configuration.

      • SecurityGroupIds — required — (Array<String>)

        The array of SecurityGroup IDs used by the VPC configuration.

    • OperationId — (String) Operation ID for tracking AddApplicationVpcConfiguration request

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • ApplicationDescription — (String)

    A summary description of the application.

  • RuntimeEnvironment — (String)

    The runtime environment for the application.

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

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

  • ApplicationConfiguration — (map)

    Use this parameter to configure the application.

    • SqlApplicationConfiguration — (map)

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

      • Inputs — (Array<map>)

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

        • NamePrefix — required — (String)

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

        • InputProcessingConfiguration — (map)

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

          • InputLambdaProcessor — required — (map)

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

            • ResourceARN — required — (String)

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

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

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

          • ResourceARN — required — (String)

            The ARN of the input Kinesis data stream to read.

        • KinesisFirehoseInput — (map)

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

          • ResourceARN — required — (String)

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

        • InputParallelism — (map)

          Describes the number of in-application streams to create.

          • Count — (Integer)

            The number of in-application streams to create.

        • InputSchema — required — (map)

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

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

          • RecordFormat — required — (map)

            Specifies the format of the records on the streaming source.

            • RecordFormatType — required — (String)

              The type of record format.

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

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

              • JSONMappingParameters — (map)

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

                • RecordRowPath — required — (String)

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

              • CSVMappingParameters — (map)

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

                • RecordRowDelimiter — required — (String)

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

                • RecordColumnDelimiter — required — (String)

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

          • RecordEncoding — (String)

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

          • RecordColumns — required — (Array<map>)

            A list of RecordColumn objects.

            • Name — required — (String)

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

            • Mapping — (String)

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

            • SqlType — required — (String)

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

      • Outputs — (Array<map>)

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

        • Name — required — (String)

          The name of the in-application stream.

        • KinesisStreamsOutput — (map)

          Identifies a Kinesis data stream as the destination.

          • ResourceARN — required — (String)

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

        • KinesisFirehoseOutput — (map)

          Identifies a Kinesis Data Firehose delivery stream as the destination.

          • ResourceARN — required — (String)

            The ARN of the destination delivery stream to write to.

        • LambdaOutput — (map)

          Identifies an Amazon Lambda function as the destination.

          • ResourceARN — required — (String)

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

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

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

          • RecordFormatType — required — (String)

            Specifies the format of the records on the output stream.

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

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

        • TableName — required — (String)

          The name of the in-application table to create.

        • S3ReferenceDataSource — (map)

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

          • BucketARN — (String)

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

          • FileKey — (String)

            The object key name containing the reference data.

        • ReferenceSchema — required — (map)

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

          • RecordFormat — required — (map)

            Specifies the format of the records on the streaming source.

            • RecordFormatType — required — (String)

              The type of record format.

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

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

              • JSONMappingParameters — (map)

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

                • RecordRowPath — required — (String)

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

              • CSVMappingParameters — (map)

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

                • RecordRowDelimiter — required — (String)

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

                • RecordColumnDelimiter — required — (String)

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

          • RecordEncoding — (String)

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

          • RecordColumns — required — (Array<map>)

            A list of RecordColumn objects.

            • Name — required — (String)

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

            • Mapping — (String)

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

            • SqlType — required — (String)

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

    • FlinkApplicationConfiguration — (map)

      The creation and update parameters for a Managed Service for Apache Flink application.

      • CheckpointConfiguration — (map)

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

        • ConfigurationType — required — (String)

          Describes whether the application uses Managed Service for Apache Flink' default checkpointing behavior. You must set this property to CUSTOM in order to set the CheckpointingEnabled, CheckpointInterval, or MinPauseBetweenCheckpoints parameters.

          Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

          • CheckpointingEnabled: true
          • CheckpointInterval: 60000
          • MinPauseBetweenCheckpoints: 5000
          Possible values include:
          • "DEFAULT"
          • "CUSTOM"
        • CheckpointingEnabled — (Boolean)

          Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.

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

          Describes the interval in milliseconds between checkpoint operations.

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

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

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

        Describes configuration parameters for Amazon CloudWatch logging for an application.

        • ConfigurationType — required — (String)

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

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

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

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

          Describes the verbosity of the CloudWatch Logs for an application.

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

        Describes parameters for how an application executes multiple tasks simultaneously.

        • ConfigurationType — required — (String)

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

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

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

        • ParallelismPerKPU — (Integer)

          Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Managed Service for Apache Flink Pricing.

        • AutoScalingEnabled — (Boolean)

          Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.

    • EnvironmentProperties — (map)

      Describes execution properties for a Managed Service for Apache Flink application.

      • PropertyGroups — required — (Array<map>)

        Describes the execution property groups.

        • PropertyGroupId — required — (String)

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

        • PropertyMap — required — (map<String>)

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

    • ApplicationCodeConfiguration — (map)

      The code location and type parameters for a Managed Service for Apache Flink application.

      • CodeContent — (map)

        The location and type of the application code.

        • TextContent — (String)

          The text-format code for a Managed Service for Apache Flink application.

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

          The zip-format code for a Managed Service for Apache Flink application.

        • S3ContentLocation — (map)

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

          • BucketARN — required — (String)

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

          • FileKey — required — (String)

            The file key for the object containing the application code.

          • ObjectVersion — (String)

            The version of the object containing the application code.

      • CodeContentType — required — (String)

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

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

      Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

      • SnapshotsEnabled — required — (Boolean)

        Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

    • ApplicationSystemRollbackConfiguration — (map) Describes system rollback configuration for a Managed Service for Apache Flink application
      • RollbackEnabled — required — (Boolean) Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application
    • VpcConfigurations — (Array<map>)

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

      • SubnetIds — required — (Array<String>)

        The array of Subnet IDs used by the VPC configuration.

      • SecurityGroupIds — required — (Array<String>)

        The array of SecurityGroup IDs used by the VPC configuration.

    • ZeppelinApplicationConfiguration — (map)

      The configuration parameters for a Managed Service for Apache Flink Studio notebook.

      • MonitoringConfiguration — (map)

        The monitoring configuration of a Managed Service for Apache Flink Studio notebook.

        • LogLevel — required — (String)

          The verbosity of the CloudWatch Logs for an application.

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

        The Amazon Glue Data Catalog that you use in queries in a Managed Service for Apache Flink Studio notebook.

        • GlueDataCatalogConfiguration — required — (map)

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

          • DatabaseARN — required — (String)

            The Amazon Resource Name (ARN) of the database.

      • DeployAsApplicationConfiguration — (map)

        The information required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.

        • S3ContentLocation — required — (map)

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

          • BucketARN — required — (String)

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

          • BasePath — (String)

            The base path for the S3 bucket.

      • CustomArtifactsConfiguration — (Array<map>)

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

        • ArtifactType — required — (String)

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

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

          For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

          • BucketARN — required — (String)

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

          • FileKey — required — (String)

            The file key for the object containing the application code.

          • ObjectVersion — (String)

            The version of the object containing the application code.

        • MavenReference — (map)

          The parameters required to fully specify a Maven reference.

          • GroupId — required — (String)

            The group ID of the Maven reference.

          • ArtifactId — required — (String)

            The artifact ID of the Maven reference.

          • Version — required — (String)

            The version of the Maven reference.

  • CloudWatchLoggingOptions — (Array<map>)

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

    • LogStreamARN — required — (String)

      The ARN of the CloudWatch log to receive application messages.

  • Tags — (Array<map>)

    A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

    • Key — required — (String)

      The key of the key-value tag.

    • Value — (String)

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

  • ApplicationMode — (String)

    Use the STREAMING mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE mode.

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationDetail — (map)

      In response to your CreateApplication request, Managed Service for Apache Flink returns a response with details of the application it created.

      • ApplicationARN — required — (String)

        The ARN of the application.

      • ApplicationDescription — (String)

        The description of the application.

      • ApplicationName — required — (String)

        The name of the application.

      • RuntimeEnvironment — required — (String)

        The runtime environment for the application.

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

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

      • ApplicationStatus — required — (String)

        The status of the application.

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

        Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.

      • CreateTimestamp — (Date)

        The current timestamp when the application was created.

      • LastUpdateTimestamp — (Date)

        The current timestamp when the application was last updated.

      • ApplicationConfigurationDescription — (map)

        Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.

        • SqlApplicationConfigurationDescription — (map)

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

          • InputDescriptions — (Array<map>)

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

            • InputId — (String)

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

            • NamePrefix — (String)

              The in-application name prefix.

            • InAppStreamNames — (Array<String>)

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

            • InputProcessingConfigurationDescription — (map)

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

              • InputLambdaProcessorDescription — (map)

                Provides configuration information about the associated InputLambdaProcessorDescription

                • ResourceARN — required — (String)

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

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

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • RecordFormat — required — (map)

                Specifies the format of the records on the streaming source.

                • RecordFormatType — required — (String)

                  The type of record format.

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

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

                  • JSONMappingParameters — (map)

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

                    • RecordRowPath — required — (String)

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

                  • CSVMappingParameters — (map)

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

                    • RecordRowDelimiter — required — (String)

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

                    • RecordColumnDelimiter — required — (String)

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

              • RecordEncoding — (String)

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

              • RecordColumns — required — (Array<map>)

                A list of RecordColumn objects.

                • Name — required — (String)

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

                • Mapping — (String)

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

                • SqlType — required — (String)

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

            • InputParallelism — (map)

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

              • Count — (Integer)

                The number of in-application streams to create.

            • InputStartingPositionConfiguration — (map)

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

              • InputStartingPosition — (String)

                The starting position on the stream.

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

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

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

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

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

            • OutputId — (String)

              A unique identifier for the output configuration.

            • Name — (String)

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

            • KinesisStreamsOutputDescription — (map)

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

              The data format used for writing data to the destination.

              • RecordFormatType — required — (String)

                Specifies the format of the records on the output stream.

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

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

            • ReferenceId — required — (String)

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

            • TableName — required — (String)

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

            • S3ReferenceDataSourceDescription — required — (map)

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

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                Amazon S3 object key name.

              • ReferenceRoleARN — (String)

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

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

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

              • RecordFormat — required — (map)

                Specifies the format of the records on the streaming source.

                • RecordFormatType — required — (String)

                  The type of record format.

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

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

                  • JSONMappingParameters — (map)

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

                    • RecordRowPath — required — (String)

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

                  • CSVMappingParameters — (map)

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

                    • RecordRowDelimiter — required — (String)

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

                    • RecordColumnDelimiter — required — (String)

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

              • RecordEncoding — (String)

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

              • RecordColumns — required — (Array<map>)

                A list of RecordColumn objects.

                • Name — required — (String)

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

                • Mapping — (String)

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

                • SqlType — required — (String)

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

        • ApplicationCodeConfigurationDescription — (map)

          The details about the application code for a Managed Service for Apache Flink application.

          • CodeContentType — required — (String)

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

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

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

            • TextContent — (String)

              The text-format code

            • CodeMD5 — (String)

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

            • CodeSize — (Integer)

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

            • S3ApplicationCodeLocationDescription — (map)

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

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                The file key for the object containing the application code.

              • ObjectVersion — (String)

                The version of the object containing the application code.

        • RunConfigurationDescription — (map)

          The details about the starting properties for a Managed Service for Apache Flink application.

          • ApplicationRestoreConfigurationDescription — (map)

            Describes the restore behavior of a restarting application.

            • ApplicationRestoreType — required — (String)

              Specifies how the application should be restored.

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

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

          • FlinkRunConfigurationDescription — (map)

            Describes the starting parameters for a Managed Service for Apache Flink application.

            • AllowNonRestoredState — (Boolean)

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

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

          The details about a Managed Service for Apache Flink application.

          • CheckpointConfigurationDescription — (map)

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

            • ConfigurationType — (String)

              Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.

              Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

              • CheckpointingEnabled: true
              • CheckpointInterval: 60000
              • MinPauseBetweenCheckpoints: 5000
              Possible values include:
              • "DEFAULT"
              • "CUSTOM"
            • CheckpointingEnabled — (Boolean)

              Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.

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

              Describes the interval in milliseconds between checkpoint operations.

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

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

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

            Describes configuration parameters for Amazon CloudWatch logging for an application.

            • ConfigurationType — (String)

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

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

              Describes the granularity of the CloudWatch Logs for an application.

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

              Describes the verbosity of the CloudWatch Logs for an application.

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

            Describes parameters for how an application executes multiple tasks simultaneously.

            • ConfigurationType — (String)

              Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.

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

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

            • ParallelismPerKPU — (Integer)

              Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.

            • CurrentParallelism — (Integer)

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

            • AutoScalingEnabled — (Boolean)

              Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.

          • JobPlanDescription — (String)

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

        • EnvironmentPropertyDescriptions — (map)

          Describes execution properties for a Managed Service for Apache Flink application.

          • PropertyGroupDescriptions — (Array<map>)

            Describes the execution property groups.

            • PropertyGroupId — required — (String)

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

            • PropertyMap — required — (map<String>)

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

        • ApplicationSnapshotConfigurationDescription — (map)

          Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

          • SnapshotsEnabled — required — (Boolean)

            Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

        • ApplicationSystemRollbackConfigurationDescription — (map) Describes system rollback configuration for a Managed Service for Apache Flink application
          • RollbackEnabled — required — (Boolean) Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application
        • VpcConfigurationDescriptions — (Array<map>)

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

          • VpcConfigurationId — required — (String)

            The ID of the VPC configuration.

          • VpcId — required — (String)

            The ID of the associated VPC.

          • SubnetIds — required — (Array<String>)

            The array of Subnet IDs used by the VPC configuration.

          • SecurityGroupIds — required — (Array<String>)

            The array of SecurityGroup IDs used by the VPC configuration.

        • ZeppelinApplicationConfigurationDescription — (map)

          The configuration parameters for a Managed Service for Apache Flink Studio notebook.

          • MonitoringConfigurationDescription — required — (map)

            The monitoring configuration of a Managed Service for Apache Flink Studio notebook.

            • LogLevel — (String)

              Describes the verbosity of the CloudWatch Logs for an application.

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

            The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.

            • GlueDataCatalogConfigurationDescription — required — (map)

              The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.

              • DatabaseARN — required — (String)

                The Amazon Resource Name (ARN) of the database.

          • DeployAsApplicationConfigurationDescription — (map)

            The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.

            • S3ContentLocationDescription — required — (map)

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

              • BucketARN — required — (String)

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

              • BasePath — (String)

                The base path for the S3 bucket.

          • CustomArtifactsConfigurationDescription — (Array<map>)

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

            • ArtifactType — (String)

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

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

              For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                The file key for the object containing the application code.

              • ObjectVersion — (String)

                The version of the object containing the application code.

            • MavenReferenceDescription — (map)

              The parameters that are required to specify a Maven dependency.

              • GroupId — required — (String)

                The group ID of the Maven reference.

              • ArtifactId — required — (String)

                The artifact ID of the Maven reference.

              • Version — required — (String)

                The version of the Maven reference.

      • CloudWatchLoggingOptionDescriptions — (Array<map>)

        Describes the application Amazon CloudWatch logging options.

        • CloudWatchLoggingOptionId — (String)

          The ID of the CloudWatch logging option description.

        • LogStreamARN — required — (String)

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

        • RoleARN — (String)

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

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

        The details of the maintenance configuration for the application.

        • ApplicationMaintenanceWindowStartTime — required — (String)

          The start time for the maintenance window.

        • ApplicationMaintenanceWindowEndTime — required — (String)

          The end time for the maintenance window.

      • ApplicationVersionUpdatedFrom — (Integer)

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

      • ApplicationVersionRolledBackFrom — (Integer)

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

      • ApplicationVersionCreateTimestamp — (Date) The current timestamp when the application version was created.
      • ConditionalToken — (String)

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

      • ApplicationVersionRolledBackTo — (Integer)

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

      • ApplicationMode — (String)

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of the application.

  • UrlType — (String)

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

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • AuthorizedUrl — (String)

      The URL of the extension.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of an existing application

  • SnapshotName — (String)

    An identifier for the application snapshot.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of the application to delete.

  • CreateTimestamp — (Date)

    Use the DescribeApplication operation to get this value.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The application name.

  • CurrentApplicationVersionId — (Integer)

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

  • CloudWatchLoggingOptionId — (String)

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

  • ConditionalToken — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The application's Amazon Resource Name (ARN).

    • ApplicationVersionId — (Integer)

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

    • CloudWatchLoggingOptionDescriptions — (Array<map>)

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

      • CloudWatchLoggingOptionId — (String)

        The ID of the CloudWatch logging option description.

      • LogStreamARN — required — (String)

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

      • RoleARN — (String)

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

        Note: Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.
    • OperationId — (String) Operation ID for tracking DeleteApplicationCloudWatchLoggingOption request

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 */
};
kinesisanalyticsv2.deleteApplicationInputProcessingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The name of the application.

  • CurrentApplicationVersionId — (Integer)

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

  • InputId — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The Amazon Resource Name (ARN) of the application.

    • ApplicationVersionId — (Integer)

      The current application version ID.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The application name.

  • CurrentApplicationVersionId — (Integer)

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

  • OutputId — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The application Amazon Resource Name (ARN).

    • ApplicationVersionId — (Integer)

      The current application version ID.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of an existing application.

  • CurrentApplicationVersionId — (Integer)

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

  • ReferenceId — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The application Amazon Resource Name (ARN).

    • ApplicationVersionId — (Integer)

      The updated version ID of the application.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of an existing application.

  • SnapshotName — (String)

    The identifier for the snapshot delete.

  • SnapshotCreationTimestamp — (Date)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of an existing application.

  • CurrentApplicationVersionId — (Integer)

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

  • VpcConfigurationId — (String)

    The ID of the VPC configuration to delete.

  • ConditionalToken — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationARN — (String)

      The ARN of the Managed Service for Apache Flink application.

    • ApplicationVersionId — (Integer)

      The updated version ID of the application.

    • OperationId — (String) Operation ID for tracking DeleteApplicationVpcConfiguration request

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of the application.

  • IncludeAdditionalDetails — (Boolean)

    Displays verbose information about a Managed Service for Apache Flink application, including the application's job plan.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationDetail — (map)

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

      • ApplicationARN — required — (String)

        The ARN of the application.

      • ApplicationDescription — (String)

        The description of the application.

      • ApplicationName — required — (String)

        The name of the application.

      • RuntimeEnvironment — required — (String)

        The runtime environment for the application.

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

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

      • ApplicationStatus — required — (String)

        The status of the application.

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

        Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.

      • CreateTimestamp — (Date)

        The current timestamp when the application was created.

      • LastUpdateTimestamp — (Date)

        The current timestamp when the application was last updated.

      • ApplicationConfigurationDescription — (map)

        Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.

        • SqlApplicationConfigurationDescription — (map)

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

          • InputDescriptions — (Array<map>)

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

            • InputId — (String)

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

            • NamePrefix — (String)

              The in-application name prefix.

            • InAppStreamNames — (Array<String>)

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

            • InputProcessingConfigurationDescription — (map)

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

              • InputLambdaProcessorDescription — (map)

                Provides configuration information about the associated InputLambdaProcessorDescription

                • ResourceARN — required — (String)

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

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

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • RecordFormat — required — (map)

                Specifies the format of the records on the streaming source.

                • RecordFormatType — required — (String)

                  The type of record format.

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

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

                  • JSONMappingParameters — (map)

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

                    • RecordRowPath — required — (String)

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

                  • CSVMappingParameters — (map)

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

                    • RecordRowDelimiter — required — (String)

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

                    • RecordColumnDelimiter — required — (String)

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

              • RecordEncoding — (String)

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

              • RecordColumns — required — (Array<map>)

                A list of RecordColumn objects.

                • Name — required — (String)

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

                • Mapping — (String)

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

                • SqlType — required — (String)

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

            • InputParallelism — (map)

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

              • Count — (Integer)

                The number of in-application streams to create.

            • InputStartingPositionConfiguration — (map)

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

              • InputStartingPosition — (String)

                The starting position on the stream.

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

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

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

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

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

            • OutputId — (String)

              A unique identifier for the output configuration.

            • Name — (String)

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

            • KinesisStreamsOutputDescription — (map)

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

              The data format used for writing data to the destination.

              • RecordFormatType — required — (String)

                Specifies the format of the records on the output stream.

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

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

            • ReferenceId — required — (String)

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

            • TableName — required — (String)

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

            • S3ReferenceDataSourceDescription — required — (map)

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

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                Amazon S3 object key name.

              • ReferenceRoleARN — (String)

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

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

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

              • RecordFormat — required — (map)

                Specifies the format of the records on the streaming source.

                • RecordFormatType — required — (String)

                  The type of record format.

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

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

                  • JSONMappingParameters — (map)

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

                    • RecordRowPath — required — (String)

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

                  • CSVMappingParameters — (map)

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

                    • RecordRowDelimiter — required — (String)

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

                    • RecordColumnDelimiter — required — (String)

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

              • RecordEncoding — (String)

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

              • RecordColumns — required — (Array<map>)

                A list of RecordColumn objects.

                • Name — required — (String)

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

                • Mapping — (String)

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

                • SqlType — required — (String)

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

        • ApplicationCodeConfigurationDescription — (map)

          The details about the application code for a Managed Service for Apache Flink application.

          • CodeContentType — required — (String)

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

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

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

            • TextContent — (String)

              The text-format code

            • CodeMD5 — (String)

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

            • CodeSize — (Integer)

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

            • S3ApplicationCodeLocationDescription — (map)

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

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                The file key for the object containing the application code.

              • ObjectVersion — (String)

                The version of the object containing the application code.

        • RunConfigurationDescription — (map)

          The details about the starting properties for a Managed Service for Apache Flink application.

          • ApplicationRestoreConfigurationDescription — (map)

            Describes the restore behavior of a restarting application.

            • ApplicationRestoreType — required — (String)

              Specifies how the application should be restored.

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

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

          • FlinkRunConfigurationDescription — (map)

            Describes the starting parameters for a Managed Service for Apache Flink application.

            • AllowNonRestoredState — (Boolean)

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

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

          The details about a Managed Service for Apache Flink application.

          • CheckpointConfigurationDescription — (map)

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

            • ConfigurationType — (String)

              Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.

              Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

              • CheckpointingEnabled: true
              • CheckpointInterval: 60000
              • MinPauseBetweenCheckpoints: 5000
              Possible values include:
              • "DEFAULT"
              • "CUSTOM"
            • CheckpointingEnabled — (Boolean)

              Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.

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

              Describes the interval in milliseconds between checkpoint operations.

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

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

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

            Describes configuration parameters for Amazon CloudWatch logging for an application.

            • ConfigurationType — (String)

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

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

              Describes the granularity of the CloudWatch Logs for an application.

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

              Describes the verbosity of the CloudWatch Logs for an application.

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

            Describes parameters for how an application executes multiple tasks simultaneously.

            • ConfigurationType — (String)

              Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.

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

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

            • ParallelismPerKPU — (Integer)

              Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.

            • CurrentParallelism — (Integer)

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

            • AutoScalingEnabled — (Boolean)

              Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.

          • JobPlanDescription — (String)

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

        • EnvironmentPropertyDescriptions — (map)

          Describes execution properties for a Managed Service for Apache Flink application.

          • PropertyGroupDescriptions — (Array<map>)

            Describes the execution property groups.

            • PropertyGroupId — required — (String)

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

            • PropertyMap — required — (map<String>)

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

        • ApplicationSnapshotConfigurationDescription — (map)

          Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

          • SnapshotsEnabled — required — (Boolean)

            Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

        • ApplicationSystemRollbackConfigurationDescription — (map) Describes system rollback configuration for a Managed Service for Apache Flink application
          • RollbackEnabled — required — (Boolean) Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application
        • VpcConfigurationDescriptions — (Array<map>)

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

          • VpcConfigurationId — required — (String)

            The ID of the VPC configuration.

          • VpcId — required — (String)

            The ID of the associated VPC.

          • SubnetIds — required — (Array<String>)

            The array of Subnet IDs used by the VPC configuration.

          • SecurityGroupIds — required — (Array<String>)

            The array of SecurityGroup IDs used by the VPC configuration.

        • ZeppelinApplicationConfigurationDescription — (map)

          The configuration parameters for a Managed Service for Apache Flink Studio notebook.

          • MonitoringConfigurationDescription — required — (map)

            The monitoring configuration of a Managed Service for Apache Flink Studio notebook.

            • LogLevel — (String)

              Describes the verbosity of the CloudWatch Logs for an application.

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

            The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.

            • GlueDataCatalogConfigurationDescription — required — (map)

              The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.

              • DatabaseARN — required — (String)

                The Amazon Resource Name (ARN) of the database.

          • DeployAsApplicationConfigurationDescription — (map)

            The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.

            • S3ContentLocationDescription — required — (map)

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

              • BucketARN — required — (String)

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

              • BasePath — (String)

                The base path for the S3 bucket.

          • CustomArtifactsConfigurationDescription — (Array<map>)

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

            • ArtifactType — (String)

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

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

              For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                The file key for the object containing the application code.

              • ObjectVersion — (String)

                The version of the object containing the application code.

            • MavenReferenceDescription — (map)

              The parameters that are required to specify a Maven dependency.

              • GroupId — required — (String)

                The group ID of the Maven reference.

              • ArtifactId — required — (String)

                The artifact ID of the Maven reference.

              • Version — required — (String)

                The version of the Maven reference.

      • CloudWatchLoggingOptionDescriptions — (Array<map>)

        Describes the application Amazon CloudWatch logging options.

        • CloudWatchLoggingOptionId — (String)

          The ID of the CloudWatch logging option description.

        • LogStreamARN — required — (String)

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

        • RoleARN — (String)

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

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

        The details of the maintenance configuration for the application.

        • ApplicationMaintenanceWindowStartTime — required — (String)

          The start time for the maintenance window.

        • ApplicationMaintenanceWindowEndTime — required — (String)

          The end time for the maintenance window.

      • ApplicationVersionUpdatedFrom — (Integer)

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

      • ApplicationVersionRolledBackFrom — (Integer)

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

      • ApplicationVersionCreateTimestamp — (Date) The current timestamp when the application version was created.
      • ConditionalToken — (String)

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

      • ApplicationVersionRolledBackTo — (Integer)

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

      • ApplicationMode — (String)

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

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

Returns:

• (AWS.Request) —

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

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

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationName — (String) The name of the application
  • OperationId — (String) Identifier of the Operation

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationOperationInfoDetails — (map) Provides a description of the operation, such as the operation-type and status
      • Operation — required — (String) Type of operation performed on an application
      • StartTime — required — (Date) The timestamp at which the operation was created
      • EndTime — required — (Date) The timestamp at which the operation finished for the application
      • OperationStatus — required — (String) Status of the operation performed on an application Possible values include:
        • "IN_PROGRESS"
        • "CANCELLED"
        • "SUCCESSFUL"
        • "FAILED"
      • ApplicationVersionChangeDetails — (map) Contains information about the application version changes due to an operation
        • ApplicationVersionUpdatedFrom — required — (Integer) The operation was performed on this version of the application
        • ApplicationVersionUpdatedTo — required — (Integer) The operation execution resulted in the transition to the following version of the application
      • OperationFailureDetails — (map) Provides a description of the operation failure
        • RollbackOperationId — (String) Provides the operation ID of a system-rollback operation executed due to failure in the current operation
        • ErrorInfo — (map) Provides a description of the operation failure error
          • ErrorString — (String) Error message resulting in failure of the operation

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The name of an existing application.

  • SnapshotName — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • SnapshotDetails — (map)

      An object containing information about the application snapshot.

      • SnapshotName — required — (String)

        The identifier for the application snapshot.

      • SnapshotStatus — required — (String)

        The status of the application snapshot.

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

        The current application version ID when the snapshot was created.

      • SnapshotCreationTimestamp — (Date)

        The timestamp of the application snapshot.

      • RuntimeEnvironment — (String)

        The Flink Runtime for the application snapshot.

        Possible values include:
        • "SQL-1_0"
        • "FLINK-1_6"
        • "FLINK-1_8"
        • "ZEPPELIN-FLINK-1_0"
        • "FLINK-1_11"
        • "FLINK-1_13"
        • "ZEPPELIN-FLINK-2_0"
        • "FLINK-1_15"
        • "ZEPPELIN-FLINK-3_0"
        • "FLINK-1_18"
        • "FLINK-1_19"
        • "FLINK-1_20"

Returns:

• (AWS.Request) —

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

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

Parameters:

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

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

  • ApplicationVersionId — (Integer)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • ApplicationVersionDetail — (map)

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

      • ApplicationARN — required — (String)

        The ARN of the application.

      • ApplicationDescription — (String)

        The description of the application.

      • ApplicationName — required — (String)

        The name of the application.

      • RuntimeEnvironment — required — (String)

        The runtime environment for the application.

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

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

      • ApplicationStatus — required — (String)

        The status of the application.

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

        Provides the current application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.

      • CreateTimestamp — (Date)

        The current timestamp when the application was created.

      • LastUpdateTimestamp — (Date)

        The current timestamp when the application was last updated.

      • ApplicationConfigurationDescription — (map)

        Describes details about the application code and starting parameters for a Managed Service for Apache Flink application.

        • SqlApplicationConfigurationDescription — (map)

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

          • InputDescriptions — (Array<map>)

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

            • InputId — (String)

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

            • NamePrefix — (String)

              The in-application name prefix.

            • InAppStreamNames — (Array<String>)

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

            • InputProcessingConfigurationDescription — (map)

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

              • InputLambdaProcessorDescription — (map)

                Provides configuration information about the associated InputLambdaProcessorDescription

                • ResourceARN — required — (String)

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

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

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • RecordFormat — required — (map)

                Specifies the format of the records on the streaming source.

                • RecordFormatType — required — (String)

                  The type of record format.

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

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

                  • JSONMappingParameters — (map)

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

                    • RecordRowPath — required — (String)

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

                  • CSVMappingParameters — (map)

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

                    • RecordRowDelimiter — required — (String)

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

                    • RecordColumnDelimiter — required — (String)

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

              • RecordEncoding — (String)

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

              • RecordColumns — required — (Array<map>)

                A list of RecordColumn objects.

                • Name — required — (String)

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

                • Mapping — (String)

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

                • SqlType — required — (String)

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

            • InputParallelism — (map)

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

              • Count — (Integer)

                The number of in-application streams to create.

            • InputStartingPositionConfiguration — (map)

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

              • InputStartingPosition — (String)

                The starting position on the stream.

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

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

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

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

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

            • OutputId — (String)

              A unique identifier for the output configuration.

            • Name — (String)

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

            • KinesisStreamsOutputDescription — (map)

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

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

              • ResourceARN — required — (String)

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

              • RoleARN — (String)

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

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

              The data format used for writing data to the destination.

              • RecordFormatType — required — (String)

                Specifies the format of the records on the output stream.

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

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

            • ReferenceId — required — (String)

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

            • TableName — required — (String)

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

            • S3ReferenceDataSourceDescription — required — (map)

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

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                Amazon S3 object key name.

              • ReferenceRoleARN — (String)

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

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

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

              • RecordFormat — required — (map)

                Specifies the format of the records on the streaming source.

                • RecordFormatType — required — (String)

                  The type of record format.

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

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

                  • JSONMappingParameters — (map)

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

                    • RecordRowPath — required — (String)

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

                  • CSVMappingParameters — (map)

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

                    • RecordRowDelimiter — required — (String)

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

                    • RecordColumnDelimiter — required — (String)

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

              • RecordEncoding — (String)

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

              • RecordColumns — required — (Array<map>)

                A list of RecordColumn objects.

                • Name — required — (String)

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

                • Mapping — (String)

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

                • SqlType — required — (String)

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

        • ApplicationCodeConfigurationDescription — (map)

          The details about the application code for a Managed Service for Apache Flink application.

          • CodeContentType — required — (String)

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

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

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

            • TextContent — (String)

              The text-format code

            • CodeMD5 — (String)

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

            • CodeSize — (Integer)

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

            • S3ApplicationCodeLocationDescription — (map)

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

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                The file key for the object containing the application code.

              • ObjectVersion — (String)

                The version of the object containing the application code.

        • RunConfigurationDescription — (map)

          The details about the starting properties for a Managed Service for Apache Flink application.

          • ApplicationRestoreConfigurationDescription — (map)

            Describes the restore behavior of a restarting application.

            • ApplicationRestoreType — required — (String)

              Specifies how the application should be restored.

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

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

          • FlinkRunConfigurationDescription — (map)

            Describes the starting parameters for a Managed Service for Apache Flink application.

            • AllowNonRestoredState — (Boolean)

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

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

          The details about a Managed Service for Apache Flink application.

          • CheckpointConfigurationDescription — (map)

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

            • ConfigurationType — (String)

              Describes whether the application uses the default checkpointing behavior in Managed Service for Apache Flink.

              Note: If this value is set to DEFAULT, the application will use the following values, even if they are set to other values using APIs or application code:

              • CheckpointingEnabled: true
              • CheckpointInterval: 60000
              • MinPauseBetweenCheckpoints: 5000
              Possible values include:
              • "DEFAULT"
              • "CUSTOM"
            • CheckpointingEnabled — (Boolean)

              Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.

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

              Describes the interval in milliseconds between checkpoint operations.

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

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

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

            Describes configuration parameters for Amazon CloudWatch logging for an application.

            • ConfigurationType — (String)

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

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

              Describes the granularity of the CloudWatch Logs for an application.

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

              Describes the verbosity of the CloudWatch Logs for an application.

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

            Describes parameters for how an application executes multiple tasks simultaneously.

            • ConfigurationType — (String)

              Describes whether the application uses the default parallelism for the Managed Service for Apache Flink service.

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

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

            • ParallelismPerKPU — (Integer)

              Describes the number of parallel tasks that a Managed Service for Apache Flink application can perform per Kinesis Processing Unit (KPU) used by the application.

            • CurrentParallelism — (Integer)

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

            • AutoScalingEnabled — (Boolean)

              Describes whether the Managed Service for Apache Flink service can increase the parallelism of the application in response to increased throughput.

          • JobPlanDescription — (String)

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

        • EnvironmentPropertyDescriptions — (map)

          Describes execution properties for a Managed Service for Apache Flink application.

          • PropertyGroupDescriptions — (Array<map>)

            Describes the execution property groups.

            • PropertyGroupId — required — (String)

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

            • PropertyMap — required — (map<String>)

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

        • ApplicationSnapshotConfigurationDescription — (map)

          Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

          • SnapshotsEnabled — required — (Boolean)

            Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

        • ApplicationSystemRollbackConfigurationDescription — (map) Describes system rollback configuration for a Managed Service for Apache Flink application
          • RollbackEnabled — required — (Boolean) Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application
        • VpcConfigurationDescriptions — (Array<map>)

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

          • VpcConfigurationId — required — (String)

            The ID of the VPC configuration.

          • VpcId — required — (String)

            The ID of the associated VPC.

          • SubnetIds — required — (Array<String>)

            The array of Subnet IDs used by the VPC configuration.

          • SecurityGroupIds — required — (Array<String>)

            The array of SecurityGroup IDs used by the VPC configuration.

        • ZeppelinApplicationConfigurationDescription — (map)

          The configuration parameters for a Managed Service for Apache Flink Studio notebook.

          • MonitoringConfigurationDescription — required — (map)

            The monitoring configuration of a Managed Service for Apache Flink Studio notebook.

            • LogLevel — (String)

              Describes the verbosity of the CloudWatch Logs for an application.

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

            The Amazon Glue Data Catalog that is associated with the Managed Service for Apache Flink Studio notebook.

            • GlueDataCatalogConfigurationDescription — required — (map)

              The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Managed Service for Apache Flink Studio notebook.

              • DatabaseARN — required — (String)

                The Amazon Resource Name (ARN) of the database.

          • DeployAsApplicationConfigurationDescription — (map)

            The parameters required to deploy a Managed Service for Apache Flink Studio notebook as an application with durable state.

            • S3ContentLocationDescription — required — (map)

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

              • BucketARN — required — (String)

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

              • BasePath — (String)

                The base path for the S3 bucket.

          • CustomArtifactsConfigurationDescription — (Array<map>)

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

            • ArtifactType — (String)

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

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

              For a Managed Service for Apache Flink application provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

              • BucketARN — required — (String)

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

              • FileKey — required — (String)

                The file key for the object containing the application code.

              • ObjectVersion — (String)

                The version of the object containing the application code.

            • MavenReferenceDescription — (map)

              The parameters that are required to specify a Maven dependency.

              • GroupId — required — (String)

                The group ID of the Maven reference.

              • ArtifactId — required — (String)

                The artifact ID of the Maven reference.

              • Version — required — (String)

                The version of the Maven reference.

      • CloudWatchLoggingOptionDescriptions — (Array<map>)

        Describes the application Amazon CloudWatch logging options.

        • CloudWatchLoggingOptionId — (String)

          The ID of the CloudWatch logging option description.

        • LogStreamARN — required — (String)

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

        • RoleARN — (String)

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

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

        The details of the maintenance configuration for the application.

        • ApplicationMaintenanceWindowStartTime — required — (String)

          The start time for the maintenance window.

        • ApplicationMaintenanceWindowEndTime — required — (String)

          The end time for the maintenance window.

      • ApplicationVersionUpdatedFrom — (Integer)

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

      • ApplicationVersionRolledBackFrom — (Integer)

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

      • ApplicationVersionCreateTimestamp — (Date) The current timestamp when the application version was created.
      • ConditionalToken — (String)

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

      • ApplicationVersionRolledBackTo — (Integer)

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

      • ApplicationMode — (String)

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

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

Returns:

• (AWS.Request) —

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

var params = {
  ServiceExecutionRole: 'STRING_VALUE', /* required */
  InputProcessingConfiguration: {
    InputLambdaProcessor: { /* required */
      ResourceARN: 'STRING_VALUE' /* required */
    }
  },
  InputStartingPositionConfiguration: {
    InputStartingPosition: NOW | TRIM_HORIZON | LAST_STOPPED_POINT
  },
  ResourceARN: 'STRING_VALUE',
  S3Configuration: {
    BucketARN: 'STRING_VALUE', /* required */
    FileKey: 'STRING_VALUE' /* required */
  }
};
kinesisanalyticsv2.discoverInputSchema(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

    The Amazon Resource Name (ARN) of the streaming source.

  • ServiceExecutionRole — (String)

    The ARN of the role that is used to access the streaming source.

  • InputStartingPositionConfiguration — (map)

    The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source for discovery purposes.

    • InputStartingPosition — (String)

      The starting position on the stream.

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

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

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

      Possible values include:
      • "NOW"
      • "TRIM_HORIZON"
      • "LAST_STOPPED_POINT"
  • S3Configuration — (map)

    Specify this parameter to discover a schema from data in an Amazon S3 object.

    • BucketARN — required — (String)

      The ARN of the S3 bucket that contains the data.

    • FileKey — required — (String)

      The name of the object that contains the data.

  • InputProcessingConfiguration — (map)

    The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

    • InputLambdaProcessor — required — (map)

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

      • ResourceARN — required — (String)

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

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • InputSchema — (map)

      The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

      • RecordFormat — required — (map)

        Specifies the format of the records on the streaming source.

        • RecordFormatType — required — (String)

          The type of record format.

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

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

          • JSONMappingParameters — (map)

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

            • RecordRowPath — required — (String)

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

          • CSVMappingParameters — (map)

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

            • RecordRowDelimiter — required — (String)

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

            • RecordColumnDelimiter — required — (String)

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

      • RecordEncoding — (String)

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

      • RecordColumns — required — (Array<map>)

        A list of RecordColumn objects.

        • Name — required — (String)

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

        • Mapping — (String)

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

        • SqlType — required — (String)

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

    • ParsedInputRecords — (Array<Array<String>>)

      An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

    • ProcessedInputRecords — (Array<String>)

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

    • RawInputRecords — (Array<String>)

      The raw stream data that was sampled to infer the schema.

Returns:

• (AWS.Request) —

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

var params = {
  ApplicationName: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Operation: 'STRING_VALUE',
  OperationStatus: IN_PROGRESS | CANCELLED | SUCCESSFUL | FAILED
};
kinesisanalyticsv2.listApplicationOperations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationName — (String) The name of the application
  • Limit — (Integer) Limit on the number of records returned in the response
  • NextToken — (String) If a previous command returned a pagination token, pass it into this value to retrieve the next set of results
  • Operation — (String) Type of operation performed on an application
  • OperationStatus — (String) Status of the operation performed on an application Possible values include:
    • "IN_PROGRESS"
    • "CANCELLED"
    • "SUCCESSFUL"
    • "FAILED"

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:

    • ApplicationOperationInfoList — (Array<map>) List of ApplicationOperationInfo for an application
      • Operation — (String) Type of operation performed on an application
      • OperationId — (String) Identifier of the Operation
      • StartTime — (Date) The timestamp at which the operation was created
      • EndTime — (Date) The timestamp at which the operation finished for the application
      • OperationStatus — (String) Status of the operation performed on an application Possible values include:
        • "IN_PROGRESS"
        • "CANCELLED"
        • "SUCCESSFUL"
        • "FAILED"
    • NextToken — (String) If a previous command returned a pagination token, pass it into this value to retrieve the next set of results

Returns:

• (AWS.Request) —

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