AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Kinesis Analytics AddApplicationInput API operation.

Syntax

Add-KINAApplicationInput
-ApplicationName <String>
-InputParallelism_Count <Int32>
-CurrentApplicationVersionId <Int64>
-Input_NamePrefix <String>
-CSVMappingParameters_RecordColumnDelimiter <String>
-InputSchema_RecordColumn <RecordColumn[]>
-InputSchema_RecordEncoding <String>
-RecordFormat_RecordFormatType <RecordFormatType>
-CSVMappingParameters_RecordRowDelimiter <String>
-JSONMappingParameters_RecordRowPath <String>
-InputLambdaProcessor_ResourceARN <String>
-KinesisFirehoseInput_ResourceARN <String>
-KinesisStreamsInput_ResourceARN <String>
-InputLambdaProcessor_RoleARN <String>
-KinesisFirehoseInput_RoleARN <String>
-KinesisStreamsInput_RoleARN <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation. Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input. You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication. Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version. This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.

Parameters

-ApplicationName <String>
Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-CSVMappingParameters_RecordColumnDelimiter <String>
Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputSchema_RecordFormat_MappingParameters_CSVMappingParameters_RecordColumnDelimiter
-CSVMappingParameters_RecordRowDelimiter <String>
Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputSchema_RecordFormat_MappingParameters_CSVMappingParameters_RecordRowDelimiter
-CurrentApplicationVersionId <Int64>
Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-Input_NamePrefix <String>
Name prefix to use when creating an in-application stream. Suppose that you specify a prefix "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001," "MyInApplicationStream_002," and so on.
Required?False
Position?Named
Accept pipeline input?False
-InputLambdaProcessor_ResourceARN <String>
The ARN of the AWS Lambda function that operates on records in the stream.To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputProcessingConfiguration_InputLambdaProcessor_ResourceARN
-InputLambdaProcessor_RoleARN <String>
The ARN of the IAM role that is used to access the AWS Lambda function.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputProcessingConfiguration_InputLambdaProcessor_RoleARN
-InputParallelism_Count <Int32>
Number of in-application streams to create. For more information, see Limits.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputParallelism_Count
-InputSchema_RecordColumn <RecordColumn[]>
A list of RecordColumn objects.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputSchema_RecordColumns
-InputSchema_RecordEncoding <String>
Specifies the encoding of the records in the streaming source. For example, UTF-8.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputSchema_RecordEncoding
-JSONMappingParameters_RecordRowPath <String>
Path to the top-level parent that contains the records.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputSchema_RecordFormat_MappingParameters_JSONMappingParameters_RecordRowPath
-KinesisFirehoseInput_ResourceARN <String>
ARN of the input delivery stream.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_KinesisFirehoseInput_ResourceARN
-KinesisFirehoseInput_RoleARN <String>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_KinesisFirehoseInput_RoleARN
-KinesisStreamsInput_ResourceARN <String>
ARN of the input Amazon Kinesis stream to read.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_KinesisStreamsInput_ResourceARN
-KinesisStreamsInput_RoleARN <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.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_KinesisStreamsInput_RoleARN
-PassThru <SwitchParameter>
Returns the value passed to the ApplicationName parameter. By default, this cmdlet does not generate any output.
Required?False
Position?Named
Accept pipeline input?False
-RecordFormat_RecordFormatType <RecordFormatType>
The type of record format.
Required?False
Position?Named
Accept pipeline input?False
AliasesInput_InputSchema_RecordFormat_RecordFormatType

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
Aliases AK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
Aliases AWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
Aliases AWSProfileName, StoredCredentials
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
Aliases SecretAccessKey, SK
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
Aliases RegionToCall
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the ApplicationName parameter.

Outputs

None or System.String
When you use the PassThru parameter, this cmdlet outputs the value supplied to the ApplicationName parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.KinesisAnalytics.Model.AddApplicationInputResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z