2017/06/02 - Amazon Kinesis Analytics - 2 new3 updated api methods
Changes Update kinesisanalytics client to latest version
Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Monitoring Configuration Errors.
See also: AWS API Documentation
Request Syntax
client.add_application_cloud_watch_logging_option(
ApplicationName='string',
CurrentApplicationVersionId=123,
CloudWatchLoggingOption={
'LogStreamARN': 'string',
'RoleARN': 'string'
}
)
string
[REQUIRED]
The Amazon Kinesis Analytics application name.
integer
[REQUIRED]
The version ID of the Amazon Kinesis Analytics application.
dict
[REQUIRED]
Provide the CloudWatch log stream ARN and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.
LogStreamARN (string) -- [REQUIRED]
ARN of the CloudWatch log to receive application messages.
RoleARN (string) -- [REQUIRED]
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Monitoring Configuration Errors.
See also: AWS API Documentation
Request Syntax
client.delete_application_cloud_watch_logging_option(
ApplicationName='string',
CurrentApplicationVersionId=123,
CloudWatchLoggingOptionId='string'
)
string
[REQUIRED]
The Amazon Kinesis Analytics application name.
integer
[REQUIRED]
The version ID of the Amazon Kinesis Analytics application.
string
[REQUIRED]
The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. You can use the DescribeApplication operation to get the CloudWatchLoggingOptionId.
dict
Response Syntax
{}
Response Structure
(dict) --
{'CloudWatchLoggingOptions': [{'LogStreamARN': 'string', 'RoleARN': 'string'}]}
Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works.
In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.
Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.
In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.
To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.
For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.
See also: AWS API Documentation
Request Syntax
client.create_application(
ApplicationName='string',
ApplicationDescription='string',
Inputs=[
{
'NamePrefix': 'string',
'KinesisStreamsInput': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInput': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputParallelism': {
'Count': 123
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
],
Outputs=[
{
'Name': 'string',
'KinesisStreamsOutput': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutput': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
CloudWatchLoggingOptions=[
{
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
ApplicationCode='string'
)
string
[REQUIRED]
Name of your Amazon Kinesis Analytics application (for example, sample-app).
string
Summary description of the application.
list
Use this parameter to configure the application input.
You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).
For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.
To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.
(dict) --
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.
NamePrefix (string) -- [REQUIRED]
Name prefix to use when creating in-application stream. Suppose you specify a prefix "MyInApplicationStream". Amazon Kinesis Analytics will then create one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001", "MyInApplicationStream_002" and so on.
KinesisStreamsInput (dict) --
If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
ResourceARN (string) -- [REQUIRED]
ARN of the input Amazon Kinesis stream to read.
RoleARN (string) -- [REQUIRED]
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
KinesisFirehoseInput (dict) --
If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the Firehose delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
ResourceARN (string) -- [REQUIRED]
ARN of the input Firehose delivery stream.
RoleARN (string) -- [REQUIRED]
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure the role has necessary permissions to access the stream.
InputParallelism (dict) --
Describes the number of in-application streams to create.
Data from your source will be routed to these in-application input streams.
(see Configuring Application Input.
Count (integer) --
Number of in-application streams to create. For more information, see Limits.
InputSchema (dict) -- [REQUIRED]
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 (dict) -- [REQUIRED]
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
Path to the top-level parent that contains the records.
For example, consider the following JSON record:
In the RecordRowPath, "$" refers to the root and path "$.vehicle.Model" refers to the specific "Model" key in the JSON.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
Row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
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 (list) -- [REQUIRED]
A list of RecordColumn objects.
(dict) --
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.
Name (string) -- [REQUIRED]
Name of the column created in the in-application input stream or reference table.
Mapping (string) --
Reference to the data element in the streaming input of the reference data source.
SqlType (string) -- [REQUIRED]
Type of column created in the in-application input stream or reference table.
list
You can configure application output to write data from any of the in-application streams to up to five destinations.
These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, or both.
In the configuration, you specify the in-application stream name, the destination stream Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf.
In the output configuration, you also provide the output stream Amazon Resource Name (ARN) and the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to this stream on your behalf.
(dict) --
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.
Name (string) -- [REQUIRED]
Name of the in-application stream.
KinesisStreamsOutput (dict) --
Identifies an Amazon Kinesis stream as the destination.
ResourceARN (string) -- [REQUIRED]
ARN of the destination Amazon Kinesis stream to write to.
RoleARN (string) -- [REQUIRED]
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.
KinesisFirehoseOutput (dict) --
Identifies an Amazon Kinesis Firehose delivery stream as the destination.
ResourceARN (string) -- [REQUIRED]
ARN of the destination Amazon Kinesis Firehose delivery stream to write to.
RoleARN (string) -- [REQUIRED]
ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.
DestinationSchema (dict) -- [REQUIRED]
Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
list
Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Monitoring Configuration Errors.
(dict) --
Provides a description of CloudWatch logging options, including the log stream ARN and the role ARN.
LogStreamARN (string) -- [REQUIRED]
ARN of the CloudWatch log to receive application messages.
RoleARN (string) -- [REQUIRED]
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.
string
One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more inforamtion about the typical pattern, see Application Code.
You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.
Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams.
dict
Response Syntax
{
'ApplicationSummary': {
'ApplicationName': 'string',
'ApplicationARN': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'
}
}
Response Structure
(dict) --
TBD
ApplicationSummary (dict) --
In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.
ApplicationName (string) --
Name of the application.
ApplicationARN (string) --
ARN of the application.
ApplicationStatus (string) --
Status of the application.
{'ApplicationDetail': {'CloudWatchLoggingOptionDescriptions': [{'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'}]}}
Returns information about a specific Amazon Kinesis Analytics application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.
See also: AWS API Documentation
Request Syntax
client.describe_application(
ApplicationName='string'
)
string
[REQUIRED]
Name of the application.
dict
Response Syntax
{
'ApplicationDetail': {
'ApplicationName': 'string',
'ApplicationDescription': 'string',
'ApplicationARN': 'string',
'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING',
'CreateTimestamp': datetime(2015, 1, 1),
'LastUpdateTimestamp': datetime(2015, 1, 1),
'InputDescriptions': [
{
'InputId': 'string',
'NamePrefix': 'string',
'InAppStreamNames': [
'string',
],
'KinesisStreamsInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseInputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'InputSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelism': {
'Count': 123
},
'InputStartingPositionConfiguration': {
'InputStartingPosition': 'NOW'|'TRIM_HORIZON'|'LAST_STOPPED_POINT'
}
},
],
'OutputDescriptions': [
{
'OutputId': 'string',
'Name': 'string',
'KinesisStreamsOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'KinesisFirehoseOutputDescription': {
'ResourceARN': 'string',
'RoleARN': 'string'
},
'DestinationSchema': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceDescriptions': [
{
'ReferenceId': 'string',
'TableName': 'string',
'S3ReferenceDataSourceDescription': {
'BucketARN': 'string',
'FileKey': 'string',
'ReferenceRoleARN': 'string'
},
'ReferenceSchema': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
],
'CloudWatchLoggingOptionDescriptions': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARN': 'string',
'RoleARN': 'string'
},
],
'ApplicationCode': 'string',
'ApplicationVersionId': 123
}
}
Response Structure
(dict) --
ApplicationDetail (dict) --
Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.
ApplicationName (string) --
Name of the application.
ApplicationDescription (string) --
Description of the application.
ApplicationARN (string) --
ARN of the application.
ApplicationStatus (string) --
Status of the application.
CreateTimestamp (datetime) --
Timestamp when the application version was created.
LastUpdateTimestamp (datetime) --
Timestamp when the application was last updated.
InputDescriptions (list) --
Describes the application input configuration. For more information, see Configuring Application Input.
(dict) --
Describes the application input configuration. For more information, see Configuring Application Input.
InputId (string) --
Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.
NamePrefix (string) --
In-application name prefix.
InAppStreamNames (list) --
Returns the in-application stream names that are mapped to the stream source.
(string) --
KinesisStreamsInputDescription (dict) --
If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
ResourceARN (string) --
Amazon Resource Name (ARN) of the Amazon Kinesis stream.
RoleARN (string) --
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
KinesisFirehoseInputDescription (dict) --
If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
ResourceARN (string) --
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
RoleARN (string) --
ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.
InputSchema (dict) --
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 (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
Path to the top-level parent that contains the records.
For example, consider the following JSON record:
In the RecordRowPath, "$" refers to the root and path "$.vehicle.Model" refers to the specific "Model" key in the JSON.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
Row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
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.
Name (string) --
Name of the column created in the in-application input stream or reference table.
Mapping (string) --
Reference to the data element in the streaming input of the reference data source.
SqlType (string) --
Type of column created in the in-application input stream or reference table.
InputParallelism (dict) --
Describes the configured parallelism (number of in-application streams mapped to the streaming source).
Count (integer) --
Number of in-application streams to create. For more information, see Limits.
InputStartingPositionConfiguration (dict) --
Point at which the application is configured to read from the input stream.
InputStartingPosition (string) --
The starting position on the stream.
NOW - Start reading just after the most recent record in the stream, start at the request 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 Firehose delivery stream.
LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
OutputDescriptions (list) --
Describes the application output configuration. For more information, see Configuring Application Output.
(dict) --
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.
OutputId (string) --
A unique identifier for the output configuration.
Name (string) --
Name of the in-application stream configured as output.
KinesisStreamsOutputDescription (dict) --
Describes Amazon Kinesis stream configured as the destination where output is written.
ResourceARN (string) --
Amazon Resource Name (ARN) of the Amazon Kinesis stream.
RoleARN (string) --
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
KinesisFirehoseOutputDescription (dict) --
Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
ResourceARN (string) --
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
RoleARN (string) --
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
DestinationSchema (dict) --
Data format used for writing data to the destination.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceDescriptions (list) --
Describes reference data sources configured for the application. For more information, see Configuring Application Input.
(dict) --
Describes the reference data source configured for an application.
ReferenceId (string) --
ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.
TableName (string) --
The in-application table name created by the specific reference data source configuration.
S3ReferenceDataSourceDescription (dict) --
Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.
BucketARN (string) --
Amazon Resource Name (ARN) of the S3 bucket.
FileKey (string) --
Amazon S3 object key name.
ReferenceRoleARN (string) --
ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.
ReferenceSchema (dict) --
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 (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) --
The type of record format.
MappingParameters (dict) --
When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) --
Path to the top-level parent that contains the records.
For example, consider the following JSON record:
In the RecordRowPath, "$" refers to the root and path "$.vehicle.Model" refers to the specific "Model" key in the JSON.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) --
Row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) --
Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncoding (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumns (list) --
A list of RecordColumn objects.
(dict) --
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.
Name (string) --
Name of the column created in the in-application input stream or reference table.
Mapping (string) --
Reference to the data element in the streaming input of the reference data source.
SqlType (string) --
Type of column created in the in-application input stream or reference table.
CloudWatchLoggingOptionDescriptions (list) --
Describes the CloudWatch log streams configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Monitoring Configuration Errors.
(dict) --
Description of the CloudWatch logging option.
CloudWatchLoggingOptionId (string) --
ID of the CloudWatch logging option description.
LogStreamARN (string) --
ARN of the CloudWatch log to receive application messages.
RoleARN (string) --
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.
ApplicationCode (string) --
Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.
ApplicationVersionId (integer) --
Provides the current application version.
{'ApplicationUpdate': {'CloudWatchLoggingOptionUpdates': [{'CloudWatchLoggingOptionId': 'string',
'LogStreamARNUpdate': 'string',
'RoleARNUpdate': 'string'}]}}
Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.
Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.
This operation requires permission for the kinesisanalytics:UpdateApplication action.
See also: AWS API Documentation
Request Syntax
client.update_application(
ApplicationName='string',
CurrentApplicationVersionId=123,
ApplicationUpdate={
'InputUpdates': [
{
'InputId': 'string',
'NamePrefixUpdate': 'string',
'KinesisStreamsInputUpdate': {
'ResourceARNUpdate': 'string',
'RoleARNUpdate': 'string'
},
'KinesisFirehoseInputUpdate': {
'ResourceARNUpdate': 'string',
'RoleARNUpdate': 'string'
},
'InputSchemaUpdate': {
'RecordFormatUpdate': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncodingUpdate': 'string',
'RecordColumnUpdates': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
},
'InputParallelismUpdate': {
'CountUpdate': 123
}
},
],
'ApplicationCodeUpdate': 'string',
'OutputUpdates': [
{
'OutputId': 'string',
'NameUpdate': 'string',
'KinesisStreamsOutputUpdate': {
'ResourceARNUpdate': 'string',
'RoleARNUpdate': 'string'
},
'KinesisFirehoseOutputUpdate': {
'ResourceARNUpdate': 'string',
'RoleARNUpdate': 'string'
},
'DestinationSchemaUpdate': {
'RecordFormatType': 'JSON'|'CSV'
}
},
],
'ReferenceDataSourceUpdates': [
{
'ReferenceId': 'string',
'TableNameUpdate': 'string',
'S3ReferenceDataSourceUpdate': {
'BucketARNUpdate': 'string',
'FileKeyUpdate': 'string',
'ReferenceRoleARNUpdate': 'string'
},
'ReferenceSchemaUpdate': {
'RecordFormat': {
'RecordFormatType': 'JSON'|'CSV',
'MappingParameters': {
'JSONMappingParameters': {
'RecordRowPath': 'string'
},
'CSVMappingParameters': {
'RecordRowDelimiter': 'string',
'RecordColumnDelimiter': 'string'
}
}
},
'RecordEncoding': 'string',
'RecordColumns': [
{
'Name': 'string',
'Mapping': 'string',
'SqlType': 'string'
},
]
}
},
],
'CloudWatchLoggingOptionUpdates': [
{
'CloudWatchLoggingOptionId': 'string',
'LogStreamARNUpdate': 'string',
'RoleARNUpdate': 'string'
},
]
}
)
string
[REQUIRED]
Name of the Amazon Kinesis Analytics application to update.
integer
[REQUIRED]
The current application version ID. You can use the DescribeApplication operation to get this value.
dict
[REQUIRED]
Describes application updates.
InputUpdates (list) --
Describes application input configuration updates.
(dict) --
Describes updates to a specific input configuration (identified by the InputId of an application).
InputId (string) -- [REQUIRED]
Input ID of the application input to be updated.
NamePrefixUpdate (string) --
Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.
KinesisStreamsInputUpdate (dict) --
If a Amazon Kinesis stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.
ResourceARNUpdate (string) --
Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.
RoleARNUpdate (string) --
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
KinesisFirehoseInputUpdate (dict) --
If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.
ResourceARNUpdate (string) --
ARN of the input Amazon Kinesis Firehose delivery stream to read.
RoleARNUpdate (string) --
Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant necessary permissions to this role.
InputSchemaUpdate (dict) --
Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.
RecordFormatUpdate (dict) --
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
Path to the top-level parent that contains the records.
For example, consider the following JSON record:
In the RecordRowPath, "$" refers to the root and path "$.vehicle.Model" refers to the specific "Model" key in the JSON.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
Row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
RecordEncodingUpdate (string) --
Specifies the encoding of the records in the streaming source. For example, UTF-8.
RecordColumnUpdates (list) --
A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.
(dict) --
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.
Name (string) -- [REQUIRED]
Name of the column created in the in-application input stream or reference table.
Mapping (string) --
Reference to the data element in the streaming input of the reference data source.
SqlType (string) -- [REQUIRED]
Type of column created in the in-application input stream or reference table.
InputParallelismUpdate (dict) --
Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the specific streaming source).
CountUpdate (integer) --
Number of in-application streams to create for the specified streaming source.
ApplicationCodeUpdate (string) --
Describes application code updates.
OutputUpdates (list) --
Describes application output configuration updates.
(dict) --
Describes updates to the output configuration identified by the OutputId.
OutputId (string) -- [REQUIRED]
Identifies the specific output configuration that you want to update.
NameUpdate (string) --
If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.
KinesisStreamsOutputUpdate (dict) --
Describes an Amazon Kinesis stream as the destination for the output.
ResourceARNUpdate (string) --
Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.
RoleARNUpdate (string) --
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.
KinesisFirehoseOutputUpdate (dict) --
Describes a Amazon Kinesis Firehose delivery stream as the destination for the output.
ResourceARNUpdate (string) --
Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.
RoleARNUpdate (string) --
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant necessary permissions to this role.
DestinationSchemaUpdate (dict) --
Describes the data format when records are written to the destination. For more information, see Configuring Application Output.
RecordFormatType (string) --
Specifies the format of the records on the output stream.
ReferenceDataSourceUpdates (list) --
Describes application reference data source updates.
(dict) --
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 (string) -- [REQUIRED]
ID of the reference data source being updated. You can use the DescribeApplication operation to get this value.
TableNameUpdate (string) --
In-application table name that is created by this update.
S3ReferenceDataSourceUpdate (dict) --
Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.
BucketARNUpdate (string) --
Amazon Resource Name (ARN) of the S3 bucket.
FileKeyUpdate (string) --
Object key name.
ReferenceRoleARNUpdate (string) --
ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.
ReferenceSchemaUpdate (dict) --
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 (dict) -- [REQUIRED]
Specifies the format of the records on the streaming source.
RecordFormatType (string) -- [REQUIRED]
The type of record format.
MappingParameters (dict) --
When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
JSONMappingParameters (dict) --
Provides additional mapping information when JSON is the record format on the streaming source.
RecordRowPath (string) -- [REQUIRED]
Path to the top-level parent that contains the records.
For example, consider the following JSON record:
In the RecordRowPath, "$" refers to the root and path "$.vehicle.Model" refers to the specific "Model" key in the JSON.
CSVMappingParameters (dict) --
Provides additional mapping information when the record format uses delimiters (for example, CSV).
RecordRowDelimiter (string) -- [REQUIRED]
Row delimiter. For example, in a CSV format, 'n' is the typical row delimiter.
RecordColumnDelimiter (string) -- [REQUIRED]
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 (list) -- [REQUIRED]
A list of RecordColumn objects.
(dict) --
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.
Name (string) -- [REQUIRED]
Name of the column created in the in-application input stream or reference table.
Mapping (string) --
Reference to the data element in the streaming input of the reference data source.
SqlType (string) -- [REQUIRED]
Type of column created in the in-application input stream or reference table.
CloudWatchLoggingOptionUpdates (list) --
Describes application CloudWatch logging option updates.
(dict) --
Describes CloudWatch logging option updates.
CloudWatchLoggingOptionId (string) -- [REQUIRED]
ID of the CloudWatch logging option to update
LogStreamARNUpdate (string) --
ARN of the CloudWatch log to receive application messages.
RoleARNUpdate (string) --
IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.
dict
Response Syntax
{}
Response Structure
(dict) --