View on GitHub
KinesisAnalyticsV2 Structure Reference
KinesisAnalyticsV2
public struct KinesisAnalyticsV2Client object for interacting with AWS KinesisAnalyticsV2 service.
Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using SQL or Java. The service enables you to quickly author and run SQL or Java code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the KinesisAnalyticsV2 client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Adds an Amazon CloudWatch log stream to monitor application configuration errors.
Declaration
Swift
public func addApplicationCloudWatchLoggingOption(_ input: AddApplicationCloudWatchLoggingOptionRequest) -> EventLoopFuture<AddApplicationCloudWatchLoggingOptionResponse> -
Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application. You can add a streaming source 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.
Declaration
Swift
public func addApplicationInput(_ input: AddApplicationInputRequest) -> EventLoopFuture<AddApplicationInputResponse> -
Adds an InputProcessingConfiguration to an SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application’s SQL code executes. Currently, the only input processor available is AWS Lambda.
Declaration
Swift
public func addApplicationInputProcessingConfiguration(_ input: AddApplicationInputProcessingConfigurationRequest) -> EventLoopFuture<AddApplicationInputProcessingConfigurationResponse> -
Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application. If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination. You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. 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.
Declaration
Swift
public func addApplicationOutput(_ input: AddApplicationOutputRequest) -> EventLoopFuture<AddApplicationOutputResponse> -
Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application. Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.
Declaration
Swift
public func addApplicationReferenceDataSource(_ input: AddApplicationReferenceDataSourceRequest) -> EventLoopFuture<AddApplicationReferenceDataSourceResponse> -
Adds a Virtual Private Cloud (VPC) configuration to the application. Applications can use VPCs to store and access resources securely. Note the following about VPC configurations for Kinesis Data Analytics applications: VPC configurations are not supported for SQL applications. When a VPC is added to a Kinesis Data Analytics application, the application can no longer be accessed from the Internet directly. To enable Internet access to the application, add an Internet gateway to your VPC.
Declaration
Swift
public func addApplicationVpcConfiguration(_ input: AddApplicationVpcConfigurationRequest) -> EventLoopFuture<AddApplicationVpcConfigurationResponse> -
Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.
Declaration
Swift
public func createApplication(_ input: CreateApplicationRequest) -> EventLoopFuture<CreateApplicationResponse> -
Creates a snapshot of the application’s state data.
Declaration
Swift
public func createApplicationSnapshot(_ input: CreateApplicationSnapshotRequest) -> EventLoopFuture<CreateApplicationSnapshotResponse> -
Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.
Declaration
Swift
public func deleteApplication(_ input: DeleteApplicationRequest) -> EventLoopFuture<DeleteApplicationResponse> -
Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.
Declaration
Swift
public func deleteApplicationCloudWatchLoggingOption(_ input: DeleteApplicationCloudWatchLoggingOptionRequest) -> EventLoopFuture<DeleteApplicationCloudWatchLoggingOptionResponse> -
Deletes an InputProcessingConfiguration from an input.
Declaration
Swift
public func deleteApplicationInputProcessingConfiguration(_ input: DeleteApplicationInputProcessingConfigurationRequest) -> EventLoopFuture<DeleteApplicationInputProcessingConfigurationResponse> -
Deletes the output destination configuration from your SQL-based Amazon Kinesis Data Analytics application’s configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.
Declaration
Swift
public func deleteApplicationOutput(_ input: DeleteApplicationOutputRequest) -> EventLoopFuture<DeleteApplicationOutputResponse> -
Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application’s configuration. If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.
Declaration
Swift
public func deleteApplicationReferenceDataSource(_ input: DeleteApplicationReferenceDataSourceRequest) -> EventLoopFuture<DeleteApplicationReferenceDataSourceResponse> -
Deletes a snapshot of application state.
Declaration
Swift
public func deleteApplicationSnapshot(_ input: DeleteApplicationSnapshotRequest) -> EventLoopFuture<DeleteApplicationSnapshotResponse> -
Removes a VPC configuration from a Kinesis Data Analytics application.
Declaration
Swift
public func deleteApplicationVpcConfiguration(_ input: DeleteApplicationVpcConfigurationRequest) -> EventLoopFuture<DeleteApplicationVpcConfigurationResponse> -
Returns information about a specific Amazon Kinesis Data Analytics application. If you want to retrieve a list of all applications in your account, use the ListApplications operation.
Declaration
Swift
public func describeApplication(_ input: DescribeApplicationRequest) -> EventLoopFuture<DescribeApplicationResponse> -
Returns information about a snapshot of application state data.
Declaration
Swift
public func describeApplicationSnapshot(_ input: DescribeApplicationSnapshotRequest) -> EventLoopFuture<DescribeApplicationSnapshotResponse> -
Infers a schema for an SQL-based Amazon Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon 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. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
Declaration
Swift
public func discoverInputSchema(_ input: DiscoverInputSchemaRequest) -> EventLoopFuture<DiscoverInputSchemaResponse> -
Lists information about the current application snapshots.
Declaration
Swift
public func listApplicationSnapshots(_ input: ListApplicationSnapshotsRequest) -> EventLoopFuture<ListApplicationSnapshotsResponse> -
Returns a list of Amazon Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If you want detailed information about a specific application, use DescribeApplication.
Declaration
Swift
public func listApplications(_ input: ListApplicationsRequest) -> EventLoopFuture<ListApplicationsResponse> -
Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
Declaration
Swift
public func listTagsForResource(_ input: ListTagsForResourceRequest) -> EventLoopFuture<ListTagsForResourceResponse> -
Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.
Declaration
Swift
public func startApplication(_ input: StartApplicationRequest) -> EventLoopFuture<StartApplicationResponse> -
Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state.
Declaration
Swift
public func stopApplication(_ input: StopApplicationRequest) -> EventLoopFuture<StopApplicationResponse> -
Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse> -
Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.
Declaration
Swift
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse> -
Updates an existing Amazon Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration. Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.
Declaration
Swift
public func updateApplication(_ input: UpdateApplicationRequest) -> EventLoopFuture<UpdateApplicationResponse>
-
Undocumented
See moreDeclaration
Swift
public enum ApplicationRestoreType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ApplicationStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum CodeContentType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ConfigurationType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum InputStartingPosition : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum LogLevel : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum MetricsLevel : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RecordFormatType : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RuntimeEnvironment : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum SnapshotStatus : String, CustomStringConvertible, Codable