AWS SDK Version 3 for .NET
API 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.

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 reference data source to an existing application.

Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.

For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginAddApplicationReferenceDataSource and EndAddApplicationReferenceDataSource.

Namespace: Amazon.KinesisAnalytics
Assembly: AWSSDK.KinesisAnalytics.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<AddApplicationReferenceDataSourceResponse> AddApplicationReferenceDataSourceAsync(
         AddApplicationReferenceDataSourceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.KinesisAnalytics.Model.AddApplicationReferenceDataSourceRequest

Container for the necessary parameters to execute the AddApplicationReferenceDataSource service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the AddApplicationReferenceDataSource service method, as returned by KinesisAnalytics.

Exceptions

ExceptionCondition
ConcurrentModificationException 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.
InvalidArgumentException Specified input parameter value is invalid.
ResourceInUseException Application is not available for this operation.
ResourceNotFoundException Specified application can't be found.
UnsupportedOperationException The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also