5.0.0 • Published 7 years ago

@datafire/amazonaws_kinesisanalytics v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_kinesisanalytics

Client library for Amazon Kinesis Analytics

Installation and Usage

npm install --save @datafire/amazonaws_kinesisanalytics
let amazonaws_kinesisanalytics = require('@datafire/amazonaws_kinesisanalytics').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_kinesisanalytics.AddApplicationCloudWatchLoggingOption({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "CloudWatchLoggingOption": {
    "LogStreamARN": "",
    "RoleARN": ""
  }
}).then(data => {
  console.log(data);
});

Description

Actions

AddApplicationCloudWatchLoggingOption

amazonaws_kinesisanalytics.AddApplicationCloudWatchLoggingOption({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "CloudWatchLoggingOption": {
    "LogStreamARN": "",
    "RoleARN": ""
  }
}, context)

Input

Output

AddApplicationInput

amazonaws_kinesisanalytics.AddApplicationInput({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "Input": {
    "NamePrefix": "",
    "InputSchema": {
      "RecordFormat": {
        "RecordFormatType": ""
      },
      "RecordColumns": []
    }
  }
}, context)

Input

Output

AddApplicationInputProcessingConfiguration

amazonaws_kinesisanalytics.AddApplicationInputProcessingConfiguration({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "InputId": "",
  "InputProcessingConfiguration": {
    "InputLambdaProcessor": {
      "ResourceARN": "",
      "RoleARN": ""
    }
  }
}, context)

Input

Output

AddApplicationOutput

amazonaws_kinesisanalytics.AddApplicationOutput({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "Output": {
    "Name": "",
    "DestinationSchema": {}
  }
}, context)

Input

Output

AddApplicationReferenceDataSource

amazonaws_kinesisanalytics.AddApplicationReferenceDataSource({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "ReferenceDataSource": {
    "TableName": "",
    "ReferenceSchema": {
      "RecordFormat": {
        "RecordFormatType": ""
      },
      "RecordColumns": []
    }
  }
}, context)

Input

Output

CreateApplication

amazonaws_kinesisanalytics.CreateApplication({
  "ApplicationName": ""
}, context)

Input

Output

DeleteApplication

amazonaws_kinesisanalytics.DeleteApplication({
  "ApplicationName": "",
  "CreateTimestamp": ""
}, context)

Input

Output

DeleteApplicationCloudWatchLoggingOption

amazonaws_kinesisanalytics.DeleteApplicationCloudWatchLoggingOption({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "CloudWatchLoggingOptionId": ""
}, context)

Input

Output

DeleteApplicationInputProcessingConfiguration

amazonaws_kinesisanalytics.DeleteApplicationInputProcessingConfiguration({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "InputId": ""
}, context)

Input

Output

DeleteApplicationOutput

amazonaws_kinesisanalytics.DeleteApplicationOutput({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "OutputId": ""
}, context)

Input

Output

DeleteApplicationReferenceDataSource

amazonaws_kinesisanalytics.DeleteApplicationReferenceDataSource({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "ReferenceId": ""
}, context)

Input

Output

DescribeApplication

amazonaws_kinesisanalytics.DescribeApplication({
  "ApplicationName": ""
}, context)

Input

Output

DiscoverInputSchema

amazonaws_kinesisanalytics.DiscoverInputSchema({}, context)

Input

Output

ListApplications

amazonaws_kinesisanalytics.ListApplications({}, context)

Input

Output

StartApplication

amazonaws_kinesisanalytics.StartApplication({
  "ApplicationName": "",
  "InputConfigurations": []
}, context)

Input

Output

StopApplication

amazonaws_kinesisanalytics.StopApplication({
  "ApplicationName": ""
}, context)

Input

Output

UpdateApplication

amazonaws_kinesisanalytics.UpdateApplication({
  "ApplicationName": "",
  "CurrentApplicationVersionId": 0,
  "ApplicationUpdate": {}
}, context)

Input

Output

Definitions

AddApplicationCloudWatchLoggingOptionRequest

AddApplicationCloudWatchLoggingOptionResponse

  • AddApplicationCloudWatchLoggingOptionResponse object

AddApplicationInputProcessingConfigurationRequest

AddApplicationInputProcessingConfigurationResponse

  • AddApplicationInputProcessingConfigurationResponse object

AddApplicationInputRequest

AddApplicationInputResponse

  • AddApplicationInputResponse object:

AddApplicationOutputRequest

AddApplicationOutputResponse

  • AddApplicationOutputResponse object:

AddApplicationReferenceDataSourceRequest

AddApplicationReferenceDataSourceResponse

  • AddApplicationReferenceDataSourceResponse object:

ApplicationCode

  • ApplicationCode string

ApplicationDescription

  • ApplicationDescription string

ApplicationDetail

ApplicationName

  • ApplicationName string

ApplicationStatus

  • ApplicationStatus string (values: DELETING, STARTING, STOPPING, READY, RUNNING, UPDATING)

ApplicationSummaries

ApplicationSummary

  • ApplicationSummary object: Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

ApplicationUpdate

ApplicationVersionId

  • ApplicationVersionId integer

BooleanObject

  • BooleanObject boolean

BucketARN

  • BucketARN string

CSVMappingParameters

  • CSVMappingParameters object: Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\n' as the row delimiter and a comma (",") as the column delimiter: "name1", "address1" "name2, "address2"

CloudWatchLoggingOption

  • CloudWatchLoggingOption object: Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.

CloudWatchLoggingOptionDescription

  • CloudWatchLoggingOptionDescription object: Description of the CloudWatch logging option.

CloudWatchLoggingOptionDescriptions

CloudWatchLoggingOptionUpdate

  • CloudWatchLoggingOptionUpdate object: Describes CloudWatch logging option updates.

CloudWatchLoggingOptionUpdates

CloudWatchLoggingOptions

CodeValidationException

  • CodeValidationException object: User-provided application code (query) is invalid. This can be a simple syntax error.

ConcurrentModificationException

  • ConcurrentModificationException object: Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

CreateApplicationRequest

CreateApplicationResponse

DeleteApplicationCloudWatchLoggingOptionRequest

  • DeleteApplicationCloudWatchLoggingOptionRequest object

DeleteApplicationCloudWatchLoggingOptionResponse

  • DeleteApplicationCloudWatchLoggingOptionResponse object

DeleteApplicationInputProcessingConfigurationRequest

DeleteApplicationInputProcessingConfigurationResponse

  • DeleteApplicationInputProcessingConfigurationResponse object

DeleteApplicationOutputRequest

DeleteApplicationOutputResponse

  • DeleteApplicationOutputResponse object:

DeleteApplicationReferenceDataSourceRequest

DeleteApplicationReferenceDataSourceResponse

  • DeleteApplicationReferenceDataSourceResponse object

DeleteApplicationRequest

DeleteApplicationResponse

  • DeleteApplicationResponse object:

DescribeApplicationRequest

  • DescribeApplicationRequest object:

DescribeApplicationResponse

DestinationSchema

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

DiscoverInputSchemaRequest

DiscoverInputSchemaResponse

ErrorMessage

  • ErrorMessage string

FileKey

  • FileKey string

Id

  • Id string

InAppStreamName

  • InAppStreamName string

InAppStreamNames

InAppTableName

  • InAppTableName string

Input

InputConfiguration

  • InputConfiguration object: When you start your application, you provide this configuration, which identifies the input source and the point in the input source at which you want the application to start processing records.

InputConfigurations

InputDescription

InputDescriptions

InputLambdaProcessor

  • InputLambdaProcessor object: An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function.

InputLambdaProcessorDescription

  • InputLambdaProcessorDescription object: An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda expression.

InputLambdaProcessorUpdate

  • InputLambdaProcessorUpdate object: Represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.

InputParallelism

  • InputParallelism object: Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input.

InputParallelismCount

  • InputParallelismCount integer

InputParallelismUpdate

  • InputParallelismUpdate object: Provides updates to the parallelism count.

InputProcessingConfiguration

  • InputProcessingConfiguration object: Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda.

InputProcessingConfigurationDescription

  • InputProcessingConfigurationDescription object: Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda.

InputProcessingConfigurationUpdate

  • InputProcessingConfigurationUpdate object: Describes updates to an InputProcessingConfiguration.

InputSchemaUpdate

InputStartingPosition

  • InputStartingPosition string (values: NOW, TRIM_HORIZON, LAST_STOPPED_POINT)

InputStartingPositionConfiguration

  • InputStartingPositionConfiguration object: Describes the point at which the application reads from the streaming source.

InputUpdate

InputUpdates

Inputs

InvalidApplicationConfigurationException

  • InvalidApplicationConfigurationException object: User-provided application configuration is not valid.

InvalidArgumentException

  • InvalidArgumentException object: Specified input parameter value is invalid.

JSONMappingParameters

  • JSONMappingParameters object: Provides additional mapping information when JSON is the record format on the streaming source.

KinesisFirehoseInput

  • KinesisFirehoseInput object: Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

KinesisFirehoseInputDescription

  • KinesisFirehoseInputDescription object: Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.

KinesisFirehoseInputUpdate

  • KinesisFirehoseInputUpdate object: When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.

KinesisFirehoseOutput

  • KinesisFirehoseOutput object: When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.

KinesisFirehoseOutputDescription

  • KinesisFirehoseOutputDescription object: For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.

KinesisFirehoseOutputUpdate

  • KinesisFirehoseOutputUpdate object: When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.

KinesisStreamsInput

  • KinesisStreamsInput object: Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

KinesisStreamsInputDescription

  • KinesisStreamsInputDescription object: Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.

KinesisStreamsInputUpdate

  • KinesisStreamsInputUpdate object: When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.

KinesisStreamsOutput

  • KinesisStreamsOutput object: When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.

KinesisStreamsOutputDescription

  • KinesisStreamsOutputDescription object: For an application output, describes the Amazon Kinesis stream configured as its destination.

KinesisStreamsOutputUpdate

  • KinesisStreamsOutputUpdate object: When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.

LambdaOutput

  • LambdaOutput object: When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf.

LambdaOutputDescription

  • LambdaOutputDescription object: For an application output, describes the AWS Lambda function configured as its destination.

LambdaOutputUpdate

  • LambdaOutputUpdate object: When updating an output configuration using the UpdateApplication operation, provides information about an AWS Lambda function configured as the destination.

LimitExceededException

  • LimitExceededException object: Exceeded the number of applications allowed.

ListApplicationsInputLimit

  • ListApplicationsInputLimit integer

ListApplicationsRequest

ListApplicationsResponse

LogStreamARN

  • LogStreamARN string

MappingParameters

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

Output

  • Output object: Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. For limits on how many destinations an application can write and other limitations, see Limits.

OutputDescription

OutputDescriptions

OutputUpdate

OutputUpdates

Outputs

ParsedInputRecord

ParsedInputRecordField

  • ParsedInputRecordField string

ParsedInputRecords

ProcessedInputRecord

  • ProcessedInputRecord string

ProcessedInputRecords

RawInputRecord

  • RawInputRecord string

RawInputRecords

RecordColumn

  • RecordColumn object: Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream. Also used to describe the format of the reference data source.

RecordColumnDelimiter

  • RecordColumnDelimiter string

RecordColumnMapping

  • RecordColumnMapping string

RecordColumnName

  • RecordColumnName string

RecordColumnSqlType

  • RecordColumnSqlType string

RecordColumns

RecordEncoding

  • RecordEncoding string

RecordFormat

  • RecordFormat object: Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

RecordFormatType

  • RecordFormatType string (values: JSON, CSV)

RecordRowDelimiter

  • RecordRowDelimiter string

RecordRowPath

  • RecordRowPath string

ReferenceDataSource

  • ReferenceDataSource object: Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

ReferenceDataSourceDescription

ReferenceDataSourceDescriptions

ReferenceDataSourceUpdate

  • ReferenceDataSourceUpdate object: When you update a reference data source configuration for an application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

ReferenceDataSourceUpdates

ResourceARN

  • ResourceARN string

ResourceInUseException

  • ResourceInUseException object: Application is not available for this operation.

ResourceNotFoundException

  • ResourceNotFoundException object: Specified application can't be found.

ResourceProvisionedThroughputExceededException

  • ResourceProvisionedThroughputExceededException object: Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.

RoleARN

  • RoleARN string

S3Configuration

  • S3Configuration object: Provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to access the bucket, and the name of the S3 object that contains the data.

S3ReferenceDataSource

  • S3ReferenceDataSource object: Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

S3ReferenceDataSourceDescription

  • S3ReferenceDataSourceDescription object: Provides the bucket name and object key name that stores the reference data.

S3ReferenceDataSourceUpdate

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

ServiceUnavailableException

  • ServiceUnavailableException object: The service is unavailable, back off and retry the operation.

SourceSchema

  • SourceSchema object: 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.

StartApplicationRequest

StartApplicationResponse

  • StartApplicationResponse object:

StopApplicationRequest

StopApplicationResponse

  • StopApplicationResponse object:

Timestamp

  • Timestamp string

UnableToDetectSchemaException

  • UnableToDetectSchemaException object: Data format is not valid, Amazon Kinesis Analytics is not able to detect schema for the given streaming source.

UpdateApplicationRequest

UpdateApplicationResponse

  • UpdateApplicationResponse object
5.0.0

7 years ago

4.0.0

8 years ago

3.0.4

8 years ago

3.0.3

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago