5.0.0 • Published 7 years ago
@datafire/amazonaws_kinesisanalytics v5.0.0
@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
- input
object
- ApplicationName required ApplicationName
- CloudWatchLoggingOption required CloudWatchLoggingOption
- CurrentApplicationVersionId required ApplicationVersionId
Output
AddApplicationInput
amazonaws_kinesisanalytics.AddApplicationInput({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"Input": {
"NamePrefix": "",
"InputSchema": {
"RecordFormat": {
"RecordFormatType": ""
},
"RecordColumns": []
}
}
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- Input required Input
Output
- output AddApplicationInputResponse
AddApplicationInputProcessingConfiguration
amazonaws_kinesisanalytics.AddApplicationInputProcessingConfiguration({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"InputId": "",
"InputProcessingConfiguration": {
"InputLambdaProcessor": {
"ResourceARN": "",
"RoleARN": ""
}
}
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- InputId required Id
- InputProcessingConfiguration required InputProcessingConfiguration
Output
AddApplicationOutput
amazonaws_kinesisanalytics.AddApplicationOutput({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"Output": {
"Name": "",
"DestinationSchema": {}
}
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- Output required Output
Output
- output AddApplicationOutputResponse
AddApplicationReferenceDataSource
amazonaws_kinesisanalytics.AddApplicationReferenceDataSource({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"ReferenceDataSource": {
"TableName": "",
"ReferenceSchema": {
"RecordFormat": {
"RecordFormatType": ""
},
"RecordColumns": []
}
}
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- ReferenceDataSource required ReferenceDataSource
Output
CreateApplication
amazonaws_kinesisanalytics.CreateApplication({
"ApplicationName": ""
}, context)
Input
- input
object
- ApplicationCode ApplicationCode
- ApplicationDescription ApplicationDescription
- ApplicationName required ApplicationName
- CloudWatchLoggingOptions CloudWatchLoggingOptions
- Inputs Inputs
- Outputs Outputs
Output
- output CreateApplicationResponse
DeleteApplication
amazonaws_kinesisanalytics.DeleteApplication({
"ApplicationName": "",
"CreateTimestamp": ""
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CreateTimestamp required Timestamp
Output
- output DeleteApplicationResponse
DeleteApplicationCloudWatchLoggingOption
amazonaws_kinesisanalytics.DeleteApplicationCloudWatchLoggingOption({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"CloudWatchLoggingOptionId": ""
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CloudWatchLoggingOptionId required Id
- CurrentApplicationVersionId required ApplicationVersionId
Output
DeleteApplicationInputProcessingConfiguration
amazonaws_kinesisanalytics.DeleteApplicationInputProcessingConfiguration({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"InputId": ""
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- InputId required Id
Output
DeleteApplicationOutput
amazonaws_kinesisanalytics.DeleteApplicationOutput({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"OutputId": ""
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- OutputId required Id
Output
DeleteApplicationReferenceDataSource
amazonaws_kinesisanalytics.DeleteApplicationReferenceDataSource({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"ReferenceId": ""
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- ReferenceId required Id
Output
DescribeApplication
amazonaws_kinesisanalytics.DescribeApplication({
"ApplicationName": ""
}, context)
Input
- input
object
- ApplicationName required ApplicationName
Output
- output DescribeApplicationResponse
DiscoverInputSchema
amazonaws_kinesisanalytics.DiscoverInputSchema({}, context)
Input
- input
object
- InputProcessingConfiguration InputProcessingConfiguration
- InputStartingPositionConfiguration InputStartingPositionConfiguration
- ResourceARN ResourceARN
- RoleARN RoleARN
- S3Configuration S3Configuration
Output
- output DiscoverInputSchemaResponse
ListApplications
amazonaws_kinesisanalytics.ListApplications({}, context)
Input
- input
object
- ExclusiveStartApplicationName ApplicationName
- Limit ListApplicationsInputLimit
Output
- output ListApplicationsResponse
StartApplication
amazonaws_kinesisanalytics.StartApplication({
"ApplicationName": "",
"InputConfigurations": []
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- InputConfigurations required InputConfigurations
Output
- output StartApplicationResponse
StopApplication
amazonaws_kinesisanalytics.StopApplication({
"ApplicationName": ""
}, context)
Input
- input
object
- ApplicationName required ApplicationName
Output
- output StopApplicationResponse
UpdateApplication
amazonaws_kinesisanalytics.UpdateApplication({
"ApplicationName": "",
"CurrentApplicationVersionId": 0,
"ApplicationUpdate": {}
}, context)
Input
- input
object
- ApplicationName required ApplicationName
- ApplicationUpdate required ApplicationUpdate
- CurrentApplicationVersionId required ApplicationVersionId
Output
- output UpdateApplicationResponse
Definitions
AddApplicationCloudWatchLoggingOptionRequest
- AddApplicationCloudWatchLoggingOptionRequest
object
- ApplicationName required ApplicationName
- CloudWatchLoggingOption required CloudWatchLoggingOption
- CurrentApplicationVersionId required ApplicationVersionId
AddApplicationCloudWatchLoggingOptionResponse
- AddApplicationCloudWatchLoggingOptionResponse
object
AddApplicationInputProcessingConfigurationRequest
- AddApplicationInputProcessingConfigurationRequest
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- InputId required Id
- InputProcessingConfiguration required InputProcessingConfiguration
AddApplicationInputProcessingConfigurationResponse
- AddApplicationInputProcessingConfigurationResponse
object
AddApplicationInputRequest
- AddApplicationInputRequest
object
:- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- Input required Input
AddApplicationInputResponse
- AddApplicationInputResponse
object
:
AddApplicationOutputRequest
- AddApplicationOutputRequest
object
:- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- Output required Output
AddApplicationOutputResponse
- AddApplicationOutputResponse
object
:
AddApplicationReferenceDataSourceRequest
- AddApplicationReferenceDataSourceRequest
object
:- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- ReferenceDataSource required ReferenceDataSource
AddApplicationReferenceDataSourceResponse
- AddApplicationReferenceDataSourceResponse
object
:
ApplicationCode
- ApplicationCode
string
ApplicationDescription
- ApplicationDescription
string
ApplicationDetail
- ApplicationDetail
object
: Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.- ApplicationARN required ResourceARN
- ApplicationCode ApplicationCode
- ApplicationDescription ApplicationDescription
- ApplicationName required ApplicationName
- ApplicationStatus required ApplicationStatus
- ApplicationVersionId required ApplicationVersionId
- CloudWatchLoggingOptionDescriptions CloudWatchLoggingOptionDescriptions
- CreateTimestamp Timestamp
- InputDescriptions InputDescriptions
- LastUpdateTimestamp Timestamp
- OutputDescriptions OutputDescriptions
- ReferenceDataSourceDescriptions ReferenceDataSourceDescriptions
ApplicationName
- ApplicationName
string
ApplicationStatus
- ApplicationStatus
string
(values: DELETING, STARTING, STOPPING, READY, RUNNING, UPDATING)
ApplicationSummaries
- ApplicationSummaries
array
- items ApplicationSummary
ApplicationSummary
- ApplicationSummary
object
: Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.- ApplicationARN required ResourceARN
- ApplicationName required ApplicationName
- ApplicationStatus required ApplicationStatus
ApplicationUpdate
- ApplicationUpdate
object
: Describes updates to apply to an existing Amazon Kinesis Analytics application.- ApplicationCodeUpdate ApplicationCode
- CloudWatchLoggingOptionUpdates CloudWatchLoggingOptionUpdates
- InputUpdates InputUpdates
- OutputUpdates OutputUpdates
- ReferenceDataSourceUpdates ReferenceDataSourceUpdates
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"- RecordColumnDelimiter required RecordColumnDelimiter
- RecordRowDelimiter required RecordRowDelimiter
CloudWatchLoggingOption
- CloudWatchLoggingOption
object
: Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.- LogStreamARN required LogStreamARN
- RoleARN required RoleARN
CloudWatchLoggingOptionDescription
- CloudWatchLoggingOptionDescription
object
: Description of the CloudWatch logging option.- CloudWatchLoggingOptionId Id
- LogStreamARN required LogStreamARN
- RoleARN required RoleARN
CloudWatchLoggingOptionDescriptions
- CloudWatchLoggingOptionDescriptions
array
CloudWatchLoggingOptionUpdate
- CloudWatchLoggingOptionUpdate
object
: Describes CloudWatch logging option updates.- CloudWatchLoggingOptionId required Id
- LogStreamARNUpdate LogStreamARN
- RoleARNUpdate RoleARN
CloudWatchLoggingOptionUpdates
- CloudWatchLoggingOptionUpdates
array
CloudWatchLoggingOptions
- CloudWatchLoggingOptions
array
- items CloudWatchLoggingOption
CodeValidationException
- CodeValidationException
object
: User-provided application code (query) is invalid. This can be a simple syntax error.- message ErrorMessage
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.- message ErrorMessage
CreateApplicationRequest
- CreateApplicationRequest
object
: TBD- ApplicationCode ApplicationCode
- ApplicationDescription ApplicationDescription
- ApplicationName required ApplicationName
- CloudWatchLoggingOptions CloudWatchLoggingOptions
- Inputs Inputs
- Outputs Outputs
CreateApplicationResponse
- CreateApplicationResponse
object
: TBD- ApplicationSummary required ApplicationSummary
DeleteApplicationCloudWatchLoggingOptionRequest
- DeleteApplicationCloudWatchLoggingOptionRequest
object
- ApplicationName required ApplicationName
- CloudWatchLoggingOptionId required Id
- CurrentApplicationVersionId required ApplicationVersionId
DeleteApplicationCloudWatchLoggingOptionResponse
- DeleteApplicationCloudWatchLoggingOptionResponse
object
DeleteApplicationInputProcessingConfigurationRequest
- DeleteApplicationInputProcessingConfigurationRequest
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- InputId required Id
DeleteApplicationInputProcessingConfigurationResponse
- DeleteApplicationInputProcessingConfigurationResponse
object
DeleteApplicationOutputRequest
- DeleteApplicationOutputRequest
object
:- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- OutputId required Id
DeleteApplicationOutputResponse
- DeleteApplicationOutputResponse
object
:
DeleteApplicationReferenceDataSourceRequest
- DeleteApplicationReferenceDataSourceRequest
object
- ApplicationName required ApplicationName
- CurrentApplicationVersionId required ApplicationVersionId
- ReferenceId required Id
DeleteApplicationReferenceDataSourceResponse
- DeleteApplicationReferenceDataSourceResponse
object
DeleteApplicationRequest
- DeleteApplicationRequest
object
:- ApplicationName required ApplicationName
- CreateTimestamp required Timestamp
DeleteApplicationResponse
- DeleteApplicationResponse
object
:
DescribeApplicationRequest
- DescribeApplicationRequest
object
:- ApplicationName required ApplicationName
DescribeApplicationResponse
- DescribeApplicationResponse
object
:- ApplicationDetail required ApplicationDetail
DestinationSchema
- DestinationSchema
object
: Describes the data format when records are written to the destination. For more information, see Configuring Application Output.- RecordFormatType RecordFormatType
DiscoverInputSchemaRequest
- DiscoverInputSchemaRequest
object
- InputProcessingConfiguration InputProcessingConfiguration
- InputStartingPositionConfiguration InputStartingPositionConfiguration
- ResourceARN ResourceARN
- RoleARN RoleARN
- S3Configuration S3Configuration
DiscoverInputSchemaResponse
- DiscoverInputSchemaResponse
object
:- InputSchema SourceSchema
- ParsedInputRecords ParsedInputRecords
- ProcessedInputRecords ProcessedInputRecords
- RawInputRecords RawInputRecords
ErrorMessage
- ErrorMessage
string
FileKey
- FileKey
string
Id
- Id
string
InAppStreamName
- InAppStreamName
string
InAppStreamNames
- InAppStreamNames
array
- items InAppStreamName
InAppTableName
- InAppTableName
string
Input
- Input
object
: When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input.- InputParallelism InputParallelism
- InputProcessingConfiguration InputProcessingConfiguration
- InputSchema required SourceSchema
- KinesisFirehoseInput KinesisFirehoseInput
- KinesisStreamsInput KinesisStreamsInput
- NamePrefix required InAppStreamName
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.- Id required Id
- InputStartingPositionConfiguration required InputStartingPositionConfiguration
InputConfigurations
- InputConfigurations
array
- items InputConfiguration
InputDescription
- InputDescription
object
: Describes the application input configuration. For more information, see Configuring Application Input.- InAppStreamNames InAppStreamNames
- InputId Id
- InputParallelism InputParallelism
- InputProcessingConfigurationDescription InputProcessingConfigurationDescription
- InputSchema SourceSchema
- InputStartingPositionConfiguration InputStartingPositionConfiguration
- KinesisFirehoseInputDescription KinesisFirehoseInputDescription
- KinesisStreamsInputDescription KinesisStreamsInputDescription
- NamePrefix InAppStreamName
InputDescriptions
- InputDescriptions
array
- items InputDescription
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.- ResourceARN required ResourceARN
- RoleARN required RoleARN
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.- ResourceARN ResourceARN
- RoleARN RoleARN
InputLambdaProcessorUpdate
- InputLambdaProcessorUpdate
object
: Represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.- ResourceARNUpdate ResourceARN
- RoleARNUpdate RoleARN
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.- Count InputParallelismCount
InputParallelismCount
- InputParallelismCount
integer
InputParallelismUpdate
- InputParallelismUpdate
object
: Provides updates to the parallelism count.- CountUpdate InputParallelismCount
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.- InputLambdaProcessor required InputLambdaProcessor
InputProcessingConfigurationDescription
- InputProcessingConfigurationDescription
object
: Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda.- InputLambdaProcessorDescription InputLambdaProcessorDescription
InputProcessingConfigurationUpdate
- InputProcessingConfigurationUpdate
object
: Describes updates to an InputProcessingConfiguration.- InputLambdaProcessorUpdate required InputLambdaProcessorUpdate
InputSchemaUpdate
- InputSchemaUpdate
object
: Describes updates for the application's input schema.- RecordColumnUpdates RecordColumns
- RecordEncodingUpdate RecordEncoding
- RecordFormatUpdate RecordFormat
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.- InputStartingPosition InputStartingPosition
InputUpdate
- InputUpdate
object
: Describes updates to a specific input configuration (identified by the InputId of an application).- InputId required Id
- InputParallelismUpdate InputParallelismUpdate
- InputProcessingConfigurationUpdate InputProcessingConfigurationUpdate
- InputSchemaUpdate InputSchemaUpdate
- KinesisFirehoseInputUpdate KinesisFirehoseInputUpdate
- KinesisStreamsInputUpdate KinesisStreamsInputUpdate
- NamePrefixUpdate InAppStreamName
InputUpdates
- InputUpdates
array
- items InputUpdate
Inputs
- Inputs
array
- items Input
InvalidApplicationConfigurationException
- InvalidApplicationConfigurationException
object
: User-provided application configuration is not valid.- message ErrorMessage
InvalidArgumentException
- InvalidArgumentException
object
: Specified input parameter value is invalid.- message ErrorMessage
JSONMappingParameters
- JSONMappingParameters
object
: Provides additional mapping information when JSON is the record format on the streaming source.- RecordRowPath required RecordRowPath
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.- ResourceARN required ResourceARN
- RoleARN required RoleARN
KinesisFirehoseInputDescription
- KinesisFirehoseInputDescription
object
: Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.- ResourceARN ResourceARN
- RoleARN RoleARN
KinesisFirehoseInputUpdate
- KinesisFirehoseInputUpdate
object
: When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.- ResourceARNUpdate ResourceARN
- RoleARNUpdate RoleARN
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.- ResourceARN required ResourceARN
- RoleARN required RoleARN
KinesisFirehoseOutputDescription
- KinesisFirehoseOutputDescription
object
: For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.- ResourceARN ResourceARN
- RoleARN RoleARN
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.- ResourceARNUpdate ResourceARN
- RoleARNUpdate RoleARN
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.- ResourceARN required ResourceARN
- RoleARN required RoleARN
KinesisStreamsInputDescription
- KinesisStreamsInputDescription
object
: Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.- ResourceARN ResourceARN
- RoleARN RoleARN
KinesisStreamsInputUpdate
- KinesisStreamsInputUpdate
object
: When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.- ResourceARNUpdate ResourceARN
- RoleARNUpdate RoleARN
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.- ResourceARN required ResourceARN
- RoleARN required RoleARN
KinesisStreamsOutputDescription
- KinesisStreamsOutputDescription
object
: For an application output, describes the Amazon Kinesis stream configured as its destination.- ResourceARN ResourceARN
- RoleARN RoleARN
KinesisStreamsOutputUpdate
- KinesisStreamsOutputUpdate
object
: When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.- ResourceARNUpdate ResourceARN
- RoleARNUpdate RoleARN
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.- ResourceARN required ResourceARN
- RoleARN required RoleARN
LambdaOutputDescription
- LambdaOutputDescription
object
: For an application output, describes the AWS Lambda function configured as its destination.- ResourceARN ResourceARN
- RoleARN RoleARN
LambdaOutputUpdate
- LambdaOutputUpdate
object
: When updating an output configuration using the UpdateApplication operation, provides information about an AWS Lambda function configured as the destination.- ResourceARNUpdate ResourceARN
- RoleARNUpdate RoleARN
LimitExceededException
- LimitExceededException
object
: Exceeded the number of applications allowed.- message ErrorMessage
ListApplicationsInputLimit
- ListApplicationsInputLimit
integer
ListApplicationsRequest
- ListApplicationsRequest
object
:- ExclusiveStartApplicationName ApplicationName
- Limit ListApplicationsInputLimit
ListApplicationsResponse
- ListApplicationsResponse
object
:- ApplicationSummaries required ApplicationSummaries
- HasMoreApplications required BooleanObject
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.- CSVMappingParameters CSVMappingParameters
- JSONMappingParameters JSONMappingParameters
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.- DestinationSchema required DestinationSchema
- KinesisFirehoseOutput KinesisFirehoseOutput
- KinesisStreamsOutput KinesisStreamsOutput
- LambdaOutput LambdaOutput
- Name required InAppStreamName
OutputDescription
- OutputDescription
object
: Describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.- DestinationSchema DestinationSchema
- KinesisFirehoseOutputDescription KinesisFirehoseOutputDescription
- KinesisStreamsOutputDescription KinesisStreamsOutputDescription
- LambdaOutputDescription LambdaOutputDescription
- Name InAppStreamName
- OutputId Id
OutputDescriptions
- OutputDescriptions
array
- items OutputDescription
OutputUpdate
- OutputUpdate
object
: Describes updates to the output configuration identified by the OutputId.- DestinationSchemaUpdate DestinationSchema
- KinesisFirehoseOutputUpdate KinesisFirehoseOutputUpdate
- KinesisStreamsOutputUpdate KinesisStreamsOutputUpdate
- LambdaOutputUpdate LambdaOutputUpdate
- NameUpdate InAppStreamName
- OutputId required Id
OutputUpdates
- OutputUpdates
array
- items OutputUpdate
Outputs
- Outputs
array
- items Output
ParsedInputRecord
- ParsedInputRecord
array
- items ParsedInputRecordField
ParsedInputRecordField
- ParsedInputRecordField
string
ParsedInputRecords
- ParsedInputRecords
array
- items ParsedInputRecord
ProcessedInputRecord
- ProcessedInputRecord
string
ProcessedInputRecords
- ProcessedInputRecords
array
- items ProcessedInputRecord
RawInputRecord
- RawInputRecord
string
RawInputRecords
- RawInputRecords
array
- items RawInputRecord
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.- Mapping RecordColumnMapping
- Name required RecordColumnName
- SqlType required RecordColumnSqlType
RecordColumnDelimiter
- RecordColumnDelimiter
string
RecordColumnMapping
- RecordColumnMapping
string
RecordColumnName
- RecordColumnName
string
RecordColumnSqlType
- RecordColumnSqlType
string
RecordColumns
- RecordColumns
array
- items RecordColumn
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.- MappingParameters MappingParameters
- RecordFormatType required RecordFormatType
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.- ReferenceSchema required SourceSchema
- S3ReferenceDataSource S3ReferenceDataSource
- TableName required InAppTableName
ReferenceDataSourceDescription
- ReferenceDataSourceDescription
object
: Describes the reference data source configured for an application.- ReferenceId required Id
- ReferenceSchema SourceSchema
- S3ReferenceDataSourceDescription required S3ReferenceDataSourceDescription
- TableName required InAppTableName
ReferenceDataSourceDescriptions
- ReferenceDataSourceDescriptions
array
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.- ReferenceId required Id
- ReferenceSchemaUpdate SourceSchema
- S3ReferenceDataSourceUpdate S3ReferenceDataSourceUpdate
- TableNameUpdate InAppTableName
ReferenceDataSourceUpdates
- ReferenceDataSourceUpdates
array
ResourceARN
- ResourceARN
string
ResourceInUseException
- ResourceInUseException
object
: Application is not available for this operation.- message ErrorMessage
ResourceNotFoundException
- ResourceNotFoundException
object
: Specified application can't be found.- message ErrorMessage
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.- message ErrorMessage
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.- message ErrorMessage
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.- RecordColumns required RecordColumns
- RecordEncoding RecordEncoding
- RecordFormat required RecordFormat
StartApplicationRequest
- StartApplicationRequest
object
:- ApplicationName required ApplicationName
- InputConfigurations required InputConfigurations
StartApplicationResponse
- StartApplicationResponse
object
:
StopApplicationRequest
- StopApplicationRequest
object
:- ApplicationName required ApplicationName
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.- ProcessedInputRecords ProcessedInputRecords
- RawInputRecords RawInputRecords
- message ErrorMessage
UpdateApplicationRequest
- UpdateApplicationRequest
object
- ApplicationName required ApplicationName
- ApplicationUpdate required ApplicationUpdate
- CurrentApplicationVersionId required ApplicationVersionId
UpdateApplicationResponse
- UpdateApplicationResponse
object