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 DiscoverInputSchema API operation.

Syntax

Find-KINAInputSchema
-S3Configuration_BucketARN <String>
-S3Configuration_FileKey <String>
-InputStartingPositionConfiguration_InputStartingPosition <InputStartingPosition>
-InputLambdaProcessor_ResourceARN <String>
-ResourceARN <String>
-InputLambdaProcessor_RoleARN <String>
-RoleARN <String>
-S3Configuration_RoleARN <String>

Description

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema. You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.

Parameters

-InputLambdaProcessor_ResourceARN <String>
The ARN of the AWS Lambda function that operates on records in the stream.
Required?False
Position?Named
Accept pipeline input?False
-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
-InputStartingPositionConfiguration_InputStartingPosition <InputStartingPosition>
The starting position on the stream.
  • NOW - Start reading just after the most recent record in the stream, start at the request time stamp 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.
Required?False
Position?Named
Accept pipeline input?False
-ResourceARN <String>
Amazon Resource Name (ARN) of the streaming source.
Required?False
Position?Named
Accept pipeline input?False
-RoleARN <String>
ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.
Required?False
Position?Named
Accept pipeline input?False
-S3Configuration_BucketARN <String>
ARN of the S3 bucket that contains the data.
Required?False
Position?Named
Accept pipeline input?False
-S3Configuration_FileKey <String>
The name of the object that contains the data.
Required?False
Position?Named
Accept pipeline input?False
-S3Configuration_RoleARN <String>
IAM ARN of the role used to access the data.
Required?False
Position?Named
Accept pipeline input?False

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
-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
-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
-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
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-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
-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

This cmdlet does not accept pipeline input.

Outputs

Amazon.KinesisAnalytics.Model.DiscoverInputSchemaResponse
This cmdlet returns a Amazon.KinesisAnalytics.Model.DiscoverInputSchemaResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
SQL Reference
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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